Wavecom W-RCI (Remote Control) V8.7.0 - Manual (Page 58)

50

TCP/IP Interface XML SDK V8.7.0 Remote Control Interface
ty, a connection to the local server on the same host is established
strPort The port which is configured on the specified server. If the string is empty, this value
is ignored
void Disconnect(RCI_HANDLE hRci)
Disconnects from the specified server.
void SendXMLMessage(const void* pMessage, size_t unMsgSize, RCI_HANDLE
hRci)
Sends an XML message to the server.
Return Value
None.
Parameters
Parameter Definition
pMessage Pointer to the XML message
unMsgSize The size of the XML message in bytes
void SetUserParameter(RCI_HANDLE hRci, void *pParam)
This function can be used to associate user data with an RCI instance.
Return Value
None.
Parameters
Parameter Definition
pParam Pointer to the user data
void *GetUserParameter(RCI_HANDLE hRci)
Returns the previously set user parameter pointer. If no pointer has been set, it returns NULL.
Return Value
Pointer to the user data.
Sink
The parameter hRci is the value which was returned by the Start method of the source. It identifies the
user within the procedural API.
void XMLRCI_SINK_FUNCTION(const void* pMessage, size_t unMsgSize,
RCI_HANDLE hRci)
typedef void (* XMLRCI_SINK_FUNCTION_TYPE)(
const void *pMessage,
size_t unMsgSize,
RCI_HANDLE hRci
);
Function type definition for server-side XML messages. Through this interface the client receives XML mes-
sages from the server. It is a callback routine which has to be defined by the client application program-
mer and has to be passed to the source.
Parameters
Parameter Definition
pMessage Pointer to the XML message
unMsgSize The size of the XML message in bytes
void XMLRCI_CONNECTED_FUNCTION(RCI_HANDLE hRci)