Extensions.Flash.GetFlashKey

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 should 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