CPopClient::GetTransferStatus Method  
 
INT GetTransferStatus(
  LPPOPTRANSFERSTATUS lpStatus  
);

The GetTransferStatus method returns information about the current file transfer in progress.

Parameters

lpStatus
A pointer to an POPTRANSFERSTATUS structure which contains information about the status of the current file transfer.

Return Value

If the method succeeds, the return value is zero. If the method fails, the return value is POP_ERROR. To get extended error information, call GetLastError.

Remarks

The GetTransferStatus method returns information about the current file transfer, including the average number of bytes transferred per second and the estimated amount of time until the transfer completes. If there is no file currently being transferred, this method will return the status of the last successful transfer made by the client.

In a multithreaded application, any thread in the current process may call this method 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: cspopv10.lib

See Also

EnableEvents, GetStatus, RegisterEvent