beautypg.com

Setproperty, Setproperty 27, Setproperty "%t – Kofax DM API User Manual

Page 297: Setproperty "%o, Setproperty "%v, Setproperty "%s, Oc.setproperty, C.setproperty

background image

DM API M

ETHODS

AND

P

ROPERTIES

277

SetProperty

SetProperty

Use this method to set a property to be used with a

Create

,

Execute

, or

Update

method. If the property already exists in the property list, its

value will be updated. If it does not exist, it will be added to the
property list.

Syntax

PCDDocObject.SetProperty( strPropName, vntVal )

PCDPropertyLists.SetProperty( strPropName,
vntVal )

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

Example

in the discussion of the

PCDGetStream

object

demonstrates how you can use the SetProperty method.

Related Items

See the following objects:

PCDDocObject

PCDPropertyLists

See the following properties:

strPropName

A string (

BSTR) variable that contains the name

of the property to be set.

vntVal

A

VARIANT that contains the value to which the

property is to be set.