RepositoryObjectVersion FreezeVersion Method
This method freezes the current RepositoryObjectVersion object.
Syntax
Call object.FreezeVersion
The FreezeVersion method syntax has the following part.
Part | Description |
---|---|
object | An object expression that evaluates to a RepositoryObjectVersion object |
Remarks
To freeze an object version, the object version must be unfrozen. You can only freeze an object version that is contained by a shared repository. You cannot freeze an object version that is checked out to a workspace.
Freezing an object version prevents changes to property values, collection attributes, and versioned relationships. Specifically, you cannot resize or resequence origin collections. Furthermore, you cannot change the versioned relationships of origin collections. That is, you cannot enlarge or shrink a TargetVersions collection of an origin versioned relationship; and you cannot pin or unpin a target object version. However, you can change the name by which the origin object version refers to the target object.
Note Annotational properties are an exception. You can modify the annotational properties of a frozen object version.
The FreezeVersion method fails in the following conditions:
- If you call this method for an item currently checked out to any workspace (including the workspace in which you are working), it returns an error.
- If the to-be-frozen object version includes any nonnull origin collection whose corresponding collection type has the COLLECTION_REQUIRESFREEZE flag set, and that nonnull collection includes an item whose TargetVersions collection contains an unfrozen object version, the method fails.
See Also
RepositoryObjectVersion Object