1.\" $NetBSD: getsockname.2,v 1.16 2002/02/08 01:28:18 ross Exp $ 2.\" 3.\" Copyright (c) 1983, 1991, 1993 4.\" The Regents of the University of California. All rights reserved. 5.\" 6.\" Redistribution and use in source and binary forms, with or without 7.\" modification, are permitted provided that the following conditions 8.\" are met: 9.\" 1. Redistributions of source code must retain the above copyright 10.\" notice, this list of conditions and the following disclaimer. 11.\" 2. Redistributions in binary form must reproduce the above copyright 12.\" notice, this list of conditions and the following disclaimer in the 13.\" documentation and/or other materials provided with the distribution. 14.\" 3. All advertising materials mentioning features or use of this software 15.\" must display the following acknowledgement: 16.\" This product includes software developed by the University of 17.\" California, Berkeley and its contributors. 18.\" 4. Neither the name of the University nor the names of its contributors 19.\" may be used to endorse or promote products derived from this software 20.\" without specific prior written permission. 21.\" 22.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 23.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 24.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 25.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 26.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 27.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 28.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 29.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 30.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 31.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 32.\" SUCH DAMAGE. 33.\" 34.\" @(#)getsockname.2 8.1 (Berkeley) 6/4/93 35.\" 36.Dd October 22, 2001 37.Dt GETSOCKNAME 2 38.Os 39.Sh NAME 40.Nm getsockname 41.Nd get socket name 42.Sh LIBRARY 43.Lb libc 44.Sh SYNOPSIS 45.Fd #include \*[Lt]sys/socket.h\*[Gt] 46.Ft int 47.Fn getsockname "int s" "struct sockaddr * restrict name" "socklen_t * restrict namelen" 48.Sh DESCRIPTION 49The 50.Fn getsockname 51system call returns the current 52.Fa name 53for the specified socket. 54The 55.Fa namelen 56parameter should be initialized to indicate the amount of space 57pointed to by 58.Fa name . 59On return it contains the actual size of the name returned (in 60bytes). 61.Sh RETURN VALUES 62A 0 is returned if the call succeeds, -1 if it fails. 63.Sh ERRORS 64The call succeeds unless: 65.Bl -tag -width Er 66.It Bq Er EBADF 67The argument 68.Fa s 69is not a valid descriptor. 70.It Bq Er ENOTSOCK 71The argument 72.Fa s 73is a file, not a socket. 74.It Bq Er ENOBUFS 75Insufficient resources were available in the system to perform the operation. 76.It Bq Er EFAULT 77The 78.Fa name 79parameter points to memory not in a valid part of the process address space. 80.El 81.Sh SEE ALSO 82.Xr bind 2 , 83.Xr socket 2 84.Sh HISTORY 85The 86.Fn getsockname 87function call appeared in 88.Bx 4.2 . 89.Sh BUGS 90Names bound to sockets in the 91.Ux 92domain are inaccessible; 93.Fn getsockname 94returns a zero length name. 95