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