workbench/libs/workbench/removeappmenuitem.c

   1 /*
   2     Copyright © 1995-2007, The AROS Development Team. All rights reserved.
   3     $Id$
   4
   5     Desc: Remove a menuitem from Workbench's list of AppMenuItems.
   6     Lang: English
   7 */
   8
   9 #include "workbench_intern.h"
  10 #include <workbench/workbench.h>
  11
  12 /*****************************************************************************
  13
  14     NAME */
  15
  16         #include <proto/workbench.h>
  17
  18         AROS_LH1(BOOL, RemoveAppMenuItem,
  19 /*  SYNOPSIS */
  20
  21         AROS_LHA(struct AppMenuItem *, appMenuItem, A0),
  22
  23 /*  LOCATION */
  24         struct WorkbenchBase *, WorkbenchBase, 13, Workbench)
  25
  26 /*  FUNCTION
  27
  28     Try to remove an AppMenuItem from workbench.library's list of AppMenuItems.
  29
  30     INPUTS
  31
  32     Pointer to an AppMenuItem structure as returned by AddAppMenuItem().
  33
  34     RESULT
  35
  36     TRUE if the menu item could be removed, FALSE otherwise.
  37
  38     NOTES
  39
  40     You have to do a final check for messages on your AppMenuItem message
  41     port as messages may have arrived between the last time you checked this
  42     and the call to this function.
  43
  44     EXAMPLE
  45
  46     BUGS
  47
  48     SEE ALSO
  49
  50     AddAppMenuItemA()
  51
  52     INTERNALS
  53
  54 ******************************************************************************/
  55 {
  56     AROS_LIBFUNC_INIT
  57
  58     if (appMenuItem == NULL)
  59     {
  60         return FALSE;
  61     }
  62
  63     LockWorkbench();
  64     Remove((struct Node *)appMenuItem);
  65     UnlockWorkbench();
  66
  67     FreeVec(appMenuItem);
  68
  69     /* NotifyWorkbench(WBNOTIFY_Delete, WBNOTIFY_AppMenuItem, WorkbenchBase);
  70      */
  71
  72     return TRUE;
  73
  74     AROS_LIBFUNC_EXIT
  75 } /* RemoveAppMenuItem */
  76
  77