share/man/man3lgrp/lgrp_children.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_CHILDREN 3LGRP "Apr 16, 2003"
   7 .SH NAME
   8 lgrp_children \- get children 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_children\fR(\fBlgrp_cookie_t\fR \fIcookie\fR, \fBlgrp_id_t\fR \fIparent\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_children()\fR function takes a \fIcookie\fR representing a snapshot
  23 of the lgroup hierarchy retrieved from \fBlgrp_init\fR(3LGRP) and returns the
  24 number of lgroups that are children of the specified lgroup. If the
  25 \fIlgrp_array\fR and \fIlgrp_array_size\fR arguments are non-null, the array is
  26 filled with as many of the children lgroup IDs as will fit, given the size of
  27 the array.
  28 .SH RETURN VALUES
  29 .sp
  30 .LP
  31 \(mi returns the number of child lgroup IDs. Otherwise, it returns \(mi1 and
  32 sets \fBerrno\fR to indicate the error.
  33 .SH ERRORS
  34 .sp
  35 .LP
  36 The \fBlgrp_children()\fR function will fail if:
  37 .sp
  38 .ne 2
  39 .na
  40 \fB\fBEINVAL\fR\fR
  41 .ad
  42 .RS 10n
  43 The specified lgroup ID is not valid or the cookie is invalid.
  44 .RE
  45
  46 .sp
  47 .ne 2
  48 .na
  49 \fB\fBESRCH\fR\fR
  50 .ad
  51 .RS 10n
  52 The specified lgroup ID was not found.
  53 .RE
  54
  55 .SH ATTRIBUTES
  56 .sp
  57 .LP
  58 See \fBattributes\fR(5) for descriptions of the following attributes:
  59 .sp
  60
  61 .sp
  62 .TS
  63 box;
  64 c | c
  65 l | l .
  66 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  67 _
  68 Interface Stability     Evolving
  69 _
  70 MT-Level        MT-Safe
  71 .TE
  72
  73 .SH SEE ALSO
  74 .sp
  75 .LP
  76 \fBlgrp_init\fR(3LGRP), \fBlgrp_nlgrps\fR(3LGRP), \fBlgrp_parents\fR(3LGRP),
  77 \fBliblgrp\fR(3LIB), \fBattributes\fR(5)