home *** CD-ROM | disk | FTP | other *** search
/ Acorn User 10 / AU_CD10.iso / Updates / Perl / Non-RPC / Docs / RISCOS-Library-Docs / Chunk.pm < prev    next >
Text File  |  1999-04-17  |  1KB  |  48 lines
  1. NAME
  2.     RISCOS::Chunk -- manipulate Chunks in Acorn Chunkfiles
  3.  
  4. SYNOPSIS
  5.         use RISCOS::Chunk;
  6.  
  7.         $chunk = new RISCOS::Chunk $chunkid, substr ($file, $offset, $size), $size,
  8.                        $index, $offset;
  9.  
  10.  
  11. DESCRIPTION
  12.     `RISCOS::Chunk' provides a class to hold details about a chunk
  13.     in a chunkfile.
  14.  
  15.   Methods
  16.  
  17.     new <ID>, <data>, [<length>, [<index>, [<offset>]]]
  18.         Returns a new `RISCOS::Chunk' object with a ChunkID *ID*,
  19.         and contents *data*. If <length> is defined it is checked
  20.         against `length *data*'. The *index* of the chunk in the
  21.         chunkfile header and the *offset* of the chunk data in the
  22.         chunkfile are stored if supplied.
  23.  
  24.     ID  Returns the chunk ID.
  25.  
  26.     Data
  27.         Returns the chunk data.
  28.  
  29.     Length
  30.         Returns the length of the chunk data - *i.e.* literally
  31.         `length Data()'
  32.  
  33.     Index
  34.         Returns the index of the chunk in the chunkfile header (if
  35.         known, else returns undefined);
  36.  
  37.     Offset
  38.         Returns the offset of the chunk data in the chunkfile (if
  39.         known, else returns undefined);
  40.  
  41.  
  42. BUGS
  43.     None known.
  44.  
  45. AUTHOR
  46.     Nicholas Clark <nick@unfortu.net>
  47.  
  48.