Go to main content

man pages section 3: Extended Library Functions, Volume 3

Exit Print View

Updated: Thursday, June 13, 2019
 
 

nvlist_lookup_nvpair(3NVPAIR)

Name

nvlist_lookup_nvpair, nvlist_exists - lookup named pairs

Synopsis

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

int nvlist_lookup_nvpair(nvlist_t *nvl, const char *name,
     nvpair_t **nvp);
boolean_t nvlist_exists(nvlist_t *nvl, const char *name);

Description

The nvlist_lookup_nvpair() function returns the nvpair with the matching name, regardless of type. It is valid only for lists allocated with NV_UNIQUE_NAME. See nvlist_alloc(3NVPAIR).

The nvlist_exists() function returns success if any nvpair exists with the given name. It is valid for all types of lists.

Return Values

The nvlist_lookup_nvpair() function returns 0 on success and an error value on failure.

The nvlist_exists() function returns B_TRUE if an nvpair with the given name exists and B_FALSE otherwise.

Errors

The nvlist_lookup_nvpair() function will fail if:

EINVAL

There is an invalid argument.

ENOENT

No matching name-value pair is found.

ENOTSUP

The list was not allocated with NV_UNIQUE_NAME.

Attributes

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

ATTRIBUTE TYPE
ATTRIBUTE VALUE
Interface Stability
Committed
MT-Level
MT-Safe

See Also

libnvpair(3LIB), nvlist_alloc(3NVPAIR), attributes(7), nvlist_lookup_nvpair(9F)