Manual Pages for UNIX Operating System command usage for man pool_query_components

Pool Configuration Manipulation Library Functions
                                             pool_get_pool(3POOL)



NAME
     pool_get_pool,   pool_get_resource,   pool_query_components,
     pool_query_pools,  pool_query_resources  - retrieve resource
     pool configuration elements

SYNOPSIS
     cc [ flag]...  file... -lpool [ library... ]
     #include 

     pool_t *pool_get_pool(pool_conf_t *conf, const char *name);


     pool_resource_t *pool_get_resource(pool_conf_t *conf
          const char *type, const char *name);


     pool_component_t **pool_query_components(pool_conf_t *conf,
          uint_t *nelem, pool_value_t **props);


     pool_t **pool_query_pools(pool_conf_t *conf, uint_t *nelem,
          pool_value_t **props);


     pool_component_t **pool_query_resources(pool_conf_t *conf,
          uint_t *nelem, pool_value_t **props);


DESCRIPTION
     These functions provide a means for querying the contents of
     the  specified  configuration.  The  conf  argument for each
     function refers to the target  configuration  to  which  the
     operation applies.


     The pool_get_pool() function returns the pool with the given
     name from the provided configuration.


     The pool_get_resource() function returns the  resource  with
     the given name and type from the provided configuration.


     The pool_query_components() function retrieves all  resource
     components  that  match the given list of properties. If the
     list of properties is NULL, all components are returned. The
     number  of  elements  returned  is  stored  in  the location
     pointed   to   by   nelem.    The    value    returned    by
     pool_query_components()  is  allocated  with  malloc(3C) and
     must be explicitly freed.




SunOS 5.11          Last change: 18 Jul 2005                    1






Pool Configuration Manipulation Library Functions
                                             pool_get_pool(3POOL)



     The  pool_query_pools()  function   behaves   similarly   to
     pool_query_components()  and  returns the list of pools that
     match the given list of properties. The value returned  must
     be freed by the caller.


     The pool_query_resources() function  similarly  returns  the
     list  of  resources that match the given list of properties.
     The return value must be freed by the caller.

RETURN VALUES
     The pool_get_pool() and pool_get_resource() functions return
     the  matching  pool  and  resource, respectively. Otherwise,
     they return NULL and  pool_error(3POOL)  returns  the  pool-
     specific error value.


     The   pool_query_components(),    pool_query_pools(),    and
     pool_query_resources()  functions  return  a null-terminated
     array of components, pools, and resources, respectively.  If
     the query was unsuccessful or there were no matches, NULL is
     returned and pool_error() returns  the  pool-specific  error
     value.

ERRORS
     The pool_get_pool() will fail if:

     POE_BADPARAM    The supplied configuration's status  is  not
                     POF_VALID.



     The pool_get_resource() will fail if:

     POE_BADPARAM    The supplied configuration's status  is  not
                     POF_VALID.


     POE_SYSTEM      There is  not  enough  memory  available  to
                     allocate  working  buffers.  Check errno for
                     the specific system error code.



     The   pool_query_components(),    pool_query_pools(),    and
     pool_query_resources() will fail if:

     POE_BADPARAM        The supplied configuration's  status  is
                         not POF_VALID.





SunOS 5.11          Last change: 18 Jul 2005                    2






Pool Configuration Manipulation Library Functions
                                             pool_get_pool(3POOL)



     POE_INVALID_CONF    The query generated  results  that  were
                         not  of the correct type. The configura-
                         tion is invalid.


     POE_SYSTEM          There is not enough memory available  to
                         allocate  working  buffers.  Check errno
                         for the specific system error code.


EXAMPLES
     Example 1 Retrieve the pool named "foo" from a given  confi-
     guration.

       #include 
       #include 

       ...

       pool_conf_t *conf;
       pool_t *pool;

       ...

       if ((pool = pool_get_pool(conf, "foo")) == NULL) {
               (void) fprintf(stderr, "Cannot retrieve pool named
               'foo'B{}n");
               ...
       }


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




















SunOS 5.11          Last change: 18 Jul 2005                    3






Pool Configuration Manipulation Library Functions
                                             pool_get_pool(3POOL)



______________________________________________________________________
    |       ATTRIBUTE TYPE        |       ATTRIBUTE VALUE       |
    |_____________________________|_____________________________|
    | CSI                         | Enabled                     |
    |_____________________________|_____________________________|
    | Interface Stability         | Uncommitted                 |
    |_____________________________|_____________________________|
    | MT-Level                    | Safe                        |
    |_____________________________|_____________________________|


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









































SunOS 5.11          Last change: 18 Jul 2005                    4






Pool Configuration Manipulation Library Functions
                                             pool_get_pool(3POOL)






















































SunOS 5.11          Last change: 18 Jul 2005                    5