Extensions.FlashPlus.GetFlashDataFileNames

From emotive
Jump to navigation Jump to search

Classification

Name GetFlashDataFileNames
Short Description Get a possibly empty otx:List of otx:String of file names.
Class Term
Extension OTX FlashPlus extension
Group Flash plus related terms
Exceptions FlashPlusException
Checker Rules -
Standard Compliant Yes

OTL Syntax

ListTerm FlashPlus.GetFlashDataFileNames(NumericTerm block, FlashSessionTerm session);

Description

Returns a possibly empty otx:List of otx:String of file names which match the pattern obtainable via MCDDbFlashData::getDataFileName().

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

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
List A possibly empty otx:List of otx:String of file names.

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;
List<String> List1;

/// Flow

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

See also

SetActiveFile
GetActiveFileName
GetOwnIdentFromComChannel
IsLateBound
FlashPlusException