FireDAC.Comp.Script.TFDScript.OnGetText

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

property OnGetText: TFDGetTextEvent read FOnGetText write FOnGetText;

C++

__property TFDGetTextEvent OnGetText = {read=FOnGetText, write=FOnGetText};

Properties

Type Visibility Source Unit Parent
event published
FireDAC.Comp.Script.pas
FireDAC.Comp.Script.hpp
FireDAC.Comp.Script TFDScript

Description

The event fires when a script engine needs a reference to a stream.

Use the OnGetText event handler to provide the script engine with a reference to a text stream. The text stream is represented by the TFDTextFile class, which can work with a string or a TStream reference. If the event handler returns nil as the AText parameter value, then a default action is taken.

If the text stream is no longer required, the OnReleaseText event is called.

  • AFileName - the name of a file to open.
  • AMode - the file open mode.
  • AText - returns a reference to the TFDTextFile object.

See Also