workbench/libs/iffparse/findprop.c

   1 /*
   2     Copyright © 1995-2007, The AROS Development Team. All rights reserved.
   3     $Id$
   4 */
   5
   6 #include "iffparse_intern.h"
   7
   8 /*****************************************************************************
   9
  10     NAME */
  11 #include <proto/iffparse.h>
  12
  13         AROS_LH3(struct StoredProperty *, FindProp,
  14
  15 /*  SYNOPSIS */
  16         AROS_LHA(struct IFFHandle *, iff, A0),
  17         AROS_LHA(LONG              , type, D0),
  18         AROS_LHA(LONG              , id, D1),
  19
  20 /*  LOCATION */
  21         struct Library *, IFFParseBase, 26, IFFParse)
  22
  23 /*  FUNCTION
  24         Searches for a StoredProperty that is valid in the given context.
  25         Property chunks are automatically stored by ParseIFF() when pre-declared
  26         by PropChunk() or PropChunks(). The returned storedproperty contains
  27         a pointer to the data in the chunk.
  28
  29     INPUTS
  30         iff    - a pointer to a an IFFHandle struct.
  31         type  - type code of property to search for.
  32         id    -  id code of property to search for.
  33
  34     RESULT
  35         sp    - pointer to a storedproperty if found, NULL if none are found.
  36
  37     NOTES
  38
  39     EXAMPLE
  40
  41     BUGS
  42
  43
  44     SEE ALSO
  45         PropChunk(), PropChunks()
  46
  47     INTERNALS
  48
  49 *****************************************************************************/
  50 {
  51     AROS_LIBFUNC_INIT
  52
  53     struct LocalContextItem *lci;
  54
  55     DEBUG_FINDPROP(dprintf("FindProp: iff 0x%lx type 0x%08lx (%c%c%c%c) id 0x%08lx (%c%c%c%c)\n",
  56                             iff, type, dmkid(type), id, dmkid(id)));
  57
  58     if (!(lci = FindLocalItem(
  59                 iff,
  60                 type,
  61                 id,
  62                 IFFLCI_PROP)))
  63     {
  64         DEBUG_FINDPROP(dprintf("FindProp: reuturn NULL\n"));
  65         return NULL;
  66     }
  67
  68     /* The userdata of the found LCI is the StoredProperty */
  69
  70     return ( LocalItemData(lci) );
  71
  72     AROS_LIBFUNC_EXIT
  73 } /* FindProp */