rom/intuition/lockibase.c

   1 /*
   2     Copyright © 1995-2013, The AROS Development Team. All rights reserved.
   3     Copyright © 2001-2003, The MorphOS Development Team. All Rights Reserved.
   4     $Id$
   5
   6     Locks the access to all public fields of the IntuitionBase.
   7 */
   8
   9 #include <proto/exec.h>
  10 #include "intuition_intern.h"
  11
  12 /*****************************************************************************
  13
  14     NAME */
  15 #include <proto/intuition.h>
  16
  17         AROS_LH1(ULONG, LockIBase,
  18
  19 /*  SYNOPSIS */
  20         AROS_LHA(ULONG, What, D0),
  21
  22 /*  LOCATION */
  23         struct IntuitionBase *, IntuitionBase, 69, Intuition)
  24
  25 /*  FUNCTION
  26         Locks Intuition. While you hold this lock, no fields of Intuition
  27         will change. Please release this as soon as possible.
  28
  29     INPUTS
  30         What - Which fields of Intuition should be locked. The only allowed
  31             value for this is currently 0 which means to lock everything.
  32
  33     RESULT
  34         The result of this function must be passed to UnlockIBase().
  35
  36     NOTES
  37         You *must not* call this function if you have any locks on other
  38         system resources like layers and LayerInfo locks.
  39
  40     EXAMPLE
  41
  42     BUGS
  43
  44     SEE ALSO
  45         UnLockIBase()
  46
  47     INTERNALS
  48
  49 *****************************************************************************/
  50 {
  51     AROS_LIBFUNC_INIT
  52
  53     ObtainSemaphore (GetPrivIBase(IntuitionBase)->IBaseLock);
  54
  55     return What;
  56     AROS_LIBFUNC_EXIT
  57 } /* LockIBase */