TM1 Function for TI, ProcessReturnCode

A global variable that stores the exist status of the most recently executed process.

What is the ProcessReturnCode function?

ProcessReturnCode is a global variable that stores the status of the most recently executed process.

Where can the ProcessReturnCode function be used?

TurboIntegrator

What is the syntax for ProcessReturnCode?

ProcessReturnCode = StatusCode​;

​StatusCode:​
– ProcessExitByBreak() = Indicates that the process exited because it encountered a ProcessBreak function.​
– ProcessExitByChoreQuit() = Indicates that the process exited due to execution of the ChoreQuit function.​
– ProcessExitByChoreRollback() = Indicates that the process exited because it encountered a ChoreRollback function.​
– ProcessExitByProcessRollback() = Indicates that the process exited because it encountered a ProcessRollback function.​
– ProcessExitByQuit() = Indicates that the process exited because of an explicit quit command.​
– ProcessExitMinorError() = Indicates that the process executed successfully but encountered minor errors.​
– ProcessExitNormal() = Indicates that the process executed normally.​
– ProcessExitOnInit() = Indicates that the process aborted during initialization.​
– ProcessExitSeriousError() = Indicates that the process exited because of a serious error.​
– ProcessExitWithMessage() = Indicates that the process exited normally, with a message written to tm1server.log.

A demonstration on how to use ProcessReturnCode

Execute a process and use ProcessReturnChild to determine if it ran normally or not.