Addreturnproperty, Ec.addreturnproperty, Addreturnproperty "l – Kofax DM API User Manual

Page 160: Addreturnproperty "d, Addreturnproperty "t, Addreturnproperty "s, Addreturnproperty "a, T.addreturnproperty("d, T.addreturnproperty("a, T.addreturnproperty("s

Advertising
background image

140 C

HAPTER

4

AddReturnProperty

AddReturnProperty

Use this method to add a property to the list of objects that you want a
search to return to you. No data is returned by default. Your search will
return no data unless you call AddReturnProperty at least one time
before you execute your search.

Syntax

PCDRecentDoc.AddReturnProperty( strPropName )

PCDSearch.AddReturnPropery( strPropName )

Parameter

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 shows how to add return properties as part of
the execution of a search.

.

.

.

'Save the document security token (DST) from the

'DM Server so the search will execute

'properly.

strDST = pClient.

GetDST

()


'Create the search object.

pSearch = Server.CreateObject( _

"PCDClient.

PCDSearch

")


'Pass the DST to the search object.

strPropName

The name of the property to be returned in the
results.

Advertising