RYOFilterSave

<< Click to Display Table of Contents >>

Navigation:  Apollo VCL Components > Apollo VCL Component Reference > TApolloTable > TApolloTable Methods >

RYOFilterSave

Declaration

function RYOFilterSave( iFilterHandle : Integer;

sFileName : String ) : WordBool;

Description

Saves the defined bitmap in a disk file.

Parameters

iFilterHandle: An integer identifier of the bitmap returned from either RYOFilterCopy or RYOFilterCreate. If this parameter is passed as zero, the active bitmap is acted upon.

sFileName: A user supplied file name fully qualified with path and extension. If the file already exists, it is overwritten without warning.

image\tip.gif Bitmaps saved to disk should only be applied in future to files that are not packed. Each TRUE bit in a saved bitmap represents a physical record location, and packed files do not retain the same sequence if deleted records are physically removed from the file.

Return Value

True or False depending on the outcome of the operation.

Delphi Example

procedure TForm1.SaveAs1Click(Sender: TObject);

begin

 if SaveDialog1.Execute then 

 ApTbl.RYOFilterSave( hBitMap, SaveDialog1.FileName );

end;

See Also

RYOFilterActivate, RYOFilterCopy, RYOFilterCreate, RYOFilterDestroy, RYOFilterRestore, RYOFilterSetBit