Rename Points with Name Pattern

Renames a list of points incrementally based on a supplied name pattern and a starting value.

 

Input Arguments

 

0

Point Name Ref List

Point Names

The list of points to rename.

1

String

Name Pattern

A prefix or pattern to use for the new point names.

2

Integer

Start Value

The starting value to apply to the first point.

 

Return Arguments

None.

 

Returned Status

 

SUCCESS

The points were renamed successfully.

FAILURE

The points were not found.

 

Remarks

If the Name Pattern argument uses the %d wildcard, it will be replaced by the current number value. For example, if the start value is 5 and the name pattern is Test%dPoint, then the first point will be named Test5Point, the sec- ond will be named Test6Point, and so on. If the %d wildcard is omitted, the current number will be appended to the name (with a hyphen). For example, a name pattern of NewPoint results in NewPoint-5, NewPoint-6, etc. The %d wildcard may be used multiple times in a name pattern.