usr/src/man/man3nvpair/nvpair_value_byte.3nvpair

   1 '\" te
   2 .\" Copyright (c) 2008, 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 NVPAIR_VALUE_BYTE 3NVPAIR "Aug 1, 2008"
   7 .SH NAME
   8 nvpair_value_byte, nvpair_value_boolean_value, nvpair_value_int8,
   9 nvpair_value_uint8, nvpair_value_int16, nvpair_value_uint16,
  10 nvpair_value_int32, nvpair_value_uint32, nvpair_value_int64,
  11 nvpair_value_uint64, nvpair_value_double, nvpair_value_string,
  12 nvpair_value_nvlist, nvpair_value_boolean_array, nvpair_value_byte_array,
  13 nvpair_value_int8_array, nvpair_value_uint8_array, nvpair_value_int16_array,
  14 nvpair_value_uint16_array, nvpair_value_int32_array, nvpair_value_uint32_array,
  15 nvpair_value_int64_array, nvpair_value_uint64_array, nvpair_value_string_array,
  16 nvpair_value_nvlist_array \- retrieve value from a name-value pair
  17 .SH SYNOPSIS
  18 .LP
  19 .nf
  20 \fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lnvpair\fR [ \fIlibrary\fR... ]
  21 #include <libnvpair.h>
  22
  23 \fBint\fR \fBnvpair_value_byte\fR(\fBnvpair_t *\fR\fInvpair\fR, \fBuchar_t *\fR\fIval\fR);
  24 .fi
  25
  26 .LP
  27 .nf
  28 \fBint\fR \fBnvpair_value_boolean_value\fR(\fBnvpair_t *\fR\fInvpair\fR,
  29      \fBboolean_t *\fR\fIval\fR);
  30 .fi
  31
  32 .LP
  33 .nf
  34 \fBint\fR \fBnvpair_value_int8\fR(\fBnvpair_t *\fR\fInvpair\fR, \fBint8_t *\fR\fIval\fR);
  35 .fi
  36
  37 .LP
  38 .nf
  39 \fBint\fR \fBnvpair_value_uint8\fR(\fBnvpair_t *\fR\fInvpair\fR, \fBuint8_t *\fR\fIval\fR);
  40 .fi
  41
  42 .LP
  43 .nf
  44 \fBint\fR \fBnvpair_value_int16\fR(\fBnvpair_t *\fR\fInvpair\fR, \fBint16_t *\fR\fIval\fR);
  45 .fi
  46
  47 .LP
  48 .nf
  49 \fBint\fR \fBnvpair_value_uint16\fR(\fBnvpair_t *\fR\fInvpair\fR, \fBuint16_t *\fR\fIval\fR);
  50 .fi
  51
  52 .LP
  53 .nf
  54 \fBint\fR \fBnvpair_value_int32\fR(\fBnvpair_t *\fR\fInvpair\fR, \fBint32_t *\fR\fIval\fR);
  55 .fi
  56
  57 .LP
  58 .nf
  59 \fBint\fR \fBnvpair_value_uint32\fR(\fBnvpair_t *\fR\fInvpair\fR, \fBuint32_t *\fR\fIval\fR);
  60 .fi
  61
  62 .LP
  63 .nf
  64 \fBint\fR \fBnvpair_value_int64\fR(\fBnvpair_t *\fR\fInvpair\fR, \fBint64_t *\fR\fIval\fR);
  65 .fi
  66
  67 .LP
  68 .nf
  69 \fBint\fR \fBnvpair_value_uint64\fR(\fBnvpair_t *\fR\fInvpair\fR, \fBuint64_t *\fR\fIval\fR);
  70 .fi
  71
  72 .LP
  73 .nf
  74 \fBint\fR \fBnvpair_value_double\fR(\fBnvpair_t *\fR\fInvpair\fR, \fBdouble *\fR\fIval\fR);
  75 .fi
  76
  77 .LP
  78 .nf
  79 \fBint\fR \fBnvpair_value_string\fR(\fBnvpair_t *\fR\fInvpair\fR, \fBchar **\fR\fIval\fR);
  80 .fi
  81
  82 .LP
  83 .nf
  84 \fBint\fR \fBnvpair_value_nvlist\fR(\fBnvpair_t *\fR\fInvpair\fR, \fBnvlist_t **\fR\fIval\fR);
  85 .fi
  86
  87 .LP
  88 .nf
  89 \fBint\fR \fBnvpair_value_boolean_array\fR(\fBnvpair_t *\fR\fInvpair\fR,
  90      \fBboolean_t **\fR\fIval\fR, \fBuint_t *\fR\fInelem\fR);
  91 .fi
  92
  93 .LP
  94 .nf
  95 \fBint\fR \fBnvpair_value_byte_array\fR(\fBnvpair_t *\fR\fInvpair\fR, \fBuchar_t **\fR\fIval\fR,
  96      \fBuint_t *\fR\fInelem\fR);
  97 .fi
  98
  99 .LP
 100 .nf
 101 \fBint\fR \fBnvpair_value_int8_array\fR(\fBnvpair_t *\fR\fInvpair\fR, \fBint8_t **\fR\fIval\fR,
 102      \fBuint_t *\fR\fInelem\fR);
 103 .fi
 104
 105 .LP
 106 .nf
 107 \fBint\fR \fBnvpair_value_uint8_array\fR(\fBnvpair_t *\fR\fInvpair\fR, \fBuint8_t **\fR\fIval\fR,
 108      \fBuint_t *\fR\fInelem\fR);
 109 .fi
 110
 111 .LP
 112 .nf
 113 \fBint\fR \fBnvpair_value_int16_array\fR(\fBnvpair_t *\fR\fInvpair\fR, \fBint16_t **\fR\fIval\fR,
 114      \fBuint_t *\fR\fInelem\fR);
 115 .fi
 116
 117 .LP
 118 .nf
 119 \fBint\fR \fBnvpair_value_uint16_array\fR(\fBnvpair_t *\fR\fInvpair\fR,
 120      \fBuint16_t **\fR\fIval\fR, \fBuint_t *\fR\fInelem\fR);
 121 .fi
 122
 123 .LP
 124 .nf
 125 \fBint\fR \fBnvpair_value_int32_array\fR(\fBnvpair_t *\fR\fInvpair\fR,
 126      \fBint32_t **\fR\fIval\fR, \fBuint_t *\fR\fInelem\fR);
 127 .fi
 128
 129 .LP
 130 .nf
 131 \fBint\fR \fBnvpair_value_uint32_array\fR(\fBnvpair_t *\fR\fInvpair\fR,
 132      \fBuint32_t **\fR\fIval\fR, \fBuint_t *\fR\fInelem\fR);
 133 .fi
 134
 135 .LP
 136 .nf
 137 \fBint\fR \fBnvpair_value_int64_array\fR(\fBnvpair_t *\fR\fInvpair\fR,
 138      \fBint64_t **\fR\fIval\fR, \fBuint_t *\fR\fInelem\fR);
 139 .fi
 140
 141 .LP
 142 .nf
 143 \fBint\fR \fBnvpair_value_uint64_array\fR(\fBnvpair_t *\fR\fInvpair\fR,
 144      \fBuint64_t **\fR\fIval\fR, \fBuint_t *\fR\fInelem\fR);
 145 .fi
 146
 147 .LP
 148 .nf
 149 \fBint\fR \fBnvpair_value_string_array\fR(\fBnvpair_t *\fR\fInvpair\fR,
 150      \fBchar ***\fR\fIval\fR, \fBuint_t *\fR\fInelem\fR);
 151 .fi
 152
 153 .LP
 154 .nf
 155 \fBint\fR \fBnvpair_value_nvlist_array\fR(\fBnvpair_t *\fR\fInvpair\fR,
 156      \fBnvlist_t ***\fR\fIval\fR, \fBuint_t *\fR\fInelem\fR);
 157 .fi
 158
 159 .SH PARAMETERS
 160 .sp
 161 .ne 2
 162 .na
 163 \fB\fInvpair\fR\fR
 164 .ad
 165 .RS 10n
 166 Name-value pair to be processed.
 167 .RE
 168
 169 .sp
 170 .ne 2
 171 .na
 172 \fB\fInelem\fR\fR
 173 .ad
 174 .RS 10n
 175 Address to store the number of elements in value.
 176 .RE
 177
 178 .sp
 179 .ne 2
 180 .na
 181 \fB\fIval\fR\fR
 182 .ad
 183 .RS 10n
 184 Address to store the value or the starting address of the array value.
 185 .RE
 186
 187 .SH DESCRIPTION
 188 .sp
 189 .LP
 190 These functions retrieve the value of \fInvpair\fR. The data type of
 191 \fInvpair\fR must match the interface name for the call to be successful.
 192 .sp
 193 .LP
 194 There is no \fBnvpair_value_boolean()\fR; the existence of the name implies the
 195 value is true.
 196 .sp
 197 .LP
 198 For array data types, including string, the memory containing the data is
 199 managed by the library and references to the value remains valid until
 200 \fBnvlist_free()\fR is called on the \fBnvlist_t\fR from which \fInvpair\fR is
 201 obtained. See \fBnvlist_free\fR(3NVPAIR).
 202 .sp
 203 .LP
 204 The value of an nvpair may not be retrieved after the nvpair has been removed
 205 from or replaced in an nvlist. Replacement can occur during pair additions to
 206 nvlists created with \fBNV_UNIQUE_NAME_TYPE\fR and \fBNV_UNIQUE_NAME\fR. See
 207 \fBnvlist_alloc\fR(3NVPAIR).
 208 .SH RETURN VALUES
 209 .sp
 210 .LP
 211 These functions return 0 on success and an error value on failure.
 212 .SH ERRORS
 213 .sp
 214 .LP
 215 These functions will fail if:
 216 .sp
 217 .ne 2
 218 .na
 219 \fB\fBEINVAL\fR\fR
 220 .ad
 221 .RS 10n
 222 Either one of the arguments is \fINULL\fR or the type of \fInvpair\fR does not
 223 match the function name.
 224 .RE
 225
 226 .SH ATTRIBUTES
 227 .sp
 228 .LP
 229 See \fBattributes\fR(5)  for descriptions of the following attributes:
 230 .sp
 231
 232 .sp
 233 .TS
 234 box;
 235 c | c
 236 l | l .
 237 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 238 _
 239 Interface Stability     Committed
 240 _
 241 MT-Level        MT-Safe
 242 .TE
 243
 244 .SH SEE ALSO
 245 .sp
 246 .LP
 247 \fBlibnvpair\fR(3LIB), \fBnvlist_alloc\fR(3NVPAIR), \fBattributes\fR(5)