niHSDIO_Abort
- Updated2023-02-21
- 2 minute(s) read
ViStatus = niHSDIO_Abort ( ViSession vi);
Purpose
Stops a running dynamic session. This function is generally not required on finite data operations, as these operations complete after the last data point is generated or acquired. This function is generally required for continuous operations or if you wish to interrupt a finite operation before it is completed.
This function is valid only for dynamic operations (acquisition or generation). It is not valid for static operations.
 |
Note To avoid receiving hardware clocking errors when reconfiguring an external clock, explicitly call the niHSDIO_Abort function after your finite operation has completed before performing any clocking reconfiguration. An external clock that stops sending pulses to the device (even after a finite operation has completed) may cause NI-HSDIO to return an error, stating that the clock became unlocked, if the device has not aborted yet. |
Related topics:
Parameters
| Input | ||
| Name | Type | Description |
| vi | ViSession | Identifies your instrument session. vi was obtained from the niHSDIO_InitAcquisitionSession or niHSDIO_InitGenerationSession function. |
Return Value
| Name | Type | Description | ||||||||
| Status | ViStatus | Reports the status of this operation. To obtain a text description of the status code, call the niHSDIO_error_message function. To obtain additional information concerning the error condition, use the niHSDIO_GetError and niHSDIO_ClearError functions. The general meaning of the status code is as follows:
|