xref: /titanic_50/usr/src/man/man3lgrp/lgrp_children.3lgrp (revision c10c16dec587a0662068f6e2991c29ed3a9db943)
te
Copyright (c) 2003, Sun Microsystems, Inc. All Rights Reserved.
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.
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.
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]
lgrp_children 3LGRP "16 Apr 2003" "SunOS 5.11" "Locality Group Library Functions"
NAME
lgrp_children - get children of given lgroup
SYNOPSIS

cc [ flag .\|.\|. ] file.\|.\|. -llgrp [ library .\|.\|. ] 
#include <sys/lgrp_user.h>

int lgrp_children(lgrp_cookie_t cookie, lgrp_id_t parent,
 lgrp_id_t *lgrp_array, uint_t lgrp_array_size);
DESCRIPTION

The lgrp_children() function takes a cookie representing a snapshot of the lgroup hierarchy retrieved from lgrp_init(3LGRP) and returns the number of lgroups that are children of the specified lgroup. If the lgrp_array and lgrp_array_size arguments are non-null, the array is filled with as many of the children lgroup IDs as will fit, given the size of the array.

RETURN VALUES

- returns the number of child lgroup IDs. Otherwise, it returns -1 and sets errno to indicate the error.

ERRORS

The lgrp_children() function will fail if:

EINVAL

The specified lgroup ID is not valid or the cookie is invalid.

ESRCH

The specified lgroup ID was not found.

ATTRIBUTES

See attributes(5) for descriptions of the following attributes:

ATTRIBUTE TYPEATTRIBUTE VALUE
Interface StabilityEvolving
MT-LevelMT-Safe
SEE ALSO

lgrp_init(3LGRP), lgrp_nlgrps(3LGRP), lgrp_parents(3LGRP), liblgrp(3LIB), attributes(5)