TK_Status

Enumerations
enum	TK_Status {   TK_Normal = 0, TK_Error = 1, TK_Pause = 2, TK_Single = 3,   TK_Pending = 4, TK_Revisit = 5, TK_Complete = 6, TK_Version = 7,   TK_NotFound = 8, TK_Abort = 9, TK_LibraryNotFound = 10 }
	Codes which can be either passed to various toolkit functions, or indicate the result of a toolkit function call. More...

Detailed Description

Enumeration Type Documentation

TK_Status

enum TK_Status

Codes which can be either passed to various toolkit functions, or indicate the result of a toolkit function call.

Various toolkit functions can take arguments which control processing behavior. Most functions also provide a return value of type TK_Status to indicate success, failure or other information about processing status.

Enumerator
TK_Normal	When used as input: read through to a 'termination' code. When used as output: function call succeeded
TK_Error	A return value; function call failed
TK_Pause	An input value; instructs toolkit to stop reading at a 'pause' code
TK_Single	An input value; instructs toolkit to stop reading after the first object is completed
TK_Pending	A return value; the toolkit is waiting for (needs) more data
TK_Revisit	A return value; interpret function succeeded, but we will run it through again later
TK_Complete	A return value; processing is complete
TK_Version	A return value; version mis-match detected, processing halted
TK_NotFound	A return value; failed to find a match
TK_Abort	A return value; non-fatal error. callback requested stop, or fall back to plan B (internal)
TK_LibraryNotFound	A return value; Indicates that an external dependency for reading a file (e.g. a material library) was required but not found.