Kofax DM API - Manual (Page 229)

DM API M ETHODS AND P ROPERTIES 209
GetPropertyValue
GetPropertyValue
Use this method to get the value of the named property from the
current row in the results set.
Syntax
PCDGetDoc.GetPropertyValue( strPropName )
PCDGetForm.GetPropertyValue( strPropName )
PCDGetStream.GetPropertyValue( strPropName )
PCDPropertyList.GetPropertyValue( strPropName )
PCDPropertyLists.GetPropertyValue( strPropName )
PCDPutDoc.GetPropertyValue( strPropName )
PCDPutStream.GetPropertyValue( strPropName )
PCDRecentDoc.GetPropertyValue( strPropName )
PCDSearch.GetPropertyValue( strPropName )
Parameter
Returns
Returns a VARIANT variable that contains the property value that you
requested when you called GetPropertyValue.
Usage
You should call NextRow or SetRow before you call this method. After
making this call to get the property value, you should check the
ErrNumber property. It should be zero ( S_OK ) unless there was an
error. Possible errors can include an invalid property name or not being
set to a valid row.
Example
The Example in the discussion of the PCDGetDoc object illustrates
how you can use this method.
Related Items
See the following objects:
strPropName The name of the property for which
GetPropertyValue is to retrieve the value.