[Contents] [Index] [Help] [Retrace] [Browse <] [Browse >]

The following are brief descriptions of the IFFParse functions discussed
in this chapter.  IFFParse library functions are avialable in Release 2 of
the Amiga OS and are backward compatible with older versions of the
system.  Further information about these and other IFFParse functions can
be found in the 3rd edition of the Amiga ROM Kernel Reference Manual:
Includes and Autodocs, also from Addison-Wesley.


                  Table 33-2: IFFParse Library Functions
  _______________________________________________________________________
 |                                                                       |
 |            Function              Description                          |
 |=======================================================================|
 |            AllocIFF()  Creates an IFFHandle structure.                |
 |             FreeIFF()  Frees the IFFHandle structure created with     |
 |                        AllocIFF().                                    |
 |             OpenIFF()  Initialize an IFFHandle structure to read or   |
 |                        write an IFF stream.                           |
 |            CloseIFF()  Closes an IFF context.                         |
 |-----------------------------------------------------------------------|
 |             InitIFF()  Initialize an IFFHandle as a user-defined      |
 |                        stream.                                        |
 |        InitIFFasDOS()  Initialize an IFFHandle as an AmigaDOS stream. |
 |       InitIFFasClip()  Initialize an IFFHandle as a clipboard stream. |
 |-----------------------------------------------------------------------|
 |       OpenClipboard()  Create a handle on a clipboard unit for        |
 |                        InitIFFasClip().                               |
 |            ParseIFF()  Parse an IFF file from an IFFHandle stream.    |
 |      ReadChunkBytes()  Read bytes from current chunk into a buffer.   |
 |    ReadChunkRecords()  Read record elements from the current chunk    |
 |                        into a buffer.                                 |
 |           StopChunk()  Declare a chunk that should cause ParseIFF()   |
 |                        to return.                                     |
 |        CurrentChunk()  Get the context node for the current chunk.    |
 |           PropChunk()  Specify a property chunk to store.             |
 |            FindProp()  Search for a stored property in a given        |
 |                        context.                                       |
 |     CollectionChunk()  Declare a chunk type for collection.           |
 |      FindCollection()  Get a pointer to the current list of           |
 |                        collection items.                              |
 |          StopOnExit()  Declare a stop condition for exiting a chunk.  |
 |        EntryHandler()  Add an entry handler to the IFFHandle context. |
 |         ExitHandler()  Add an exit handler to the IFFHandle context.  |
 |-----------------------------------------------------------------------|
 |           PushChunk()  Push a given context node onto the top of the  |
 |                        context stack.                                 |
 |            PopChunk()  Pop the top context node off of the context    |
 |                        stack.                                         |
 |        CurrentChunk()  Get the top context node for the current chunk.|
 |         ParentChunk()  Get the nesting context node for a given chunk.|
 |-----------------------------------------------------------------------|
 |      AllocLocalItem()  Create a LocalContextItem (LCI) structure.     |
 |       LocalItemData()  Returns a pointer to the user data of a        |
 |                        LocalContextItem (LCI).                        |
 |      StoreLocalItem()  Insert a LocalContextItem (LCI).               |
 |  StoreItemInContext()  Store a LocalContextItem in a given context    |
 |                        node.                                          |
 |     FindPropContext()  Find the property context for the current      |
 |                        state.                                         |
 |       FindLocalItem()  Return a LocalContextItem from the context     |
 |                        stack.                                         |
 |       FreeLocalItem()  Free a LocalContextItem (LCI) created with     |
 |                        AllocLocalItem().                              |
 |   SetLocalItemPurge()  Set purge vector for a local context item.     |
 |_______________________________________________________________________|