ALPHA-VISION® Functions: aci.Obj_GetRefPointId

aci.Obj_GetRefPointId

SUMMARY

Get the target of a reference object

SYNTAX

aci.Obj_GetRefPointId((<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:string)

Returns the point id of the target of the given reference 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 target cannot be retrieved (possibly because the given data object is not a reference object). If this occurs and strict checking is disabled the function returns nil.

EXAMPLES

print("MY_REF_OBJ points to", aci.Obj_GetRefPointId("MY_REF_OBJ"))
		

---

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