beautypg.com

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

Page 411

background image

DM API T

OKENS

391

%GET_LOCAL_RELATED

%GET_LOCAL_RELATED

Use this token to get all the documents related to the search item that
are in the same library as the search object.

Syntax

PCDDocObject.SetProperty( _

“%GET_RELATED_ITEMS”, _

“%GET_LOCAL_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)


'Set the related token.

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

This token identifier indicates that only
the library that contains the search
object is to be searched for related
items.