Edit

SIO_WSK_QUERY_RECEIVE_BACKLOG

  • Article

The SIO_WSK_QUERY_RECEIVE_BACKLOG socket I/O control operation allows a WSK application to query the current backlog of received data for a connection-oriented socket. This socket I/O control operation applies only to connection-oriented sockets.

If a WSK application uses this socket I/O control operation to query the receive backlog, it must do so after the connection-oriented socket has been connected to a remote transport address.

To query the current backlog of received data for a connection-oriented socket, a WSK application calls the WskControlSocket function with the following parameters.

Parameter Value

RequestType

WskIoctl

ControlCode

SIO_WSK_QUERY_RECEIVE_BACKLOG

Level

0

InputSize

0

InputBuffer

NULL

OutputSize

sizeof(SIZE_T)

OutputBuffer

A pointer to a SIZE_T-typed variable that receives the current backlog of received data

OutputSizeReturned

NULL

A WSK application must specify a pointer to an IRP when calling the WskControlSocket function to query the current backlog of received data for a connection-oriented socket.

Requirements

Version

Available in Windows Vista and later versions of the Windows operating systems.

Header

 Wsk.h (include Wsk.h)