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

Page 419

Advertising
background image

DM API T

OKENS

399

%HITLIST

%HITLIST

This token is used with the

%FORM_LIST_TYPE

token to retrieve data

items referenced on a

HITLIST

form.

Syntax

PCDDocObject.SetProperty(“%FORM_LIST_TYPE”, _

“%HITLIST”)

Parameters

Example

'Create an object to get property info about forms.

Set pDocObject = CreateObject("PCDClient.PCDDocObject.1")


'Set the DM security token.

pDocObject.SetDST(strDST)


'Check for errors.

checkError(pDocObject,"ERROR_CREATESEARCH")


'Identify the form to search.

pDocObject.SetObjectType("DocsFormsList")


'Set the destination library.

pDocObject.SetProperty("%TARGET_LIBRARY", library)


'Set the form type.

pDocObject.SetProperty("%FORM_LIST_TYPE", "%HITLIST")


'Run the search.

pDocObject.Fetch()

%FORM_LIST_TYPE

The token identifier that indicates the
current command line identifies the type
of form that the list operation is to
retrieve.

%HITLIST

The token identifier that indicates a

HITLIST search is to take place.

Advertising