FileVersionInfo.Comments Property

Definition

Namespace:

System.Diagnostics

Assemblies:

netstandard.dll, System.Diagnostics.FileVersionInfo.dll

Source:

FileVersionInfo.cs

Gets the comments associated with the file.

public:
 property System::String ^ Comments { System::String ^ get(); };

public string? Comments { get; }

member this.Comments : string

Public ReadOnly Property Comments As String

Property Value

String

The comments associated with the file or null if the file did not contain version information.

Examples

The following example calls GetVersionInfo to get the FileVersionInfo for the Notepad. Then it prints the comments in a text box. This code assumes textBox1 has been instantiated.

void GetComments()
{
    // Get the file version for the notepad.
    FileVersionInfo^ myFileVersionInfo =
        FileVersionInfo::GetVersionInfo(Environment::SystemDirectory + "\\Notepad.exe");
    // Print the comments in a text box.
    textBox1->Text = "Comments: " + myFileVersionInfo->Comments;
}

void GetComments()
{
    // Get the file version for the notepad.
    FileVersionInfo myFileVersionInfo =
        FileVersionInfo.GetVersionInfo(Environment.SystemDirectory + "\\Notepad.exe");
    // Print the comments in a text box.
    textBox1.Text = "Comments: " + myFileVersionInfo.Comments;
}

Sub GetComments()
    ' Get the file version for the notepad.
    Dim myFileVersionInfo As FileVersionInfo = _
       FileVersionInfo.GetVersionInfo(Environment.SystemDirectory + "\Notepad.exe")

    ' Print the comments in a text box.
    textBox1.Text = "Comments: " & myFileVersionInfo.Comments
End Sub

Remarks

This property contains additional information that can be displayed for diagnostic purposes.