usr/src/man/man9f/net_phylookup.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_PHYLOOKUP 9F "May 1, 2008"
   7 .SH NAME
   8 net_phylookup \- determine if a network interface name exists for a network
   9 protocol
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 #include <sys/neti.h>
  14
  15 \fBphy_if_t\fR \fBnet_phylookup\fR(\fBconst\fR \fBnet_data_t\fR \fInet\fR, \fBconst\fR \fBchar\fR *\fIname\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 8n
  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\fIname\fR\fR
  36 .ad
  37 .RS 8n
  38 name of the network interface to find.
  39 .RE
  40
  41 .SH DESCRIPTION
  42 .sp
  43 .LP
  44 The \fBnet_phylookup()\fR function attempts to resolve the interface name
  45 passed in with the network protocol.
  46 .sp
  47 .LP
  48 When called successfully, the value returned represents a network interface
  49 that exists, at the time of the call, within the scope of the network
  50 interface. This value is only guaranteed to be unique for a name within the
  51 scope of the network protocol.
  52 .SH RETURN VALUES
  53 .sp
  54 .LP
  55 The \fBnet_phylookup()\fR function returns -1 if it is not supported by the
  56 network  protocol,  and 0 if the named network interface does not exist (or is
  57 otherwise  unknown).  Otherwise, it returns  a  value  greater  than 0
  58 representing a network interface that currently exists within the scope of this
  59 network protocol.
  60 .SH CONTEXT
  61 .sp
  62 .LP
  63 The \fBnet_phylookup()\fR function may be called from user,  kernel, or
  64 interrupt context.
  65 .SH ATTRIBUTES
  66 .sp
  67 .LP
  68 See \fBattributes\fR(5) for descriptions of the following attributes:
  69 .sp
  70
  71 .sp
  72 .TS
  73 box;
  74 c | c
  75 l | l .
  76 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  77 _
  78 Interface Stability     Committed
  79 .TE
  80
  81 .SH SEE ALSO
  82 .sp
  83 .LP
  84 \fBnet_getifname\fR(9F), \fBnet_phygetnext\fR(9F),
  85 \fBnet_protocol_lookup\fR(9F), \fBattributes\fR(5)