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

  m6_IsFiltRec():

  Purpose:  Used to test if a record is in a Roll-Your-Own filter.

   Syntax:  m6_IsFiltRec( <nHandle>, <nRecord> )

    Where:  <nHandle>     --  Is a handle to a previously allocated
                              RYO filter.

            <nRecord>     --  Record to check in the filter

  Returns:  Logical value:  .T. means the record is set in the filter ( if
            the filter is partially optimizable, .T. means a potential match),
            .F. indicates that record is NOT if the filter.

     Note:  If the filter is partially optimizable ( To test the optimization
            level of a filter call m6_FiltInfo().) then a true value from
            this function indicates that record is a candidate to be in the
            filter.  A candidate record is one that the indexed portion of the
            query determined could be in the filter, however until the
            partially optimizable portion has been tested, one cannot be
            certain that the record is actually in the filter.  See the
            function m6_EvalPartial() to resolve the uncertainty of a
            partially optimizable filter.

            *Always free RYO filters that are no longer being used.*

  Example:

         #include "SIXCDX.CH"
         #include "MACHSIX.CH"

         //..............................................create RYO filter
         nHandle := m6_NewFilter( 100 )

         //......................................add records to the filter
         ? m6_FiltAddRec( nHandle,  5 )  // .T.
         ? m6_FiltAddRec( nHandle, 10 )  // .T.

         //..............................fest if records are in the filter
         ? m6_IsFiltRec( nHandle,  5 )   // .T.
         ? m6_IsFiltRec( nHandle, 20 )   // .F.

         //.................................free memory allocated to filter
         ? m6_FreeFilter( nHandle )      // .T.