rom/utility/taginarray.c

   1 /*
   2     Copyright © 1995-2001, The AROS Development Team. All rights reserved.
   3     $Id$
   4
   5     Desc:
   6     Lang: english
   7 */
   8 #include "intern.h"
   9 #include <utility/tagitem.h>
  10
  11 /*****************************************************************************
  12
  13     NAME */
  14 #include <proto/utility.h>
  15
  16         AROS_LH2(BOOL, TagInArray,
  17
  18 /*  SYNOPSIS */
  19         AROS_LHA(Tag  , tagValue, D0),
  20         AROS_LHA(Tag *, tagArray, A0),
  21
  22 /*  LOCATION */
  23         struct UtilityBase *, UtilityBase, 15, Utility)
  24
  25 /*  FUNCTION
  26         Determines whether the value tagValue exists in an array of Tags
  27         pointed to by tagArray. This array must be contiguous, and must be
  28         terminated by TAG_DONE.
  29
  30         This is an array of Tags (ie: Tag tagArray[]), not an array of
  31         TagItems (ie: struct TagItem tagArray[]).
  32
  33     INPUTS
  34         tagValue    -   The value of the Tag to search for.
  35         tagArray    -   The ARRAY of Tag's to scan through.
  36
  37     RESULT
  38         TRUE    if tagValue exists in tagArray
  39         FALSE   otherwise
  40
  41     NOTES
  42
  43     EXAMPLE
  44
  45     BUGS
  46
  47     SEE ALSO
  48         <utility/tagitem.h>, FilterTagItems()
  49
  50     INTERNALS
  51
  52     HISTORY
  53         29-10-95    digulla automatically created from
  54                             utility_lib.fd and clib/utility_protos.h
  55         01-09-96    iaint   Implemented from autodoc.
  56
  57 *****************************************************************************/
  58 {
  59     AROS_LIBFUNC_INIT
  60
  61     while(*tagArray != TAG_DONE)
  62     {
  63         if(*tagArray == tagValue)
  64             return TRUE;
  65         tagArray++;
  66     }
  67     return FALSE;
  68
  69     AROS_LIBFUNC_EXIT
  70 } /* TagInArray */