Extensions.Flash.GetSessionPriority

From emotive
Jump to navigation Jump to search

Classification

Name GetSessionPriority
Short Description Gets the priority setting for a flash session
Class Term
Extension OTX Flash extension
Group Flash session related terms
Exceptions -
Checker Rules -
Standard Compliant Yes

OTL Syntax

IntegerTerm Flash.GetSessionPriority(FlashSessionTerm session);

Description

The GetSessionPriority term will return the priority setting for a flash session. The resulting priority will be represented by a non-negative integer value where 0 represents the highest possible priority. If no priority information is available for a flash session, a default value of 100 will be returned.

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
Integer The priority setting for 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;
Integer Integer1;

/// Flow

ComChannel1 = DiagCom.GetComChannel("SCHEINWERFER", "SCHEINWERFER_1", false);
List1 = Flash.GetListOfValidFlashSessions(ComChannel1, @Audience:SUPPLIER, @Directions:DOWNLOAD);
FlashSession1 = Flash.GetFlashSession(List1[2]);
Integer1 = Flash.GetSessionPriority(FlashSession1);

See also

GetListOfValidFlashSessions
GetFlashSession
GetSessionID
GetFlashKey
GetNumberOfBlocks
IsDownloadSession
GetComChannel