Extensions.Job.GetJobProgress

From emotive
Revision as of 10:36, 8 August 2014 by Nb (talk | contribs) (Created page with "Category:Job == Classification == {{ClassificationActivity | GetJobProgress | Get progress information from a '''DiagService''' object | Term | Job|OTX Job extension...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

Classification

Name GetJobProgress
Short Description Get progress information from a DiagService object
Class Term
Extension OTX Job extension
Group Job related terms
Exceptions -
Checker Rules -
Standard Compliant Yes

Pseudo-Code Syntax

Integer GetJobProgress();

Description

GetJobProgress brings progress information out of a DiagService object that encapsulates a OTX job.

Return Value

The Term returns the value, see table below.

Icons Note.png In OTX, Terms are categorized according to its return data type!
Data Type Description
Integer Progress information from a DiagService

Properties

Name Data Type Class Default Cardinality Description
DiagJob DiagService Term - [0..1] This diagnostic service object is a job where progress information to be retrieved from the job.

Examples

Integer result = GetJobProgress();

See also

CreateResult
CreateResult
GetJobInfo