usr/src/man/man3nvpair/nvlist_remove.3nvpair

   1 '\" te
   2 .\" Copyright (c) 2004, 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_REMOVE 3NVPAIR "Feb 2, 2004"
   7 .SH NAME
   8 nvlist_remove, nvlist_remove_all \- remove name-value pairs
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lnvpair\fR [ \fIlibrary\fR... ]
  13 #include <libnvpair.h>
  14
  15 \fBint\fR \fBnvlist_remove\fR(\fBnvlist_t *\fR\fInvl\fR, \fBconst char *\fR\fIname\fR,
  16      \fBdata_type_t\fR \fItype\fR);
  17 .fi
  18
  19 .LP
  20 .nf
  21 \fBint\fR \fBnvlist_remove_all\fR(\fBnvlist_t *\fR\fInvl\fR, \fBconst char *\fR\fIname\fR);
  22 .fi
  23
  24 .SH PARAMETERS
  25 .sp
  26 .ne 2
  27 .na
  28 \fB\fInvl\fR\fR
  29 .ad
  30 .RS 8n
  31 The \fBnvlist_t\fR to be processed.
  32 .RE
  33
  34 .sp
  35 .ne 2
  36 .na
  37 \fB\fIname\fR\fR
  38 .ad
  39 .RS 8n
  40 Name of the name-value pair to be removed.
  41 .RE
  42
  43 .sp
  44 .ne 2
  45 .na
  46 \fB\fItype\fR\fR
  47 .ad
  48 .RS 8n
  49 Data type of the \fBnvpair\fR to be removed.
  50 .RE
  51
  52 .SH DESCRIPTION
  53 .sp
  54 .LP
  55 The \fBnvlist_remove()\fR function removes the first occurrence of \fBnvpair\fR
  56 that matches the name and the type.
  57 .sp
  58 .LP
  59 The \fBnvlist_remove_all()\fR function removes all occurrences of \fBnvpair\fR
  60 that match the name, regardless of type.
  61 .sp
  62 .LP
  63 Multiple threads can simultaneously read the same \fBnvlist_t\fR but only one
  64 thread can actively change a given \fBnvlist_t\fR at a time. The caller is
  65 responsible for the synchronization.
  66 .SH RETURN VALUES
  67 .sp
  68 .LP
  69 These functions return 0 on success and an error value on failure.
  70 .SH ERRORS
  71 .sp
  72 .LP
  73 These functions will fail if:
  74 .sp
  75 .ne 2
  76 .na
  77 \fB\fBEINVAL\fR\fR
  78 .ad
  79 .RS 10n
  80 There is an invalid argument.
  81 .RE
  82
  83 .sp
  84 .ne 2
  85 .na
  86 \fB\fBENOENT\fR\fR
  87 .ad
  88 .RS 10n
  89 No name-value pairs were found to match the criteria specified by \fIname\fR
  90 and \fItype\fR.
  91 .RE
  92
  93 .SH ATTRIBUTES
  94 .sp
  95 .LP
  96 See \fBattributes\fR(5) for descriptions of the following attributes:
  97 .sp
  98
  99 .sp
 100 .TS
 101 box;
 102 c | c
 103 l | l .
 104 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 105 _
 106 Interface Stability     Evolving
 107 _
 108 MT-Level        MT-Safe
 109 .TE
 110
 111 .SH SEE ALSO
 112 .sp
 113 .LP
 114 \fBlibnvpair\fR(3LIB), \fBattributes\fR(5)