Kofax DM API - Manual (Page 492)

472 C HAPTER 5
%STATUS
%STATUS
This token is used to change the status of a document. The document
status can be set to one of the following:
• Lock the document, using the %LOCK token.
• Lock the document and check it out to the specified user, by use of
the
%LOCK_FOR_CHECKOUT token.
• Make the document read only using the %MAKE_READ_ONLY
token.
• Remove the read-only setting from the document, using the
%REMOVE_READ_ONLY token.
• Remove the read only status from the document, using the
%UNLOCK token.
Syntax
PCDDocObject.SetProperty(“%STATUS”, strSetting)
Parameters d
Example
'Create a doc object.
pDocObject = CreateObject("PCDClient.PCDDocObject.1")
'Set the DM security token.
pDocObject.SetDST( myDST )
'Set the object (Form) type.
pDocObject.SetObjectType("cyd_defprof")
'Set the object identifier.
%STATUS The token that indicates that this
command statement adjusts the status
of the document.
strSetting A variable that resolves to one of the
settings that the
%STATUS token
supports.