PTREE_FIND_NODE(3PICLTREE) PICL Plug-In Library Functions
ptree_find_node - find node with given property and value
cc [ flag... ] file... -lpicltree [library... ]
#include <picltree.h>
int ptree_find_node(picl_nodehdl_t rooth, char *pname,
picl_prop_type_t ptype, void *pval, size_t valsize,
picl_nodehdl_t *retnodeh);
The ptree_find_node() function visits the nodes in the subtree under
the node specified by rooth. The handle of the node that has the
property whose name, type, and value matches the name, type, and
value specified in pname, ptype, and pval respectively, is returned
in the location given by retnodeh. The argument valsize gives the
size of the value in pval. The first valsize number of bytes of the
property value is compared with pval.
Upon successful completion, 0 is returned. On failure, a non-negative
integer is returned to indicate an error.
PICL_NODENOTFOUND is returned if there is no node that matches the
property criteria can be found.
PICL_NOTNODE
Not a node
PICL_INVALIDHANDLE
Invalid handle
PICL_STALEHANDLE
Stale handle
PICL_PROPNOTFOUND
Property not found
PICL_FAILURE
General system failure
See attributes(7) for descriptions of the following attributes:
+--------------------+-----------------+
| ATTRIBUTE TYPE | ATTRIBUTE VALUE |
+--------------------+-----------------+
|Interface Stability | Evolving |
+--------------------+-----------------+
|MT-Level | MT-Safe |
+--------------------+-----------------+
ptree_get_prop_by_name(3PICLTREE), ptree_get_propinfo(3PICLTREE),
ptree_get_propval(3PICLTREE), ptree_get_propval_by_name(3PICLTREE),
attributes(7)
August 1, 2000 PTREE_FIND_NODE(3PICLTREE)
NAME
ptree_find_node - find node with given property and value
SYNOPSIS
cc [ flag... ] file... -lpicltree [library... ]
#include <picltree.h>
int ptree_find_node(picl_nodehdl_t rooth, char *pname,
picl_prop_type_t ptype, void *pval, size_t valsize,
picl_nodehdl_t *retnodeh);
DESCRIPTION
The ptree_find_node() function visits the nodes in the subtree under
the node specified by rooth. The handle of the node that has the
property whose name, type, and value matches the name, type, and
value specified in pname, ptype, and pval respectively, is returned
in the location given by retnodeh. The argument valsize gives the
size of the value in pval. The first valsize number of bytes of the
property value is compared with pval.
RETURN VALUES
Upon successful completion, 0 is returned. On failure, a non-negative
integer is returned to indicate an error.
PICL_NODENOTFOUND is returned if there is no node that matches the
property criteria can be found.
ERRORS
PICL_NOTNODE
Not a node
PICL_INVALIDHANDLE
Invalid handle
PICL_STALEHANDLE
Stale handle
PICL_PROPNOTFOUND
Property not found
PICL_FAILURE
General system failure
ATTRIBUTES
See attributes(7) for descriptions of the following attributes:
+--------------------+-----------------+
| ATTRIBUTE TYPE | ATTRIBUTE VALUE |
+--------------------+-----------------+
|Interface Stability | Evolving |
+--------------------+-----------------+
|MT-Level | MT-Safe |
+--------------------+-----------------+
SEE ALSO
ptree_get_prop_by_name(3PICLTREE), ptree_get_propinfo(3PICLTREE),
ptree_get_propval(3PICLTREE), ptree_get_propval_by_name(3PICLTREE),
attributes(7)
August 1, 2000 PTREE_FIND_NODE(3PICLTREE)