beautypg.com

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

Page 489: Related items

background image

DM API T

OKENS

469

%SEARCH

%SEARCH

This token is used in conjunction with %FORM_LIST_TYPE to return
all search forms available to the user.

Syntax

PCDDocObject.SetProperty(“%FORM_LIST_TYPE”, _

“%SEARCH”)

Parameters

Example

'Create a doc object.

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


'Set the DM security token.

pDocObject.SetDST(strDST)


'Set the object (form) type.

pDocObject.SetObjectType("FormsList")


'Set the library.

pDocObject.SetProperty("%TARGET_LIBRARY", strMyLib))


'Specify the type of forms that this search should list.

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


'Fetch the list of forms.

pDocObject.Fetch()

Related Items

See the

PCDDocObject

object.

See the

SetProperty

method.

%FORM_LIST_TYPE

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

%SEARCH

The token identifier that specifies that
the list of search forms available to the
user should be returned.