Datasnap.DBClient.TCustomClientDataSet.SaveToFile

From RAD Studio API Documentation
Jump to: navigation, search

[–] Properties
Type:
procedure
function
Visibility: public
Source:
Datasnap.DBClient.pas
Datasnap.DBClient.hpp
Unit: Datasnap.DBClient
Parent: TCustomClientDataSet

Delphi

procedure SaveToFile(const FileName: string = ''; Format: TDataPacketFormat = dfBinary);

C++

void __fastcall SaveToFile(const System::UnicodeString FileName = System::UnicodeString(), TDataPacketFormat Format = (TDataPacketFormat)(0x0));

Description

Saves a client dataset's data to an external file.

Call SaveToFile to write a client dataset's data to an external file for later use by this or other client datasets.

FileName is the name of the external file to use. If the file already exists, its current contents are overwritten. If an empty string is passed for the FileName parameter (or, in Delphi, if this parameter is omitted), the data is saved to the file specified by the FileName property.

Format indicates what format to use when saving the data: binary (dfBinary) or XML (dfXML), or UTF8-based XML (dfXMLUTF8).

See Also


Code Examples