GX5296, GX5961, GX5964
Returns the sequencer status.
GtDio6xSequencerGetStatus (nHandle, pdwStatus, 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. |
pdwStatus |
PDWORD |
Returns the sequencer status bits. |
pnStatus |
PSHORT |
Returned status: 0 on success, negative value on failure. |
The following describes the bit definitions of the status register.
Bit |
Description |
0 |
Sequencer is running. |
1 |
Sequencer is in Pause state caused by GtDio6xStepSetPauseResumeTrigger settings. |
2 |
Sequencer Halted. |
3 |
A pending Start was caused by Software. |
4 |
A pending Start was caused externally. |
5 |
A pending Stop was caused by Software. |
6 |
A pending Stop was caused externally. |
7 |
Indicates if the probe button is being pushed. |
8 |
500Mhz Internal Clock is functioning normally (GX5960 only). |
9 |
The sequencer has been run. |
10 |
The sequencer has been paused. |
11 |
The sequencer has been stopped externally. |
12 |
Run has completed. |
13 |
Multiple Subroutine calls have occurred. |
14 |
Run ended within a Subroutine. |
15 |
Return occurred without Subroutine. |
16 |
Return Overvoltage Flag (GX5961/GX5964). |
17 |
Return Under Voltage Flag (GX5961/GX5964). |
18 |
Sequencer is running idle step. |
19 |
Single Step Pending. |
20 |
Drivers Enabled. |
21 |
External Halt Pending. |
22 |
Idle sequence occurred. |
23 |
Burst error occurred. |
24 |
Jump occurred. |
25 |
Sequence timeout occurred. |
26 |
Pattern timeout occurred. |
27 |
Pause occurred. |
28 |
Record Address Overflow. |
29 |
Record Index Overflow. |
30 |
Not used. |
31 |
Record Buffer Overflow. During run, if the record buffer overflows this status bit will set high and remain high until GtDio6xSequencerReset() or GtDio6xReset() API are called (GX5296 Only). |
The following example gets the sequencer status:
DWORD dwStatus
SHORT nStatus;
GtDio6xSequencerGetStatus(nHandle, &dwStatus, &nStatus);