| BOOL GetStreamInfo( |
| |
SOCKET hSocket |
|
| |
LPINETSTREAMINFO
lpStreamInfo |
|
| ); |
| BOOL GetStreamInfo( |
| |
LPINETSTREAMINFO
lpStreamInfo |
|
| ); |
The GetStreamInfo function fills a structure with
information about the current stream I/O operation.
Parameters
- hSocket
- An optional parameter that specifies the handle to the client socket.
If this parameter is omitted, the socket handle for the active
client session will be used. If this method is called outside of a
server event handler, the socket handle must be specified.
- lpSecurityInfo
- A pointer to an INETSTREAMINFO structure which contains
information about the status of the current operation.
Return Value
If the method succeeds, the return value is non-zero. If the
method fails, the return value is zero. To get extended error
information, call GetLastError.
Remarks
The GetStreamInfo method returns information about the
current streaming socket operation, including the average number of
bytes transferred per second and the estimated amount of time until
the operation completes. If there is no operation currently in
progress, this method will return the status of the last successful
streaming read or write performed by the client.
Requirements
Minimum Desktop Platform: Windows 7 (Service Pack 1)
Minimum Server Platform: Windows Server 2008 R2 (Service Pack 1)
Header: Include cswsock10.h
Import Library: cswskv10.lib
See Also
ReadStream,
StoreStream,
WriteStream,
INETSTREAMINFO
|