NI-HSDIO LabVIEW VIs

niHSDIO Wait Until Done VI

  • Updated2023-02-21
  • 4 minute(s) read
Installed With: NI-HSDIO

Pauses execution of your program until the dynamic data operation is completed or the VI returns a timeout error. The niHSDIO Wait Until Done VI periodically checks the operation status and returns control to the calling program if the operation completes successfully or if an error occurs (including a timeout error).

Use this VI for finite data operations that you expect to complete within a certain time.

niHSDIO Wait Until Done

civrn.gif

instrument handle identifies your instrument session. instrument handle is obtained from the niHSDIO Init Acquisition Session VI, the niHSDIO Init Generation Session VI, or the niHSDIO Init Ext Cal VI.

ci32.gif

max time milliseconds specifies the number of milliseconds to allow the function to complete before returning. If the specified time elapses before the data operation has completed, the function returns a timeout error.

Setting a value of 0 causes the VI to return immediately. This setting can be useful to manually poll for hardware errors after a data operation has been initiated. If no other error has occurred and the data operation is still not complete, the VI returns a timeout error.

Setting a value of -1 causes the VI to never timeout. Be careful not to use this value during a continuous operation, as it never returns unless a hardware error occurs. Perform a manual device reset from Measurement & Automation Explorer if you cannot exit this state or use the niHSDIO Reset or niHSDIO Reset Device VI from the other session of the device.

cerrcodeclst.gif

error in (no error) describes error conditions that occur before this node runs. This input provides standard error in functionality.

cbool.gif

status is TRUE (X) if an error occurred before this VI or function ran or FALSE (checkmark) to indicate a warning or that no error occurred before this VI or function ran. The default is FALSE.

ci32.gif

code is the error or warning code. The default is 0. If status is TRUE, code is a negative error code. If status is FALSE, code is 0 or a warning code.

cstr.gif

source identifies where an error occurred. The source string includes the name of the VI that produced the error, what inputs are in error, and how to eliminate the error.

iivrn.gif

instrument handle out passes a reference to your instrument session to the next VI. instrument handle is obtained from the niHSDIO Init Acquisition Session VI or the niHSDIO Init Generation Session VI.

ierrcodeclst.gif

error out contains error information. This output provides standard error out functionality.

ibool.gif

status is TRUE (X) if an error occurred or FALSE (checkmark) to indicate a warning or that no error occurred.

ii32.gif

code is the error or warning code. If status is TRUE, code is a nonzero error code. If status is FALSE, code is 0 or a warning code.

istr.gif

source identifies where and why an error occurred. The source string includes the name of the VI that produced the error, what inputs are in error, and how to eliminate the error.