nvlist_next_nvpair.3nvpair revision c10c16dec587a0662068f6e2991c29ed3a9db943
te
Copyright (c) 2004, Sun Microsystems, Inc. All Rights Reserved.
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.
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.
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]
nvlist_next_nvpair 3NVPAIR "2 Feb 2004" "SunOS 5.11" "Name-value Pair Library Functions"
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_BOOLEAN_VALUE

DATA_TYPE_BYTE

DATA_TYPE_INT8

DATA_TYPE_UINT8

DATA_TYPE_INT16

DATA_TYPE_UINT16

DATA_TYPE_INT32

DATA_TYPE_UINT32

DATA_TYPE_INT64

DATA_TYPE_UINT64

DATA_TYPE_STRING

DATA_TYPE_NVLIST

DATA_TYPE_BOOLEAN_ARRAY

DATA_TYPE_BYTE_ARRAY

DATA_TYPE_INT8_ARRAY

DATA_TYPE_UINT8_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

DATA_TYPE_NVLIST_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.

These and other libnvpair(3LIB) functions cannot manipulate nvpairs after they have been removed from or replaced in an nvlist. Replacement can occur during pair additions to nvlists created with NV_UNIQUE_NAME_TYPE and NV_UNIQUE_NAME. See nvlist_alloc(3NVPAIR).

ERRORS

No errors are defined.

EXAMPLES

Example 1 Example of usage of nvlist_next_nvpair().

/*
 * usage of nvlist_next_nvpair() 
 */
 static int 
 edit_nvl(nvlist_t *nvl) 
 {
 nvpair_t *curr = nvlist_next_nvpair(nvl, NULL); 
 
 while (curr != NULL) { 
 int err; 
 nvpair_t *next = nvlist_next_nvpair(nvl, curr); 
 
 if (!nvl_check(curr)) 
 if ((err = nvlist_remove(nvl, nvpair_name(curr), 
 nvpair_type(curr))) != 0) 
 return (err); 
 
 curr = next; 
 } 
 return (0); 
 }
ATTRIBUTES

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

ATTRIBUTE TYPEATTRIBUTE VALUE
Interface StabilityEvolving
MT-LevelMT-Safe
SEE ALSO

libnvpair(3LIB), nvlist_alloc(3NVPAIR), attributes(5)

NOTES

The enumerated nvpair data types might not be an exhaustive list and new data types can be added. An application using the data type enumeration, data_type_t, should be written to expect or ignore new data types.