PICL_GET_PROPINFO(3PICL) PICL Library Functions PICL_GET_PROPINFO(3PICL)


NAME


picl_get_propinfo - get the information about a property

SYNOPSIS


cc [ flag... ] file... -lpicl [ library... ]
#include <picl.h>

int picl_get_propinfo(picl_prophdl_t proph,
picl_propinfo_t *pinfo);


DESCRIPTION


The picl_get_propinfo() function gets the information about the property
specified by handle proph and copies it into the location specified by
pinfo. The property information includes the property type, access mode,
size, and the name of the property as described on libpicl(3PICL) manual
page.


The maximum size of a property value is specified by PICL_PROPSIZE_MAX.
It is currently set to 512KB.

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.
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_NOTPROP
Not a property


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 |
+---------------+-----------------+
|MT-Level | MT-Safe |
+---------------+-----------------+

SEE ALSO


libpicl(3PICL), picl_get_propval(3PICL), picl_get_propval_by_name(3PICL),
attributes(5)


May 16, 2020 PICL_GET_PROPINFO(3PICL)