Difference between revisions of "Extensions.Flash.GetFlashSession"
Jump to navigation
Jump to search
(Created page with "Category:Flash == Classification == {{ClassificationActivity | GetFlashSession | Specifies the handle of flash back session by session ID | Term | Flash|OTX Flash ex...") |
|||
| (8 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
| − | [[Category:Flash]] | + | {{DISPLAYTITLE: '''GetFlashSession'''}}[[Category:Flash]] |
== Classification == | == Classification == | ||
| − | {{ClassificationActivity | GetFlashSession | | + | {{ClassificationActivity | GetFlashSession |Gets a '''FlashSession''' handle | [[Term]] | [[Extensions.Flash|OTX Flash extension]] | [[Extensions.Flash#Terms|Flash session related terms]] | [[Extensions.Flash.UnsupportedFormatException|UnsupportedFormatException]] | - }} |
| − | == | + | == OTL Syntax == |
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | <syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | ||
| − | + | FlashSessionTerm Flash.GetFlashSession(StringTerm sessionID); | |
</syntaxhighlight> | </syntaxhighlight> | ||
== Description == | == Description == | ||
| − | The '''GetFlashSession''' term | + | The '''GetFlashSession''' term shall return a [[Extensions.Flash.FlashSession|FlashSession]] handle which is identified by a session ID. |
| − | {{TermReturnValue| [[FlashSession]] | | + | {{TermReturnValue| [[Extensions.Flash.FlashSession|FlashSession]] | The handle of Flash Session.}} |
== Properties == | == Properties == | ||
{| {{TableHeader}} | {| {{TableHeader}} | ||
{{TableRowPropertiesHeader}} | {{TableRowPropertiesHeader}} | ||
| − | {{ | + | {{TableRowPropertie2| SessionID | [[Core.DataTypes.SimpleDataType.String|String]] | [[Term]] | - | [1] | This element shall represent a unique identifier in the environment which is used for identifying a flash session.}} |
|} | |} | ||
| − | == Examples == | + | == OTL Examples == |
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | <syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | ||
| − | FlashSession | + | /// Local Declarations |
| + | |||
| + | DiagCom.ComChannel ComChannel1; | ||
| + | Flash.FlashSession FlashSession1; | ||
| + | List<String> List1; | ||
| + | |||
| + | /// Flow | ||
| + | |||
| + | ComChannel1 = DiagCom.GetComChannel("SCHEINWERFER", "SCHEINWERFER_1", false); | ||
| + | List1 = Flash.GetListOfValidFlashSessions(ComChannel1, @Audience:SUPPLIER, @Directions:DOWNLOAD); | ||
| + | FlashSession1 = Flash.GetFlashSession(List1[2]); | ||
</syntaxhighlight> | </syntaxhighlight> | ||
== See also == | == See also == | ||
| − | [[GetListOfValidFlashSessions]] <br/> | + | [[Extensions.Flash.GetListOfValidFlashSessions|GetListOfValidFlashSessions]] <br/> |
| − | [[GetSessionID]] <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 04:48, 5 November 2018
Contents
Classification
| Name | GetFlashSession |
| Short Description | Gets a FlashSession handle |
| Class | Term |
| Extension | OTX Flash extension |
| Group | Flash session related terms |
| Exceptions | UnsupportedFormatException |
| Checker Rules | - |
| Standard Compliant | Yes |
OTL Syntax
FlashSessionTerm Flash.GetFlashSession(StringTerm sessionID);Description
The GetFlashSession term shall return a FlashSession handle which is identified by a session ID.
Return Value
The Term returns the value, see table below.
In OTX, Terms are categorized according to its return data type!
| Data Type | Description |
| FlashSession | The handle of Flash Session. |
Properties
| Name | Data Type | Class | Default | Cardinality | Description |
| SessionID | String | Term | - | [1] | This element shall represent a unique identifier in the environment which is used for identifying a flash session. |
OTL Examples
/// Local Declarations
DiagCom.ComChannel ComChannel1;
Flash.FlashSession FlashSession1;
List<String> List1;
/// Flow
ComChannel1 = DiagCom.GetComChannel("SCHEINWERFER", "SCHEINWERFER_1", false);
List1 = Flash.GetListOfValidFlashSessions(ComChannel1, @Audience:SUPPLIER, @Directions:DOWNLOAD);
FlashSession1 = Flash.GetFlashSession(List1[2]);See also
GetListOfValidFlashSessions
GetSessionID
GetFlashKey
GetSessionPriority
GetNumberOfBlocks
IsDownloadSession
GetComChannel
