Rename Point

Renames a point.

 

Input Arguments

 

0

Point Name

Original Point Name

The name of the point to rename.

1

Point Name

New Point Name

A new name for the point.

2

Boolean

Overwrite if exists?

Specify whether a point should be overwritten if it already exists.

 

Return Arguments

None.

 

Returned Status

 

SUCCESS

The point was renamed successfully.

FAILURE

The original point was not found, or a point already exists with the new point name and “Overwrite if exists?” is set to FALSE.

 

Remarks

Renaming a point will preserve its status as a measured or constructed point. (In other words, measured points will maintain their association with the instrument that measured them).

 

If a specified point group does not already exist, it will be created for you.

* Note with Overwrite if exists? (A1) the original point will be renamed to the new point name and the new point will be deleted if present in the job rather than built from strings.