beautypg.com

Getreturnproperty – Kofax DM API User Manual

Page 235

background image

DM API M

ETHODS

AND

P

ROPERTIES

215

GetReturnProperty

GetReturnProperty

Use this method to get the value of a return property.

Syntax

PCDDocObject.GetReturnProperty( strPropName )

Parameter

Returns

Returns a pointer to a

VARIANT

structure where the value of the

property is put. Languages such as JavaScript, Visual Basic, and
VBScript return this as a function value. This value is also available in
the

ErrNumber

property.

Example

The

Example

in the discussion of the

PCDPutDoc

object illustrates

how you can use the GetReturnProperty method in your custom
applications.

Related Items

See the

PCDDocObject

object.

See the following properties:

ErrDescription
ErrNumber

strPropName

A string (

BSTR) that contains the name of the

property that the GetReturnProperty method is to
return.