Begingetblock – Kofax DM API User Manual

Page 170

Advertising
background image

150 C

HAPTER

4

BeginGetBlock

BeginGetBlock

Use this method to tell the object that you are beginning a block of
“Get” operations so that it will hold the results until

EndGetBlock

is

called. Normally, the result set is released and recreated on each call to,
for example,

GetPropertyValue

. The results remain cached on the

server, but the interface is normally released to prevent it from timing
out. If you are doing a block of operations such as

GetPropertyValue

,

with no intervening user interaction or other operations that could
cause an indefinite wait between calls, you can use

BeginGetBlock

and

EndGetBlock

to improve performance.

Syntax

PCDRecentDoc.BeginGetBlock()

PCDSearch.BeginGetBlock()

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.

Related Items

See the following objects:

PCDRecentDoc

PCDSearch

See the following method:

EndGetBlock

.

See the following properties:

ErrDescription

ErrNumber

Advertising