man/man3picltree/ptree_get_propval.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_get_propval 3PICLTREE "28 Mar 2000" "SunOS 5.11" "PICL Plug-In Library Functions"
 NAME
ptree_get_propval, ptree_get_propval_by_name - get the value of a property
 SYNOPSIS

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

int ptree_get_propval(picl_prophdl_t proph, void *valbuf,
 size_t nbytes);


int ptree_get_propval_by_name(picl_nodehdl_t nodeh,
 void *name, void *valbuf, size_t nbytes);


 DESCRIPTION

The ptree_get_propval() function gets the value of the property specified
by the handle proph and copies it into the buffer specified by
valbuf. The size of the buffer valbuf is specifed in nbytes.

The ptree_get_propval_by_name() function gets the value of the property,
whose name is specified by name, from the node specified by handle
nodeh. The value is copied into the buffer specified by valbuf.
The size of the buffer is specified by nbytes.

For volatile properties, the read access function provided by the plug-in
publishing the property is invoked.
 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_VALUETOOBIG

Value too big


PICL_NOTPROP

Not a property


PICL_NOTNODE

Not a node


PICL_INVALIDHANDLE

Invalid handle


PICL_STALEHANDLE

Stale handle


PICL_PROPNOTFOUND

Property not found


PICL_FAILURE

General system failure


 ATTRIBUTES

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


ATTRIBUTE TYPEATTRIBUTE VALUE
MT-LevelMT-Safe


 SEE ALSO

ptree_update_propval(3PICLTREE), attributes(5)