Packable::UnpackChunkList

Defined in: C4Packing.h

Unpacks a sequence of chunks from an input stream.

Prototype

template <class type> void UnpackChunkList(Unpacker& data, unsigned long unpackFlags, UnpackProc proc);

Parameters

`data`	The `Unpacker` object from which the object data is read.
`unpackFlags`	The unpacking flags.
`proc`	A pointer to a function that is called for each chunk to read the chunk's data.

Description

The UnpackChunkList function is used to unpack a sequence of chunks from an input stream that was previously packed using ChunkHeader structures. This function should be called from the Packable::Unpack function, and it iterates through the chunks in the input stream until a terminator chunk is found. For each chunk, the callback function pointed to by the proc parameter is called to unpack the data in the chunk. The UnpackProc type is defined as follows.

typedef bool (type::*UnpackProc)(const ChunkHeader *, Unpacker&, unsigned long);

The proc parameter should point to a member function of the same class implementing the Unpack function. The ChunkHeader passed to this callback function should be examined, and the data corresponding to its type should be read from the Unpacker object passed in. The third parameter passed to the callback function is the value of the unpackFlags parameter passed to the UnpackChunkList function. The callback function should return true if data was unpacked from the chunk, and it should return false if the chunk type is not supported (which ordinarily means that it's obsolete). The UnpackChunkList function simply skips the data for chunks that are identified as unsupported by the callback function.