usr/src/man/man3pool/pool_component_to_elem.3pool

   1 '\" te
   2 .\" Copyright (c) 2003, Sun Microsystems, Inc. All Rights Reserved.
   3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   5 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   6 .TH POOL_COMPONENT_TO_ELEM 3POOL "Sep 23, 2003"
   7 .SH NAME
   8 pool_component_to_elem, pool_to_elem, pool_conf_to_elem, pool_resource_to_elem
   9 \- resource pool element-related functions
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-lpool\fR [ \fIlibrary\fR\&.\|.\|. ]
  14 #include <pool.h>
  15
  16 \fBpool_elem_t *\fR\fBpool_component_to_elem\fR(\fBpool_conf_t *\fR\fIconf\fR,
  17      \fBpool_component_t *\fR\fIcomponent\fR);
  18 .fi
  19
  20 .LP
  21 .nf
  22 \fBpool_elem_t *\fR\fBpool_conf_to_elem\fR(\fBpool_conf_t *\fR\fIconf\fR);
  23 .fi
  24
  25 .LP
  26 .nf
  27 \fBpool_elem_t *\fR\fBpool_resource_to_elem\fR(\fBpool_conf_t *\fR\fIconf\fR
  28       \fBpool_resource_t *\fR\fIresource\fR);
  29 .fi
  30
  31 .LP
  32 .nf
  33 \fBpool_elem_t *\fR\fBpool_to_elem\fR(\fBpool_conf_t *\fR\fIconf\fR, \fBpool_t *\fR\fIpool\fR);
  34 .fi
  35
  36 .SH DESCRIPTION
  37 .sp
  38 .LP
  39 A pool element, as represented by a \fBpool_elem_t\fR, is a common abstraction
  40 for any \fBlibpool\fR entity that contains properties. All such types can be
  41 converted to the opaque \fBpool_elem_t\fR type using the appropriate conversion
  42 functions prototyped above. The \fIconf\fR argument for each function refers to
  43 the target configuration to which the operation applies.
  44 .SH RETURN VALUES
  45 .sp
  46 .LP
  47 Upon successful completion, these functions return a \fBpool_elem_t\fR
  48 corresponding to the argument passed in. Otherwise they return \fINULL\fR and
  49 \fBpool_error\fR(3POOL) returns the pool-specific error value.
  50 .SH ERRORS
  51 .sp
  52 .LP
  53 These function will fail if:
  54 .sp
  55 .ne 2
  56 .na
  57 \fB\fBPOE_BADPARAM\fR\fR
  58 .ad
  59 .RS 16n
  60 The supplied configuration's status is not \fBPOF_VALID\fR.
  61 .RE
  62
  63 .SH ATTRIBUTES
  64 .sp
  65 .LP
  66 See \fBattributes\fR(5) for descriptions of the following attributes:
  67 .sp
  68
  69 .sp
  70 .TS
  71 box;
  72 c | c
  73 l | l .
  74 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  75 _
  76 CSI     Enabled
  77 _
  78 Interface Stability     Unstable
  79 _
  80 MT-Level        Safe
  81 .TE
  82
  83 .SH SEE ALSO
  84 .sp
  85 .LP
  86 \fBlibpool\fR(3LIB), \fBpool_error\fR(3POOL), \fBattributes\fR(5)