Sun Microsystems, Inc.
spacerspacer
spacer   www.sun.com docs.sun.com | | |  
spacer
black dot
   
A   B   C   D   E   F   G   H   I   J   K   L   M   N   O   P   Q   R   S   T   U   V   W   X   Y   Z
    
 
PICL Plug-In Library Functionsptree_get_propval(3PICLTREE)


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)


SunOS 5.9Go To TopLast Changed 28 Mar 2000

 
      
      
Copyright 2002 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms.