Setsearchobject, Ec.setsearchobject, Setsearchobject "c – Kofax DM API User Manual

Page 304: T.setsearchobject

Advertising
background image

284 C

HAPTER

4

SetSearchObject

SetSearchObject

Use this method to identify the form that you want to use to process the
specified operation.

Syntax

PCDGetDoc.SetSearchObject( strObjName )

PCDLookup.SetSearchObject( strObjName )

PCDPutDoc.SetSearchObject( strObjName )

PCDRecentDoc.SetSearchObject( strObjName )

PCDSearch.SetSearchObject( strObjName )

Parameter

Returns

Returns an

HRESULT

to receive the result of the call.

S_OK

indicates

success. Languages such as JavaScript, Visual Basic, and VBScript
return this as a function value.

Usage

Use this method before calling

Execute

. The

FORM_NAME

column in the

FORMS

table contains the identifier that you use to identify the form

that is to be used in an operation.

Example

The

Example

in the discussion of

PCDLookup

shows how you can use

this method in your custom applications.

Related Items

See the following objects:

PCDGetDoc
PCDLookup
PCDPutDoc

strObjName

A string variable that identifies the form to be
used in the operation.

Advertising