NI-TClk C Function Reference

niTClk_IsDone

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

Specific Function

ViStatus niTClk_IsDone (ViUInt32 sessionCount, ViSession sessions [], ViBoolean *done);

Purpose

Reports the progress of the acquisitions and/or generations, corresponding to the sessions.

Parameters

Input
Name Type Description
sessionCount ViUInt32 Specifies the number of elements in the sessions array.
sessions ViSession [] Specifies the array of session references that are being synchronized. Obtain session references from the instrument driver by using the <driver name> Get Session Reference function, where <driver name> is the name of the instrument driver. Example: niScope_GetSessionReference.
Output
done ViBoolean* Indicates whether the operation is done. The operation is done when each session has completed without any errors, or when any one of the sessions reports an error.

Return Value