Comment Property (IGlobalVariable)

Gets or sets comment for global variable.

Syntax

[DataMember()]
string Comment {get; set;}

Property Value

Type: System.String

The comment of global variable.

Example

The following example demonstrates using Comment property.

// get global variable
IGlobalVariable gv = project.GlobalVariables["MyNamespace", "MyGlobalVariable"];
 
// get comment for current global variable
string comment = gv.Comment;
// set comment for global variable
gv.Comment = "Set the comment for this global variable";

// get global variable
$gv = $project->GlobalVariables->get_Item("MyNamespace", "MyGlobalVariable");
 
// get comment for current global variable
$comment = $gv->Comment;
// set comment for global variable
$gv->Comment = "Set the comment for this global variable";

Requirements

Target Platforms: Desktop: Windows XP SP3 and older. Server: Windows Server 2003 and older.

Reference

IGlobalVariable Interface
IGlobalVariable Members
IGlobalVariables Interface
ILocalVariable Interface