diff options
Diffstat (limited to 'usr/src/man/man3scf/scf_value_create.3scf')
| -rw-r--r-- | usr/src/man/man3scf/scf_value_create.3scf | 73 |
1 files changed, 25 insertions, 48 deletions
diff --git a/usr/src/man/man3scf/scf_value_create.3scf b/usr/src/man/man3scf/scf_value_create.3scf index a340c3ae88..d1662df58a 100644 --- a/usr/src/man/man3scf/scf_value_create.3scf +++ b/usr/src/man/man3scf/scf_value_create.3scf @@ -3,7 +3,7 @@ .\" 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. 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. 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] -.TH scf_value_create 3SCF "28 May 2009" "SunOS 5.11" "Service Configuration Facility Library Functions" +.TH SCF_VALUE_CREATE 3SCF "May 28, 2009" .SH NAME scf_value_create, scf_value_handle, scf_value_reset, scf_value_destroy, scf_value_type, scf_value_base_type, scf_value_is_type, scf_type_base_type, @@ -17,7 +17,7 @@ Configuration Facility .SH SYNOPSIS .LP .nf -cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-lscf\fR [ \fIlibrary\fR\&.\|.\|. ] +cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-lscf\fR [ \fIlibrary\fR\&.\|.\|. ] #include <libscf.h> \fBscf_value_t *\fR\fBscf_value_create\fR(\fBscf_handle_t *\fR\fIh\fR); @@ -173,32 +173,30 @@ value's type). .sp .TS -tab(); -cw(1.8i) cw(.84i) cw(2.86i) -lw(1.8i) lw(.84i) lw(2.86i) -. -Type IdentifierBase TypeType Description +c c c +l l l . +Type Identifier Base Type Type Description _ -\fBSCF_TYPE_INVALID\fRreserved invalid type -\fBSCF_TYPE_BOOLEAN\fRsingle bit -\fBSCF_TYPE_COUNT\fRunsigned 64-bit quantity -\fBSCF_TYPE_INTEGER\fRsigned 64-bit quantity -\fBSCF_TYPE_TIME\fRT{ +\fBSCF_TYPE_INVALID\fR reserved invalid type +\fBSCF_TYPE_BOOLEAN\fR single bit +\fBSCF_TYPE_COUNT\fR unsigned 64-bit quantity +\fBSCF_TYPE_INTEGER\fR signed 64-bit quantity +\fBSCF_TYPE_TIME\fR T{ signed 64-bit seconds, signed 32-bit nanoseconds in the range 0 <= \fIns\fR < 1,000,000,000 T} -\fBSCF_TYPE_ASTRING\fR8-bit NUL-terminated string -\fBSCF_TYPE_OPAQUE\fRopaque 8-bit data -\fBSCF_TYPE_USTRING\fR\fBASTRING\fR8-bit UTF-8 string -\fBSCF_TYPE_URI\fR\fBUSTRING\fRa URI string -\fBSCF_TYPE_FMRI\fR\fBURI\fRa Fault Management Resource Identifier -\fBSCF_TYPE_HOST\fR\fBUSTRING\fRT{ +\fBSCF_TYPE_ASTRING\fR 8-bit NUL-terminated string +\fBSCF_TYPE_OPAQUE\fR opaque 8-bit data +\fBSCF_TYPE_USTRING\fR \fBASTRING\fR 8-bit UTF-8 string +\fBSCF_TYPE_URI\fR \fBUSTRING\fR a URI string +\fBSCF_TYPE_FMRI\fR \fBURI\fR a Fault Management Resource Identifier +\fBSCF_TYPE_HOST\fR \fBUSTRING\fR T{ either a hostname, IPv4 address, or IPv6 address T} -\fBSCF_TYPE_HOSTNAME\fR\fBHOST\fRa fully-qualified domain name -\fBSCF_TYPE_NET_ADDR_V4\fR\fBHOST\fRT{ +\fBSCF_TYPE_HOSTNAME\fR \fBHOST\fR a fully-qualified domain name +\fBSCF_TYPE_NET_ADDR_V4\fR \fBHOST\fR T{ a dotted-quad IPv4 address with optional network portion T} -\fBSCF_TYPE_NET_ADDR_V6\fR\fBHOST\fRlegal IPv6 address +\fBSCF_TYPE_NET_ADDR_V6\fR \fBHOST\fR legal IPv6 address .TE .sp @@ -271,34 +269,28 @@ bytes written. Otherwise, it returns -1. The \fBscf_value_create()\fR function will fail if: .sp .ne 2 -.mk .na \fB\fBSCF_ERROR_HANDLE_DESTROYED\fR\fR .ad .RS 30n -.rt The handle associated with \fIh\fR has been destroyed. .RE .sp .ne 2 -.mk .na \fB\fBSCF_ERROR_INVALID_ARGUMENT\fR\fR .ad .RS 30n -.rt The handle is \fINULL\fR. .RE .sp .ne 2 -.mk .na \fB\fBSCF_ERROR_NO_MEMORY\fR\fR .ad .RS 30n -.rt There is not enough memory to allocate an \fBscf_value_t\fR. .RE @@ -307,12 +299,10 @@ There is not enough memory to allocate an \fBscf_value_t\fR. The \fBscf_value_handle()\fR function will fail if: .sp .ne 2 -.mk .na \fB\fBSCF_ERROR_HANDLE_DESTROYED\fR\fR .ad .RS 30n -.rt The handle associated with \fIv\fR has been destroyed. .RE @@ -321,12 +311,10 @@ The handle associated with \fIv\fR has been destroyed. The \fBscf_value_set_time()\fR function will fail if: .sp .ne 2 -.mk .na \fB\fBSCF_ERROR_INVALID_ARGUMENT\fR\fR .ad .RS 30n -.rt The nanoseconds field is not in the range 0 <= \fIns\fR < 1,000,000,000. .RE @@ -335,12 +323,10 @@ The nanoseconds field is not in the range 0 <= \fIns\fR < 1,000,000,000. The \fBscf_type_base_type()\fR function will fail if: .sp .ne 2 -.mk .na \fB\fBSCF_ERROR_INVALID_ARGUMENT\fR\fR .ad .RS 30n -.rt The \fItype\fR argument is not a valid type. .RE @@ -351,12 +337,10 @@ The \fBscf_value_set_astring()\fR, \fBscf_value_set_ustring()\fR, will fail if: .sp .ne 2 -.mk .na \fB\fBSCF_ERROR_INVALID_ARGUMENT\fR\fR .ad .RS 30n -.rt The \fIin\fR argument is not a valid value for the specified type or is longer than the maximum supported value length. .RE @@ -367,12 +351,10 @@ The \fBscf_type_base_type()\fR, \fBscf_value_is_type()\fR, and \fBscf_value_get_as_string_typed()\fR functions will fail if: .sp .ne 2 -.mk .na \fB\fBSCF_ERROR_INVALID_ARGUMENT\fR\fR .ad .RS 30n -.rt The \fItype\fR argument is not a valid type. .RE @@ -386,12 +368,10 @@ The \fBscf_value_type()\fR, \fBscf_value_base_type()\fR, functions will fail if: .sp .ne 2 -.mk .na \fB\fBSCF_ERROR_NOT_SET\fR\fR .ad .RS 21n -.rt The \fIv\fR argument has not been set to a value. .RE @@ -403,12 +383,10 @@ The \fBscf_value_get_boolean()\fR, \fBscf_value_get_count()\fR, \fBscf_value_get_as_string_typed()\fR functions will fail if: .sp .ne 2 -.mk .na \fB\fBSCF_ERROR_TYPE_MISMATCH\fR\fR .ad .RS 27n -.rt The requested type is not the same as the value's type and is not in the base-type chain. .RE @@ -424,15 +402,14 @@ See \fBattributes\fR(5) for descriptions of the following attributes: .sp .TS -tab() box; -cw(2.75i) |cw(2.75i) -lw(2.75i) |lw(2.75i) -. -ATTRIBUTE TYPEATTRIBUTE VALUE +box; +c | c +l | l . +ATTRIBUTE TYPE ATTRIBUTE VALUE _ -Interface StabilityCommitted +Interface Stability Committed _ -MT-LevelSafe +MT-Level Safe .TE .SH SEE ALSO |