Get Hidden Point Rod Index by Name    

Returns the index of an existing hidden point rod based upon the specified rod name.

 

Input Arguments

 

0

String

Hidden Point Rod Name

Name of the hidden Point Rod to return

 

Return Arguments

 

1

Integer

Hidden Point Rod Index

Index of the specified hidden point rod

 

Returned Status

 

SUCCESS

The hidden point rod was identified successfully.

FAILURE

The hidden point rod with the specified name could not be found.

 

Remarks

This command can be helpful in identifying the index of an existing rod. The index will change if an existing rod is deleted, where as the name will remain as a part of the rod definition.