Comment Property (ILocalVariable)

Gets or sets comment for local variable.

Syntax

string Comment {get; set;}

Property Value

Type: System.String

The comment of local variable.

Example

The following example demonstrates using Comment property.

// get local variable
ILocalVariable lv = project.Variables["VariableName"];
 
// get comment for current local variable
string comment = lv.Comment;
// set comment for local variable
lv.Comment = "Set the comment for this local variable";

// get local variable
$lv = $project->Variables->get_Item("VariableName");
 
// get comment for current local variable
$comment = $lv->Comment;
// set comment for local variable
$lv->Comment = "Set the comment for this local variable";

Requirements

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

Reference

ILocalVariable Interface
ILocalVariable Members
IGlobalVariable Interface
ILocalVariables Interface