xref: /illumos-gate/usr/src/man/man3picltree/ptree_init_propinfo.3picltree (revision d0b3c59ba652f183eeec1414dd9fbdc56bf05cc8)
te
Copyright (c) 2000, Sun Microsystems, Inc. All Rights Reserved.
The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License.
You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License.
When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
PTREE_INIT_PROPINFO 3PICLTREE "Aug 1, 2000"
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(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)