Kofax DM API - Manual (Page 476)

456 C HAPTER 5
%REMOVE_READ_ONLY
%REMOVE_READ_ONLY
This token is used in conjunction with the %STATUS and
%VERSION_DIRECTIVE tokens to remove the read-only setting from a
document or a document version. See the %STATUS and
%VERSION_DIRECTIVE token descriptions for further information.
Syntax
PCDDocObject.SetProperty(“%STATUS”, _
“%REMOVE_READ_ONLY”)
PCDDocObject.SetProperty(“%VERSION_DIRECTIVE”, _
“%REMOVE_READ_ONLY”)
Parameters
Returns
The RemoveReadOnly 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 or document version read only, follow the
following steps:
1 Create a PCDClient.PCDDocObject .
%STATUS The token that indicates that this
command statement adjusts the status
of the document.
%VERSION_DIRECTIVE The token that indicates that this
command statement adjusts the
document version settings.
%REMOVE_READ_ONLY The token identifier that indicates that
the DM system should remove the read-
only setting from the specified document
or document version.