imgSessionTriggerRead
Usage
rval imgSessionTriggerRead(SESSION_ID sid, uInt32 trigger, uInt32 polarity, uInt32* status);
Purpose
Reads the current value of the specified trigger line.
 |
Note This function is obsolete. The replacement function is imgSessionTriggerRead2, which incorporates the functionality of imgSessionTriggerRead but also returns additional information. |
Parameters
| Name | Type | Direction |
| sid | SESSION_ID | input |
| trigger | uInt32 | input |
| polarity | uInt32 | input |
| status | uInt32* | output |
| rval | Int32 | output |
Parameter Discussion
sid: valid SESSION_ID.
trigger: trigger line to read. trigger can be one of the following constants:
| IMG_EXT_TRIG0 | IMG_EXT_RTSI2 |
| IMG_EXT_TRIG1 | IMG_EXT_RTSI3 |
| IMG_EXT_TRIG2 | IMG_EXT_RTSI4 |
| IMG_EXT_TRIG3 | IMG_EXT_RTSI5 |
| IMG_EXT_RTSI0 | IMG_EXT_RTSI6 |
| IMG_EXT_RTSI1 |
|
Note IMG_EXT_TRIG ‹0..3› refers to the external trigger lines of the image acquisition device. IMG_EXT_RTSI ‹0..6› refers to the internal pins on the RTSI controller of the image acquisition device. |
polarity: polarity of the trigger line. polarity can be one of the following constants:
| IMG_TRIG_POLAR_ACTIVEL | Asserts the trigger line when the signal is low. |
| IMG_TRIG_POLAR_ACTIVEH | Asserts the trigger line when the signal is high. |
status: pointer to a variable to receive the state of the trigger. Upon return, the function sets status to a non-zero value if the trigger is asserted and to a zero value if the trigger is unasserted.
Return Value
This function returns 0 on success. On failure, this function returns an error code. For information about the error code, call imgShowError.
For more information, refer to the Obsolete functions topic.