FireDAC.Comp.Client.TFDCustomSchemaAdapter.SaveToFile

From RAD Studio API Documentation
Jump to: navigation, search

[–] Properties
Type:
procedure
function
Visibility: public
Source:
FireDAC.Comp.Client.pas
FireDAC.Comp.Client.hpp
Unit: FireDAC.Comp.Client
Parent: TFDCustomSchemaAdapter

Delphi 

procedure SaveToFile(const AFileName: String = ''; AFormat: TFDStorageFormat = sfAuto);

C++ 

void __fastcall SaveToFile(const System::UnicodeString AFileName = System::UnicodeString(), Firedac::Stan::Intf::TFDStorageFormat AFormat = (Firedac::Stan::Intf::TFDStorageFormat)(0x0));

Description

Saves the content of the datasets associated with TFDCustomSchemaAdapter to a file.

Use the SaveToFile procedure to save the content of the datasets associated with a TFDCustomSchemaAdapter to a file with a specific format.

AFileName is the name of the external file in which to save the data.

AFormat is the file format:

  • sfXML: an XML file.
  • sfBinary: a binary file with a custom FireDAC format.
  • sfAuto: the format is determined by the AFileName extension: ".XML" - XML file, ".ADB" / ".BIN" / ".DAT" - binary file.

Note: If the AFileName does not have an extension, then the format is determined by the ResourceOptions.DefaultStoreExt, provided that it is sepcified. Otherwise, it is determined by ResourceOptions.DefaultStoreFormat.

SaveToFile stores into the file the items specified by ResourceOptions.StoreItems.

See Also

Retrieved from "https://docwiki.embarcadero.com/Libraries/Florence/e/index.php?title=FireDAC.Comp.Client.TFDCustomSchemaAdapter.SaveToFile&oldid=689540"