Apollo API Listing > sx

VB Declaration

Declare Function sx_RYOFilterSave Lib "Apollo9.dll"

(ByVal iFilterHandle As Integer,

ByVal cpFileName As String)

As Integer

C Declaration

BOOL FAR PASCAL sx_RYOFilterSave

(SHORT iFilterHandle,

BYTEP cpFileName);

Description

Saves the defined bitmap in a disk file.

Parameters

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

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

Note: 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.

VB Example

sx_RYOFilterSave( hBitMap, "C:\DATA\SAVED.DAT" )

C Example

sx_RYOFilterSave( hBitMap, "C:\\DATA\\SAVED.DAT" );

sx_RYOFilterSave