r3iff

Class

oops/r3iff.h

Library

r3oops

Description:

IFF Parser

See Also

oops/r3file.h

Super Class

r3File

R3CLID_FILE

JavaScript

r3Iff

Class Identifier

R3CLID_IFF - 127

Methods

BEGINREAD, ENDREAD, BEGINWRITE, ENDWRITE, SKIP,

Attributes

Native, Large,

R3IFFM_BEGINREAD

Method

BEGINREAD

Identifier

R3IFFM_BEGINREAD

Return

R3BOOL, TRUE if chunk was found

JavaScript

rc = obj.BEGINREAD();

Description

Begin reading of a chunk

R3IFFM_ENDREAD

Method

ENDREAD

Identifier

R3IFFM_ENDREAD

Return

R3BOOL, TRUE if succeeded. FALSE may indicate corrupted file.

JavaScript

rc = obj.ENDREAD();

Description

Terminates current chunk. Must be called after all data inside a chunk is read (including all sub chunks).

R3IFFM_BEGINWRITE

Method

BEGINWRITE

Identifier

R3IFFM_BEGINWRITE

Return

R3BOOL, TRUE if succeeded

JavaScript

rc = obj.BEGINWRITE();

Description

Begin writing of new chunk.

R3IFFM_ENDWRITE

Method

ENDWRITE

Identifier

R3IFFM_ENDWRITE

Return

R3BOOL, TRUE if succeeded

JavaScript

rc = obj.ENDWRITE();

Description

Terminates chunk.

R3IFFM_SKIP

Method

SKIP

Identifier

R3IFFM_SKIP

JavaScript

obj.SKIP();

Description

Skip the chunk and proceed to the next chunk.

Native

Attribute

Native

Identifier

R3IFFA_Native

JavaScript type

Boolean

C type

R3BOOL

Description

Read only, TRUE if file is native. You don't actually need this, since IFF class takes care of crossplatform converstion

Syntax

jsobj.SetNative(value);
value = jsobj.GetNative();

R3BOOL value = ...;
R3SetAttrs(r3obj, R3IFFA_Native, value, R3TAG_END);
R3BOOL value;
R3GetAttrs(r3obj, R3IFFA_Native, &value, R3TAG_END);

Large

Attribute

Large

Identifier

R3IFFA_Large

JavaScript type

Boolean

C type

R3BOOL

Description

64 bit format

Syntax

jsobj.SetLarge(value);
value = jsobj.GetLarge();

R3BOOL value = ...;
R3SetAttrs(r3obj, R3IFFA_Large, value, R3TAG_END);
R3BOOL value;
R3GetAttrs(r3obj, R3IFFA_Large, &value, R3TAG_END);

Tags

R3IFFA_ChunkID

R3IFFA_SubID