NVLIST_LOOKUP_NVPAIR(3NVPAIR) Name-value Pair Library Functions
NAME
nvlist_lookup_nvpair, nvlist_exists, nvlist_empty - 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);
boolean_t nvlist_empty(
nvlist_t *nvl);
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.
The
nvlist_empty() function returns success if the list
nvl contains
no nvpairs. 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.
The
nvlist_empty() function returns
B_TRUE if the given list,
nvl,
contains no nvpairs 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) March 13, 2016 NVLIST_LOOKUP_NVPAIR(3NVPAIR)
