Manual Pages for UNIX Operating System command usage for man wsreg_get_data_pairs

Product Install Registry Library Functions
                                           wsreg_set_data(3WSREG)



NAME
     wsreg_set_data, wsreg_get_data, wsreg_get_data_pairs  -  add
     or retrieve a key-value pair

SYNOPSIS
     cc [flag ...]  file ...-lwsreg [library ...]
     #include 

     int wsreg_set_data(Wsreg_component *comp, const char *key,
          const char *value);


     char *wsreg_get_data(const Wsreg_component *comp, const char *key);


     char *wsreg_get_data_pairs(const Wsreg_component *comp);


DESCRIPTION
     The wsreg_set_data() function adds the key-value pair speci-
     fied by key and value to the component specified by comp. If
     value is NULL, the key and current value is removed from the
     specified component.


     The wsreg_get_data() function retrieves the value associated
     with  the  key specified by key from the component specified
     by comp.


     The wsreg_get_data_pairs()  function  returns  the  list  of
     key-value pairs from the component specified by comp.

RETURN VALUES
     The wsreg_set_data() function returns a  non-zero  value  if
     the  specified  key-value  pair  was successfully added.  It
     returns 0 if the addition failed. If NULL is passed  as  the
     value,  the  current  key-value  pair  are  removed from the
     specified component.


     The wsreg_get_data() function returns the  value  associated
     with  the  specified  key.   It  returns NULL if there is no
     value associated with the specified key.  The  char  pointer
     that  is returned is not a clone, so it must not be freed by
     the caller.


     The  wsreg_get_data_pairs()   function   returns   a   null-
     terminated array of char pointers that represents the speci-
     fied component's list of data pairs.  The  even  indexes  of



SunOS 5.11          Last change: 22 Sep 2000                    1






Product Install Registry Library Functions
                                           wsreg_set_data(3WSREG)



     the  resulting  array  represent  the  key  names.   The odd
     indexes of the array represent the values. If the  specified
     component  has no data pairs, NULL is returned.  The result-
     ing array (not its contents) must be released by the caller.

USAGE
     Any string data can be associated with a component.  Because
     this  information  can  be  viewed  in  the prodreg registry
     viewer, it is a good place to store support contact informa-
     tion.


     After the data pairs are added  or  removed,  the  component
     must  be  updated  with a call to wsreg_register(3WSREG) for
     the modifications to be persistent.

ATTRIBUTES
     See attributes(5) for descriptions of the  following  attri-
     butes:



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


SEE ALSO
     prodreg(1M),                       wsreg_initialize(3WSREG),
     wsreg_register(3WSREG), attributes(5)






















SunOS 5.11          Last change: 22 Sep 2000                    2






Product Install Registry Library Functions
                                           wsreg_set_data(3WSREG)






















































SunOS 5.11          Last change: 22 Sep 2000                    3