Difference between revisions of "Extensions.Flash.CreateFlashJobByName"
Jump to navigation
Jump to search
m (Hb moved page CreateFlashJobByName to Extensions.Flash.CreateFlashJobByName: #3153) |
|||
| Line 1: | Line 1: | ||
| − | [[Category:Flash]] | + | {{DISPLAYTITLE: '''CreateFlashJobByName'''}}[[Category:Flash]] |
== Classification == | == Classification == | ||
| − | {{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]] | [[Extensions.Flash|OTX Flash extension]] | [[Flash jobs related terms]] | [[Extensions.DiagCom.UnknownTargetException|UnknownTargetException]] | - }} |
== OTL Syntax == | == OTL Syntax == | ||
| Line 10: | Line 10: | ||
== Description == | == Description == | ||
The '''CreateFlashJobByName''' term create a new '''FlashJob''' for the specified '''ComChannel'''. The '''FlashJob''' can subsequently be used for initiating an ECU reprogramming session. | The '''CreateFlashJobByName''' term create a new '''FlashJob''' for the specified '''ComChannel'''. The '''FlashJob''' can subsequently be used for initiating an ECU reprogramming session. | ||
| − | {{TermReturnValue| [[FlashJob]] | A new FlashJob for the specified ComChannel.}} | + | {{TermReturnValue| [[Extensions.Flash.FlashJob|FlashJob]] | A new FlashJob for the specified ComChannel.}} |
== Properties == | == Properties == | ||
{| {{TableHeader}} | {| {{TableHeader}} | ||
{{TableRowPropertiesHeader}} | {{TableRowPropertiesHeader}} | ||
| − | {{TableRowPropertie1| ComChannel | [[ComChannel]] | [[Term]] | - | [1] | Communication Channel.}} | + | {{TableRowPropertie1| ComChannel | [[Extensions.DiagCom.ComChannel|ComChannel]] | [[Term]] | - | [1] | Communication Channel.}} |
| − | {{TableRowPropertie2| Name | [[String]] | [[Term]] | - | [1] | Represents the name of the to-be-created FlashJob.}} | + | {{TableRowPropertie2| Name | [[Core.DataTypes.SimpleDataType.String|String]] | [[Term]] | - | [1] | Represents the name of the to-be-created FlashJob.}} |
| − | {{TableRowPropertie1| Session | [[FlashSession]] | [[Term]] | - | [0..1] | This optional element represents the FlashSession to be programmed by the FlashJob.}} | + | {{TableRowPropertie1| Session | [[Extensions.Flash.FlashSession|FlashSession]] | [[Term]] | - | [0..1] | This optional element represents the FlashSession to be programmed by the FlashJob.}} |
|} | |} | ||
| Line 32: | Line 32: | ||
== See also == | == See also == | ||
| − | [[CreateFlashJob]] <br/> | + | [[Extensions.Flash.CreateFlashJob|CreateFlashJob]] <br/> |
| − | [[CreateFlashJobBySemantic]] <br/> | + | [[Extensions.Flash.CreateFlashJobBySemantic|CreateFlashJobBySemantic]] <br/> |
| − | [[GetComChannel]] | + | [[Extensions.DiagCom.GetComChannel|GetComChannel]] |
Revision as of 07:25, 15 February 2016
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);