ALPHA-VISION® Functions: aci.Obj_Sts

aci.Obj_Sts

SUMMARY

Get the status of a data object

SYNTAX

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

ARGUMENTS

object number (type:number)

A data object number

point id (type:string)

The name of a data object

RETURN VALUES

1 (type:number)

Returns the status of the given 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 value cannot be retrieved. If this occurs and strict checking is disabled the function returns nil.

EXAMPLES

if aci.Obj_Sts("TANKLEVEL") == 2 then
        print("Tanklevel too high") --diagnostic message
        return
end
		

---

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