usr/src/man/man3socket/getsockname.3socket

   1 '\" te
   2 .\"  Copyright 1989 AT&T  Copyright (c) 1997, Sun Microsystems, Inc.  All Rights Reserved
   3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   5 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   6 .TH GETSOCKNAME 3SOCKET "Dec 12, 1997"
   7 .SH NAME
   8 getsockname \- get socket name
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fBcc\fR [ \fIflag\fR ... ] \fIfile\fR ... \fB-lsocket\fR \fB -lnsl \fR [ \fIlibrary\fR ... ]
  13 #include <sys/types.h>
  14 #include <sys/socket.h>
  15
  16 \fBint\fR \fBgetsockname\fR(\fBint\fR \fIs\fR, \fBstruct sockaddr *\fR\fIname\fR, \fBsocklen_t *\fR\fInamelen\fR);
  17 .fi
  18
  19 .SH DESCRIPTION
  20 .LP
  21 \fBgetsockname()\fR returns the current \fIname\fR for socket \fIs\fR. The
  22 \fInamelen\fR parameter should be initialized to indicate the amount of space
  23 pointed to by \fIname\fR. On return it contains the actual size in bytes of the
  24 name returned.
  25 .SH RETURN VALUES
  26 .LP
  27 If successful, \fBgetsockname()\fR returns  \fB0\fR; otherwise it returns
  28 \fB\(mi1\fR and sets  \fIerrno\fR to indicate the error.
  29 .SH ERRORS
  30 .LP
  31 The call succeeds unless:
  32 .sp
  33 .ne 2
  34 .na
  35 \fB\fBEBADF\fR\fR
  36 .ad
  37 .RS 12n
  38 The argument \fIs\fR is not a valid file descriptor.
  39 .RE
  40
  41 .sp
  42 .ne 2
  43 .na
  44 \fB\fBENOMEM\fR\fR
  45 .ad
  46 .RS 12n
  47 There was insufficient memory available for the operation to complete.
  48 .RE
  49
  50 .sp
  51 .ne 2
  52 .na
  53 \fB\fBENOSR\fR\fR
  54 .ad
  55 .RS 12n
  56 There were insufficient STREAMS resources available for the operation to
  57 complete.
  58 .RE
  59
  60 .sp
  61 .ne 2
  62 .na
  63 \fB\fBENOTSOCK\fR\fR
  64 .ad
  65 .RS 12n
  66 The argument \fIs\fR is not a socket.
  67 .RE
  68
  69 .SH ATTRIBUTES
  70 .LP
  71 See \fBattributes\fR(5) for descriptions of the following attributes:
  72 .sp
  73
  74 .sp
  75 .TS
  76 box;
  77 c | c
  78 l | l .
  79 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  80 _
  81 MT-Level        Safe
  82 .TE
  83
  84 .SH SEE ALSO
  85 .LP
  86 \fBbind\fR(3SOCKET), \fBgetpeername\fR(3SOCKET), \fBsockaddr\fR(3SOCKET),
  87 \fBsocket\fR(3SOCKET), \fBattributes\fR(5)