Extensions.Flash.GetSessionID

From emotive
Jump to navigation Jump to search

Classification

Name GetSessionID
Short Description Gets the identifier 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.GetSessionID(FlashSessionTerm session);

Description

The GetSessionID term will return the identifier of a flash session. The identifier is a string value.

Icons Note.png In ODX/MVCI based systems, the returned ID string will correspond to the SHORT-NAME of the session.

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 identifier of a referenced 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.GetSessionID(FlashSession1);

See also

GetListOfValidFlashSessions
GetFlashSession
GetFlashKey
GetSessionPriority
GetNumberOfBlocks
IsDownloadSession
GetComChannel