TAPICLIENT_ClientInitialize

The TAPICLIENT_ClientInitialize function is called when a new client attaches to the telephony server. This occurs when a client calls the lineInitialize, lineInitializeEx, phoneInitialize, or phoneInitializeEx function for the first time.

Every Client Management DLL must export TAPICLIENT_ClientInitialize.

LONG TAPICLIENT_ClientInitialize(
  LPCWSTR szDomain,              
  LPCWSTR szUserName,            
  LPCWSTR szMachineName,         
  LPMANAGEMENTCLIENT phmClient   
);
 

Parameters

szDomain

A NULL-terminated string containing the domain name of the new client.

szUserName

A NULL-terminated string containing the new client's user name.

szMachineName

A NULL-terminated string containing the machine name of the machine the client is connecting from.

phmClient

A pointer to an opaque handle that the DLL fills if the function succeeds. This handle is passed to the DLL in every other TAPICLIENT API to identify the client.

Return Values

Returns zero if the function succeeds; otherwise, returns one of the following values:

LINEERR_OPERATIONFAILED
LINEERR_NOMEM

Remarks

The Client Management DLL must fill in the phClient parameter with a handle that it can use to identify the client. The phClient parameter cannot be NULL if TAPICLIENT_ClientInitialize returns success.

See Also

lineInitialize, lineInitializeEx, phoneInitialize, phoneInitializeEx