Sun Microsystems, Inc.
spacerspacer
spacer   www.sun.com docs.sun.com | | |  
spacer
black dot
   
A   B   C   D   E   F   G   H   I   J   K   L   M   N   O   P   Q   R   S   T   U   V   W   X   Y   Z
    
 
Name-value Pair Library Functionsnvlist_next_nvpair(3NVPAIR)


NAME

 nvlist_next_nvpair, nvpair_name, nvpair_type - return data regarding name-value pairs

SYNOPSIS

 
cc [ flag ... ] file ...-lnvpair [ library ... ] 
#include <libnvpair.h>
nvpair_t *nvlist_next_nvpair(nvlist_t *nvl, nvpair_t *nvpair);
 char *nvpair_name(nvpair_t *nvpair);
 data_type_t nvpair_type(nvpair_t *nvpair);

PARAMETERS

 

nvl
The nvlist_t to be processed.
nvpair
Handle to a name-value pair.

DESCRIPTION

 

The nvlist_next_nvpair() function returns a handle to the next nvpair in the list following nvpair. If nvpair is NULL, the first pair is returned. If nvpair is the last pair in the nvlist, NULL is returned.

The nvpair_name() function returns a string containing the name of nvpair.

The nvpair_type() function retrieves the value of the nvpair in the form of enumerated type data_type_t. This is used to determine the appropriate nvpair_*() function to call for retrieving the value.

RETURN VALUES

 

Upon successful completion, nvpair_name() returns a string containing the name of the name-value pair.

Upon successful completion, nvpair_type() returns an enumerated data type data_type_t. Possible values for data_type_t are as follows:

 
DATA_TYPE_BOOLEAN
DATA_TYPE_BYTE
DATA_TYPE_INT16
DATA_TYPE_UINT16
DATA_TYPE_INT32
DATA_TYPE_UINT32
DATA_TYPE_INT64
DATA_TYPE_UINT64
DATA_TYPE_STRING
DATA_TYPE_BYTE_ARRAY
DATA_TYPE_INT16_ARRAY
DATA_TYPE_UINT16_ARRAY
DATA_TYPE_INT32_ARRAY
DATA_TYPE_UINT32_ARRAY
DATA_TYPE_INT64_ARRAY
DATA_TYPE_UINT64_ARRAY
DATA_TYPE_STRING_ARRAY

Upon reaching the end of a list, nvlist_next_pair() returns NULL. Otherwise, the function returns a handle to next nvpair in the list.

ERRORS

 

No errors are defined.

ATTRIBUTES

 

See attributes(5) for descriptions of the following attributes:

ATTRIBUTE TYPEATTRIBUTE VALUE
Interface StabilityEvolving
MT-LevelMT-Safe

SEE ALSO

 

libnvpair(3NVPAIR), attributes(5)


SunOS 5.9Go To TopLast Changed 16 Aug 2001

 
      
      
Copyright 2002 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms.