Click above to get retro games delivered to your door ever month!

 aofGetFilterHandle()
 Gets the handle of a Client Advantage Optimized Filter owned by the system
------------------------------------------------------------------------------

Syntax

     aofGetFilterHandle() -> numeric

Returns

     Returns a numeric handle for the system-owned filter. A handle of
     0 (zero) indicates an error occurred or that no system-owned filter
     exists in this work area. If aofGetFilterHandle() failed,
     aofErrorCode() will return information on why the function failed.

Description

     aofGetFilterHandle() returns a handle for the system-owned filter.
     This function is useful so that Client AOF functions requiring a filter
     handle can use system-owned filters.

     The system will still retain ownership of the filter after this
     function is called, so the system will free the memory associated
     with this handle. If you want to transfer ownership of a filter from
     the system to the user, then use the aofFiltToUser() function.

Example

     USE Customer VIA "DBFCDXAX" INDEX state

     // Create a system-owned filter
     aofSetFilter( "state = 'CA'" )

     GO TOP

     // Get a handle to the system-owned filter
     nHandle := aofGetFilterHandle()

     // Add a couple records to the filter
     aofAddRecord( nHandle, 10 )
     aofAddRecord( nHandle, 20 )

     // Browse records in filter.  Note only 10 and 20 will be visible
     Browse()