LabWindows/CVI

Table of Contents
  • LabWindows/CVI Fundamentals
  • Creating Applications
  • Distributing Applications
  • Library Reference
  • Programmer Reference
  • Hardware Information

TDMS_GetChannelGroups

int TDMS_GetChannelGroups (TDMSFileHandle file, TDMSChannelGroupHandle channelGroupsBuffer[], size_t numberOfChannelGroups);

Purpose

Obtains the 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.
numberOfChannelGroups size_t The number of channel groups to copy into the buffer.

The array you pass in the channelGroupsBuffer parameter must hold at least as many items as specified in this parameter.
Output
Name Type Description
channelGroupsBuffer TDMSChannelGroupHandle [] The array that will receive the channel groups for the specified file.

This array must be large enough to hold at least as many items as you specify in the numberOfChannelGroups parameter.

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_GetChannelGroups function.

Log in to get a better experience