share/man/man9f/nvlist_lookup_nvpair.9f

   1 '\" te
   2 .\" Copyright (c) 2007, Sun Microsystems Inc. All Rights Reserved.
   3 .\" 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.
   4 .\" 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.
   5 .\" 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]
   6 .TH NVLIST_LOOKUP_NVPAIR 9F "Oct 24, 2007"
   7 .SH NAME
   8 nvlist_lookup_nvpair, nvlist_exists \- lookup named pairs
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 #include <libnvpair.h>
  13
  14 \fBint\fR \fBnvlist_lookup_nvpair\fR(\fBnvlist_t *\fR\fInvl\fR, \fBconst char *\fR\fIname\fR,
  15      nvpair_t **\fInvp\fR);
  16 .fi
  17
  18 .LP
  19 .nf
  20 \fBboolean_t\fR \fBnvlist_exists\fR(\fBnvlist_t *\fR\fInvl\fR, \fBconst char *\fR\fIname\fR);
  21 .fi
  22
  23 .SH DESCRIPTION
  24 .sp
  25 .LP
  26 The \fBnvlist_lookup_nvpair()\fR function returns the nvpair with the matching
  27 name, regardless of type. It is valid only for lists allocated with
  28 \fBNV_UNIQUE_NAME\fR. See \fBnvlist_alloc\fR(9F).
  29 .sp
  30 .LP
  31 The \fBnvlist_exists()\fR function returns success if any nvpair exists with
  32 the given name. It is valid for all types of lists.
  33 .SH RETURN VALUES
  34 .sp
  35 .LP
  36 The \fBnvlist_lookup_nvpair()\fR function returns 0 on success and an error
  37 value on failure.
  38 .sp
  39 .LP
  40 The \fBnvlist_exists()\fR function returns \fBB_TRUE\fR if an nvpair with the
  41 given name exists and \fBB_FALSE\fR otherwise.
  42 .SH ERRORS
  43 .sp
  44 .LP
  45 The \fBnvlist_lookup_nvpair()\fR function will fail if:
  46 .sp
  47 .ne 2
  48 .na
  49 \fB\fBEINVAL\fR\fR
  50 .ad
  51 .RS 11n
  52 There is an invalid argument.
  53 .RE
  54
  55 .sp
  56 .ne 2
  57 .na
  58 \fB\fBENOENT\fR\fR
  59 .ad
  60 .RS 11n
  61 No matching name-value pair is found.
  62 .RE
  63
  64 .sp
  65 .ne 2
  66 .na
  67 \fB\fBENOTSUP\fR\fR
  68 .ad
  69 .RS 11n
  70 The list was not allocated with \fBNV_UNIQUE_NAME\fR.
  71 .RE
  72
  73 .SH ATTRIBUTES
  74 .sp
  75 .LP
  76 See \fBattributes\fR(5) for descriptions of the following attributes:
  77 .sp
  78
  79 .sp
  80 .TS
  81 box;
  82 c | c
  83 l | l .
  84 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  85 _
  86 Interface Stability     Committed
  87 .TE
  88
  89 .SH SEE ALSO
  90 .sp
  91 .LP
  92 \fBnvlist_lookup_nvpair\fR(3NVPAIR), \fBnvlist_alloc\fR(9F),
  93 \fBattributes\fR(5)