ptree_init_propinfo(3picltre) [opensolaris man page]

ptree_init_propinfo(3PICLTREE)				  PICL Plug-In Library Functions			    ptree_init_propinfo(3PICLTREE)

NAME

       ptree_init_propinfo - initialize ptree_propinfo_t structure

SYNOPSIS

       cc [ flag... ] file... -lpicltree [ library... ]
       #include <picltree.h>

       int ptree_init_propinfo(ptree_propinfo_t *infop, int version,
	    int ptype, int pmode, size_t psize, char *pname,
	    int (*readfn)(ptree_rarg_t *, void *),
	    int (*writefn)(ptree_warg_t *, const void *));

DESCRIPTION

       The  ptree_init_propinfo()  function  initializes a ptree_propinfo_t property information structure given by location infop with the values
       provided by the arguments.

       The version argument specifies the version of the ptree_propinfo_t structure. PTREE_PROPINFO_VERSION gives the current version.	The  argu-
       ments  ptype, pmode, psize, and pname specify the property's PICL type, access mode, size, and name. The maximum size of a property name is
       defined by PICL_PROPNAMELEN_MAX. The arguments readfn and writefn specify a volatile property's read and write access functions.  For  non-
       volatile properties, these are set to NULL.

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_NOTSUPPORTED    Property version not supported

       PICL_FAILURE	    General system failure

ATTRIBUTES

       See attributes(5) for descriptions of the following attributes:

       +-----------------------------+-----------------------------+
       |      ATTRIBUTE TYPE	     |	    ATTRIBUTE VALUE	   |
       +-----------------------------+-----------------------------+
       |Interface Stability	     |Evolving			   |
       +-----------------------------+-----------------------------+
       |MT-Level		     |MT-Safe			   |
       +-----------------------------+-----------------------------+

SEE ALSO

       ptree_get_propinfo(3PICLTREE), attributes(5)

SunOS 5.11							    1 Aug 2000					    ptree_init_propinfo(3PICLTREE)

ptree_create_prop(3PICLTREE)				  PICL Plug-In Library Functions			      ptree_create_prop(3PICLTREE)

NAME

       ptree_create_prop, ptree_destroy_prop - create or destroy a property

SYNOPSIS

       cc [ flag... ] file... -lpicltree [ library... ]
       #include <picltree.h>

       int ptree_create_prop(ptree_propinfo_t *pinfo, void *valbuf, picl_prophdl_t *proph);

       int ptree_destroy_prop(picl_prophdl_t proph);

DESCRIPTION

       The  ptree_create_prop()  function creates a property using the information specified in pinfo, which includes the name, type, access mode,
       and size of the property, as well as the read access function for a volatile property. The value of the property is specified in the buffer
       valbuf,	which  may  be	NULL  for volatile properties. The handle of the property created is copied into the location given by proph.  See
       libpicltree(3PICLTREE) for more information on the structure of ptree_propinfo_t structure.

       The ptree_destroy_prop() function destroys the property specified by the  handle  proph.   For  a  table  property,  the  entire  table	is
       destroyed. The property to be destroyed must have been previously deleted.

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_NOTSUPPORTED       Property version not supported

       PICL_VALUETOOBIG        Value exceeds maximum size

       PICL_NOTPROP	       Not a property

       PICL_CANTDESTROY        Attempting to destroy before delete

       PICL_RESERVEDNAME       Property name is reserved

       PICL_INVREFERENCE       Invalid reference property value

       PICL_INVALIDHANDLE      Invalid handle

       PICL_STALEHANDLE        Stale handle

       PICL_FAILURE	       General system failure

ATTRIBUTES

       See attributes(5) for descriptions of the following attributes:

       +-----------------------------+-----------------------------+
       |      ATTRIBUTE TYPE	     |	    ATTRIBUTE VALUE	   |
       +-----------------------------+-----------------------------+
       |Interface Stability	     |Evolving			   |
       +-----------------------------+-----------------------------+
       |MT-Level		     |MT-Safe			   |
       +-----------------------------+-----------------------------+

SEE ALSO

       libpicltree(3PICLTREE), ptree_add_prop(3PICLTREE), attributes(5)

SunOS 5.10							    28 Mar 2000 				      ptree_create_prop(3PICLTREE)