share/man/man3lgrp/lgrp_nlgrps.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_NLGRPS 3LGRP "Apr 16, 2003"
   7 .SH NAME
   8 lgrp_nlgrps \- get number of lgroups
   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_nlgrps\fR(\fBlgrp_cookie_t\fR \fIcookie\fR);
  16 .fi
  17
  18 .SH DESCRIPTION
  19 .sp
  20 .LP
  21 The \fBlgrp_nlgrps()\fR function takes a \fIcookie\fR representing a snapshot
  22 of the lgroup hierarchy obtained from \fBlgrp_init\fR(3LGRP). It returns the
  23 number of lgroups in the hierarchy where the number is always at least one.
  24 .SH RETURN VALUES
  25 .sp
  26 .LP
  27 Upon successful completion,\fB lgrp_nlgrps()\fR returns the number of lgroups
  28 in the system. Otherwise, it returns \(mi1 and sets \fBerrno\fR to indicate the
  29 error.
  30 .SH ERRORS
  31 .sp
  32 .LP
  33 The \fBlgrp_nlgrps()\fR function will fail if:
  34 .sp
  35 .ne 2
  36 .na
  37 \fB\fBEINVAL\fR\fR
  38 .ad
  39 .RS 10n
  40 The \fIcookie\fR is not valid.
  41 .RE
  42
  43 .SH ATTRIBUTES
  44 .sp
  45 .LP
  46 See \fBattributes\fR(5) for descriptions of the following attributes:
  47 .sp
  48
  49 .sp
  50 .TS
  51 box;
  52 c | c
  53 l | l .
  54 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  55 _
  56 Interface Stability     Evolving
  57 _
  58 MT-Level        MT-Safe
  59 .TE
  60
  61 .SH SEE ALSO
  62 .sp
  63 .LP
  64 \fBlgrp_children\fR(3LGRP), \fBlgrp_init\fR(3LGRP), \fBlgrp_parents\fR(3LGRP),
  65 \fBliblgrp\fR(3LIB), \fBattributes\fR(5)