man/man3picltree/ptree_create_prop.3picltree

         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_CREATE_PROP 3PICLTREE "Mar 28, 2000"
 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)