Setchunkfactor – Kofax DM API User Manual

Page 280

Advertising
background image

260 C

HAPTER

4

SetChunkFactor

SetChunkFactor

This method sets the number of rows to retrieve from the server results
set when a SQL call is made. The default is 10.

Syntax

PCDLookup.SetChunkFactor( lngChunkSize )

PCDPropertyLists.SetChunkFactor( lngChunkSize )

PCDRecentDoc.SetChunkFactor( lngChunkSize )

PCDSearch.SetChunkFactor( lngChunkSize )

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

You are never required to call this method—it is provided to optimize
wire traffic to the server.

Related Items

See the following objects:

PCDLookup
PCDPropertyLists
PCDRecentDoc
PCDSearch

See the following properties:

lngChunkSize

A long integer that specifies the number of rows
to retrieve into the local cache at one time.

Advertising