| INT WINAPI WhoisGetStatus( |
| |
HCLIENT hClient |
|
| ); |
The WhoisGetStatus function returns the current status of
the client session.
Parameters
- hClient
- Handle to the client session.
Return Value
If the function succeeds, the return value is the client status
code. If the function fails, the return value is WHOIS_ERROR. To get
extended error information, call WhoisGetLastError.
Remarks
The WhoisGetStatus function returns a numeric code which
identifies the current state of the client session. The following
values may be returned:
| Value |
Constant |
Description |
| 1 |
WHOIS_STATUS_IDLE |
The client is current idle and not sending or receiving
data. |
| 2 |
WHOIS_STATUS_CONNECT |
The client is establishing a connection with the
server. |
| 3 |
WHOIS_STATUS_READ |
The client is reading data from the server. |
| 4 |
WHOIS_STATUS_WRITE |
The client is writing data to the server. |
| 5 |
WHOIS_STATUS_DISCONNECT |
The client is disconnecting from the server. |
In a multithreaded application, any thread in the current process
may call this function to obtain status information for the specified
client session.
Requirements
Minimum Desktop Platform: Windows 7 (Service Pack 1)
Minimum Server Platform: Windows Server 2008 R2 (Service Pack 1)
Header File: cstools10.h
Import Library: cswhov10.lib
See Also
WhoisIsBlocking,
WhoisIsConnected,
WhoisIsReadable
|