usr/src/man/man3lgrp/lgrp_parents.3lgrp

   1 '\" te
   2 .\" Copyright (c) 2003, 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 LGRP_PARENTS 3LGRP "Apr 16, 2003"
   7 .SH NAME
   8 lgrp_parents \- get parents of given lgroup
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 cc [ \fIflag \&.\|.\|.\fR ] \fIfile\fR\&.\|.\|. \fB-llgrp\fR [ \fIlibrary \&.\|.\|.\fR ]
  13 #include <sys/lgrp_user.h>
  14
  15 \fBint\fR \fBlgrp_parents\fR(\fBlgrp_cookie_t\fR \fIcookie\fR, \fBlgrp_id_t\fR \fIchild\fR,
  16      \fBlgrp_id_t *\fR\fIlgrp_array\fR, \fBuint_t\fR \fIlgrp_array_size\fR);
  17 .fi
  18
  19 .SH DESCRIPTION
  20 .sp
  21 .LP
  22 The \fBlgrp_parents()\fR function takes a \fIcookie\fR representing a snapshot
  23 of the lgroup hierarchy obtained from \fBlgrp_init\fR(3LGRP) and returns the
  24 number of parent lgroups of the specified lgroup. If \fIlgrp_array\fR is
  25 non-null and the \fIlgrp_array_size\fR is non-zero, the array is filled with as
  26 many of the parent lgroup IDs as will fit given the size of the array. For the
  27 root lgroup, the number of parents returned is 0 and the \fIlgrp_array\fR
  28 argument is not filled in.
  29 .SH RETURN VALUES
  30 .sp
  31 .LP
  32 Upon successful completion, \fBlgrp_parents()\fR returns the number of parent
  33 lgroup IDs. Otherwise, \(mi1 is returned and \fBerrno\fR is set to indicate the
  34 error.
  35 .SH ERRORS
  36 .sp
  37 .LP
  38 The \fBlgrp_parents()\fR function will fail if:
  39 .sp
  40 .ne 2
  41 .na
  42 \fB\fBEINVAL\fR\fR
  43 .ad
  44 .RS 10n
  45 The specified cookie or lgroup ID is not valid.
  46 .RE
  47
  48 .sp
  49 .ne 2
  50 .na
  51 \fB\fBESRCH\fR\fR
  52 .ad
  53 .RS 10n
  54 The specified lgroup ID was not found.
  55 .RE
  56
  57 .SH ATTRIBUTES
  58 .sp
  59 .LP
  60 See \fBattributes\fR(5) for descriptions of the following attributes:
  61 .sp
  62
  63 .sp
  64 .TS
  65 box;
  66 c | c
  67 l | l .
  68 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  69 _
  70 Interface Stability     Evolving
  71 _
  72 MT-Level        MT-Safe
  73 .TE
  74
  75 .SH SEE ALSO
  76 .sp
  77 .LP
  78 \fBlgrp_children\fR(3LGRP), \fBlgrp_init\fR(3LGRP), \fBlgrp_nlgrps\fR(3LGRP),
  79 \fBliblgrp\fR(3LIB), \fBattributes\fR(5)