linux man page for pool_component_info

pool_component_info(3POOL)			 Pool Configuration Manipulation Library Functions			pool_component_info(3POOL)

NAME
       pool_component_info, pool_get_owning_resource - resource pool component functions

SYNOPSIS
       cc [ flag... ] file... -lpool [ library... ]
       #include <pool.h>

       const char *pool_component_info(pool_conf_t *conf, pool_component_t *component, int flags);

       pool_resource_t *pool_get_owning_resource(pool_conf_t *conf, pool_component_t *component);

DESCRIPTION
       Certain	resources,  such as processor sets, are composed of resource components. Informational and ownership attributes of resource compo-
       nents are made available with the pool_component_info() and pool_get_owning_resource() functions.  The  conf  argument  for  each  function
       refers to the target configuration to which the operation applies.

       The  pool_component_info() function returns a string describing component. The string is allocated with malloc(3C).  The caller is reponsi-
       ble for freeing the returned string. The flags argument is ignored.

       The pool_get_owning_resource() function returns the resource currently containing component.  Every component is contained by a resource.

RETURN VALUES
       Upon successful completion, pool_component_info() returns a string. Otherwise it returns NULL and pool_error(3POOL) returns  the  pool-spe-
       cific error value.

       Upon  successful completion, pool_get_owning_resource() returns the owning resource. Otherwise it returns NULL and pool_error() returns the
       pool-specific error value.

ERRORS
       The pool_component_info() function will fail if:

       POE_BADPARAM	       The supplied configuration's status is not POF_VALID or the flags paramter is neither 0 or 1.

       POE_INVALID_CONF        The configuration is invalid.

       POE_SYSTEM	       A system error has occurred. Check the system error code for more details.

       The pool_get_owning_resource() function will fail if:

       POE_BADPARAM	       The supplied configuration's status is not POF_VALID.

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

       +-----------------------------+-----------------------------+
       |      ATTRIBUTE TYPE	     |	    ATTRIBUTE VALUE	   |
       +-----------------------------+-----------------------------+
       |CSI			     |Enabled			   |
       +-----------------------------+-----------------------------+
       |Interface Stability	     |Unstable			   |
       +-----------------------------+-----------------------------+
       |MT-Level		     |Safe			   |
       +-----------------------------+-----------------------------+

SEE ALSO
       libpool(3LIB), pool_error(3POOL), attributes(5)

SunOS 5.10							    23 Sep 2003 					pool_component_info(3POOL)