Difference between revisions of "Extensions.Flash.CreateFlashJob"

From emotive
Jump to navigation Jump to search
Line 1: Line 1:
[[Category:Flash]]
+
{{DISPLAYTITLE:  '''CreateFlashJob'''}}[[Category:Flash]]
 
== Classification ==
 
== Classification ==
{{ClassificationActivity | CreateFlashJob | Create a new '''FlashJob''' for the specified '''FlashSession''' | [[Term]] | [[Flash|OTX Flash extension]] | [[Flash jobs related terms]] | - | - }}
+
{{ClassificationActivity | CreateFlashJob | Create a new '''FlashJob''' for the specified '''FlashSession''' | [[Term]] | [[Extensions.Flash|OTX Flash extension]] | [[Flash jobs related terms]] | - | - }}
  
 
== OTL Syntax ==
 
== OTL Syntax ==
Line 11: Line 11:
 
The '''CreateFlashJob''' term create a new '''FlashJob''' for the specified '''FlashSession'''. The FlashJob can subsequently be used for initiating an ECU reprogramming session.
 
The '''CreateFlashJob''' term create a new '''FlashJob''' for the specified '''FlashSession'''. The FlashJob can subsequently be used for initiating an ECU reprogramming session.
  
{{TermReturnValue| [[FlashJob]] | A new FlashJob for the specified FlashSession.}}
+
{{TermReturnValue| [[Extensions.Flash.FlashJob|FlashJob]] | A new FlashJob for the specified FlashSession.}}
  
 
== Properties ==
 
== Properties ==
 
{| {{TableHeader}}
 
{| {{TableHeader}}
 
{{TableRowPropertiesHeader}}
 
{{TableRowPropertiesHeader}}
{{TableRowPropertie1| ComChannel | [[ComChannel]] | [[Term]] | - | [0..1] | Communication Channel.}}
+
{{TableRowPropertie1| ComChannel | [[Extensions.DiagCom.ComChannel|ComChannel]] | [[Term]] | - | [0..1] | Communication Channel.}}
{{TableRowPropertie2| Session | [[FlashSession]] | [[Term]] | - | [1] | This element represents the FlashSession to be programmed by the FlashJob.}}
+
{{TableRowPropertie2| Session | [[Extensions.Flash.FlashSession|FlashSession]] | [[Term]] | - | [1] | This element represents the FlashSession to be programmed by the FlashJob.}}
 
|}
 
|}
  
Line 34: Line 34:
  
 
== See also ==
 
== See also ==
[[CreateFlashJobByName]] <br/>
+
[[Extensions.Flash.CreateFlashJobByName|CreateFlashJobByName]] <br/>
[[CreateFlashJobBySemantic]] <br/>
+
[[Extensions.Flash.CreateFlashJobBySemantic|CreateFlashJobBySemantic]] <br/>
[[GetComChannel]]
+
[[Extensions.Flash.GetComChannel|GetComChannel]]

Revision as of 07:19, 15 February 2016

Classification

Name CreateFlashJob
Short Description Create a new FlashJob for the specified FlashSession
Class Term
Extension OTX Flash extension
Group Flash jobs related terms
Exceptions -
Checker Rules -
Standard Compliant Yes

OTL Syntax

FlashJobTerm = Flash.CreateFlashJob(ComChannelTerm, FlashSessionTerm);

Description

The CreateFlashJob term create a new FlashJob for the specified FlashSession. The FlashJob can subsequently be used for initiating an ECU reprogramming session.

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
FlashJob A new FlashJob for the specified FlashSession.

Properties

Name Data Type Class Default Cardinality Description
ComChannel ComChannel Term - [0..1] Communication Channel.
Session FlashSession Term - [1] This element represents the FlashSession to be programmed by the FlashJob.

OTL Examples

DiagCom.ComChannel ComChannel1;
List<String> List1;
Flash.FlashSession FlashSession1;
Flash.FlashJob FlashJob1;

ComChannel1 = DiagCom.GetComChannel("DiagnosticsCan_ECU_1", null, false);
List1 = Flash.GetListOfValidFlashSessions(@Directions:DOWNLOAD, ComChannel1, @Audiences:SUPPLIER);
FlashSession1 = Flash.GetFlashSession(List1[0]);
FlashJob1 = Flash.CreateFlashJob(ComChannel1, FlashSession1);

See also

CreateFlashJobByName
CreateFlashJobBySemantic
GetComChannel