57 The conf argument for each function refers to the target configuration
58 to which the operation applies.
59
60
61 The pool_get_property() function attempts to retrieve the value of the
62 named property from the element. If the property is not found or an
63 error occurs, the value POC_INVAL is returned to indicate error.
64 Otherwise the type of the value retrieved is returned.
65
66
67 The pool_put_property() function attempts to set the named property on
68 the element to the specified value. Attempting to set a property that
69 does not currently exist on the element will cause the property with
70 the given name and value to be created on the element and will not
71 cause an error. An attempt to overwrite an existing property with a new
72 property of a different type is an error.
73
74
75 The pool_rm_property() function attempts to remove the named property
76 from the element. If the property does not exist or is not removable,
77 -1 is returned and pool_error(3POOL) reporst an error of POE_PUTPROP.
78
79
80 The pool_walk_properties() function invokes callback on all properties
81 defined for the given element. The callback is called with the element
82 itself, the name of the property, the value of the property, and the
83 caller-provided opaque argument.
84
85
86 A number of special properties are reserved for internal use and cannot
87 be set or removed. Attempting to do so will fail. These properties are
88 documented on the libpool(3LIB) manual page.
89
90 RETURN VALUES
91 Upon successful completion, pool_get_property() returns the type of the
92 property. Otherwise it returns POC_INVAL and pool_error() returns the
93 pool-specific error value.
94
95
96 Upon successful completion, pool_put_property(), pool_rm_property(),
97 and pool_walk_properties() return 0. Otherwise they return -1 and
173 See attributes(5) for descriptions of the following attributes:
174
175
176
177
178 +--------------------+-----------------+
179 | ATTRIBUTE TYPE | ATTRIBUTE VALUE |
180 +--------------------+-----------------+
181 |CSI | Enabled |
182 +--------------------+-----------------+
183 |Interface Stability | Unstable |
184 +--------------------+-----------------+
185 |MT-Level | Safe |
186 +--------------------+-----------------+
187
188 SEE ALSO
189 libpool(3LIB), pool_error(3POOL), attributes(5)
190
191
192
193 September 23, 2003 POOL_GET_PROPERTY(3POOL)
|
57 The conf argument for each function refers to the target configuration
58 to which the operation applies.
59
60
61 The pool_get_property() function attempts to retrieve the value of the
62 named property from the element. If the property is not found or an
63 error occurs, the value POC_INVAL is returned to indicate error.
64 Otherwise the type of the value retrieved is returned.
65
66
67 The pool_put_property() function attempts to set the named property on
68 the element to the specified value. Attempting to set a property that
69 does not currently exist on the element will cause the property with
70 the given name and value to be created on the element and will not
71 cause an error. An attempt to overwrite an existing property with a new
72 property of a different type is an error.
73
74
75 The pool_rm_property() function attempts to remove the named property
76 from the element. If the property does not exist or is not removable,
77 -1 is returned and pool_error(3POOL) reports an error of POE_PUTPROP.
78
79
80 The pool_walk_properties() function invokes callback on all properties
81 defined for the given element. The callback is called with the element
82 itself, the name of the property, the value of the property, and the
83 caller-provided opaque argument.
84
85
86 A number of special properties are reserved for internal use and cannot
87 be set or removed. Attempting to do so will fail. These properties are
88 documented on the libpool(3LIB) manual page.
89
90 RETURN VALUES
91 Upon successful completion, pool_get_property() returns the type of the
92 property. Otherwise it returns POC_INVAL and pool_error() returns the
93 pool-specific error value.
94
95
96 Upon successful completion, pool_put_property(), pool_rm_property(),
97 and pool_walk_properties() return 0. Otherwise they return -1 and
173 See attributes(5) for descriptions of the following attributes:
174
175
176
177
178 +--------------------+-----------------+
179 | ATTRIBUTE TYPE | ATTRIBUTE VALUE |
180 +--------------------+-----------------+
181 |CSI | Enabled |
182 +--------------------+-----------------+
183 |Interface Stability | Unstable |
184 +--------------------+-----------------+
185 |MT-Level | Safe |
186 +--------------------+-----------------+
187
188 SEE ALSO
189 libpool(3LIB), pool_error(3POOL), attributes(5)
190
191
192
193 May 16, 2020 POOL_GET_PROPERTY(3POOL)
|