PTREE_GET_PROPINFO(3PICLTREE) PICL Plug-In Library Functions
ptree_get_propinfo - get property information
cc [ flag... ] file... -lpicltree [ library... ]
#include <picltree.h>
int ptree_get_propinfo(picl_prophdl_t proph,
ptree_propinfo_t *pi);
The ptree_get_propinfo() function gets the information about the
property specified by handle proph and copies it into the location
specified by pi. See libpicltree(3PICLTREE) for more information
about ptree_propinfo_t structure.
Upon successful completion, 0 is returned. On failure, a non-negative
integer is returned to indicate an error.
PICL_STALEHANDLE is returned if the handle is no longer valid. This
occurs if the PICL tree was refreshed or reinitialized.
PICL_INVALIDHANDLE is returned if the specified handle never existed.
PICL_INVALIDHANDLE
Invalid handle
PICL_STALEHANDLE
Stale handle
PICL_NOTPROP
Not a property
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_prop(3PICLTREE), attributes(7)
March 28, 2000 PTREE_GET_PROPINFO(3PICLTREE)
NAME
ptree_get_propinfo - get property information
SYNOPSIS
cc [ flag... ] file... -lpicltree [ library... ]
#include <picltree.h>
int ptree_get_propinfo(picl_prophdl_t proph,
ptree_propinfo_t *pi);
DESCRIPTION
The ptree_get_propinfo() function gets the information about the
property specified by handle proph and copies it into the location
specified by pi. See libpicltree(3PICLTREE) for more information
about ptree_propinfo_t structure.
RETURN VALUES
Upon successful completion, 0 is returned. On failure, a non-negative
integer is returned to indicate an error.
PICL_STALEHANDLE is returned if the handle is no longer valid. This
occurs if the PICL tree was refreshed or reinitialized.
PICL_INVALIDHANDLE is returned if the specified handle never existed.
ERRORS
PICL_INVALIDHANDLE
Invalid handle
PICL_STALEHANDLE
Stale handle
PICL_NOTPROP
Not a property
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_prop(3PICLTREE), attributes(7)
March 28, 2000 PTREE_GET_PROPINFO(3PICLTREE)