PTREE_GET_ROOT(3PICLTREE) PICL Plug-In Library Functions
ptree_get_root - get the root node handle
cc [ flag... ] file... -lpicltree [ library... ]
#include <picltree.h>
int ptree_get_root(picl_nodehdl_t *nodeh);
The ptree_get_root() function copies the handle of the root node of
the PICL tree into the location specified by nodeh.
Upon successful completion, 0 is returned. On failure, a non-negative
integer is returned to indicate an error.
PICL_INVALIDARG
Invalid argument
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 |
+--------------------+-----------------+
libpicltree(3PICLTREE), ptree_create_node(3PICLTREE), attributes(7)
March 28, 2000 PTREE_GET_ROOT(3PICLTREE)
NAME
ptree_get_root - get the root node handle
SYNOPSIS
cc [ flag... ] file... -lpicltree [ library... ]
#include <picltree.h>
int ptree_get_root(picl_nodehdl_t *nodeh);
DESCRIPTION
The ptree_get_root() function copies the handle of the root node of
the PICL tree into the location specified by nodeh.
RETURN VALUES
Upon successful completion, 0 is returned. On failure, a non-negative
integer is returned to indicate an error.
ERRORS
PICL_INVALIDARG
Invalid argument
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
libpicltree(3PICLTREE), ptree_create_node(3PICLTREE), attributes(7)
March 28, 2000 PTREE_GET_ROOT(3PICLTREE)