TDMS_GetChannelGroupPropertyNames
- Updated2023-02-21
- 1 minute(s) read
int TDMS_GetChannelGroupPropertyNames (TDMSChannelGroupHandle channelGroup, char **propertyNames, size_t numberOfPropertyNames);
Purpose
Gets the names of the properties on the specified channel group.
Parameters
| Input | ||
| Name | Type | Description |
| channelGroup | TDMSChannelGroupHandle | The channel group handle. |
| numberOfPropertyNames | size_t | The number of property names to copy into the buffer. The array you pass in the propertyNames parameter must hold at least as many items as specified in this parameter. |
| Output | ||
| Name | Type | Description |
| propertyNames | char * | The array that will receive the property names of the specified channel group. This array must be large enough to hold at least the number of values specified by the numberOfPropertyNames parameter. Pass an array of type character pointer (char *). This function fills the array with string pointers allocated by this function. You must free these strings. Sample code is shown below: char **propertyNames = 0; unsigned int numberOfProperties, i; TDMS_GetNumChannelGroupProperties (file, &numberOfProperties); propertyNames = malloc(numberOfProperties * sizeof(char*)); TDMS_GetChannelGroupPropertyNames (file, propertyNames, numberOfProperties); for (i = 0; i < numberOfProperties; i++) TDMS_FreeMemory (propertyNames[i]); free(propertyNames); |
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.