PICL_GET_PROP_BY_NAME(3PICL) PICL Library Functions
picl_get_prop_by_name - get the handle of the property by name
cc [ flag... ] file... -lpicl [ library... ]
#include <picl.h>
int picl_get_prop_by_name(picl_nodehdl_t nodeh, char *name,
picl_prophdl_t *proph);
The picl_get_prop_by_name() function gets the handle of the property
of node nodeh whose name is specified in name. The handle is copied
into the location specified by proph.
Upon successful completion, 0 is returned. On failure, a non-negative
integer is returned to indicate an error.
PICL_PROPNOTFOUND is returned if the property of the specified name
does not exist.
PICL_RESERVEDNAME is returned if the property name specified is one
of the reserved property names.
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.
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.
PICL_NOTINITIALIZED
Session not initialized
PICL_NORESPONSE
Daemon not responding
PICL_NOTNODE
Not a node
PICL_PROPNOTFOUND
Property not found
PICL_RESERVEDNAME
Reserved property name specified
PICL_INVALIDHANDLE
Invalid handle
PICL_STALEHANDLE
Stale handle
PICL_FAILURE
General system failure
See attributes(7) for descriptions of the following attributes:
+---------------+-----------------+
|ATTRIBUTE TYPE | ATTRIBUTE VALUE |
+---------------+-----------------+
|MT-Level | MT-Safe |
+---------------+-----------------+
attributes(7)
March 28, 2000 PICL_GET_PROP_BY_NAME(3PICL)
NAME
picl_get_prop_by_name - get the handle of the property by name
SYNOPSIS
cc [ flag... ] file... -lpicl [ library... ]
#include <picl.h>
int picl_get_prop_by_name(picl_nodehdl_t nodeh, char *name,
picl_prophdl_t *proph);
DESCRIPTION
The picl_get_prop_by_name() function gets the handle of the property
of node nodeh whose name is specified in name. The handle is copied
into the location specified by proph.
RETURN VALUES
Upon successful completion, 0 is returned. On failure, a non-negative
integer is returned to indicate an error.
PICL_PROPNOTFOUND is returned if the property of the specified name
does not exist.
PICL_RESERVEDNAME is returned if the property name specified is one
of the reserved property names.
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.
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.
ERRORS
PICL_NOTINITIALIZED
Session not initialized
PICL_NORESPONSE
Daemon not responding
PICL_NOTNODE
Not a node
PICL_PROPNOTFOUND
Property not found
PICL_RESERVEDNAME
Reserved property name specified
PICL_INVALIDHANDLE
Invalid handle
PICL_STALEHANDLE
Stale handle
PICL_FAILURE
General system failure
ATTRIBUTES
See attributes(7) for descriptions of the following attributes:
+---------------+-----------------+
|ATTRIBUTE TYPE | ATTRIBUTE VALUE |
+---------------+-----------------+
|MT-Level | MT-Safe |
+---------------+-----------------+
SEE ALSO
attributes(7)
March 28, 2000 PICL_GET_PROP_BY_NAME(3PICL)