GX5296, GX5961, GX5964, File
Returns the halt trigger settings.
GtDio6xTrigConfigGetHaltTrigger (nHandle, pnHaltTriggerSource, pbInvertTriggerSource, pnLevelOrEdge, pnTriggerResetMode, pnStatus)
Name |
Type |
Comments |
nHandle |
SHORT |
Session identifier:● Board handle is used when communicating with the hardware. The Board handle session identifier is returned by calling GtDio6xInitialize or GtDio6xSetupInitialization. ● File handle is used when communicating with a file. The File handle session identifier is returned by calling GtDio6xFileOpen. |
pnHaltTriggerSource |
PSHORT |
Used to return the trigger source as follows:0. GTDIO6X_TRIGGER_SOURCE_NONE: No Signal is used as the halt trigger source. 1. GTDIO6X_TRIGGER_SOURCE_AUX_0: Auxiliary channel 0 used as the halt trigger source. 2. GTDIO6X_TRIGGER_SOURCE_AUX_1: Auxiliary channel 1 used as the halt trigger source. 3. GTDIO6X_TRIGGER_SOURCE_AUX_2: Auxiliary channel 2 used as the halt trigger source. 4. GTDIO6X_TRIGGER_SOURCE_AUX_3: Auxiliary channel 3 used as the halt trigger source. 5. GTDIO6X_TRIGGER_SOURCE_AUX_4: Auxiliary channel 4 used as the halt trigger source. GX5961 only. 6. GTDIO6X_TRIGGER_SOURCE_AUX_5: Auxiliary channel 5 used as the halt trigger source. GX5961 only. 7. GTDIO6X_TRIGGER_SOURCE_AUX_6: Auxiliary channel 6 used as the halt trigger source. GX5961 only. 8. GTDIO6X_TRIGGER_SOURCE_AUX_7: Auxiliary channel 7 used as the halt trigger source. GX5961 only. 9. GTDIO6X_TRIGGER_SOURCE_AUX_8: Auxiliary channel 8 used as the halt trigger source. GX5296 TTL Input, GX5961 TTL Input/Output. 10. GTDIO6X_TRIGGER_SOURCE_AUX_9: Auxiliary channel 9 used as the halt trigger source. GX5296 TTL Input, GX5961 TTL Input/Output. 11. GTDIO6X_TRIGGER_SOURCE_AUX_10: Auxiliary channel 10 used as the halt trigger source. GX5296 TTL Input, GX5961 TTL Input/Output. 12. GTDIO6X_TRIGGER_SOURCE_AUX_11: Auxiliary channel 11 used as the halt trigger source. GX5296 TTL Input, GX5961 TTL Input/Output. 13. GTDIO6X_TRIGGER_SOURCE_CH_COMPARE_0: Channel Test Signal 0 used as the halt trigger source. 14. GTDIO6X_TRIGGER_SOURCE_LOCAL_BUS: Domain Resource used as the halt trigger source. 15. GTDIO6X_TRIGGER_SOURCE_PXI_0: PXI Trigger 0 used as the halt trigger source. 16. GTDIO6X_TRIGGER_SOURCE_PXI_1 PXI Trigger 0 used as the halt trigger source. 17. GTDIO6X_TRIGGER_SOURCE_PXI_2 PXI Trigger 0 used as the halt trigger source. 18. GTDIO6X_TRIGGER_SOURCE_PXI_3 PXI Trigger 0 used as the halt trigger source. 19. GTDIO6X_TRIGGER_SOURCE_PXI_4 PXI Trigger 0 used as the halt trigger source. 20. GTDIO6X_TRIGGER_SOURCE_PXI_5 PXI Trigger 0 used as the halt trigger source. 21. GTDIO6X_TRIGGER_SOURCE_PXI_6 PXI Trigger 0 used as the halt trigger source. 22. GTDIO6X_TRIGGER_SOURCE_PXI_7 PXI Trigger 0 used as the halt trigger source. |
pbInvertTriggerSource |
PBOOL |
Used to return the trigger inverter state as follows:0. FALSE: Disable signal inverter, do not modify input signal before testing. 1. TRUE: Enable signal inverter, invert input signal before testing. |
pnLevelOrEdge |
PSHORT |
Used to return the trigger test mode as follows:0. GTDIO6X_TRIGGER_ON_LOW_LEVEL: Trigger when a low logic level is detected. 1. GTDIO6X_TRIGGER_ON_HIGH_LEVEL: Trigger when a high logic level is detected. 2. GTDIO6X_TRIGGER_ON_RISING_EDGE: Trigger when a rising edge is detected. 3. GTDIO6X_TRIGGER_ON_FALLING_EDGE: Trigger when a falling edge is detected. |
pnTriggerResetMode |
PSHORT |
Used to return the trigger reset level/edge mode as follows:0. GTDIO6X_HALT_TRIGGER_RESET_ON_START: Reset trigger only at the beginning of burst. 1. GTDIO6X_HALT_TRIGGER_RESET_ON_STEP_START_END_STEP: Reset trigger at the beginning and end of each step. 2. GTDIO6X_HALT_TRIGGER_RESET_ON_STEP_START_RESUME: Reset trigger at the beginning of each step and when execution is resume |
pnStatus |
PSHORT |
Returned status: 0 on success, negative value on failure. |
The halt trigger causes the sequencer to halt based on the current halt mode. Use the GtDio6xSequencerSetHaltMode API to program the halt mode.
The following example sets the Halt trigger as follows:
● Trigger source is Channel Test Signal 0 used as the halt trigger source.
● Enable signal inverter, invert input signal before testing.
● Trigger when a rising edge is detected.
● Reset trigger only at the beginning of burst.
SHORT nStatus, nHaltTriggerSource, bInvertTriggerSource, nLevelOrEdge, nTriggerResetMode;
BOOL bInvert;
GtDio6xTrigConfigSetHaltTrigger (nHandle, GTDIO6X_TRIGGER_SOURCE_CH_COMPARE_0, TRUE, GTDIO6X_TRIGGER_ON_RISING_EDGE, GTDIO6X_HALT_TRIGGER_RESET_ON_START, &nStatus);
GtDio6xTrigConfigGetHaltTrigger (nHandle, &nHaltTriggerSource, &bInvertTriggerSource, &nLevelOrEdge, &nTriggerResetMode, &nStatus);
GtDio6xTrigConfigSetHaltTrigger, GtDio6xTrigConfigSetJumpTrigger, GtDio6xTrigConfigSetLocalBusTriggerSource, GtDio6xTrigConfigSetPauseResumeTrigger, GtDio6xTrigConfigSetPxiTrigger, GtDio6xTrigConfigSetRunTrigger, GtDio6xTrigConfigSetStopTrigger, GtDio6xGetErrorString