Manual Pages for UNIX Operating System command usage for man wsreg_add_required_component

Product Install Registry Library Functions
                             wsreg_add_required_component(3WSREG)



NAME
     wsreg_add_required_component,
     wsreg_remove_required_component,
     wsreg_get_required_components - add  or  remove  a  required
     component

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

     int wsreg_add_required_component(Wsreg_component *comp,
          const Wsreg_component *requiredComp);


     int wsreg_remove_required_component(Wsreg_component *comp,
          const Wsreg_component *requiredComp);


     Wsreg_component **wsreg_get_required_components
          (const Wsreg_component *comp);


DESCRIPTION
     The wsreg_add_required_component() function  adds  the  com-
     ponent  specified  by  requiredComp  to the list of required
     components contained in the component specified by comp.


     The wsreg_remove_required_component() function  removes  the
     component   specified  by  requiredComp  from  the  list  of
     required components contained in the component specified  by
     comp.


     The  wsreg_get_required_components()  function  returns  the
     list  of  required  components  contained  in  the component
     specified by comp.

RETURN VALUES
     The wsreg_add_required_component() function returns  a  non-
     zero  value if the specified required component was success-
     fully added. Otherwise, 0 is returned.


     The  wsreg_remove_required_component()  function  returns  a
     non-zero  value if the specified required component was suc-
     cessfully removed. Otherwise, 0 is returned.


     The  wsreg_get_required_components()  function   returns   a
     null-terminated   array  of  Wsreg_component  pointers  that



SunOS 5.11          Last change: 22 Sep 2000                    1






Product Install Registry Library Functions
                             wsreg_add_required_component(3WSREG)



     represents the specified component's list of  required  com-
     ponents.   If  the  specified component has no required com-
     ponents, NULL is returned.   The  resulting  array  must  be
     released    by    the    caller    through    a    call   to
     wsreg_free_component_array().                            See
     wsreg_create_component(3WSREG).

USAGE
     The relationship between two components in which one must be
     installed    for   the   other   to   be   complete   is   a
     dependent/required  relationship.   The  component  that  is
     required  by  the other component is the required component.
     The component that requires the other is the dependent  com-
     ponent.


     The required component  must  be  installed  and  registered
     before the dependent component can be.  Uninstaller applica-
     tions should check  the  registry  before  uninstalling  and
     unregistering  components  so a successful uninstallation of
     one  product  will  not  result  in  another  product  being
     compromised.


     Read access to the product install registry is  required  in
     order to use these functions because these relationships are
     held with lightweight component references that can only  be
     fully resolved using the registry contents.

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



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


SEE ALSO
     wsreg_add_dependent_component(3WSREG),
     wsreg_can_access_registry(3WSREG),
     wsreg_create_component(3WSREG),    wsreg_initialize(3WSREG),
     wsreg_register(3WSREG), attributes(5)







SunOS 5.11          Last change: 22 Sep 2000                    2






Product Install Registry Library Functions
                             wsreg_add_required_component(3WSREG)






















































SunOS 5.11          Last change: 22 Sep 2000                    3