 |
The manual testing functionality is deprecated. Do not use it for creating new tests. It will be removed in a future TestComplete release. |
Description
Use this method to get the description for the manual test step. The description text is shown in the Step description edit box of the Manual Testing editor.
Declaration
ManualTestingStepInfoObj.GetDescription()
| ManualTestingStepInfoObj | An expression, variable or parameter that specifies a reference to a ManualTestingStepInfo object | |||
| Result | String | |||
Applies To
The method is applied to the following object:
Result Value
The string containing the description for the step.
Example
The following code snippet obtains information on a manual test step by the step’s ID and posts the step description to the test log.
JavaScript, JScript
function ManualTestStepInfo()
{
var ID, Info, Description;
// Specifies the test step ID
ID = "STEP_1";
// Obtains information on the test step
Info = ManualTests.NewManualTest.GetStepInfo(ID);
// Obtains the test step description
Description = Info.GetDescription();
Log.Message(Description);
...
}
{
var ID, Info, Description;
// Specifies the test step ID
ID = "STEP_1";
// Obtains information on the test step
Info = ManualTests.NewManualTest.GetStepInfo(ID);
// Obtains the test step description
Description = Info.GetDescription();
Log.Message(Description);
...
}
Python
def ManualTestStepInfo():
# Specifies the test step ID
ID = "STEP_1"
# Obtains information on the test step
Info = ManualTests.NewManualTest.GetStepInfo(ID)
# Obtains the test step description
Description = Info.GetDescription()
Log.Message(Description)VBScript
Sub ManualTestStepInfo
' Specifies the test step ID
ID = "STEP_1"
' Obtains information on the test step
Set Info = ManualTests.NewManualTest.GetStepInfo(ID)
' Obtains the test step description
Description = Info.GetDescription
Log.Message Description
...
End Sub
' Specifies the test step ID
ID = "STEP_1"
' Obtains information on the test step
Set Info = ManualTests.NewManualTest.GetStepInfo(ID)
' Obtains the test step description
Description = Info.GetDescription
Log.Message Description
...
End Sub
DelphiScript
procedure ManualTestStepInfo();
var ID, Info, Description;
begin
// Specifies the test step ID
ID := 'STEP_1';
// Obtains information on the test step
Info := ManualTests.NewManualTest.GetStepInfo(ID);
// Obtains the test step description
Description := Info.GetDescription;
Log.Message(Description);
...
end;
var ID, Info, Description;
begin
// Specifies the test step ID
ID := 'STEP_1';
// Obtains information on the test step
Info := ManualTests.NewManualTest.GetStepInfo(ID);
// Obtains the test step description
Description := Info.GetDescription;
Log.Message(Description);
...
end;
C++Script, C#Script
function ManualTestStepInfo()
{
var ID, Info, Description;
// Specifies the test step ID
ID = "STEP_1";
// Obtains information on the test step
Info = ManualTests["NewManualTest"]["GetStepInfo"](ID);
// Obtains the test step description
Description = Info["GetDescription"]();
Log["Message"](Description);
...
}
{
var ID, Info, Description;
// Specifies the test step ID
ID = "STEP_1";
// Obtains information on the test step
Info = ManualTests["NewManualTest"]["GetStepInfo"](ID);
// Obtains the test step description
Description = Info["GetDescription"]();
Log["Message"](Description);
...
}
See Also
Manual Testing
Executing Manual Tests
About Manual Test Editor
Manual Testing Events
ManualTesting Object