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 =
0When used as input: read through to a ‘termination’ code. When used as output: function call succeeded
-
enumerator
TK_Status::TK_Pause - TK_Pause =
2An input value; instructs toolkit to stop reading at a ‘pause’ code
-
enumerator
TK_Status::TK_Single - TK_Single =
3An input value; instructs toolkit to stop reading after the first object is completed
-
enumerator
TK_Status::TK_Pending - TK_Pending =
4A return value; the toolkit is waiting for (needs) more data
-
enumerator
TK_Status::TK_Revisit - TK_Revisit =
5A return value; interpret function succeeded, but we will run it through again later
-
enumerator
TK_Status::TK_Version - TK_Version =
7A return value; version mis-match detected, processing halted