share/man/man3picltree/ptree_find_node.3picltree

   1 '\" te
   2 .\" Copyright (c) 2000, 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 PTREE_FIND_NODE 3PICLTREE "Aug 1, 2000"
   7 .SH NAME
   8 ptree_find_node \- find node with given property and value
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lpicltree\fR [\fIlibrary\fR... ]
  13 #include <picltree.h>
  14
  15 \fBint\fR \fBptree_find_node\fR(\fBpicl_nodehdl_t\fR \fIrooth\fR, \fBchar *\fR\fIpname\fR,
  16      \fBpicl_prop_type_t\fR \fIptype\fR, \fBvoid *\fR\fIpval\fR, \fBsize_t\fR \fIvalsize\fR,
  17      \fBpicl_nodehdl_t *\fR\fIretnodeh\fR);
  18 .fi
  19
  20 .SH DESCRIPTION
  21 .sp
  22 .LP
  23 The \fBptree_find_node()\fR function visits the nodes in the subtree under the
  24 node specified by \fIrooth\fR. The handle of the node that has the property
  25 whose name, type, and value matches the name, type, and value specified in
  26 \fIpname\fR, \fIptype\fR, and \fIpval\fR respectively, is returned in the
  27 location given by \fIretnodeh\fR. The argument \fIvalsize\fR gives the size of
  28 the value in \fIpval\fR. The first \fIvalsize\fR number of bytes of the
  29 property value is compared with \fIpval\fR.
  30 .SH RETURN VALUES
  31 .sp
  32 .LP
  33 Upon successful completion, \fB0\fR is returned. On failure, a non-negative
  34 integer is returned to indicate an error.
  35 .sp
  36 .LP
  37 \fBPICL_NODENOTFOUND\fR is returned if there is no node that matches the
  38 property criteria can be found.
  39 .SH ERRORS
  40 .sp
  41 .ne 2
  42 .na
  43 \fB\fBPICL_NOTNODE\fR\fR
  44 .ad
  45 .RS 22n
  46 Not a node
  47 .RE
  48
  49 .sp
  50 .ne 2
  51 .na
  52 \fB\fBPICL_INVALIDHANDLE\fR\fR
  53 .ad
  54 .RS 22n
  55 Invalid handle
  56 .RE
  57
  58 .sp
  59 .ne 2
  60 .na
  61 \fB\fBPICL_STALEHANDLE\fR\fR
  62 .ad
  63 .RS 22n
  64 Stale handle
  65 .RE
  66
  67 .sp
  68 .ne 2
  69 .na
  70 \fB\fBPICL_PROPNOTFOUND\fR\fR
  71 .ad
  72 .RS 22n
  73 Property not found
  74 .RE
  75
  76 .sp
  77 .ne 2
  78 .na
  79 \fB\fBPICL_FAILURE\fR\fR
  80 .ad
  81 .RS 22n
  82 General system failure
  83 .RE
  84
  85 .SH ATTRIBUTES
  86 .sp
  87 .LP
  88 See \fBattributes\fR(5) for descriptions of the following attributes:
  89 .sp
  90
  91 .sp
  92 .TS
  93 box;
  94 c | c
  95 l | l .
  96 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  97 _
  98 Interface Stability     Evolving
  99 _
 100 MT-Level        MT-Safe
 101 .TE
 102
 103 .SH SEE ALSO
 104 .sp
 105 .LP
 106 \fBptree_get_prop_by_name\fR(3PICLTREE), \fBptree_get_propinfo\fR(3PICLTREE),
 107 \fBptree_get_propval\fR(3PICLTREE), \fBptree_get_propval_by_name\fR(3PICLTREE),
 108 \fBattributes\fR(5)