TDMS_GetNumChannelGroups
- Updated2023-02-21
- 1 minute(s) read
int TDMS_GetNumChannelGroups (TDMSFileHandle file, unsigned int *numberOfChannelGroups);
Purpose
Obtains the number of channel groups in the specified file.
Parameters
| Input | ||
| Name | Type | Description |
| file | TDMSFileHandle | The file handle. You obtain this handle from the TDMS_OpenFileEx, TDMS_CreateFileEx, TDMS_AdvancedOpenFile, or TDMS_AdvancedCreateFile function. |
| Output | ||
| Name | Type | Description |
| numberOfChannelGroups | unsigned int | The number of channel groups in the specified file. |
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 8.1 and later
© 2016 National Instruments. All rights reserved.
Example
Refer to TDM Streaming\tdmsReader.cws for an example of using the TDMS_GetNumChannelGroups function.