TDMS_GetNumChannels
- Updated2023-02-21
- 1 minute(s) read
int TDMS_GetNumChannels (TDMSChannelGroupHandle channelGroup, unsigned int *numberOfChannels);
Purpose
Obtains the number of channels located immediately under the specified channel group.
Parameters
| Input | ||
| Name | Type | Description |
| channelGroup | TDMSChannelGroupHandle | The channel group handle. |
| Output | ||
| Name | Type | Description |
| numberOfChannels | unsigned int | The number of channels located immediately under the specified channel group. |
Return Value
| Name | Type | Description |
| status | int | Return value indicating whether the function was successful. A negative return value indicates that an error occurred. A non-negative return value indicates success. A return value of 1 indicates a warning that this function detected additional objects within the specified group that cannot be accessed by this function. The Number Of Channels output parameter will still contain the number of channels located immediately under the specified group. 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_GetNumChannels function.