TDMS_GetAsyncReadStatus
- Updated2023-02-21
- 1 minute(s) read
int TDMS_GetAsyncReadStatus (TDMSFileHandle file, unsigned int *numberOfPendingReads);
Purpose
Returns the number of pending asynchronous reads issued by TDMS_AdvancedAsyncRead.
Use this function to monitor an application that issues a series of asynchronous reads over a long period of time. By querying the number of pending reads and keeping track of the highest value, you can choose an appropriate value for the maxNumConcurrentAsyncReads parameter of TDMS_ConfigureAsyncReads.
(Linux) This function is not supported.
(Real-Time Module) This function is not supported.
Parameters
| Input | ||
| Name | Type | Description |
| file | TDMSFileHandle | The file handle. You obtain this handle from TDMS_AdvancedOpenFile or TDMS_AdvancedCreateFile. You must specify the enable asynchronous operations option when you open or create the file. |
| Output | ||
| Name | Type | Description |
| numberOfPendingReads | unsigned int | The number of asynchronous reads that have not completed. You can use this information to monitor a read-from-disk operation. |
Return Value
| Name | Type | Description |
| status | int | Return value indicating whether the function was successful. Unless otherwise stated, zero represents successful execution and a negative number represents the error code. Error codes are defined in cvi\include\cvitdms.h. |
Additional Information
Library: TDM Streaming Library
Include file: cvitdms.h
LabWindows/CVI compatibility: LabWindows/CVI 2013 and later
© 2016 National Instruments. All rights reserved.