Getpropertyvaluebyindex – Kofax DM API User Manual
Page 231

DM API M
ETHODS
AND
P
ROPERTIES
211
GetPropertyValueByIndex
GetPropertyValueByIndex
Use this method to get the value of a return property based on its
location in the return properties index.
Syntax
PCDLookup.GetPropertyValueByIndex( intPropNdx )
PCDRecentDoc.GetPropertyValueByIndex( intPropNdx
)
PCDSearch.GetPropertyValueByIndex( intPropNdx )
Parameter
Returns
Returns a
VARIANT
that contains the property value data from the
requested index position in the return array.
Usage
The position of the requested property value is determined by when it
was added to the return property data set by use of the
method. For example, if the first call to
AddReturnProperty(“DocName”)
, then,
after calling
, a call to
GetPropertyValueByIndex( 0 )
would retrieve the value of the
DocName
property for the first row in the results set.
Related Items
See the following objects:
PCDLookup
PCDRecentDoc
PCDSearch
See the following properties:
intPropNdx
The zero-based index of the return property
whose value is desired.