Setmaxrows, Setmaxrows 268 – Kofax DM API User Manual

Page 288

Advertising
background image

268 C

HAPTER

4

SetMaxRows

SetMaxRows

Use this method to set the maximum number of rows to be returned by
your lookup or search.

Syntax

PCDLookup.SetMaxRows( intMaxRows )

PCDRecentDoc.SetMaxRows( intMaxRows )

PCDSearch.SetMaxRows( intMaxRows )

Parameter

Return Values

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

If you intend to limit the number of rows returned by your search, you
must use this method before you call the Execute method. SetMaxRows
has no effect if called after the lookup or search has been executed.
Passing a maximum row parameter that is set to zero or less than zero
results in an unlimited number of rows being returned.

Related Items

See the following objects:

PCDLookup

PCDRecentDoc

PCDSearch

See the following properties:

intMaxRows

An integer variable that contains the maximum
number of rows.

Advertising