FileDescription Property

Applies to TestComplete 14.80, last modified on April 20, 2021

Description

Use the FileDescription property to get the file description that is presented to the users.

Declaration

aqFileVersionInfoObj.FileDescription(Index)

Read-Only Property String
aqFileVersionInfoObj An expression, variable or parameter that specifies a reference to an aqFileVersionInfo object
Index [in]    Optional    Integer Default value: 0   

Applies To

The property is applied to the following object:

Parameters

The property has the following parameter:

Index

A file can contain multiple version information blocks translated in different languages. This parameter specifies a zero-based index of the desired version information translation, among those included in the file. The default value is 0, which means the default version information block. To get the total number of version information translations in a file, use the Languages property.

Property Value

A string that contains the file description.

Remarks

If you use Python or DelphiScript, you should enclose the parameter of the FileDescription property in square brackets: FileDescription[Index].

Example

The sample script below obtains additional information about Notepad:

JavaScript, JScript

function FileVersionInfoSample()
{
  var FileName = Sys.OSInfo.WindowsDirectory + "\\notepad.exe";
  var VerInfo = aqFileSystem.GetFileInfo(FileName).VersionInfo;

  Log.Message("Description: " + VerInfo.FileDescription);
  Log.Message("Comments: " + VerInfo.Comments);
  Log.Message("Company: " + VerInfo.CompanyName);
}

Python

def FileVersionInfoSample():
  FileName = Sys.OSInfo.WindowsDirectory + "\\notepad.exe"
  VerInfo = aqFileSystem.GetFileInfo(FileName).VersionInfo
  Log.Message("File version: " + str(VerInfo.FileMajorVersion) + "." + str(VerInfo.FileMinorVersion) + "." + str(VerInfo.FileBuildVersion) + "." + str(VerInfo.FileRevisionVersion))
  Log.Message("Description: " + str(VerInfo.FileDescription[0]))
  Log.Message("Product: " + str(VerInfo.ProductName[0]))
  Log.Message("Company: " + str(VerInfo.CompanyName[0]))

VBScript

Sub FileVersionInfoSample
  Dim FileName, VerInfo

  FileName = Sys.OSInfo.WindowsDirectory & "\notepad.exe"
  Set VerInfo = aqFileSystem.GetFileInfo(FileName).VersionInfo

  Log.Message "Description: " & VerInfo.FileDescription
  Log.Message "Comments: " & VerInfo.Comments
  Log.Message "Company: " & VerInfo.CompanyName
End Sub

DelphiScript

procedure FileVersionInfoSample;
var FileName, VerInfo;
begin
  FileName := Sys.OSInfo.WindowsDirectory + '\notepad.exe';
  VerInfo := aqFileSystem.GetFileInfo(FileName).VersionInfo;

  Log.Message('Description: ' + VerInfo.FileDescription);
  Log.Message('Product: ' + VerInfo.ProductName);
  Log.Message('Company: ' + VerInfo.CompanyName);
end;

C++Script, C#Script

function FileVersionInfoSample()
{
  var FileName = Sys["OSInfo"]["WindowsDirectory"] + "\\notepad.exe";
  var VerInfo = aqFileSystem["GetFileInfo"](FileName)["VersionInfo"];

  Log["Message"]("Description: " + VerInfo["FileDescription"]);
  Log["Message"]("Comments: " + VerInfo["Comments"]);
  Log["Message"]("Company: " + VerInfo["CompanyName"]);
}

See Also

Comments Property
Languages Property

Highlight search results