Version_comment, Version_comment 49 – Kofax DM API User Manual

Page 518

Advertising
background image

498 C

HAPTER

5

%VERSION_COMMENT

%VERSION_COMMENT

This token allows you to specify the comment for the document
version.

Syntax

PCDDocObject.SetProperty(“%VERSION_COMMENT”, _

strCommentText)

Parameters

Usage

The version comment text is inserted into the

COMMENTS

column of

the

VERSIONS

table for the specified document version.

Example

'Create a document object.

Set pObj = CreateObject("PCDClient.PCDDocObject")


'Set the DM security token.

pObj.SetDST(strDST)


'Set the object (form) type.

pObj.SetObjectType(“NewDocProfileForm”)


'Set the comment for this document version.

pObj.SetProperty("%VERSION_ COMMENT", _

“Operating Plan, Final Version”)


'Perform the update.

pObj.Update

Related Items

See the

PCDDocObject

object.

%VERSION_COMMENT

The token that indicates the comment
for this version is being set.

strCommentText

A string variable (or literal text in double
quotes) that contains the comment for
the specified document version.

Advertising