Extensions.Flash.GetFlashSession

From emotive
Jump to navigation Jump to search

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.

Icons Note.png 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