TCustomADODataSet.SaveToFile Method

Saves a recordset to a file.

Pascal

procedure SaveToFile(const FileName: WideString = ''; Format: TPersistFormat = pfADTG);

C++

__fastcall SaveToFile(const BSTR FileName = '', TPersistFormat Format = pfADTG);

Description

Call SaveToFile to save the current recordset to a file. If the destination file already exists, it is overwritten.

FileName is a string containing the name of the destination file. This file remains open from the first call to SaveToFile until the dataset is closed. This file can be read by other applications while it is open, but they cannot write to the file.

Format specifies the file format for the saved recordset. By default, Format is pfADTG (Advanced Data TableGram format).

Note: Microsoft recommends using a client-side cursor (the dataset is opened with a CursorLocation property value of clUseClient). This way, if the provider used does not support saving the recordset the client cursor will provide the necessary functionality.