'\" te
.\" Copyright (c) 2003, 2014, Oracle and/or its affiliates. All rights reserved.
.TH pool_component_to_elem 3POOL "23 Apr 2014" "SunOS 5.11" "Pool Configuration Manipulation Library Functions"
.SH NAME
pool_component_to_elem, pool_to_elem, pool_conf_to_elem, pool_resource_to_elem \- resource pool element-related functions
.SH SYNOPSIS
.LP
.nf
cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-lpool\fR [ \fIlibrary\fR\&.\|.\|. ] 
#include <pool.h>

\fBpool_elem_t *\fR\fBpool_component_to_elem\fR(\fBpool_conf_t *\fR\fIconf\fR,
     \fBpool_component_t *\fR\fIcomponent\fR);
.fi

.LP
.nf
\fBpool_elem_t *\fR\fBpool_conf_to_elem\fR(\fBpool_conf_t *\fR\fIconf\fR);
.fi

.LP
.nf
\fBpool_elem_t *\fR\fBpool_resource_to_elem\fR(\fBpool_conf_t *\fR\fIconf\fR, 
      \fBpool_resource_t *\fR\fIresource\fR);
.fi

.LP
.nf
\fBpool_elem_t *\fR\fBpool_to_elem\fR(\fBpool_conf_t *\fR\fIconf\fR, \fBpool_t *\fR\fIpool\fR);
.fi

.SH DESCRIPTION
.sp
.LP
A pool element, as represented by a \fBpool_elem_t\fR, is a common abstraction for any \fBlibpool\fR entity that contains properties. All such types can be converted to the opaque \fBpool_elem_t\fR type using the appropriate conversion functions prototyped above. The \fIconf\fR argument for each function refers to the target configuration to which the operation applies.
.SH RETURN VALUES
.sp
.LP
Upon successful completion, these functions return a \fBpool_elem_t\fR corresponding to the argument passed in. Otherwise they return \fINULL\fR and \fBpool_error\fR(3POOL) returns the pool-specific error value.
.SH ERRORS
.sp
.LP
These function will fail if:
.sp
.ne 2
.mk
.na
\fB\fBPOE_BADPARAM\fR\fR
.ad
.RS 16n
.rt  
The supplied configuration's status is not \fBPOF_VALID\fR.
.RE

.SH ATTRIBUTES
.sp
.LP
See \fBattributes\fR(5) for descriptions of the following attributes:
.sp

.sp
.TS
tab() box;
cw(2.75i) |cw(2.75i) 
lw(2.75i) |lw(2.75i) 
.
ATTRIBUTE TYPEATTRIBUTE VALUE
_
CSIEnabled
_
Interface StabilityUncommitted
_
MT-LevelSafe
.TE

.SH SEE ALSO
.sp
.LP
\fBlibpool\fR(3LIB), \fBpool_error\fR(3POOL), \fBattributes\fR(5)