share/man/man9f/nvpair_value_byte.9f

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