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

 aofFiltToSystem()
 Transfers ownership of a Client Advantage Optimized Filter from the user to
 the system
------------------------------------------------------------------------------

Syntax

     aofFiltToSystem( <nHandle> ) -> logical

     <nHandle>  Handle to an existing user-owned filter.

Returns

     Returns .T. if the operation was successful; .F. indicates it failed.
     If aofFiltToSystem() failed, aofErrorCode() will return information
     on why the function failed.

Description

     Transfers ownership of a user-owned filter to the system. By
     transferring ownership of a filter to the system, movement
     operations such as GO TOP, SEEK, etc., will now obey the new filter.

     If there is an existing system-owned filter, it will be replaced
     with the specified filter.

     Once a user-owned filter is transferred to the system, the filter no
     longer needs to be freed via the aofFreeFilter() function. The
     system will handle freeing the filter.

Example

     USE Customer VIA "DBFCDXAX" INDEX state

     // Create an empty, user-owned filter
     nHandle := aofCreateFilter()

     // Add records 10 and 5 to the filter
     ? aofAddRecord( nHandle, 10  )  //  .T.
     ? aofAddRecord( nHandle,  5  )  //  .T.

     // Transfer ownership of the filter to the system
     aofFiltToSystem( nHandle )

     // Browse the data.  Only records 5 and 10 will be visible.
     browse()

     // Attempt to free filter.  Note that the function returns .F.
     // because the filter is now owned by the system.
     ? aofFreeFilter( nHandle )            //  .F.