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