xref: /illumos-gate/usr/src/man/man3picltree/ptree_create_and_add_prop.3picltree (revision cd61ae21816e53b94bc1673f3f1aa651fc3115e8)
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_AND_ADD_PROP 3PICLTREE "Aug 1, 2000"
NAME
ptree_create_and_add_prop - create and add property to node and return property handle
SYNOPSIS

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

int ptree_create_and_add_prop(picl_nodehdl_t nodeh,
 ptree_propinfo_t *infop, void *vbuf, picl_prophdl_t *proph);
DESCRIPTION

The ptree_create_and_add_prop() function creates a property using the property information specified in infop and the value buffer vbuf and adds the property to the node specified by nodeh. If proph is not NULL, the handle of the property added to the node is returned in proph.

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_NOTTABLE

Not a table

PICL_PROPEXISTS

Property already exists

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

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