Difference between revisions of "Extensions.Flash.SetFlashSession"

From emotive
Jump to navigation Jump to search
 
Line 9: Line 9:
  
 
== Description ==
 
== Description ==
This action shall set the flash session to be programmed when the '''FlashJob''' is executed. Only one session can be set at a time. If this action is used multiple times, the later call shall overwrite the session set by a previous call.  
+
This action will set the flash session to be programmed when the '''FlashJob''' is executed. Only one session can be set at a time. If this action is used multiple times, the later call will overwrite the session set by a previous call.  
  
 
== Properties ==
 
== Properties ==
 
{| {{TableHeader}}
 
{| {{TableHeader}}
 
{{TableRowPropertiesHeader}}
 
{{TableRowPropertiesHeader}}
{{TableRowPropertie1| FlashJob | [[Extensions.Flash.FlashJob|FlashJob]] | [[Variable]] | - | [1] | Represents the '''FlashJob''' where the session shall be set.}}
+
{{TableRowPropertie1| FlashJob | [[Extensions.Flash.FlashJob|FlashJob]] | [[Variable]] | - | [1] | Represents the '''FlashJob''' where the session will be set.}}
 
{{TableRowPropertie2| FlashSession | [[Extensions.Flash.FlashSession|FlashSession]] | [[Term]] | - | [1] | Represents the '''FlashSession''' to be programmed by the '''FlashJob'''.}}
 
{{TableRowPropertie2| FlashSession | [[Extensions.Flash.FlashSession|FlashSession]] | [[Term]] | - | [1] | Represents the '''FlashSession''' to be programmed by the '''FlashJob'''.}}
 
|}
 
|}

Latest revision as of 01:40, 13 September 2019

Classification

Name SetFlashSession
Short Description Set the flash session to be programmed
Class Action
Extension OTX Flash extension
Group Flash related actions
Exceptions -
Checker Rules -
Standard Compliant Yes

OTL Syntax

Flash.SetFlashSession(FlashJobVariable flashJob, FlashSessionTerm flashSession);

Description

This action will set the flash session to be programmed when the FlashJob is executed. Only one session can be set at a time. If this action is used multiple times, the later call will overwrite the session set by a previous call.

Properties

Name Data Type Class Default Cardinality Description
FlashJob FlashJob Variable - [1] Represents the FlashJob where the session will be set.
FlashSession FlashSession Term - [1] Represents the FlashSession to be programmed by the FlashJob.

OTL Examples

/// Local Declarations

DiagCom.ComChannel ComChannel1;
Flash.FlashSession FlashSession1;
Flash.FlashJob FlashJob1;

/// Flow

ComChannel1 = DiagCom.GetComChannel("SCHEINWERFER", NULL, false);
FlashSession1 = Flash.GetFlashSession("_7PP907357F_7520");
FlashJob1 = Flash.CreateFlashJob(ComChannel1, FlashSession1);
Flash.SetFlashSession(FlashJob1, FlashSession1);

See also

GetDownloadData
StoreUploadData