Kofax DM API - Manual (Page 413)

DM API T OKENS 393
%GET_RELATED_ITEMS
%GET_RELATED_ITEMS
This token indicates that the search should return related items.
Syntax
PCDSearch.AddSearchCriteria( _
“%GET_RELATED_ITEMS”, _
strTypeOfRelatedSearch)
Parameters
Usage
The %GET_RELATED_ITEMS token supports the following search
types:
• Searches across both local and remote libraries, using the
%GET_ALL_RELATED token.
• Searches only the library only, using the %GET_LOCAL_RELATED
token.
• Searches only libraries that are remote to the current document
object, using the
%GET_REMOTE_RELATED token.
Example
See the %GET_ALL_RELATED Example on page 389 or the
%GET_LOCAL_RELATED Example on page 391 .
Related Items
See the PCDSearch object.
%GET_RELATED_ITEMS This token identifier indicates that a
search parameter is to be set that
indicates whether local or remote
libraries are to be searched.
strTypeOfRelatedSearch A string variable or quoted literal that
resolves to one of the search types that
the
%GET_RELATED_ITEMS token
supports.