The Windows Sockets WSARecvDisconnect function terminates reception on a socket, and retrieves the disconnect data if the socket is connection oriented.
int WSARecvDisconnect (
SOCKET s,
LPWSABUF lpInboundDisconnectData
);
The WSARecvDisconnect function is used on connection-oriented sockets to disable reception and retrieve any incoming disconnect data from the remote party.This is equivalent to a shutdown(SD_RECV), except that WSASendDisconnect also allows receipt of disconnect data (in protocols that support it).
After this function has been successfully issued, subsequent receives on the socket will be disallowed. Calling WSARecvDisconnect has no effect on the lower protocol layers. For TCP sockets, if there is still data queued on the socket waiting to be received, or data arrives subsequently, the connection is reset, since the data cannot be delivered to the user. For UDP, incoming datagrams are accepted and queued. In no case will an ICMP error packet be generated.
To successfully receive incoming disconnect data, an application must use other mechanisms to determine that the circuit has been closed. For example, an application needs to receive an FD_CLOSE notification, to receive a zero return value, or to receive a WSAEDISCON or WSAECONNRESET error code from recv/WSARecv.
The WSARecvDisconnect function does not close the socket, and resources attached to the socket will not be freed until closesocket is invoked.
The WSARecvDisconnect function does not block regardless of the SO_LINGER setting on the socket.
An application should not rely on being able to re-use a socket after it has been disconnected using WSARecvDisconnect. In particular, a Windows Sockets provider is not required to support the use of connect/WSAConnect on such a socket.
If no error occurs, WSARecvDisconnect returns zero. Otherwise, a value of SOCKET_ERROR is returned, and a specific error code can be retrieved by calling WSAGetLastError.
| WSANOTINITIALISED | A successful WSAStartup must occur before using this function. |
| WSAENETDOWN | The network subsystem has failed. |
| WSAEFAULT | The buffer referenced by the parameter lpInboundDisconnectData is too small. |
| WSAENOPROTOOPT | The disconnect data is not supported by the indicated protocol family. |
| WSAEINPROGRESS | A blocking Windows Sockets 1.1 call is in progress, or the service provider is still processing a callback function. |
| WSAENOTCONN | The socket is not connected (connection-oriented sockets only). |
| WSAENOTSOCK | The descriptor is not a socket. |
Windows NT: Yes
Windows: Yes
Windows CE: Unsupported.
Header: Declared in winsock2.h.
Import Library: Link with ws2_32.lib.