| DWORD GetClientIdleTime( |
| |
SOCKET hSocket |
|
| ); |
| DWORD GetClientIdleTime(); |
Returns the number of milliseconds that the specified client
session has been idle.
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.
Return Value
If the method succeeds, the return value is an unsigned integer
value which specifies the number of milliseconds the client session
has been idle. If the method
fails, the return value is INFINITE. To get extended error information,
call GetLastError.
Remarks
The GetClientIdleTime method will return the number of
milliseconds that have elapsed since data was exchanged with the
client. The elapsed time is limited to the resolution of the system
timer, which is typically in the range of 10 milliseconds to 16
milliseconds.
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
GetClientHandle,
GetClientId,
GetClientMoniker,
GetTimeout
|