Difference between revisions of "Extensions.Flash.SetFlashSession"
Jump to navigation
Jump to search
(Created page with "Category:Flash == Classification == {{ClassificationActivity | SetFlashSession | Set the flash session to be programmed | Action| OTX Flash extension | Fla...") |
|||
| (7 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| − | [[Category:Flash]] | + | {{DISPLAYTITLE: ''' SetFlashSession '''}}[[Category:Flash]] |
== Classification == | == Classification == | ||
| − | {{ClassificationActivity | SetFlashSession | Set the flash session to be programmed | [[Action]]| [[Flash|OTX Flash extension]] | [[Flash related actions]] | - | - }} | + | {{ClassificationActivity | SetFlashSession | Set the flash session to be programmed | [[Action]]| [[Extensions.Flash|OTX Flash extension]] | [[Extensions.Flash#Actions|Flash related actions]] | - | - }} |
| − | == | + | == OTL Syntax == |
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | <syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | ||
| − | SetFlashSession( | + | Flash.SetFlashSession(FlashJobVariable flashJob, FlashSessionTerm flashSession); |
</syntaxhighlight> | </syntaxhighlight> | ||
== Description == | == Description == | ||
| − | This action | + | 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 | [[FlashJob]] | [[ | + | {{TableRowPropertie1| FlashJob | [[Extensions.Flash.FlashJob|FlashJob]] | [[Variable]] | - | [1] | Represents the '''FlashJob''' where the session will be set.}} |
| − | {{TableRowPropertie2| 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'''.}} |
|} | |} | ||
| − | == Examples == | + | == OTL Examples == |
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | <syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | ||
| − | SetFlashSession( | + | /// 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); | ||
</syntaxhighlight> | </syntaxhighlight> | ||
== See also == | == See also == | ||
| − | [[GetDownloadData]] <br/> | + | [[Extensions.Flash.GetDownloadData|GetDownloadData]] <br/> |
| − | [[StoreUploadData]] | + | [[Extensions.Flash.StoreUploadData|StoreUploadData]] |
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);