|Download Help (Windows Only)|
Owning Class: support
Requires: MathScript RT Module
getfileproperty(file, objname, objtype, name)
value = getfileproperty(file, objname, objtype, name)
Returns a property value from a binary measurement file (.tdm or .tdms), a channel, or a channel group you specify. (Mac OS X and Linux) You cannot use this function with binary measurement files (.tdm or .tdms).
|file||Specifies the path to the file from which you want to get a property value. If file is a relative path, LabVIEW begins searching for the file in the current working directory. file is a string.|
|objname||Specifies the name of the channel or channel group. If objtype is 'file', objname can be empty. objname is a string.|
|objtype||Specifies whether to return a property value from a file, a channel, or a channel group. objtype is a string that accepts the following values.
|name||Specifies the name of the property for which to return the value. name is a string.|
|value||Returns the property value from the file, channel, or channel group.|
If you use this function in a stand-alone application or shared library and file is a relative path, LabVIEW searches for the file in the path where you installed the application or shared library. If file is an absolute path, LabVIEW searches for the file on the local machine or target at the specified location. (Real-Time Module) If you deploy this function to an RT target and file is a relative path, LabVIEW searches for the file in the path returned by the Default Data Directory VI.
The following table lists the support characteristics of this function.
|Supported in the LabVIEW Run-Time Engine||Yes|
|Supported on RT targets||Yes|
|Suitable for bounded execution times on RT||No (affects entire script)|
a = 1:10;
save 'test.tdm' a;
value = getfileproperty('test.tdm', '', 'file', 'author');