Difference between revisions of "Extensions.Flash.GetFlashKey"

From emotive
Jump to navigation Jump to search
(Created page with "Category:Flash == Classification == {{ClassificationActivity | GetFlashKey | Return the key of a flash session | Term | OTX Flash extension | Flash session...")
 
Line 3: Line 3:
 
{{ClassificationActivity | GetFlashKey | Return the key of a flash session | [[Term]] | [[Flash|OTX Flash extension]] | [[Flash session related terms]] | - | - }}
 
{{ClassificationActivity | GetFlashKey | Return the key of a flash session | [[Term]] | [[Flash|OTX Flash extension]] | [[Flash session related terms]] | - | - }}
  
== Pseudo-Code Syntax ==
+
== OTL Syntax ==
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
String GetFlashKey(FlashSession session);
+
StringTerm = Flash.GetFlashKey(FlashSessionTerm);
 
</syntaxhighlight>
 
</syntaxhighlight>
  
Line 19: Line 19:
 
|}
 
|}
  
== Examples ==
+
== OTL Examples ==
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
String result = GetFlashKey(flashSession);
+
DiagCom.ComChannel ComChannel1;
 +
List<String> List1;
 +
Flash.FlashSession FlashSession1;
 +
String String1;
 +
 
 +
ComChannel1 = DiagCom.GetComChannel("DiagnosticsCan_ECU_1", null, false);
 +
List1 = Flash.GetListOfValidFlashSessions(@Directions:DOWNLOAD, ComChannel1, @Audiences:SUPPLIER);
 +
FlashSession1 = Flash.GetFlashSession(List1[0]);
 +
String1 = Flash.GetFlashKey(FlashSession1);
 
</syntaxhighlight>
 
</syntaxhighlight>
  

Revision as of 10:38, 6 February 2015

Classification

Name GetFlashKey
Short Description Return the key of a flash session
Class Term
Extension OTX Flash extension
Group Flash session related terms
Exceptions -
Checker Rules -
Standard Compliant Yes

OTL Syntax

StringTerm = Flash.GetFlashKey(FlashSessionTerm);

Description

The GetFlashKey term return the key of a flash session. The key is a string value.

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
String The key of a flash session.

Properties

Name Data Type Class Default Cardinality Description
Session FlashSession Term - [1] This element represent the FlashSession to be used.

OTL Examples

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

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

See also

GetListOfValidFlashSessions
GetFlashSession
GetSessionPriority
GetNumberOfBlocks
IsDownloadSession
GetSessionID