VcCom API

Home of the VcCom API

CIP (Client IP Address) for Citrix Servers

This small API allows applications on a Citrix server to retrieve a client's local  IP Address. The API provides a COM interface which can be called from several development languages, including VB, C++ .net Java etc.

How to use the API

On your developer machine, install the server side of the API. The server side of the API contains the required files to include in your own software.

In a VB project, add the following file into the references of your project:

CLIIPSVR.DLL

The following code is taken from the example VB project which can also be downloaded, this shows how to connect and get the client's IP Address:

' Var specifying CitrixClientIPAddress.ClientIPAddress
Private m_CIP As CitrixClientIPAddress.ClientIPAddress

' Get data from the Citrix Client and return it in the function call
Private Sub GetData_Click()

    On Error GoTo error_handle


    ' Create a CitrixClientInfo.ClientDiskSerialNumber
    Set m_CIP = New CitrixClientIPAddress.ClientIPAddress

    ' Call GetClientIPAddress to get the info
    txtGetData.Text = m_CIP .GetClientIPAddress

    ' Delete the m_CDI
    Set m_CIP = Nothing

    Exit Sub

error_handle:

' Do not attempt to create the CIP object on a client PC as it uses Citrix server side function calls.
    MsgBox "GetData_Click : Only create the CIP object on a Citrix  Server"

End Sub


As you can see this is very simple, refer to the example application to see an alternative method that uses events to gain access to the clients IP Address.

To try out this API, please see the downloads page.