| BOOL WINAPI LlmIsConnected( |
| |
HCLIENT hClient |
|
| ); |
The LlmIsConnected function verifies that the client
session remains valid.
Parameters
- hClient
- A handle to the client session.
Return Value
If the client session is valid and connected to a server, the
function returns a non-zero value. If the client is not connected,
or the client handle is invalid, the function returns zero. To get
extended error information, call LlmGetLastError.
Remarks
The LlmIsConnected function determines whether there is
a logical connection to the service provider and the client has
successfully authenticated with the API server. Calling this function
is not simply a passive status check. The network connection to the
provider may be transient and can be automatically re-established
if the client session has been idle. Calling LlmIsConnected
may cause the library to reconnect and re-authenticate with the
server if necessary.
If the client must re-authenticate, it will attempt to reconnect
to the server and validate the selected model for the session. If
the server reports an error condition, such as an invalid API key,
the connection will not be re-established and the function will
return zero.
Requirements
Minimum Desktop Platform: Windows 7 Service Pack 1
Minimum Server Platform: Windows Server 2008 R2 Service Pack 1
Header File: cstools12.h
Import Library: csllmv12.lib
See Also
LlmConnect,
LlmConnectEx,
LlmDisconnect,
LlmGetIdleTime,
LlmIsBlocking,
LlmSetIdleTime
|