Vicon Shogun banner

Description

Sets the exit code that is passed back to the Windows system when Shogun Post shuts down.

All processes in Windows return an exit code when the shut down. The exit code is often used to signify some sort of failure, but can signal anything.

By default Shogun Post returns 0, but you may wish it to return something else in certain situations.

Functional area

System

Command syntax

Syntax

setExitCode exitCode

Arguments

NameTypeRequiredComments
exitCodeintegeryesThe exit code to be passed back to the Windows system when Shogun Post shuts down.

Flags

None

Return value

void

Examples

// Set the exit code to -5, which we agree to mean that this script
// that we rely on failed
if( `runScript "MyImportantScript; " -noFail` == false )
{
setExitCode -5;
exit;
}

Additional information

Related commands