Manual Pages for UNIX Operating System command usage for man ptree_get_propval_by_name

PICL Plug-In Library Functions       ptree_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 

     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  pro-
     perty  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 speci-
     fied 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 reini-
     tialized.


     PICL_INVALIDHANDLE is returned if the specified handle never
     existed.

ERRORS
     PICL_VALUETOOBIG      Value too big


     PICL_NOTPROP          Not a property




SunOS 5.11          Last change: 28 Mar 2000                    1






PICL Plug-In Library Functions       ptree_get_propval(3PICLTREE)



     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  attri-
     butes:



     ____________________________________________________________
    |       ATTRIBUTE TYPE        |       ATTRIBUTE VALUE       |
    |_____________________________|_____________________________|
    | MT-Level                    | MT-Safe                     |
    |_____________________________|_____________________________|


SEE ALSO
     ptree_update_propval(3PICLTREE), attributes(5)

























SunOS 5.11          Last change: 28 Mar 2000                    2