Getpropertyindex, Method – Kofax DM API User Manual

Page 226

Advertising
background image

206 C

HAPTER

4

GetPropertyIndex

GetPropertyIndex

Use this method to get the property index of a named property. Check
the

ErrNumber

property after calling this method to verify that the

return value is valid.

Syntax

PCDPropertyList.GetPropertyIndex( strPropName )

Parameter

Returns

Returns an integer that identifies the location of the specified property
in the index array. This index is zero-based.

Usage

If the requested property is not present in the property index array, the
return value will be set to a value of negative one (-1). This will set an
error in

PCDError

, while still returning

S_OK

.

strPropName

A string value that contains the name of the
property for which GetPropertyIndex is to
return the index value.

Advertising