Beginiter, Beginiter 151 – Kofax DM API User Manual

Page 171

Advertising
background image

DM API M

ETHODS

AND

P

ROPERTIES

151

BeginIter

BeginIter

Use this method to position the current pointer to the first position in
a list. This method begins a BeginIter()/

NextProperty

(), a BeginIter/

NextRow

, or a BeginIter()/

NextTrustee

() loop.

Syntax

PCDPropertyList.BeginIter()

PCDPropertyLists.BeginIter()

PCDTrusteeList.BeginIter()

Returns

It returns

S_OK

as an

HRESULT

if it successfully positioned on a list

entry, and returns

PCD_S_END_OF_LIST

if the list is empty. JavaScript,

Visual Basic, and VBScript return this as a function value. This value is
also available in the

ErrNumber

property.

Example

The BeginIter method is used in the

Example

for the

PCDPropertyList

object.

Related Items

See the following objects:

PCDPropertyList
PCDPropertyLists
PCDTrusteeList

See the following methods:

NextProperty
NextRow
NextTrustee

See the following properties:

Advertising