TDMS_GetChannelGroupStringPropertyLength

Download PDF

Updated2023-02-21
1 minute(s) read

int TDMS_GetChannelGroupStringPropertyLength (TDMSChannelGroupHandle channelGroup, 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

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:

Property	Constant	Data Type
Name	TDMS_CHANNELGROUP_NAME	String (char *)
Description	TDMS_CHANNELGROUP_DESCRIPTION	String (char *)

The following virtual properties are available:

Property	Constant	Data Type	Description
NI_MinimumBufferSize	TDMS_NI_MINIMUM_BUFFER_SIZE	unsigned int	Use this property to reduce the size of a .tdms file by controlling the number of times the data is written to disk.

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

Example

Refer to TDM Streaming\tdmsReader.cws for an example of using the TDMS_GetChannelGroupStringPropertyLength function.