Addorderbyproperty, Ec.addorderbyproperty, T.addorderbyproperty – Kofax DM API User Manual
Page 155: Metho
DM API M
ETHODS
AND
P
ROPERTIES
135
AddOrderByProperty
AddOrderByProperty
AddOrderByProperty allows you to set the order that search results are
returned to you.
Syntax
PCDLookup.AddOrderByPropery( strPropName, _
blnAscending )
PCDRecentDoc.AddOrderByProperty( strPropName, _
blnAscending )
PCDSearch.AddOrderByPropery( strPropName, _
blnAscending )
Parameters
Returns
Returns an
HRESULT
to receive the result of the call.
S_OK
indicates
success. Languages such as JavaScript, Visual Basic, and VBScript
return this as a function value.
Example
The following example uses the
AUTHOR_ID
value to display search
results in ascending order.
.
.
.
'Save the document security token (DST) from the
'DM Server so the search can be done.
strDST = objLogin.
strPropName
The name of the property by which to
order the results of a search.
blnAscending
A Boolean flag indicating whether to
sort on the name property in
ascending or descending order.
FALSE (or zero) sorts in descending
order. Any other value (not
FALSE)
sorts in ascending order.