Content-type: text/html Man page of nvlist_remove

nvlist_remove

Section: Name-value Pair Library Functions (3NVPAIR)
Updated: 2 Feb 2004
Index Return to Main Contents
 

NAME

nvlist_remove, nvlist_remove_all - remove name-value pairs  

SYNOPSIS

cc [ flag... ] file... -lnvpair [ library... ]
#include <libnvpair.h>

int nvlist_remove(nvlist_t *nvl, const char *name, data_type_t type);

int nvlist_remove_all(nvlist_t *nvl, const char *name);  

PARAMETERS

nvl The nvlist_t to be processed.

name Name of the name-value pair to be removed.

type Data type of the nvpair to be removed.

 

DESCRIPTION

The nvlist_remove() function removes the first occurrence of nvpair that matches the name and the type.

The nvlist_remove_all() function removes all occurrences of nvpair that match the name, regardless of type.

Multiple threads can simultaneously read the same nvlist_t but only one thread can actively change a given nvlist_t at a time. The caller is responsible for the synchronization.  

RETURN VALUES

These functions return 0 on success and an error value on failure.  

ERRORS

These functions will fail if:

EINVAL There is an invalid argument.

ENOENT No name-value pairs were found to match the criteria specified by name and type.

 

ATTRIBUTES

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

ATTRIBUTE TYPEATTRIBUTE VALUE
Interface StabilityEvolving
MT-LevelMT-Safe

 

SEE ALSO

libnvpair(3LIB), attributes(5)


 

Index

NAME
SYNOPSIS
PARAMETERS
DESCRIPTION
RETURN VALUES
ERRORS
ATTRIBUTES
SEE ALSO

This document was created by man2html, using the manual pages.
Time: 02:39:19 GMT, October 02, 2010