Get_all_related, Syntax, Parameters example – Kofax DM API User Manual

Page 409

Advertising
background image

DM API T

OKENS

389

%GET_ALL_RELATED

%GET_ALL_RELATED

Use this token to get all items that relate to the search item, whether
they are located in the same library as the search item or in remote
libraries.

Syntax

PCDSearch.AddSearchCriteria( _

“%GET_RELATED_ITEMS”, _

“%GET_ALL_RELATED”)

Parameters

Example

'Create a search object.

pRelated = CreateObject("PCDClient.PCDSearch")


'Check for errors.

checkError(pRelated, "ERROR_CREATESEARCH")


'Set the search type.

pRelated.SetSearchObject('RelatedItemsSearch')


'Set the DM security token

pRelated.SetDST(strDST)


'Current display library

pRelated.AddSearchLib(library)


'Search for items related to this search object.

pRelated.AddSearchCriteria(“%OBJECT_IDENTIFIER”, _

strDocNum)

%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.

%GET_ALL_RELATED

This token identifier indicates that both
library that contains the search object
and remote libraries are to be searched
for related items.

Advertising