Kofax DM API - Manual (Page 233)

DM API M ETHODS AND P ROPERTIES 213
GetReturnProperties
GetReturnProperties
Use this method to get a copy of the list of properties that the server will
return when the search is executed.
Syntax
PCDDocObject.GetReturnProperties()
PCDGetDoc.GetReturnProperties()
PCDPutDoc.GetReturnProperties()
PCDRecentDoc.GetReturnProperties()
Returns
Returns a pointer to a PCDPropertyList object.
Usage
The GetReturnProperties method is used to retrieve data in the result
set array that is returned by the
Fetch method. You identify items that
the Fetch returns by use of the AddProperty method prior to calling the
Fetch. You can also use the SetReturnProperties method to set more
than one return property with one method. You initialize the retrieval
process by calling the
BeginIter method. Use SetProperty to set the
pointer to the first array element. Use NextProperty to advance to the
next array element. Monitor whether or not an error occurs to
determine when all array elements have been retrieved.
Related Items
See the following objects:
PCDGetDoc
PCDPropertyList
PCDPutDoc
PCDRecentDoc
See the following methods:
AddProperty
BeginIter