This Method starts the latch capture function of the Encoder. The security constraints defined in chapter 6.6 apply.
Signature
Ref1LatchStart (
);
The Method Result Codes (defined in Call Service) are defined in Table 15.
Table 18 – Possible Method Result Codes
|
Result Code |
Description |
|
Good |
The Method execution was successful. |
|
Bad_UserAccessDenied |
The user has not the right to execute the Method. |
|
Bad_Locked |
The parent EncoderChannelType Object is locked by a different Client’s Session. |
|
Bad_RequiresLock |
The parent EncoderChannelType Object is not locked. Clients must lock the parent EncoderChannelType Object before invoking a Method. |
|
Bad_UnexpectedError |
The server is not able to execute the function because an unexpected error occurred. The Device might be temporarily unavailable or unreachable due to network failure. |
The Ref1LatchActive Variable contains True if the Ref1 latch is active, otherwise False.
The Ref1LastLatchedPos Variable contains the last latched Ref1 position of the Encoder.
The Server might provide the Client with information about changes of the Ref1 latch data by sending EncoderRefLatchEventType Events.