workbench/libs/workbench/removeappicon.c

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