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.

Enumerators

enumerator TK_Status::TK_Normal
TK_Normal = 0

When used as input: read through to a ‘termination’ code. When used as output: function call succeeded

enumerator TK_Status::TK_Error
TK_Error = 1

A return value; function call failed

enumerator TK_Status::TK_Pause
TK_Pause = 2

An input value; instructs toolkit to stop reading at a ‘pause’ code

enumerator TK_Status::TK_Single
TK_Single = 3

An input value; instructs toolkit to stop reading after the first object is completed

enumerator TK_Status::TK_Pending
TK_Pending = 4

A return value; the toolkit is waiting for (needs) more data

enumerator TK_Status::TK_Revisit
TK_Revisit = 5

A return value; interpret function succeeded, but we will run it through again later

enumerator TK_Status::TK_Complete
TK_Complete = 6

A return value; processing is complete

enumerator TK_Status::TK_Version
TK_Version = 7

A return value; version mis-match detected, processing halted

enumerator TK_Status::TK_NotFound
TK_NotFound = 8

A return value; failed to find a match

enumerator TK_Status::TK_Abort
TK_Abort = 9

A return value; non-fatal error. callback requested stop, or fall back to plan B (internal)

enumerator TK_Status::TK_LibraryNotFound
TK_LibraryNotFound = 10

A return value; Indicates that an external dependency for reading a file (e.g. a material library) was required but not found.