PICL Library Functions piclwalktreebyclass(3PICL)
NAME
piclwalktreebyclass - walk subtree by class
SYNOPSIS
cc [ flag... ] file... -lpicl [ library... ]
#include
int piclwalktreebyclass(piclnodehdlt rooth,
const char *classname, void *cargs,
int (*callback)(piclnodehdlt nodeh, void *cargs));
DESCRIPTION
The piclwalktreebyclass() 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, then
the callback function specified by callback is called with
the matching node handle and the argument provided in
cargs. If the class name specified in classname is NUL,
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 PICLWALKCONTINUE or
PICLWALKTERMINATE to continue or terminate the tree walk.
RETURN VALUES
Upon successful completion, 0 is returned. On failure, a
non-negative integer is returned to indicate an error.
PICLSTALEHANDLE is returned if the handle is no longer
valid. This occurs if the PICL tree was refreshed or reini-
tialized.
PICLINVALIDHANDLE is returned if the specified handle never
existed. This error may be returned for a previously valid
handle if the daemon was brought down and restarted. When
this occurs a client must revalidate any saved handles.
ERORS
PICLNOTINITIALIZED Session not initialized
PICLNORESPONSE Daemon not responding
PICLNOTNODE Not a node
SunOS 5.11 Last change: 1 Aug 2000 1
PICL Library Functions piclwalktreebyclass(3PICL)
PICLINVALIDHANDLE Invalid handle specified
PICLSTALEHANDLE Stale handle specified
PICLFAILURE General system failure
ATRIBUTES
See attributes(5) for descriptions of the following attri-
butes:
ATRIBUTE TYPE ATRIBUTE VALUE
MT-Level MT-Safe
SEE ALSO
piclgetpropvalbyname(3PICL), attributes(5)
SunOS 5.11 Last change: 1 Aug 2000 2
|