share/man/man9f/net_getifname.9f

   1 '\" te
   2 .\" Copyright (C) 2008, 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 NET_GETIFNAME 9F "May 1, 2008"
   7 .SH NAME
   8 net_getifname \- determine the name given to a network interface
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 #include <sys/neti.h>
  13
  14 \fBint\fR \fBnet_getifname\fR(\fBconst\fR \fBnet_data_t\fR \fInet\fR, \fBconst\fR \fBphy_if_t\fR \fIifp\fR,
  15      \fBchar *\fR\fIbuffer\fR, \fBsize_t\fR \fIbuflen\fR);
  16 .fi
  17
  18 .SH INTERFACE LEVEL
  19 .sp
  20 .LP
  21 Solaris DDI specific (Solaris DDI).
  22 .SH PARAMETERS
  23 .sp
  24 .ne 2
  25 .na
  26 \fB\fInet\fR\fR
  27 .ad
  28 .RS 10n
  29 value returned from a successful call to \fBnet_protocol_lookup\fR(9F).
  30 .RE
  31
  32 .sp
  33 .ne 2
  34 .na
  35 \fB\fIifp\fR\fR
  36 .ad
  37 .RS 10n
  38 value returned from a successful call to \fBnet_phylookup\fR(9F) or
  39 \fBnet_phygetnext\fR(9F).
  40 .RE
  41
  42 .sp
  43 .ne 2
  44 .na
  45 \fB\fIbuffer\fR\fR
  46 .ad
  47 .RS 10n
  48 pointer to the buffer in which to write the interface name.
  49 .RE
  50
  51 .sp
  52 .ne 2
  53 .na
  54 \fB\fIbuflen\fR\fR
  55 .ad
  56 .RS 10n
  57 size of the buffer in which to store the interface name.
  58 .RE
  59
  60 .SH DESCRIPTION
  61 .sp
  62 .LP
  63 The \fBnet_getifname()\fR function copies the name of the network interface
  64 into the buffer provided. The name will always be null-terminated. If the
  65 buffer is too small to fit both the interface name and the null-terminated
  66 name, the name in the buffer is truncated to fit. See \fBnet_phygetnext\fR(9F)
  67 for an example on how to use this function.
  68 .SH RETURN VALUES
  69 .sp
  70 .LP
  71 The \fBnet_getifname()\fR function returns:
  72 .sp
  73 .ne 2
  74 .na
  75 \fB-1\fR
  76 .ad
  77 .RS 6n
  78 The network protocol does not support this function.
  79 .RE
  80
  81 .sp
  82 .ne 2
  83 .na
  84 \fB0\fR
  85 .ad
  86 .RS 6n
  87 Successful completion.
  88 .RE
  89
  90 .sp
  91 .ne 2
  92 .na
  93 \fB1\fR
  94 .ad
  95 .RS 6n
  96 Unsuccessful.
  97 .RE
  98
  99 .SH CONTEXT
 100 .sp
 101 .LP
 102 The \fBnet_getifname()\fR function may be called from user,  kernel, or
 103 interrupt context.
 104 .SH ATTRIBUTES
 105 .sp
 106 .LP
 107 See \fBattributes\fR(5) for descriptions of the following attributes:
 108 .sp
 109
 110 .sp
 111 .TS
 112 box;
 113 c | c
 114 l | l .
 115 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 116 _
 117 Interface Stability     Committed
 118 .TE
 119
 120 .SH SEE ALSO
 121 .sp
 122 .LP
 123 \fBnet_phygetnext\fR(9F), \fBnet_phylookup\fR(9F),
 124 \fBnet_protocol_lookup\fR(9F)