Get Instrument Target Status

Retrieves information on the instrument’s target.

 

Input Arguments

 

0

Collection Instrument ID

Instrument ID

The ID of the instrument in question.

 

Return Arguments

 

1

Boolean

Is Locked?

Returns TRUE if the instrument is locked on a target, FALSE if not.

2

String

Name

The name of the currently active target.

3

Integer

Number of Faces

The number of faces on the selected target (for Leica’s multi-face T-MAC).

4

Integer

Locked Face

The face currently locked on (for Leica’s multi-face

T-MAC).

 

Returned Status

 

SUCCESS

The status was retrieved successfully.

FAILURE

The specified instrument was not found.

 

Remarks

This command only applies to laser trackers.