TDMS_SetChannelGroupProperty
- Updated2023-02-21
- 2 minute(s) read
TDMS_SetChannelGroupProperty
int TDMS_SetChannelGroupProperty (TDMSChannelGroupHandle channelGroup, const char *property, TDMSDataType dataType, ...);
Purpose
Sets the value of a channel group property. If the property does not exist, this function creates it.
Parameters
| Input | |||||||||||||||||||
| Name | Type | Description | |||||||||||||||||
| channelGroup | TDMSChannelGroupHandle | The channel group handle. | |||||||||||||||||
| property | const char * | The name of the channel group property. You can specify a built-in property, virtual property, or a property created by TDMS_SetChannelGroupProperty. Virtual properties are special properties that are not saved in the .tdms file, but they can be used to perform certain actions. The following built-in properties are available:
The following virtual properties are available:
|
|||||||||||||||||
| dataType | TDMSDataType | The data type of the property. If the data type of the property is TDMS_Timestamp, you must use the CVIAbsoluteTime type when you set or get the value of that property. Refer to the Absolute Time functions in the Utility Library for more information about this data type. |
|||||||||||||||||
| value | ... | The value of the property. If the data type of the specified property is TDMS_Timestamp, you must pass a value of type CVIAbsoluteTime. Refer to the Absolute Time functions in the Utility Library for more information about this type. |
|||||||||||||||||
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.