This method commands the system to go into the Halted state from where it is safe to power down the system without damage to system resources (like files, data bases, etc.); what the system does during this transition and how long it takes, is application-defined and may depend on the parameter given to the Halt method (e.g. to distinguish between a fast shutdown due to power-loss or a more gentle shutdown completing ongoing evaluations).

Signature

Halt ([in]Int32cause[in]StringcauseDescription[out]Int32error);

Table 85 – Halt Method Arguments

Argument	Description
cause	Implementation-specific number denoting the reason for the Halt method call.
causeDescription	Text for said reason, e.g. for logging purposes. May be empty.
error	0 – OK Values > 0 are reserved for errors defined by this and future standards. Values < 0 shall be used for application-specific errors.

Table 86 – Halt Method AddressSpace Definition

Attribute	Value
BrowseName	Halt
References	NodeClass	BrowseName	DataType	TypeDefinition	ModellingRule
HasProperty	Variable	InputArguments	Argument[]	PropertyType	Mandatory
HasProperty	Variable	OutputArguments	Argument[]	PropertyType	Mandatory

The cause argument given to the method can only be interpreted by the underlying vision system It can be used, for example, for logging purposes. It is expected that a value of 0 will be considered an “unspecified reason”.