workbench/libs/commodities/activatecxobj.c

   1 /*
   2     Copyright © 1995-2001, The AROS Development Team. All rights reserved.
   3     $Id$
   4
   5     Desc:
   6     Lang: English
   7 */
   8
   9 /*****************************************************************************
  10
  11     NAME */
  12
  13 #define DEBUG 0
  14 #include <aros/debug.h>
  15
  16 #include "cxintern.h"
  17 #include <libraries/commodities.h>
  18 #include <proto/commodities.h>
  19
  20     AROS_LH2(LONG, ActivateCxObj,
  21
  22 /*  SYNOPSIS */
  23
  24         AROS_LHA(CxObj *, co,   A0),
  25         AROS_LHA(LONG,    true, D0),
  26
  27 /*  LOCATION */
  28
  29         struct Library *, CxBase, 7, Commodities)
  30
  31 /*  FUNCTION
  32
  33     Activates/deactivates a given commodity object. (An inactive object
  34     doesn't perform its function on its input - it just passes it on to
  35     the next object.) The activation depends on the value of 'true'; if
  36     it's TRUE the object is activated, if it's FALSE it's deactivated.
  37         All objects are created in the active state except for brokers;
  38     remember to activate your broker when you have linked your other
  39     objects to it.
  40
  41     INPUTS
  42
  43     co   - a pointer to a commodity object
  44     true - boolean telling whether the object should be activated or
  45            deactivated
  46
  47     RESULT
  48
  49     The activation state of the object prior to the operation. (0 is
  50     also returned if 'co' was NULL.)
  51
  52     NOTES
  53
  54     EXAMPLE
  55
  56     BUGS
  57
  58     SEE ALSO
  59
  60     CxBroker()
  61
  62     INTERNALS
  63
  64     HISTORY
  65
  66 ******************************************************************************/
  67
  68 {
  69     AROS_LIBFUNC_INIT
  70
  71     LONG temp;
  72
  73     D(bug("Enter ActivateCxObj(cxobj = %p, true = %d)\n", co, true));
  74
  75     if (co == NULL)
  76     {
  77         return 0;
  78     }
  79
  80     temp = (co->co_Flags & COF_ACTIVE);
  81
  82     if (true)
  83     {
  84         co->co_Flags |= COF_ACTIVE;
  85     }
  86     else
  87     {
  88         co->co_Flags &= ~COF_ACTIVE;
  89     }
  90
  91     if (co->co_Node.ln_Type == CX_BROKER)
  92     {
  93         BrokerCommand(NULL, CXCMD_LIST_CHG);
  94     }
  95
  96     return temp;
  97
  98     AROS_LIBFUNC_EXIT
  99 } /* ActivateCxObject */