ALPHA-VISION® Functions: aci.Obj_SetRef

aci.Obj_SetRef

SUMMARY

Set the pointer of a reference object to a new target object.

SYNTAX

aci.Obj_SetRef( (<reference object number>|<reference object point id>), (<target object number>|<target object point id>))

ARGUMENTS

reference object number (type:number)

The object number of the reference object

reference object point id (type:string)

The name of the reference object

target object number (type:number)

The object number of the target object

target object point id (type:string)

The name of the target 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. This applies only to the reference object, the target object may be 0.
• The reference cannot be set.

EXAMPLES

Display the value of TANKLEVEL in trend 1 (assumes that a reference object TREND1 is specified in the variables category of trend curve 1).

aci.Obj_SetRef("TREND1", "TANKLEVEL") 
		

aci.Obj_SetRef("TREND2", 0) --reset reference object TREND2 
		

---

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