Kofax DM API - Manual (Page 366)

346 C HAPTER 5
%DOCS_LIBRARY_NAME
%DOCS_LIBRARY_NAME
When used with the PCDSearch object, this token retrieves the library
name associated with the document specified in the search. When used
with the
PCDPropertyLists object, it retrieves the library name
associated with the current row of the list.
Syntax
PCDPropertyLists.GetCurrentPropertyName( _
“%DOCS_LIBRARY_NAME”)
PCDSearch.AddReturnProperty( _
“%DOCS_LIBRARY_NAME”)
Parameters
Example
'Create a PCDSearch object.
pRelated = CreateObject("PCDClient.PCDSearch")
'Check for errors.
checkError(pRelated, "ERROR_CREATESEARCH")
'Set the search object.
pRelated.SetSearchObject('RelatedItemsSearch')
'Set the DM security token.
pRelated.SetDST(strDST)
'Add the current library.
pRelated.AddSearchLib(strLibName)
'Set the number of the document to get.
pRelated.AddSearchCriteria("%OBJECT_IDENTIFIER",docnum)
'Define the properties to be returned.
pRelated.AddReturnProperty("DOCNUMBER")
pRelated.AddReturnProperty("%DOCS_LIBRARY_NAME")
%DOCS_LIBRARY_NAME The token identifier that indicates that
the name of the library is to be extracted
from the property list or search results.