Extensions.FlashPlus.GetActiveFileName

From emotive
Jump to navigation Jump to search

Classification

Name GetActiveFileName
Short Description Get the active flash file name
Class Term
Extension OTX FlashPlus extension
Group Flash plus related terms
Exceptions FlashPlusException
Checker Rules -
Standard Compliant Yes

OTL Syntax

StringTerm FlashPlus.GetActiveFileName(NumericTerm block, FlashSessionTerm session);

Description

Returns the active flash file name for the given block of the given flash:FlashSession as an otx:String.

Icons Note.png The appropriate MVCI system operation is MCDDbFlashData.isLatebound.

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 active flash file name

Properties

Name Data Type Class Default Cardinality Description
Block Numeric Term [1..1] Specifies a block in the flash:FlashSession context that will be addressed. The value will be in the range of the existing blocks. Float values will be truncated.
Session FlashSession Term - [1..1] Specifies the flash:FlashSession, which provides the data that will be addressed.

OTL Examples

/// Local Declarations

DiagCom.ComChannel ComChannel1;
Flash.FlashSession FlashSession1;
Flash.FlashJob FlashJob1;
String String1;

/// Flow

ComChannel1 = DiagCom.GetComChannel("SCHEINWERFER", NULL, false);
FlashSession1 = Flash.GetFlashSession("_7PP907357F_7520");
String1 = FlashPlus.GetActiveFileName(1, FlashSession1);

See also

SetActiveFile
GetFlashDataFileNames
GetOwnIdentFromComChannel
IsLateBound
FlashPlusException