share/man/man9f/net_netidtozonid.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_NETIDTOZONID 9F "May 1, 2008"
   7 .SH NAME
   8 net_netidtozonid \- map a netid_t structure identifier to a zoneid_t structure
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 #include <sys/neti.h>
  13
  14 \fBzoneid_t\fR \fBnet_netidtozonid\fR(\fBconst\fR \fBnetid_t\fR \fInet\fR);
  15 .fi
  16
  17 .SH INTERFACE LEVEL
  18 .sp
  19 .LP
  20 Solaris DDI specific (Solaris DDI).
  21 .SH PARAMETERS
  22 .sp
  23 .ne 2
  24 .na
  25 \fB\fInet\fR\fR
  26 .ad
  27 .RS 7n
  28 valid \fBnetid_t\fR structure that refers to an existing \fBIP\fR instance.
  29 .RE
  30
  31 .SH DESCRIPTION
  32 .sp
  33 .LP
  34 The \fBnet_netidtozonid()\fR function maps the given \fBnetid_t\fR (used to
  35 represent an instance of \fBIP\fR) into the matching \fBzoneid_t\fR structure
  36 that is associated with it.
  37 .SH RETURN VALUES
  38 .sp
  39 .LP
  40 The \fBnet_netidtozonid()\fR function returns -1 if no mapping took place.
  41 Otherwise, it returns the \fBzoneid_t\fR structure currently associated with a
  42 \fBnetid_t\fR structure. For shared stack zones, the \fBzoneid_t\fR structure
  43 for the global zone is returned.
  44 .SH CONTEXT
  45 .sp
  46 .LP
  47 The \fBnet_netidtozonid()\fR function may be called from user,  kernel, or
  48 interrupt context.
  49 .SH ATTRIBUTES
  50 .sp
  51 .LP
  52 See \fBattributes\fR(5) for descriptions of the following attributes:
  53 .sp
  54
  55 .sp
  56 .TS
  57 box;
  58 c | c
  59 l | l .
  60 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  61 _
  62 Interface Stability     Committed
  63 .TE
  64
  65 .SH SEE ALSO
  66 .sp
  67 .LP
  68 \fBnet_zoneidtonetid\fR(9F), \fBattributes\fR(5)