opensolaris man page for lgrp_children

lgrp_children(3LGRP)					 Locality Group Library Functions				      lgrp_children(3LGRP)

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 TYPE	     |	    ATTRIBUTE VALUE	   |
       +-----------------------------+-----------------------------+
       |Interface Stability	     |Evolving			   |
       +-----------------------------+-----------------------------+
       |MT-Level		     |MT-Safe			   |
       +-----------------------------+-----------------------------+

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

SunOS 5.11							    16 Apr 2003 					      lgrp_children(3LGRP)