CNntpClient::GetStatus Method  
 
INT GetStatus();

The GetStatus method the current status of the client session.

Parameters

None.

Return Value

If the method succeeds, the return value is the client status code. If the method fails, the return value is NNTP_ERROR. To get extended error information, call GetLastError.

Remarks

The GetStatus method returns a numeric code which identifies the current state of the client session. The following values may be returned:

Value Constant Description
0 NNTP_STATUS_UNUSED No connection has been established.
1 NNTP_STATUS_IDLE The client is current idle and not sending or receiving data.
2 NNTP_STATUS_CONNECT The client is establishing a connection with the server.
3 NNTP_STATUS_READ The client is reading data from the server.
4 NNTP_STATUS_WRITE The client is writing data to the server.
5 NNTP_STATUS_DISCONNECT The client is disconnecting from the server.

In a multithreaded application, any thread in the current process may call this method to obtain status information for the specified client session. To obtain status information about a file transfer, use the GetTransferStatus method.

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: csnwsv10.lib

See Also

IsBlocking, IsInitialized, IsReadable, IsWritable