usr/src/man/man3tsol/getzonerootbyid.3tsol

   1 '\" te
   2 .\" Copyright (c) 2007, 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 GETZONEROOTBYID 3TSOL "Jul 20, 2007"
   7 .SH NAME
   8 getzonerootbyid, getzonerootbylabel, getzonerootbyname \- map between zone root
   9 pathnames and labels
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 \fBcc\fR [\fIflags\fR...] \fIfile\fR... \fB-ltsol\fR [\fIlibrary\fR...]
  14 .fi
  15
  16 .LP
  17 .nf
  18 #include <tsol/label.h>
  19
  20 \fBchar *\fR\fBgetzonerootbyid\fR(\fBzoneid_t\fR \fIzoneid\fR);
  21 .fi
  22
  23 .LP
  24 .nf
  25 \fBchar *\fR\fBgetzonerootbylabel\fR(\fBconst m_label_t *\fR\fIlabel\fR);
  26 .fi
  27
  28 .LP
  29 .nf
  30 \fBchar *\fR\fBgetzonerootbyname\fR(\fBconst char *\fR\fIzonename\fR);
  31 .fi
  32
  33 .SH DESCRIPTION
  34 .sp
  35 .LP
  36 The \fBgetzonerootbyid()\fR function returns the root pathname of \fIzoneid\fR.
  37 .sp
  38 .LP
  39 The \fBgetzonerootbylabel()\fR function returns the root pathname of the zone
  40 whose label is \fIlabel\fR.
  41 .sp
  42 .LP
  43 The \fBgetzonerootbyname()\fR function returns the root pathname of
  44 \fIzonename\fR.
  45 .sp
  46 .LP
  47 All of these functions require that the specified zone's state is at least
  48 \fBZONE_IS_READY\fR. The zone of the calling process must dominate the
  49 specified zone's label, or the calling process must be in the global zone. The
  50 returned pathname is relative to the root path of the caller's zone.
  51 .SH RETURN VALUES
  52 .sp
  53 .LP
  54 On successful completion, the \fBgetzonerootbyid()\fR,
  55 \fBgetzonerootbylabel()\fR, and \fBgetzonerootbyname()\fR functions return a
  56 pointer to a pathname that is allocated within these functions. To free the
  57 storage, use \fBfree\fR(3C). On failure, these functions return \fBNULL\fR and
  58 set \fIerrno\fR to indicate the error.
  59 .SH ERRORS
  60 .sp
  61 .LP
  62 These functions will fail if:
  63 .sp
  64 .ne 2
  65 .na
  66 \fB\fBEFAULT\fR\fR
  67 .ad
  68 .RS 10n
  69 Invalid argument; pointer location is invalid.
  70 .RE
  71
  72 .sp
  73 .ne 2
  74 .na
  75 \fB\fBEINVAL\fR\fR
  76 .ad
  77 .RS 10n
  78 \fIzoneid\fR invalid, or zone not found or not ready.
  79 .RE
  80
  81 .sp
  82 .ne 2
  83 .na
  84 \fB\fBENOENT\fR\fR
  85 .ad
  86 .RS 10n
  87 Zone does not exist.
  88 .RE
  89
  90 .sp
  91 .ne 2
  92 .na
  93 \fB\fBENOMEM\fR\fR
  94 .ad
  95 .RS 10n
  96 Unable to allocate pathname.
  97 .RE
  98
  99 .SH ATTRIBUTES
 100 .sp
 101 .LP
 102 See \fBattributes\fR(5) for descriptions of the following attributes:
 103 .sp
 104
 105 .sp
 106 .TS
 107 box;
 108 c | c
 109 l | l .
 110 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 111 _
 112 Interface Stability     Committed
 113 _
 114 MT-Level        Safe
 115 .TE
 116
 117 .SH SEE ALSO
 118 .sp
 119 .LP
 120 \fBIntro\fR(2), \fBfree\fR(3C), \fBgetzonenamebyid\fR(3C), \fBlibtsol\fR(3LIB),
 121 \fBattributes\fR(5), \fBlabels\fR(5)
 122 .SH NOTES
 123 .sp
 124 .LP
 125 The functionality described on this manual page is available only if the system
 126 is configured with Trusted Extensions.