Kofax DM API - Manual (Page 512)

492 C HAPTER 5
%UNPUBLISH_VERSION
%UNPUBLISH_VERSION
This token is used with the %VERSION_DIRECTIVE token to reset a
previously published document version so it is unpublished. See the
“%VERSION_DIRECTIVE” token on page 500 for further
information.
Syntax
PCDDocObject.SetProperty(“%VERSION_DIRECTIVE”, _
“%UNPUBLISH_VERSION”)
Parameters
Returns
The UnpublishVersion token returns SUCCESS if the document
version had its “published” status removed. If the user does not have
sufficient security rights to remove the published status of a document
version, then a
PCD_ERR_INSUFFICIENT_RIGHTS error will be
returned.
Usage
To remove the published status of a document version, 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.
%VERSION_DIRECTIVE The token that indicates that this
command statement adjusts the
document version settings.
%UNPUBLISH_VERSION The token identifier that indicates that a
document version is being reset so that
it no longer indicates that it has been
published.