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