LabWindows/CVI

TDMS_FilePropertyExists

int TDMS_FilePropertyExists (TDMSFileHandle file, const char *property, int *exists);

Purpose

Determines whether the specified file property exists.

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.
property const char * The name of the file property.
Output
Name Type Description
exists int A boolean value indicating whether the property exists.

0 = Does not exist
1 = Does exist

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.