Plank IffFileWriter class

A generic IFF/RIFF file writer helper. More...

Typedefs
typedef struct PlankIffFileWriter *	PlankIffFileWriterRef
	An opaque reference to the Plank IffFileWriter object.
Functions
PlankIffFileWriterRef	pl_IffFileWriter_CreateAndInit ()
	Create and initialise a Plank IffFileWriter object and return an oqaque reference to it.
PlankIffFileWriterRef	pl_IffFileWriter_Create ()
	Create a Plank IffFileWriter object and return an oqaque reference to it.
PlankResult	pl_IffFileWriter_Init (PlankIffFileWriterRef p)
	Initialise a Plank IffFileWriter object.
PlankResult	pl_IffFileWriter_DeInit (PlankIffFileWriterRef p)
	Deinitialise a Plank IffFileWriter object.
PlankResult	pl_IffFileWriter_Destroy (PlankIffFileWriterRef p)
	Destroy a Plank IffFileWriter object.
PlankFileRef	pl_IffFileWriter_GetFile (PlankIffFileWriterRef p)
	Gets the underlying Plank File object.

---

Detailed Description

A generic IFF/RIFF file writer helper.

---

Typedef Documentation

typedef struct PlankIffFileWriter* PlankIffFileWriterRef

An opaque reference to the Plank IffFileWriter object.

---

Function Documentation

PlankIffFileWriterRef pl_IffFileWriter_Create

(

)

Create a Plank IffFileWriter object and return an oqaque reference to it.

Returns:

A Plank IffFileWriter object as an opaque reference or PLANK_NULL.

PlankIffFileWriterRef pl_IffFileWriter_CreateAndInit

(

)

Create and initialise a Plank IffFileWriter object and return an oqaque reference to it.

Returns:

A Plank IffFileWriter object as an opaque reference or PLANK_NULL.

PlankResult pl_IffFileWriter_DeInit

(

PlankIffFileWriterRef

p

)

Deinitialise a Plank IffFileWriter object.

Parameters:

p	The Plank IffFileWriter object.

Returns:

A result code which will be PlankResult_OK if the operation was completely successful.

PlankResult pl_IffFileWriter_Destroy

(

PlankIffFileWriterRef

p

)

Destroy a Plank IffFileWriter object.

Parameters:

p	The Plank IffFileWriter object.

Returns:

A result code which will be PlankResult_OK if the operation was completely successful.

PlankFileRef pl_IffFileWriter_GetFile

(

PlankIffFileWriterRef

p

)

Gets the underlying Plank File object.

This is the raw file object that is performing the fundamental file access operations.

Parameters:

p	The Plank IffFileWriter object.

Returns:

The Plank File object.

PlankResult pl_IffFileWriter_Init

(

PlankIffFileWriterRef

p

)

Initialise a Plank IffFileWriter object.

Parameters:

p	The Plank IffFileWriter object.

Returns:

A result code which will be PlankResult_OK if the operation was completely successful.