projects / unix-history / blame
| Commit | Line | Data |
|---|---|---|
| 15637ed4 RG |
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 | .\" @(#)getsockname.2 6.4 (Berkeley) 3/10/91 | |
| 33 | .\" | |
| 34 | .Dd March 10, 1991 | |
| 35 | .Dt GETSOCKNAME 2 | |
| 36 | .Os BSD 4.2 | |
| 37 | .Sh NAME | |
| 38 | .Nm getsockname | |
| 39 | .Nd get socket name | |
| 40 | .Sh SYNOPSIS | |
| 41 | .Ft int | |
| 42 | .Fn getsockname "int s" "struct sockaddr *name" "int *namelen" | |
| 43 | .Sh DESCRIPTION | |
| 44 | .Fn Getsockname | |
| 45 | returns the current | |
| 46 | .Fa name | |
| 47 | for the specified socket. The | |
| 48 | .Fa namelen | |
| 49 | parameter should be initialized to indicate | |
| 50 | the amount of space pointed to by | |
| 51 | .Fa name . | |
| 52 | On return it contains the actual size of the name | |
| 53 | returned (in bytes). | |
| 54 | .Sh DIAGNOSTICS | |
| 55 | A 0 is returned if the call succeeds, -1 if it fails. | |
| 56 | .Sh ERRORS | |
| 57 | The call succeeds unless: | |
| 58 | .Bl -tag -width ENOTSOCKAA | |
| 59 | .It Bq Er EBADF | |
| 60 | The argument | |
| 61 | .Fa s | |
| 62 | is not a valid descriptor. | |
| 63 | .It Bq Er ENOTSOCK | |
| 64 | The argument | |
| 65 | .Fa s | |
| 66 | is a file, not a socket. | |
| 67 | .It Bq Er ENOBUFS | |
| 68 | Insufficient resources were available in the system | |
| 69 | to perform the operation. | |
| 70 | .It Bq Er EFAULT | |
| 71 | The | |
| 72 | .Fa name | |
| 73 | parameter points to memory not in a valid part of the | |
| 74 | process address space. | |
| 75 | .El | |
| 76 | .Sh SEE ALSO | |
| 77 | .Xr bind 2 , | |
| 78 | .Xr socket 2 | |
| 79 | .Sh BUGS | |
| 80 | Names bound to sockets in the UNIX domain are inaccessible; | |
| 81 | .Xr getsockname | |
| 82 | returns a zero length name. | |
| 83 | .Sh HISTORY | |
| 84 | The | |
| 85 | .Nm | |
| 86 | function call appeared in | |
| 87 | .Bx 4.2 . |