WSPGetPeerName function
The WSPGetPeerName function gets the address of the peer to which a socket is connected.
int WSPGetPeerName(
_In_ SOCKET s,
_Out_ struct sockaddr *name,
_Inout_ LPINT namelen,
_Out_ LPINT lpErrno
);
s [in]
Descriptor identifying a connected socket.name [out]
Pointer to the sockaddr structure to receive the name of the peer.namelen [in, out]
On input, pointer to an integer that indicates the size of the structure pointed to by name, in bytes. On output, indicates the size of the returned name, in bytes.lpErrno [out]
Pointer to the error code.
If no error occurs, WSPGetPeerName returns zero. Otherwise, a value of SOCKET_ERROR is returned, and a specific error code is available in lpErrno.
| Error code | Meaning |
|---|---|
| WSAENETDOWN | The network subsystem has failed. |
| WSAEFAULT | The name or the namelen parameter is not a valid part of the user address space, or the namelen parameter is too small. |
| WSAEINPROGRESS | Function is invoked when a callback is in progress. |
| WSAENOTCONN | Socket is not connected. |
| WSAENOTSOCK | The descriptor is not a socket. |
The WSPGetPeerName function supplies the name of the peer connected to the socket s and stores it in the structure sockaddr referenced by name. It can be used only on a connected socket. For datagram sockets, only the name of a peer specified in a previous WSPConnect call will be returned—any name specified by a previous WSPSendTo call will not be returned by WSPGetPeerName.
On return, the namelen parameter contains the actual size of the name returned in bytes.
Minimum supported client |
Windows 2000 Professional [desktop apps only] |
Minimum supported server |
Windows 2000 Server [desktop apps only] |
Header |
Ws2spi.h |