NAME
getsockname — get
the socket name
SYNOPSIS
#include
<sys/socket.h>
int getsockname(int socket, struct sockaddr *restrict address,
socklen_t *restrict address_len);
DESCRIPTION
The getsockname () function shall retrieve
the locally-bound name of the specified socket, store this address in the
sockaddr structure pointed to by the
address argument, and store the length of this address in
the object pointed to by the address_len argument.
If the actual length of the address is greater than the length of the supplied sockaddr structure, the stored address shall be truncated.
If the socket has not been bound to a local name, the value stored in the object pointed to by address is unspecified.
RETURN VALUE
Upon successful completion, 0 shall be returned, the address argument shall point to the address of the socket, and the address_len argument shall point to the length of the address. Otherwise, -1 shall be returned and errno set to indicate the error.
ERRORS
The getsockname () function shall fail
if:
- [EBADF]
- The socket argument is not a valid file descriptor.
- [ENOTSOCK]
- The socket argument does not refer to a socket.
- [EOPNOTSUPP]
- The operation is not supported for this socket's protocol.
The getsockname () function may fail
if:
EXAMPLES
None.
APPLICATION USAGE
None.
RATIONALE
None.
FUTURE DIRECTIONS
None.
SEE ALSO
accept(3) , bind(3) , getpeername(3) , socket(3)
XBD <sys/socket.h>
CHANGE HISTORY
First released in Issue 6. Derived from the XNS, Issue 5.2 specification.
The
restrict keyword
is added to the getsockname () prototype for
alignment with the ISO/IEC 9899:1999
(“ISO C99”) standard.