Difference between revisions of "Extensions.Flash.CreateFlashJobByName"
Jump to navigation
Jump to search
| Line 3: | Line 3: | ||
{{ClassificationActivity | CreateFlashJobByName | Create a new '''FlashJob''' for the specified '''ComChannel''' | [[Term]] | [[Flash|OTX Flash extension]] | [[Flash jobs related terms]] | [[UnknownTargetException]] | - }} | {{ClassificationActivity | CreateFlashJobByName | Create a new '''FlashJob''' for the specified '''ComChannel''' | [[Term]] | [[Flash|OTX Flash extension]] | [[Flash jobs related terms]] | [[UnknownTargetException]] | - }} | ||
| − | == | + | == OTL Syntax == |
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | <syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | ||
| − | + | FlashJobTerm = Flash.CreateFlashJobByName(ComChannelTerm, StringTerm); | |
</syntaxhighlight> | </syntaxhighlight> | ||
| Line 20: | Line 20: | ||
|} | |} | ||
| − | == Examples == | + | == OTL Examples == |
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | <syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | ||
| − | ComChannel | + | DiagCom.ComChannel ComChannel1; |
| − | + | List<String> List1; | |
| + | Flash.FlashJob FlashJob1; | ||
| + | |||
| + | ComChannel1 = DiagCom.GetComChannel("DiagnosticsCan_ECU_1", null, false); | ||
| + | List1 = Flash.GetListOfValidFlashSessions(@Directions:DOWNLOAD, ComChannel1, @Audiences:SUPPLIER); | ||
| + | FlashJob1 = Flash.CreateFlashJobByName(ComChannel1, "VariantCoding_Read", null); | ||
</syntaxhighlight> | </syntaxhighlight> | ||
Revision as of 10:16, 6 February 2015
Contents
Classification
| Name | CreateFlashJobByName |
| Short Description | Create a new FlashJob for the specified ComChannel |
| Class | Term |
| Extension | OTX Flash extension |
| Group | Flash jobs related terms |
| Exceptions | UnknownTargetException |
| Checker Rules | - |
| Standard Compliant | Yes |
OTL Syntax
FlashJobTerm = Flash.CreateFlashJobByName(ComChannelTerm, StringTerm);Description
The CreateFlashJobByName term create a new FlashJob for the specified ComChannel. The FlashJob can subsequently be used for initiating an ECU reprogramming session.
Return Value
The Term returns the value, see table below.
In OTX, Terms are categorized according to its return data type!
| Data Type | Description |
| FlashJob | A new FlashJob for the specified ComChannel. |
Properties
| Name | Data Type | Class | Default | Cardinality | Description |
| ComChannel | ComChannel | Term | - | [1] | Communication Channel. |
| Name | String | Term | - | [1] | Represents the name of the to-be-created FlashJob. |
| Session | FlashSession | Term | - | [0..1] | This optional element represents the FlashSession to be programmed by the FlashJob. |
OTL Examples
DiagCom.ComChannel ComChannel1;
List<String> List1;
Flash.FlashJob FlashJob1;
ComChannel1 = DiagCom.GetComChannel("DiagnosticsCan_ECU_1", null, false);
List1 = Flash.GetListOfValidFlashSessions(@Directions:DOWNLOAD, ComChannel1, @Audiences:SUPPLIER);
FlashJob1 = Flash.CreateFlashJobByName(ComChannel1, "VariantCoding_Read", null);