PTREE_WALK_TREE_BY_CLASS(3PICLTREE)PTREE_WALK_TREE_BY_CLASS(3PICLTREE)NAMEptree_walk_tree_by_class - walk subtree by class
SYNOPSIS
cc [ flag... ] file... -lpicltree [ library... ]
#include <picltree.h>
int ptree_walk_tree_by_class(picl_nodehdl_t rooth,
const char *classname, void *c_args,
int (*callback)(picl_nodehdl_t nodeh, void *c_args));
DESCRIPTION
The ptree_walk_tree_by_class() function visits all the nodes of the
subtree under the node specified by rooth. The PICL class name of the
visited node is compared with the class name specified by classname. If
the class names match, the callback function specified by callback is
called with the matching node handle and the argument provided in
c_args. If the class name specified in classname is NULL, then the
callback function is invoked for all the nodes.
The return value from the callback function is used to determine
whether to continue or terminate the tree walk. The callback function
returns PICL_WALK_CONTINUE or PICL_WALK_TERMINATE to continue or termi‐
nate the tree walk.
RETURN VALUES
Upon successful completion, 0 is returned. On failure, a non-negative
integer is returned to indicate an error.
ERRORS
PICL_NOTNODE
Not a node
PICL_INVALIDHANDLE
Invalid handle specified
PICL_STALEHANDLE
Stale handle specified
PICL_FAILURE
General system failure
ATTRIBUTES
See attributes(5) for descriptions of the following attributes:
┌────────────────────┬─────────────────┐
│ ATTRIBUTE TYPE │ ATTRIBUTE VALUE │
├────────────────────┼─────────────────┤
│Interface Stability │ Evolving │
├────────────────────┼─────────────────┤
│MT-Level │ MT-Safe │
└────────────────────┴─────────────────┘
SEE ALSOptree_get_propval_by_name(3PICLTREE), attributes(5)
Aug 1, 20PTREE_WALK_TREE_BY_CLASS(3PICLTREE)
