Kofax DM API - Manual (Page 385)

DM API T OKENS 365
%FORM_NAME
%FORM_NAME
Use this token to set the name of a form that a search operation uses.
After a search has been performed, this token can also be used to
retrieve the name of the form used in the search.
Syntax
PCDDocObject.SetProperty(“%FORM_NAME”, _
strFormName)
PCDPropertyList.GetPropertyValue(“%FORM_NAME”)
Parameters
Example
'Create a doc object.
Set pClient = CreateObject("PCDClient.PCDDocObject.1")
'Check for errors.
checkError(pClient, "ERROR_CREATESEARCH")
'Set the DM security token.
pClient.SetDST(strDST)
'Set the search object.
pClient.SetObjectType("DocsForm")
'Set the library that is to be searched.
pClient.SetProperty("%TARGET_LIBRARY", library)
'Set the form ID.
pClient.SetProperty("%OBJECT_IDENTIFIER", formId)
'Fetch the search results.
pClient.Fetch()
'Check for errors.
%FORM_NAME The token identifier that indicates a form
name is either being specified or
requested.
strFormName The name of the form that is to be used
for the search.