NI-HSDIO C Function Reference

niHSDIO_ConfigureIdleStateU32

  • Updated2023-02-21
  • 1 minute(s) read

ViStatus = niHSDIO_ConfigureIdleStateU32 ( ViSession vi, ViUInt32 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.

Unlike the niHSDIO_ConfigureIdleState function which uses a string, this function uses a binary format to only represent high and low. If you require more choices for your Idle state, use the niHSDIO_ConfigureIdleState function.

Related topics:

Parameters

Input
Name Type Description
vi ViSession Identifies your instrument session. vi was obtained from the niHSDIO_InitAcquisitionSession or niHSDIO_InitGenerationSession function.
Idle State ViInt32 Specifies the bit mask representing the Idle state. High is specified with a 1, and low is specified with a 0. If you need to specify values other than high or low, use the niHSDIO_ConfigureIdleState 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:

Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

Log in to get a better experience