GETSOCKNAME

Section: Linux Programmer's Manual (2)
Updated: 2021-03-22
Index Return to Main Contents
 

NAME

getsockname - get socket name  

SYNOPSIS

#include <sys/socket.h>

int getsockname(int sockfd, struct sockaddr *restrict addr,
                socklen_t *restrict addrlen);
 

DESCRIPTION

getsockname() returns the current address to which the socket sockfd is bound, in the buffer pointed to by addr. The addrlen argument should be initialized to indicate the amount of space (in bytes) pointed to by addr. On return it contains the actual size of the socket address.

The returned address is truncated if the buffer provided is too small; in this case, addrlen will return a value greater than was supplied to the call.  

RETURN VALUE

On success, zero is returned. On error, -1 is returned, and errno is set to indicate the error.  

ERRORS

EBADF
The argument sockfd is not a valid file descriptor.
EFAULT
The addr argument points to memory not in a valid part of the process address space.
EINVAL
addrlen is invalid (e.g., is negative).
ENOBUFS
Insufficient resources were available in the system to perform the operation.
ENOTSOCK
The file descriptor sockfd does not refer to a socket.
 

CONFORMING TO

POSIX.1-2001, POSIX.1-2008, SVr4, 4.4BSD (getsockname() first appeared in 4.2BSD).  

NOTES

For background on the socklen_t type, see accept(2).  

SEE ALSO

bind(2), socket(2), getifaddrs(3), ip(7), socket(7), unix(7)  

COLOPHON

This page is part of release 5.11 of the Linux man-pages project. A description of the project, information about reporting bugs, and the latest version of this page, can be found at https://www.kernel.org/doc/man-pages/.


 

Index

NAME
SYNOPSIS
DESCRIPTION
RETURN VALUE
ERRORS
CONFORMING TO
NOTES
SEE ALSO
COLOPHON

This document was created by man2html, using the manual pages.
Time: 06:22:43 GMT, May 09, 2021