The getpeername function retrieves the address of the peer to which a socket is connected.

Syntax

int getpeername(
  __in     SOCKET s,
  __out    struct sockaddr *name,
  __inout  int *namelen
);

Parameters

s [in]

A descriptor identifying a connected socket.

name [out]

The SOCKADDR structure that receives the address of the peer.

namelen [in, out]

A pointer to the size, in bytes, of the name parameter.

Return Value

If no error occurs, getpeername returns zero. Otherwise, a value of SOCKET_ERROR is returned, and a specific error code can be retrieved by calling WSAGetLastError.

Remarks

The getpeername function retrieves the address of the peer connected to the socket s and stores the address in the SOCKADDR structure identified by the name parameter. This function works with any address family and it simply returns the address to which the socket is connected. The getpeername function can be used only on a connected socket.

For datagram sockets, only the address of a peer specified in a previous connect call will be returned. Any address specified by a previous sendto call will not be returned by getpeername.

On call, the namelen parameter contains the size, in bytes, of the name buffer. On return, the namelen parameter contains the actual size, in bytes, of the name parameter returned.

Requirements

See Also

Winsock Reference

Winsock Functions

bind

connect

getsockname

sendto

socket

Send comments about this topic to Microsoft

Build date: 11/12/2009