Difference between revisions of "Extensions.Flash.CreateFlashJobByName"
Jump to navigation
Jump to search
| Line 18: | Line 18: | ||
{{TableRowPropertie2| ComChannel | [[Extensions.DiagCom.ComChannel|ComChannel]] | [[Term]] | - | [1] | This specifies the '''diag:ComChannel''' object to which the to-be-created [[Extensions.Flash.FlashJob|FlashJob]] belongs to and will be executed on when the [[Extensions.DiagCom.ExecuteDiagService|diag:ExecuteDiagService]] action is used}} | {{TableRowPropertie2| ComChannel | [[Extensions.DiagCom.ComChannel|ComChannel]] | [[Term]] | - | [1] | This specifies the '''diag:ComChannel''' object to which the to-be-created [[Extensions.Flash.FlashJob|FlashJob]] belongs to and will be executed on when the [[Extensions.DiagCom.ExecuteDiagService|diag:ExecuteDiagService]] action is used}} | ||
{{TableRowPropertie1| Name | [[Core.DataTypes.SimpleDataType.String|String]] | [[Term]] | - | [1] | Represents the name of the to-be-created '''FlashJob'''.}} | {{TableRowPropertie1| Name | [[Core.DataTypes.SimpleDataType.String|String]] | [[Term]] | - | [1] | Represents the name of the to-be-created '''FlashJob'''.}} | ||
| − | {{TableRowPropertie2| Session | [[Extensions.Flash.FlashSession|FlashSession]] | [[Term]] | - | [0..1] | This optional element represents the '''FlashSession''' to be programmed by the '''FlashJob'''. | + | {{TableRowPropertie2| Session | [[Extensions.Flash.FlashSession|FlashSession]] | [[Term]] | - | [0..1] | This optional element represents the '''FlashSession''' to be programmed by the '''FlashJob'''.}} |
| − | |||
|} | |} | ||
Revision as of 08:01, 16 October 2018
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, FlashSessionTerm);Description
The CreateFlashJobByName term create a new FlashJob for the specified ComChannel. The FlashJob can subsequently be used for initiating an ECU reprogramming session. Optionally a FlashSession can be specified which will be used by the FlashJob for reprogramming (alternatively the SetFlashSession action can be used to assign a different FlashSession to an already existing FlashJob object).
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] | This specifies the diag:ComChannel object to which the to-be-created FlashJob belongs to and will be executed on when the diag:ExecuteDiagService action is used |
| 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;
Flash.FlashSession FlashSession1;
Flash.FlashJob FlashJob1;
/// Flow
ComChannel1 = DiagCom.GetComChannel("SCHEINWERFER", NULL, false);
FlashSession1 = Flash.GetFlashSession("_7PP907357F_7520");
FlashJob1 = Flash.CreateFlashJobByName(ComChannel1, "Flash Jobs FlashJob_UDS", FlashSession1);See also
CreateFlashJob
CreateFlashJobBySemantic
GetFlashSession
GetComChannel
