SetClassDescVersioningFlag
Purpose
SetClassDescVersioningFlag allows an application to dynamically enable or disable data versioning for a class.
Description
If bVersioningAllowed is false, data versioning will be disabled for the class. If bVersioningAllowed is true and repository versioning is enabled, then data versioning will be enabled for the class, else versioning will be left disabled for the class. bDeleteVersions indicates if existing historical versions for objects in the class should be deleted or retained. The class is specified with the same values as needed for ReadObject.
Disabling versioning can affect the existing objects in the class. If bDeleteVersions is true, all objects in the class will be modified so that all non-published versions are deleted and the remaining versions will be renumbered to version one. This can be a very lengthy operation. If bDeleteVersions is false, all existing versions of data objects in the class will be retained. Any new objects added to the class will be created without support of versioning.
Changing the data versioning support for a class will also change the versioning support for any derived classes that have the class as their base class. A derived class's data versioning support is always the same as that of the base class.
Requirements
The object name or the object ID (internal or globally unique) must be set
Derived classes may not be used with this API.
The caller must have write permission for the class.
Syntax
HRESULT SetClassDescVersioningFlag(
const bool bVersioningAllowed,
const bool bDeleteVersions = false);
|
Argument |
In/Out |
Description |
|
bVersioningAllowed |
in |
Value of versioning support for the class |
|
bDeleteVersions |
in |
Indicates if existing data objects in the class should have their non-published versions deleted. True = delete all non-published versions; false = retain all non-published versions |