Name-value Pair Library Functions nvpairvaluebyte(3NVPAIR)
NAME
nvpairvaluebyte, nvpairvaluebooleanvalue,
nvpairvalueint8, nvpairvalueuint8, nvpairvalueint16,
nvpairvalueuint16, nvpairvalueint32,
nvpairvalueuint32, nvpairvalueint64,
nvpairvalueuint64, nvpairvaluedouble,
nvpairvaluestring, nvpairvaluenvlist,
nvpairvaluebooleanarray, nvpairvaluebytearray,
nvpairvalueint8array, nvpairvalueuint8array,
nvpairvalueint16array, nvpairvalueuint16array,
nvpairvalueint32array, nvpairvalueuint32array,
nvpairvalueint64array, nvpairvalueuint64array,
nvpairvaluestringarray, nvpairvaluenvlistarray -
retrieve value from a name-value pair
SYNOPSIS
cc [ flag... ] file... -lnvpair [ library... ]
#include
int nvpairvaluebyte(nvpairt *nvpair, uchart *val);
int nvpairvaluebooleanvalue(nvpairt *nvpair,
booleant *val);
int nvpairvalueint8(nvpairt *nvpair, int8t *val);
int nvpairvalueuint8(nvpairt *nvpair, uint8t *val);
int nvpairvalueint16(nvpairt *nvpair, int16t *val);
int nvpairvalueuint16(nvpairt *nvpair, uint16t *val);
int nvpairvalueint32(nvpairt *nvpair, int32t *val);
int nvpairvalueuint32(nvpairt *nvpair, uint32t *val);
int nvpairvalueint64(nvpairt *nvpair, int64t *val);
int nvpairvalueuint64(nvpairt *nvpair, uint64t *val);
int nvpairvaluedouble(nvpairt *nvpair, double *val);
SunOS 5.11 Last change: 1 Aug 2008 1
Name-value Pair Library Functions nvpairvaluebyte(3NVPAIR)
int nvpairvaluestring(nvpairt *nvpair, char **val);
int nvpairvaluenvlist(nvpairt *nvpair, nvlistt **val);
int nvpairvaluebooleanarray(nvpairt *nvpair,
booleant **val, uintt *nelem);
int nvpairvaluebytearray(nvpairt *nvpair, uchart **val,
uintt *nelem);
int nvpairvalueint8array(nvpairt *nvpair, int8t **val,
uintt *nelem);
int nvpairvalueuint8array(nvpairt *nvpair, uint8t **val,
uintt *nelem);
int nvpairvalueint16array(nvpairt *nvpair, int16t **val,
uintt *nelem);
int nvpairvalueuint16array(nvpairt *nvpair,
uint16t **val, uintt *nelem);
int nvpairvalueint32array(nvpairt *nvpair,
int32t **val, uintt *nelem);
int nvpairvalueuint32array(nvpairt *nvpair,
uint32t **val, uintt *nelem);
int nvpairvalueint64array(nvpairt *nvpair,
int64t **val, uintt *nelem);
int nvpairvalueuint64array(nvpairt *nvpair,
uint64t **val, uintt *nelem);
int nvpairvaluestringarray(nvpairt *nvpair,
char ***val, uintt *nelem);
int nvpairvaluenvlistarray(nvpairt *nvpair,
nvlistt ***val, uintt *nelem);
SunOS 5.11 Last change: 1 Aug 2008 2
Name-value Pair Library Functions nvpairvaluebyte(3NVPAIR)
PARAMETERS
nvpair Name-value pair to be processed.
nelem Address to store the number of elements in value.
val Address to store the value or the starting address
of the array value.
DESCRIPTION
These functions retrieve the value of nvpair. The data type
of nvpair must match the interface name for the call to be
successful.
There is no nvpairvalueboolean(); the existence of the
name implies the value is true.
For array data types, including string, the memory contain-
ing the data is managed by the library and references to the
value remains valid until nvlistfree() is called on the
nvlistt from which nvpair is obtained. See
nvlistfree(3NVPAIR).
The value of an nvpair may not be retrieved after the nvpair
has been removed from or replaced in an nvlist. Replacement
can occur during pair additions to nvlists created with
NVUNIQUENAMETYPE and NVUNIQUENAME. See
nvlistalloc(3NVPAIR).
RETURN VALUES
These functions return 0 on success and an error value on
failure.
ERORS
These functions will fail if:
EINVAL Either one of the arguments is NUL or the type of
nvpair does not match the function name.
ATRIBUTES
See attributes(5) for descriptions of the following attri-
butes:
SunOS 5.11 Last change: 1 Aug 2008 3
Name-value Pair Library Functions nvpairvaluebyte(3NVPAIR)
ATRIBUTE TYPE ATRIBUTE VALUE
Interface Stability Committed
MT-Level MT-Safe
SEE ALSO
libnvpair(3LIB), nvlistalloc(3NVPAIR), attributes(5)
SunOS 5.11 Last change: 1 Aug 2008 4
|