Platform SDK: Windows Sockets

WSPSendDisconnect

The WSPSendDisconnect function initiates termination of the connection for the socket and sends disconnect data.

int WSPSendDisconnect (
  SOCKET      s,                            
  LPWSABUF    lpOutboundDisconnectData,   
  LPINT       lpErrno                        
);

Parameters

s: [in] A descriptor identifying a socket.
lpOutboundDisconnectData: [in] A pointer to the outgoing disconnect data.
lpErrno: [out] A pointer to the error code.

Return Values

If no error occurs, WSPSendDisconnect returns zero. Otherwise, a value of SOCKET_ERROR is returned, and a specific error code is available in lpErrno.

Remarks

WSPSendDisconnect is used on connection-oriented sockets to disable transmission, and to initiate termination of the connection along with the transmission of disconnect data, if any.

After this function has been successfully issued, subsequent sends are disallowed.

lpOutboundDisconnectData, if not NULL, points to a buffer containing the outgoing disconnect data to be sent to the remote party.

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

Note WSPSendDisconnect does not block regardless of the SO_LINGER setting on the socket.

A Windows Sockets SPI client should not rely on being able to reuse a socket after it has been disconnected. In particular, a Windows Sockets provider is not required to support the use of WSPConnect on such a socket.

Error Codes

Error code	Meaning
WSAENETDOWN	Network subsystem has failed.
WSAENOPROTOOPT	Parameter lpOutboundDisconnectData is not NULL, and the disconnect data is not supported by the service provider.
WSAEINPROGRESS	Blocking Windows Sockets call is in progress, or the service provider is still processing a callback function.
WSAENOTCONN	Socket is not connected (connection-oriented sockets only).
WSAENOTSOCK	Descriptor is not a socket.
WSAEFAULT	The lpOutboundDisconnectData argument is not totally contained in a valid part of the user address space.

Requirements