TDMS_GetChannels
- Updated2023-02-21
- 1 minute(s) read
int TDMS_GetChannels (TDMSChannelGroupHandle channelGroup, TDMSChannelHandle channelsBuffer[], size_t numberOfChannels);
Purpose
Obtains the channels located immediately under the specified channel group.
Parameters
| Input | ||
| Name | Type | Description |
| channelGroup | TDMSChannelGroupHandle | The channel group handle. |
| numberOfChannels | size_t | The number of channels to copy into the buffer. The array you pass in the channelsBuffer parameter must hold at least as many items as specified in this parameter. |
| Output | ||
| Name | Type | Description |
| channelsBuffer | TDMSChannelHandle [] | The array that will receive the channels for the specified channel group. This array must be large enough to hold at least as many items as you specify in the numberOfChannels parameter. |
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 Channels Buffer output parameter will still contain the requested 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_GetChannels function.