niHSDIO_ConfigureIdleState
- Updated2023-02-21
- 1 minute(s) read
ViStatus = niHSDIO_ConfigureIdleState ( ViSession vi, ViConstString channelList, ViConstString idleState);
Purpose
Sets the Idle state for a dynamic generation operation. The Idle state may be active in a variety of conditions:
- The generation operation completes normally.
- The generation operation pauses from an active Pause trigger.
- The generation operation terminates due to an underflow error.
Valid Syntax:
The order of channelList determines the order of the pattern string. For example, the following two examples are equivalent:
niHSDIO_ConfigureIdleState(vi, "19-0", "0000 0XXX XX11 111Z ZZZZ");
niHSDIO_ConfigureIdleState(vi, "0-19", "ZZZZ Z111 11XX XXX0 0000");
Related topics:
Parameters
| Input | ||
| Name | Type | Description |
| vi | ViSession | Identifies your instrument session. vi was obtained from the niHSDIO_InitAcquisitionSession or niHSDIO_InitGenerationSession function. |
| Channel List | ViConstString | Specifies which channels have their idle value set using the idleState string. The order of channels in channelList determines the order of the idleState string. |
| Idle State | ViConstString | Describes the Idle state of a dynamic generation operation.
This expression is composed of the following characters:
|
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:
|