Difference between revisions of "Extensions.Flash.GetFlashKey"
Jump to navigation
Jump to search
m (Hb moved page GetFlashKey to Extensions.Flash.GetFlashKey: #3153) |
|||
| (6 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| − | [[Category:Flash]] | + | {{DISPLAYTITLE: '''GetFlashKey'''}}[[Category:Flash]] |
== Classification == | == Classification == | ||
| − | {{ClassificationActivity | GetFlashKey | | + | {{ClassificationActivity | GetFlashKey | Gets the key of a flash session | [[Term]] | [[Extensions.Flash|OTX Flash extension]] | [[Extensions.Flash#Terms|Flash session related terms]] | - | - }} |
== OTL Syntax == | == OTL Syntax == | ||
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | <syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | ||
| − | StringTerm | + | StringTerm Flash.GetFlashKey(FlashSessionTerm session); |
</syntaxhighlight> | </syntaxhighlight> | ||
== Description == | == Description == | ||
| − | The '''GetFlashKey''' term return the key of a flash session. The key is a string value. | + | The '''GetFlashKey''' term will return the key of a flash session. The key is a string value. |
| − | {{TermReturnValue| [[String]] | The key of a flash session.}} | + | {{Note|In ODX/MVCI based systems, the returned key will correspond to the '''PARTNUMBER''' of the session (SESSION-DESC).}} |
| + | |||
| + | {{TermReturnValue| [[Core.DataTypes.SimpleDataType.String|String]] | The key of a flash session.}} | ||
== Properties == | == Properties == | ||
{| {{TableHeader}} | {| {{TableHeader}} | ||
{{TableRowPropertiesHeader}} | {{TableRowPropertiesHeader}} | ||
| − | {{ | + | {{TableRowPropertie2| Session | [[Extensions.Flash.FlashSession|FlashSession]] | [[Term]] | - | [1] | This element represent the '''FlashSession''' to be used.}} |
|} | |} | ||
== OTL Examples == | == OTL Examples == | ||
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | <syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | ||
| + | /// Local Declarations | ||
| + | |||
DiagCom.ComChannel ComChannel1; | DiagCom.ComChannel ComChannel1; | ||
| + | Flash.FlashSession FlashSession1; | ||
List<String> List1; | List<String> List1; | ||
| − | + | String String1 = ""; | |
| − | String String1; | + | |
| + | /// Flow | ||
| − | ComChannel1 = DiagCom.GetComChannel(" | + | ComChannel1 = DiagCom.GetComChannel("SCHEINWERFER", "SCHEINWERFER_1", false); |
| − | List1 = Flash.GetListOfValidFlashSessions(@ | + | List1 = Flash.GetListOfValidFlashSessions(ComChannel1, @Audience:SUPPLIER, @Directions:DOWNLOAD); |
| − | FlashSession1 = Flash.GetFlashSession(List1[ | + | FlashSession1 = Flash.GetFlashSession(List1[2]); |
String1 = Flash.GetFlashKey(FlashSession1); | String1 = Flash.GetFlashKey(FlashSession1); | ||
</syntaxhighlight> | </syntaxhighlight> | ||
== See also == | == See also == | ||
| − | [[GetListOfValidFlashSessions]] <br/> | + | [[Extensions.Flash.GetListOfValidFlashSessions|GetListOfValidFlashSessions]] <br/> |
| − | [[GetFlashSession]] <br/> | + | [[Extensions.Flash.GetFlashSession|GetFlashSession]]<br/> |
| − | [[GetSessionPriority]] <br/> | + | [[Extensions.Flash.GetSessionID|GetSessionID]]<br/> |
| − | [[GetNumberOfBlocks]] <br/> | + | <!--[[Extensions.Flash.GetFlashKey|GetFlashKey]]<br/>--> |
| − | [[IsDownloadSession]] <br/> | + | [[Extensions.Flash.GetSessionPriority|GetSessionPriority]]<br/> |
| − | [[ | + | [[Extensions.Flash.GetNumberOfBlocks|GetNumberOfBlocks]]<br/> |
| + | [[Extensions.Flash.IsDownloadSession|IsDownloadSession]]<br/> | ||
| + | [[Extensions.DiagCom.GetComChannel|GetComChannel]]<br/> | ||
Latest revision as of 02:27, 13 September 2019
Contents
Classification
| Name | GetFlashKey |
| Short Description | Gets 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 session);Description
The GetFlashKey term will return the key of a flash session. The key is a string value.
In ODX/MVCI based systems, the returned key will correspond to the PARTNUMBER of the session (SESSION-DESC).
Return Value
The Term returns the value, see table below.
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
/// Local Declarations
DiagCom.ComChannel ComChannel1;
Flash.FlashSession FlashSession1;
List<String> List1;
String String1 = "";
/// Flow
ComChannel1 = DiagCom.GetComChannel("SCHEINWERFER", "SCHEINWERFER_1", false);
List1 = Flash.GetListOfValidFlashSessions(ComChannel1, @Audience:SUPPLIER, @Directions:DOWNLOAD);
FlashSession1 = Flash.GetFlashSession(List1[2]);
String1 = Flash.GetFlashKey(FlashSession1);See also
GetListOfValidFlashSessions
GetFlashSession
GetSessionID
GetSessionPriority
GetNumberOfBlocks
IsDownloadSession
GetComChannel
