POOL_COMPONENT_TO_ELEM(3POOL)
Pool Configuration Manipulation Library Functions
pool_component_to_elem, pool_to_elem, pool_conf_to_elem,
pool_resource_to_elem - resource pool element-related functions
cc [ flag... ] file... -lpool [ library... ]
#include <pool.h>
pool_elem_t *pool_component_to_elem(pool_conf_t *conf,
pool_component_t *component);
pool_elem_t *pool_conf_to_elem(pool_conf_t *conf);
pool_elem_t *pool_resource_to_elem(pool_conf_t *conf
pool_resource_t *resource);
pool_elem_t *pool_to_elem(pool_conf_t *conf, pool_t *pool);
A pool element, as represented by a pool_elem_t, is a common
abstraction for any libpool entity that contains properties. All such
types can be converted to the opaque pool_elem_t type using the
appropriate conversion functions prototyped above. The conf argument
for each function refers to the target configuration to which the
operation applies.
Upon successful completion, these functions return a pool_elem_t
corresponding to the argument passed in. Otherwise they return NULL
and pool_error(3POOL) returns the pool-specific error value.
These function will fail if:
POE_BADPARAM
The supplied configuration's status is not POF_VALID.
See attributes(7) for descriptions of the following attributes:
+--------------------+-----------------+
| ATTRIBUTE TYPE | ATTRIBUTE VALUE |
+--------------------+-----------------+
|CSI | Enabled |
+--------------------+-----------------+
|Interface Stability | Unstable |
+--------------------+-----------------+
|MT-Level | Safe |
+--------------------+-----------------+
libpool(3LIB), pool_error(3POOL), attributes(7)
September 23, 2003
POOL_COMPONENT_TO_ELEM(3POOL)
Pool Configuration Manipulation Library Functions
NAME
pool_component_to_elem, pool_to_elem, pool_conf_to_elem,
pool_resource_to_elem - resource pool element-related functions
SYNOPSIS
cc [ flag... ] file... -lpool [ library... ]
#include <pool.h>
pool_elem_t *pool_component_to_elem(pool_conf_t *conf,
pool_component_t *component);
pool_elem_t *pool_conf_to_elem(pool_conf_t *conf);
pool_elem_t *pool_resource_to_elem(pool_conf_t *conf
pool_resource_t *resource);
pool_elem_t *pool_to_elem(pool_conf_t *conf, pool_t *pool);
DESCRIPTION
A pool element, as represented by a pool_elem_t, is a common
abstraction for any libpool entity that contains properties. All such
types can be converted to the opaque pool_elem_t type using the
appropriate conversion functions prototyped above. The conf argument
for each function refers to the target configuration to which the
operation applies.
RETURN VALUES
Upon successful completion, these functions return a pool_elem_t
corresponding to the argument passed in. Otherwise they return NULL
and pool_error(3POOL) returns the pool-specific error value.
ERRORS
These function will fail if:
POE_BADPARAM
The supplied configuration's status is not POF_VALID.
ATTRIBUTES
See attributes(7) 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(7)
September 23, 2003
POOL_COMPONENT_TO_ELEM(3POOL)