WSARecvDisconnect - Microsoft Windows Telephony API (TAPI) Programmer's Reference (tapi.hlp)

Microsoft Windows Telephony API
(TAPI) Programmer's Reference

WSARecvDisconnect

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
);

Parameters
s

[in] A descriptor identifying a socket.

lpInboundDisconnectData

[out] A pointer to the incoming disconnect data.

Remarks
WSARecvDisconnect is used on connection-oriented sockets to disable reception, and retrieve any incoming disconnect data from the remote party.

After this function has been successfully issued, subsequent receives on the socket will be disallowed. This has no effect on the lower protocol layers. For TCP, the TCP window is not changed and incoming data will be accepted (but not acknowledged) until the window is exhausted. 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, or get a zero return value, or a WSAEDISCON or WSAECONNRESET error code from recv/WSARecv.

Note that WSARecvDisconnect does not close the socket, and resources attached to the socket will not be freed until closesocket is invoked.

Comments
WSARecvDisconnect 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 WSARecvDisconnected. In particular, a Windows Sockets provider is not required to support the use of connect/WSAConnect on such a socket.

Return Values
If no error occurs, WSARecvDisconnect returns zero. Otherwise, a value of SOCKET_ERROR is returned, and a specific error code may be retrieved by calling WSAGetLastError.

Error Codes

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.