| INT GetTransferStatus( |
| |
LPNNTPTRANSFERSTATUS lpStatus |
|
| ); |
| INT GetTransferStatus( |
| |
LPNNTPTRANSFERSTATUSEX lpStatus |
|
| ); |
The GetTransferStatus method returns information about the
current data transfer in progress.
Parameters
- lpStatus
- A pointer to an NNTPTRANSFERSTATUS
or NNTPTRANSFERSTATUSEX structure which
contains information about the status of the current data
transfer. If the server can potentially return very large article
IDs, it is recommended that you use the
NNTPTRANSFERSTATUSEX structure.
Return Value
If the method succeeds, the return value is zero. If the method
fails, the return value is NNTP_ERROR. To get extended error
information, call GetLastError.
Remarks
The GetTransferStatus method returns information
about the current data transfer, including the average number of
bytes transferred per second and the estimated amount of time until
the transfer completes. If no article is currently being
retrieved or submitted to the server, this function will return the status of the last
successful data 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: csnwsv10.lib
Unicode: Implemented as Unicode and ANSI versions.
See Also
EnableEvents,
GetStatus,
RegisterEvent
|