TDMS_GetChannelStringPropertyLength
- Updated2023-02-21
- 2 minute(s) read
TDMS_GetChannelStringPropertyLength
int TDMS_GetChannelStringPropertyLength (TDMSChannelHandle channel, const char *property, unsigned int *length);
Purpose
Gets the length of the current value of a string property. The length does not include the terminating NUL byte.
You can call this function to determine the necessary buffer size before getting the value of a string property.
Parameters
| Input | ||||||||||||||||||||||
| Name | Type | Description | ||||||||||||||||||||
| channel | TDMSChannelHandle | The channel handle. | ||||||||||||||||||||
| property | const char * | The name of the channel property. You can specify a built-in property, virtual property, or a property created by TDMS_SetChannelProperty. 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:
|
||||||||||||||||||||
| Output | ||||||||||||||||||||||
| Name | Type | Description | ||||||||||||||||||||
| length | unsigned int | The length of the current value of the string property. The length does not include the terminating NUL byte. | ||||||||||||||||||||
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_GetChannelStringPropertyLength function.