1 PICL_GET_PROPINFO(3PICL)    PICL Library Functions    PICL_GET_PROPINFO(3PICL)
   2 
   3 
   4 
   5 NAME
   6        picl_get_propinfo - get the information about a property
   7 
   8 SYNOPSIS
   9        cc [ flag... ] file... -lpicl [ library... ]
  10        #include <picl.h>
  11 
  12        int picl_get_propinfo(picl_prophdl_t proph,
  13             picl_propinfo_t *pinfo);
  14 
  15 
  16 DESCRIPTION
  17        The picl_get_propinfo() function gets the information about the
  18        property specified by handle proph and copies it into the location
  19        specified by pinfo.  The property information includes the property
  20        type, access mode, size, and the name of the property as described on
  21        libpicl(3PICL) manual page.
  22 
  23 
  24        The maximum size of a property value is specified by PICL_PROPSIZE_MAX.
  25        It is currently set to 512KB.
  26 
  27 RETURN VALUES
  28        Upon successful completion, 0 is returned. On failure, a non-negative
  29        integer is returned to indicate an error.
  30 
  31 
  32        PICL_STALEHANDLE is returned if the handle is no longer valid. This
  33        occurs if the PICL tree was refreshed or reinitialized.
  34 
  35 
  36        PICL_INVALIDHANDLE is returned if the specified handle never existed.
  37        This error may be returned for a previously valid handle if the daemon
  38        was brought down and restarted. When this occurs a client must
  39        revalidate any saved handles.
  40 
  41 ERRORS
  42        PICL_NOTINITIALIZED
  43                               Session not initialized
  44 
  45 
  46        PICL_NORESPONSE
  47                               Daemon not responding
  48 
  49 
  50        PICL_NOTPROP
  51                               Not a property
  52 
  53 
  54        PICL_INVALIDHANDLE
  55                               Invalid handle specified
  56 
  57 
  58        PICL_STALEHANDLE
  59                               Stale handle specified
  60 
  61 
  62        PICL_FAILURE
  63                               General system failure
  64 
  65 
  66 ATTRIBUTES
  67        See attributes(5) for descriptions of the following attributes:
  68 
  69 
  70 
  71 
  72        +---------------+-----------------+
  73        |ATTRIBUTE TYPE | ATTRIBUTE VALUE |
  74        +---------------+-----------------+
  75        |MT-Level       | MT-Safe         |
  76        +---------------+-----------------+
  77 
  78 SEE ALSO
  79        libpicl(3PICL), picl_get_propval(3PICL),
  80        picl_get_propval_by_name(3PICL), attributes(5)
  81 
  82 
  83 
  84                                  May 16, 2020         PICL_GET_PROPINFO(3PICL)