Go to main content

man pages section 3: Extended Library Functions, Volume 3

Exit Print View

Updated: Thursday, June 13, 2019
 
 

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 arguments 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(7) for descriptions of the following attributes:

ATTRIBUTE TYPE
ATTRIBUTE VALUE
Interface Stability
Committed
MT-Level
MT-Safe

See Also

ptree_get_propinfo(3PICLTREE), attributes(7)