Kofax DM API - Manual (Page 389)

DM API T OKENS 369
%FORM_TITLE
%FORM_TITLE
This token is used to get the form title from the search result set. It is
usually used when searching for a particular form or a collection of
forms.
Syntax
PCDPropertyList.GetPropertyValue(“%FORM_TITLE”)
Parameters
Example
'Ccreate 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)
'Retrieve the search values.
pClient.Fetch()
'Get the returned properties.
Set pProperties = pClient.GetReturnProperties()
'Get the form name.
formName = pProperties.GetPropertyValue("%FORM_TITLE")
%FORM_TITLE The token that indicates the title of the
form is to be returned by the fetch
operation.