Form_list_type – Kofax DM API User Manual

Page 383

Advertising
background image

DM API T

OKENS

363

%FORM_LIST_TYPE

%FORM_LIST_TYPE

This token is used to perform a search of a form. Returns a list
properties describing the form.

Syntax

PCDDocObject.SetProperty(“%FORM_LIST_TYPE”, _

strFormType)

Parameters

Usage

The

%FORM_LIST_TYPE

token can take any of the following form

types as its second parameter:

%HITLIST

%PROFILE

%SEARCH

Example

'Create a doc object.

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


'Set the DM security token.

pDMObj.SetDST(strDST)


'Set the object type.

pDMObj.SetObjectType("DocsFormsList")


'Set the destination library.

pDMObj.SetProperty("%TARGET_LIBRARY", lib)


'Search for the profile forms.

pDMObj.SetProperty("%FORM_LIST_TYPE", "%PROFILE")

%FORM_LIST_TYPE

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

strFormType

A string variable or quoted string that
contains the form type that the list is to
contain.

Advertising