Workspace Object
A workspace is a repository object that can provide a context for your work that is separate from other work occurring in the repository. A workspace is a subset of a larger, shared repository. Within a workspace, you can have only one version of any given repository object at a time.
When to Use
Use the Workspace object to control the contents of a workspace.
Properties
| Property | Description |
|---|---|
| CheckedOutToWorkspace | Always null, because a workspace cannot be contained in or checked out to another workspace.
This property is not a default interface member. |
| Interface | The specified object interface.
This property is not a default interface member. |
| InternalID | The internal object identifier of the workspace.
This property is not a default interface member. |
| IsCheckedOut | Always FALSE, because a workspace cannot be present in (or checked out to) another workspace.
This property is not a default interface member. |
| IsFrozen | Always FALSE, because you cannot freeze a workspace.
This property is not a default interface member. |
| Name | The name of the workspace.
This property is not a default interface member. |
| Object | A property used to retrieve a particular repository object.
This property is not a default interface member. |
| ObjectID | The object identifier of the workspace.
This property is not a default interface member. |
| MajorDBVersion | The major version number of the first repository engine version that introduced this database format.
This property is not a default interface member. |
| MinorDBVersion | The minor version number of the first repository engine version that introduced this database format.
This property is not a default interface member. |
| PredecessorCreationVersion | Always null, because each workspace has only one version.
This property is not a default interface member. |
| Repository | The open repository instance through which this workspace was instantiated.
This property is not a default interface member. |
| ResolutionType | Always LATEST_VERSION, because each workspace has only one version.
This property is not a default interface member. |
| RootObject | The root repository object of the open repository.
This property is not a default interface member. |
| Transaction | The transaction-processing interface.
This property is not a default interface member. |
| Type | An object identifier of the type to which this workspace conforms. The property is always the object identifier of the workspace definition object of the Repository Type Information Model (RTIM).
This property is not a default interface member. |
| Version | Retrieves the specified object version.
This property is not a default interface member. |
| VersionID | The object-version identifier of the workspace.
This property is not a default interface member. |
| VersionInternalID | The internal object-version identifier of the workspace. |
Methods
| Method | Description |
|---|---|
| Checkin | Returns an error, because a workspace cannot be present in (or checked out to) another workspace.
This method is not a default interface member. |
| Checkout | Returns an error, because a workspace cannot be present in (or checked out to) another workspace.
This method is not a default interface member. |
| Create | Returns an error, because you cannot create a new repository database from within a workspace.
This method is not a default interface member. |
| CreateObject | Creates a new repository object in the open repository.
This method is not a default interface member. |
| CreateVersion | Returns an error, because each workspace has only one version.
This method is not a default interface member. |
| Delete | Deletes a workspace.
This method is not a default interface member. |
| FreezeVersion | Returns an error, because you cannot freeze a workspace.
This method is not a default interface member. |
| InternalIDToObjectID | Converts an internal identifier into an object identifier. |
| InternalIDToVersionID | Converts an internal object-version identifier into an object-version identifier.
This method is not a default interface member. |
| Lock | Locks the workspace.
This method is not a default interface member. |
| MergeVersion | Returns an error, because each workspace has only one version.
This method is not a default interface member. |
| ObjectIDToInternalID | Converts an object identifier into an internal identifier.
This method is not a default interface member. |
| Open | Returns an error, because you cannot open a new repository database from within a workspace.
This method is not a default interface member. |
| Refresh | Supports backward compatibility of the Refresh method. This method is not used.
This method is not a default interface member. |
| Refresh (from IRepositoryObjectVersion) | Supports backward compatibility of the Refresh method. This method is not used.
This method is not a default interface member. |
| VersionIDToInternalID | Converts an object-version identifier into an internal object-version identifier.
This method is not a default interface member. |
Collections
| Collection | Description |
|---|---|
| Checkouts | The collection of object versions checked out to the workspace. |
| Containers | A collection that contains this workspace. The collection has only one item, the root object.
This collection is not a default interface member. |
| Contents | The collection of object versions present in the workspace. |
| ObjectVersions | The collection of all the versions of the repository object representing the workspace. It always contains one item, because you cannot invoke CreateVersion on a workspace.
This collection is not a default interface member. |
| PredecessorVersions | Always null, because you cannot invoke CreateVersion on a workspace.
This collection is not a default interface member. |
| Properties | The collection of all properties that are attached to the workspace. |
| SuccessorVersions | Always null, because you cannot invoke CreateVersion on a workspace.
This collection is not a default interface member. |
| Workspaces | Always null, because a workspace cannot be contained in other workspaces.
This collection is not a default interface member. |