Kofax DM API - Manual (Page 376)

356 C HAPTER 5
%FILTER_DISABLED_ROWS
%FILTER_DISABLED_ROWS
Some tables have a DISABLED column, which allows the system to
specify that a row is disabled. Use this token to exclude such rows from
a search result set.
Syntax
PCDLookup.AddUserFilterCriteria( _
“%FILTER_DISABLED_ROWS”, “Y”)
Parameters
Usage
Because, the default setting is not to exclude disabled rows, the Server
ignores any non-Y value.
Example
'Create a look-up object.
pSearch = CreateObject ("PCDClient.PCDLookup.1")
'Tell the DM Server to exclude disabled rows.
pSearch.AddUserFilterCriteria("%FILTER_DISABLED_ROWS","Y")
'Delete the object.
delete pSearch
Related Items
See the PCDLookup object.
See the AddUserFilterCriteria method.
%FILTER_DISABLED_ROWS The token identifier that indicates that
this command line will specify whether
disabled rows are to be filtered or not.
Y Yes, disabled rows are to be filtered out
of the result set. (Because the default
setting is not to exclude disabled rows,
the Server ignores any non-Y value.)