xref: /openbsd/lib/libc/sys/getsockname.2 (revision df930be7)
1.\"	$NetBSD: getsockname.2,v 1.5 1995/02/27 12:33:26 cgd 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 June 4, 1993
37.Dt GETSOCKNAME 2
38.Os BSD 4.2
39.Sh NAME
40.Nm getsockname
41.Nd get socket name
42.Sh SYNOPSIS
43.Ft int
44.Fn getsockname "int s" "struct sockaddr *name" "int *namelen"
45.Sh DESCRIPTION
46.Fn Getsockname
47returns the current
48.Fa name
49for the specified socket.  The
50.Fa namelen
51parameter should be initialized to indicate
52the amount of space pointed to by
53.Fa name .
54On return it contains the actual size of the name
55returned (in bytes).
56.Sh DIAGNOSTICS
57A 0 is returned if the call succeeds, -1 if it fails.
58.Sh ERRORS
59The call succeeds unless:
60.Bl -tag -width Er
61.It Bq Er EBADF
62The argument
63.Fa s
64is not a valid descriptor.
65.It Bq Er ENOTSOCK
66The argument
67.Fa s
68is a file, not a socket.
69.It Bq Er ENOBUFS
70Insufficient resources were available in the system
71to perform the operation.
72.It Bq Er EFAULT
73The
74.Fa name
75parameter points to memory not in a valid part of the
76process address space.
77.El
78.Sh SEE ALSO
79.Xr bind 2 ,
80.Xr socket 2
81.Sh BUGS
82Names bound to sockets in the UNIX domain are inaccessible;
83.Xr getsockname
84returns a zero length name.
85.Sh HISTORY
86The
87.Fn getsockname
88function call appeared in
89.Bx 4.2 .
90