WSPShutdown (Compact 2013)
3/26/2014
This function disables sends and/or receives on a socket.
Syntax
int WSPShutdown(
SOCKET s,
int how,
LPINT lpErrno
);
Parameters
- s
[in] Descriptor identifying a socket.
- how
[in] Flag that describes what types of operation will no longer be allowed.
- lpErrno
[out] Pointer to the error code.
Return Value
If no error occurs, WSPShutdown returns zero. Otherwise, a value of SOCKET_ERROR is returned, and a specific error code is available in lpErrno.
The following table shows the possible error codes.
Error value |
Description |
|---|---|
WSAENETDOWN |
Network subsystem has failed. |
WSAEINVAL |
The how is not valid, or is not consistent with the socket type. For example, SD_SEND is used with a UNI_RECV socket type. |
WSAEINPROGRESS |
Function is invoked when a callback is in progress. |
WSAENOTCONN |
Socket is not connected (connection-oriented sockets only). |
WSAENOTSOCK |
Descriptor is not a socket. |
Remarks
This function is used on all types of sockets to disable reception, transmission, or both.
If how is SD_RECEIVE, subsequent receives on the socket will be disallowed. This 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, because the data cannot be delivered to the user. For UDP sockets, incoming datagrams are accepted and queued. In no case will an ICMP error packet be generated.
If how is SD_SEND, subsequent sends on the socket are disallowed. For TCP sockets, a FIN will be sent. Setting how to SD_BOTH disables both sends and receives as described above.
Note
WSPShutdown does not close the socket, and resources attached to the socket will not be freed until WSPCloseSocket is invoked.
WSPShutdown 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 shut down. In particular, a Windows Sockets service provider is not required to support the use of WSPConnect on such a socket.
Requirements
Header |
ws2spi.h |
Library |
Ws2.lib |