Rockwell Automation 2098-IPD-xxx Ultra5000 C Programming using the Motion Library - Manual (Page 94)

Publication 2098-PM001E-EN-P — July 2002
2-54 Referencing the Motion Library
Latch Services
long LatchOnIndex(long channel, long encoder, long rising);
Arms a latch to trigger on an encoder index. The channel argument
selects the latch channel. The encoder argument selects which
encoder index triggers the latch.
Valid channel arguments are:
• 1 = Primary motor latch
• 2 = Secondary motor latch
• 3 = Primary auxiliary latch
• 4 = Secondary auxiliary latch
Valid encoder arguments are:
• 1 = Motor Encoder Index
• 2 = Auxiliary Encoder Index
Valid rising arguments are:
• 0 = Falling edge of encoder index pulse
(This is the default argument.)
• Non-zero = Rising edge of encoder index pulse
Returns 0 if successful, or -1 on an error.