Extensions.Job.SetProgressInfo

From emotive
Revision as of 03:14, 18 October 2018 by Hb (talk | contribs)
Jump to navigation Jump to search

Classification

Name SetProgressInfo
Short Description Sends progress information
Class Action
Extension OTX Job extension
Group Job related actions
Exceptions InvalidStateException
Checker Rules -
Standard Compliant Yes

OTL Syntax

Job.SetProgressInfo(IntegerTerm);

Description

SetProgressInfo sends progress information in the form of an integer value to the tester. The value corresponds to a percentage of completion and should be a number between 0 and 100. In the case of the value provided is less than 0, the OTX term is the value set to 0. If the value specified is greater than 100, the OTX runtime is set the value to 100.

Properties

Name Data Type Class Default Cardinality Description
Info Integer Term - [1] The progress information as a percentage of completion.

OTL Examples

Job.SetProgressInfo(50);

See also

SendFinalResult
SendIntermediateResult
SetJobInfo
AddElement
AddBranchByName
AddBranchByIndex
AddBranchByValue
AddEnvDataByDtc