Extensions.FlashPlus.SetActiveFile

From emotive
Jump to navigation Jump to search

Classification

Name SetActiveFile
Short Description Sets the flash file name to a temporarily defined flash file name
Class Action
Extension OTX FlashPlus extension
Group FlashPlus related actions
Exceptions FlashPlusException
Checker Rules -
Standard Compliant Yes

OTL Syntax

ActionRealisation FlashPlus.SetActiveFile(NumericTerm block, StringTerm filePath, FlashSessionTerm session);

Description

Sets the flash file name to a temporarily defined flash file name for the given block of the given flash:FlashSession.

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

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.
FilePath String Term - [1..1] Specifies the path to the file.
Session FlashSession Term - [1..1] Specifies the flash:FlashSession, which provides the data that will be addressed.

OTL Examples

/// Local Declarations

Flash.FlashSession FlashSession1;
Integer Integer1;

/// Flow

FlashPlus.SetActiveFile(Integer1, "file:///D:/file_simple.txt", FlashSession1);

See also