niTClk Wait Until Done

NI-TClk Synchronization

previous page next page

niTClk Wait Until Done

Call this VI to pause execution of your program until the acquisitions and/or generations corresponding to sessions are done or until the function returns a timeout error.

niTClk Wait Until Done is a blocking VI that periodically checks the operation status. It returns control to the calling program if the operation completes successfully or an error occurs (including a timeout error).

This VI is most useful for finite data operations that you expect to complete within a certain time.

c1dgenclassrn sessions is an array of session references that are being synchronized.

You obtain session references from the instrument driver by using <driver name> Get Session Reference VI, where <driver name> is the name of the instrument driver—for example, the niScope Get Session Reference VI.
timeout is the amount of time in seconds that the niTClk Wait Until Done VI waits for the sessions to complete. If timeout is exceeded, the niTClk Wait Until Done VI returns an error.
error in describes error conditions that occur before this VI or function runs.
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. If status is TRUE, this VI propagates the error and does not do anything else.
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.
source identifies where an error occurred. The source string includes the name of the VI that produced the error and often offers additional information about the error.
sessions out passes the array of session references to the next VI.
error out contains error information. If error in indicates that an error occurred before this VI or function ran, error out contains the same error information. Otherwise, it describes the error status that this VI or function produces.
status is TRUE (X) if an error occurred or FALSE (checkmark) to indicate a warning or that no error occurred.
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.
source identifies where and why an error occurred. The source string includes the name of the VI that produced the error and often offers additional information about the error.

The LabVIEW Simple Error Handler VI and the LabVIEW General Error Handler VI use the source string to deliver messages that may help you to troubleshoot your application.

previous page start next page