beautypg.com

Checkout_comment – Kofax DM API User Manual

Page 325

background image

DM API T

OKENS

305

%CHECKOUT_COMMENT

%CHECKOUT_COMMENT

This token is used in the

Update

method that the

PCDDocObject

object supports to specify the checkout comment when an object is
being checked out or locked.

Syntax

PCDDocObject.SetProperty( _

“%CHECKOUT_COMMENT”, strComment)

Parameters

Example

pDocObject = CreateObject("PCDClient.PCDDocObject.1")


'Set the comment, if any.

If ( comment.length > 0 ) Then

pDocObject.SetProperty( "%CHECKOUT_COMMENT", comment )

End If

Related Items

See the

PCDDocObject

object.

See the

SetProperty

method.

See the following tokens:

%CHECKIN_DATE

%ELAPSED_TIME

%CHECKOUT_COMMENT

The token identifier that indicates a
check-out comment is being set.

strComment

A string variable that contains the check-
out comment.