nvpair_value_byte(9F)					   Kernel Functions for Drivers 				     nvpair_value_byte(9F)

NAME

       nvpair_value_byte,  nvpair_value_nvlist, nvpair_value_int8, nvpair_value_int16, nvpair_value_int32, nvpair_value_int64, nvpair_value_uint8,
       nvpair_value_uint16, nvpair_value_uint32, nvpair_value_uint64,  nvpair_value_string,  nvpair_value_boolean_array,  nvpair_value_byte_array,
       nvpair_value_nvlist_array,    nvpair_value_int8_array,	 nvpair_value_int16_array,   nvpair_value_int32_array,	 nvpair_value_int64_array,
       nvpair_value_uint8_array,  nvpair_value_uint16_array,  nvpair_value_uint32_array,  nvpair_value_uint64_array,  nvpair_value_string_array  -
       retrieve value from a name-value pair

SYNOPSIS

       #include <sys/nvpair.h>

       int nvpair_value_boolean_value(nvpair_t *nvpair, boolean_t *val);

       int nvpair_value_byte(nvpair_t *nvpair, uchar_t *val);

       int nvpair_value_int8(nvpair_t *nvpair, int8_t *val);

       int nvpair_value_uint8(nvpair_t *nvpair, uint8_t *val);

       int nvpair_value_int16(nvpair_t *nvpair, int16_t *val);

       int nvpair_value_uint16(nvpair_t *nvpair, uint16_t *val);

       int nvpair_value_int32(nvpair_t *nvpair, int32_t *val);

       int nvpair_value_uint32(nvpair_t *nvpair, uint32_t *val);

       int nvpair_value_int64(nvpair_t *nvpair, int64_t *val);

       int nvpair_value_uint64(nvpair_t *nvpair, uint64_t *val);

       int nvpair_value_string(nvpair_t *nvpair, char **val);

       int nvpair_value_nvlist(nvpair_t *nvpair, nvlist_t **val);

       int nvpair_value_boolean_array(nvpair_t *nvpair, boolean_t **val, uint_t *nelem);

       int nvpair_value_byte_array(nvpair_t *nvpair, uchar_t **val, uint_t *nelem);

       int nvpair_value_int8_array(nvpair_t *nvpair, int8_t **val, uint_t *nelem);

       int nvpair_value_uint8_array(nvpair_t *nvpair, uint8_t **val, uint_t *nelem);

       int nvpair_value_int16_array(nvpair_t *nvpair, int16_t **val, uint_t *nelem);

       int nvpair_value_uint16_array(nvpair_t *nvpair, uint16_t **val, uint_t *nelem);

       int nvpair_value_int32_array(nvpair_t *nvpair, int32_t **val, uint_t *nelem);

       int nvpair_value_uint32_array(nvpair_t *nvpair, uint32_t **val, uint_t *nelem);

       int nvpair_value_int64_array(nvpair_t *nvpair, int64_t **val, uint_t *nelem);

       int nvpair_value_uint64_array(nvpair_t *nvpair, uint64_t **val, uint_t *nelem);

       int nvpair_value_string_array(nvpair_t *nvpair, char ***val, uint_t *nelem);

       int nvpair_value_nvlist_array(nvpair_t *nvpair, nvlist_t ***val, uint_t *nelem);

INTERFACE LEVEL

       Solaris DDI specific (Solaris DDI)

PARAMETERS

       nvpair	       Name-value pair (nvpair) to be processed.

       nelem	       Address to store the number of elements in value.

       val	       Address to store the value or starting address of array value.

DESCRIPTION

       These functions retrieve the value of nvpair. The data type of nvpair must match the function name for the call to be successful.

       There is no nvpair_value_boolean(); the existence of the name implies the value is true.

       For  array data types, including string, the memory containing the data is managed by the library and references to the value remains valid
       until nvlist_free() is called on the nvlist_t from which nvpair is obtained. See nvlist_free(9F)

       The value of an nvpair may not be retrieved after the nvpair having been removed from or replaced in an nvlist. Replacement can happen dur-
       ing pair addition on nvlists created with NV_UNIQUE_NAME_TYPE and NV_UNIQUE_NAME. See nvlist_alloc(9F) for more details.

RETURN VALUES

       0	       Success

       EINVAL	       Either one of the arguments is NULL or type of nvpair does not match the interface name.

CONTEXT

       These functions can be called from user or interrupt context.

SunOS 5.10							    2 Feb 2004						     nvpair_value_byte(9F)