Extensions.Flash.GetNumberOfBlocks

Classification

Name	GetNumberOfBlocks
Short Description	Gets the number of blocks in a FlashSession
Class	Term
Extension	OTX Flash extension
Group	Flash session related terms
Exceptions	-
Checker Rules	-
Standard Compliant	Yes

OTL Syntax

/// Local Declarations
Integer IntegerVariable;
/// Flow
IntegerVariable = Flash.GetNumberOfBlocks(FlashSessionTerm);

Description

The GetNumberOfBlocks term shall return the number of blocks in a FlashSession. If no blocks exist, the return value shall be zero, otherwise it shall be a positive number.

Return Value

The Term returns the value, see table below.

In OTX, Terms are categorized according to its return data type!

Data Type	Description
Integer	The number of blocks in a flash session.

Properties

Name	Data Type	Class	Default	Cardinality	Description
Session	FlashSession	Term	-	[1]	This element represents the FlashSession from which the number of blocks shall be returned.

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.GetNumberOfBlocks(FlashSession1);

See also

GetListOfValidFlashSessions
GetFlashSession
GetSessionID
GetFlashKey
GetSessionPriority
IsDownloadSession
GetComChannel