The WSARecvDisconnect function terminates reception on a socket, and retrieves the disconnect data if the socket is connection oriented.
int WSAAPI WSARecvDisconnect( SOCKET s, LPWSABUF lpInboundDisconnectData );
A descriptor identifying a socket.
A pointer to the incoming disconnect data.
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.
|A successful WSAStartup call must occur before using this function.|
|The network subsystem has failed.|
|The buffer referenced by the parameter lpInboundDisconnectData is too small.|
|The disconnect data is not supported by the indicated protocol family. Note that implementations of TCP/IP that do not support disconnect data are not required to return the WSAENOPROTOOPT error code. See the remarks section for information about the Microsoft implementation of TCP/IP.|
|A blocking Windows Sockets 1.1 call is in progress, or the service provider is still processing a callback function.|
|The socket is not connected (connection-oriented sockets only).|
|The descriptor is not a socket.|
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_RECEIVE), except that WSARecvDisconnect 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.
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 reuse a socket after it has been disconnected using WSARecvDisconnect. In particular, a Windows Sockets provider is not required to support the use of connect or WSAConnect on such a socket.
|Minimum supported client||Windows 2000 Professional [desktop apps only]|
|Minimum supported server||Windows 2000 Server [desktop apps only]|