ALPHA-VISION® Functions: aci.Obj_TickOff

aci.Obj_TickOff

SUMMARY

Stop a "ticking" data object. Reverse of Obj_TickOn.

SYNTAX

aci.Obj_TickOff((<object number>|<point id>))

ARGUMENTS

object number (type:number)

A data object number

point id (type:string)

The name of a data object

ERROR HANDLING

The function will fail and terminate script execution if strict error checking is enabled (see aci.SetStrictMode()) and one of the following conditions is met:

• The given data object does not exist.
• The status cannot be set or ticking cannot be stopped. If this occurs and strict checking is disabled the function returns nil.

DESCRIPTION

The status of the data object will be set to 0 to indicate ticking is off.

EXAMPLES

aci.Obj_TickOff("TREND_X", 120)
		

---

Syntax Notation

[aaa]

aaa is optional (zero or one occurences)

(aaa|bbb)

aaa exclusive or bbb

(aaa)*

aaa may occur indefinitely often or may be omitted

(aaa)+

aaa may occur indefinitely often but at least once

(aaa)m..n

aaa may occur from m to n times