C++ API Reference: MIffFile Class Reference
Read file images stored on disk.
More...
#include <MIffFile.h>
Read file images stored on disk.
This class provides a simple C++ interface to the IFF i/o library (flib). A class called MIffTag is used to create the 4 byte tags that are used to distinguish the different block types within an IFF file.
Alternate class constructor.
Opens the specified file for reading.
Parameters
[in] fileName The file name (full path).
Opens the file for reading.
Parameters
[in] fileName The file name (full path).
Returns
MS::kSuccess if the open was successful,
MS::kFailure otherwise.
Close the currently open file.
Returns
MS::kSuccess if the close was successful.
MS::kFailure Invalid object.
Is the file currently active?
Returns True if the file is active, false otherwise.
Opens a group for reading.
A group is composed of several chunks (sub-groups). Provides the id and type of the current group. Can be followed by several calls to chunk reading functions or to nested beginReadGroup(...) calls if needed (depending on the file structure). The function endReadGroup(...) is used to closed a group skipping remaining data (including nested groups).
Parameters
[out] id id of the group being read
[out] type type of the group being read
Returns
MS::kSuccess if the operation was successful,
MS::kFailure otherwise.
Closes group currently being read, skipping remaining data (including nested groups).
Returns
MS::kSuccess if the close was successful
MS::kFailure otherwise.
const void * getChunk
(
MIffTag &
chunkTag ,
unsigned *
byteCount
)
Opens a chunk for reading.
A chunk is a block of unstructured data with an associated tag.
Parameters
[out] chunkTag chunk's associated tag
[out] byteCount number of bytes in the chunk
Returns
Returns a pointer to the data, the content of which should not be modified.
NULL if the read was not successful.
Begin grabbing the data.
Parameters
[out] chunkTag tag of current chunk
[out] byteCount number of bytes in the chunk
Returns MS::kSuccess if the read was successful, MS::kFailure otherwise.
Finish grabbing the data.
Returns MS::kSuccess if successful, MS::kFailure otherwise.
int get
(
void *
buf ,
unsigned
byteCount ,
MStatus *
ReturnStatus = NULL
)
Attempt to read 'byteCount' bytes from the file into the buffer pointed to by buf.
Parameters
[out] buf pointer to buffer in which to store the data read from the file.
[in] byteCount maximum number of bytes that buf can hold
[out] ReturnStatus status code
Returns Number of bytes read if successful.
Status Codes:
MS::kSuccess Operation successful
MS::kFailure Read failure has occurred.
MStatus iffGetShort
(
short int &
result )
Grabs a short from the active file.
Parameters
[out] result the short value read from the file
Returns
MS::kSuccess if the open was successful,
MS::kFailure otherwise.
Grabs an integer from the active file.
Parameters
[out] result the int value read from the file
Returns
MS::kSuccess if the open was successful,
MS::fFailure otherwise.
MStatus iffGetFloat
(
float &
result )
Grabs a float from the active file.
Parameters
[out] result the float value read from the file
Returns
MS::kSuccess if the open was successful
MS::kFailure Invalid object or read.
const char * className
(
)
static
Returns the name of this class.
Returns The name of this class.
The documentation for this class was generated from the following files: