Make_read_only – Kofax DM API User Manual

Page 427

Advertising
background image

DM API T

OKENS

407

%MAKE_READ_ONLY

5 Set the

%OBJECT_IDENTIFIER

token equal to the document

number of the item that is to be made read only.

6 If working with a document, set the

%STATUS

token equal to

%MAKE_READ_ONLY

, indicating that you want to make this

document read only.

If working with a document version, set the

%VERSION_DIRECTIVE

token equal to

%MAKE_READ_ONLY

,

indicating that you want to make this version read only.

7 Execute the

Update

method.

The

%MakeReadOnly

token returns

SUCCESS

if the document was

made read only. If the user does not have sufficient security rights to
make the document or version read only, then a

PCD_ERR_INSUFFICIENT_RIGHTS

error is returned.

Example

See the

%STATUS

example on page 472

.

See the %VERSION_DIRECTIVE

example on page 500

.

Related Items

See the

PCDDocObject

object.

See the

SetProperty

method.

See the following tokens:

%STATUS

%REMOVE_READ_ONLY

%VERSION_DIRECTIVE

Advertising