TDMS_GetChannelByName
- Updated2023-02-21
- 1 minute(s) read
int TDMS_GetChannelByName (TDMSChannelGroupHandle channelGroup, char *name, TDMSChannelHandle *channel);
Purpose
Obtains the channel with the specified name from the specified channel group. This function is only supported when using version 2.0 or later of the TDM Streaming file format.
Parameters
| Input | ||
| Name | Type | Description |
| channelGroup | TDMSChannelGroupHandle | The channel group handle. |
| name | char * | The value of the Name property of the channel you want to obtain. |
| Output | ||
| Name | Type | Description |
| channel | TDMSChannelHandle | The handle for the requested channel. Pass this handle to other TDM Streaming Library functions that require a channel. LabWindows/CVI automatically discards this handle when you close the containing file handle with TDMS_CloseFile. To discard the channel handle explicitly, call the TDMS_CloseChannel function. |
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 2009 and later
© 2016 National Instruments. All rights reserved.