Kofax DM API - Manual (Page 478)

458 C HAPTER 5
%REMOVE_READ_ONLY
RemoveReadOnly Document Token
Use the RemoveReadOnly Document token to remove the read-only
setting from a document. PH Note: Merge this text into the main
discussion of the %REMOVE_READ_ONLY token.
Returns
The RemoveReadOnly Document method returns SUCCESS if the
document was set so it is not read only. This allows the document to be
modified. If the user does not have sufficient security rights to remove
any read-only setting, then a
PCD_ERR_INSUFFICIENT_RIGHTS error
will be returned.
Usage
To make a document version read only, follow the following steps:
1 Create a PCDClient.PCDDocObject .
2 Set the object type to whatever value is appropriate.
3 Set the DM security token (DST).
4 Set the %TARGET_LIBRARY token equal to the library name.
5 Set the %OBJECT_IDENTIFIER token equal to the document
number of the document version that is to have its read-only
setting removed.
6 Set the %STATUS token equal to %REMOVE_READ_ONLY , indicating
that you want to remove the read-only setting for this document.
7 Execute the Update method.
Related Items
See the PCDDocObject object.
See the following methods:
%MAKE_READ_ONLY
%REMOVE_READ_ONLY