Share via


UpdateWorkspaceParameters Class

An UpdateWorkspaceParameters object encapsulates all the information that is required to call Workspace.Update.

Inheritance Hierarchy

System.Object
  Microsoft.TeamFoundation.VersionControl.Client.UpdateWorkspaceParameters

Namespace:  Microsoft.TeamFoundation.VersionControl.Client
Assembly:  Microsoft.TeamFoundation.VersionControl.Client (in Microsoft.TeamFoundation.VersionControl.Client.dll)

Syntax

'Declaration
Public Class UpdateWorkspaceParameters
public class UpdateWorkspaceParameters
public ref class UpdateWorkspaceParameters
type UpdateWorkspaceParameters =  class end
public class UpdateWorkspaceParameters

The UpdateWorkspaceParameters type exposes the following members.

Constructors

  Name Description
Public method UpdateWorkspaceParameters Initializes a new instance of the UpdateWorkspaceParameters class.

Top

Properties

  Name Description
Public property Comment If set, the comment of the workspace will be changed to this value.
Public property Computer If set, the computer name of the workspace will be changed to this value.
Public property Folders If set, the working folders (mappings) of the workspace will be replaced with these working folders.
Public property Location If set, the workspace's location (local or server) will be changed to the value provided. This value may not be changed at the same time as other any other properties of the workspace. It requires its own call to UpdateWorkspace.
Public property OwnerName If set, the owner of the workspace will be changed to this value. The owner of a workspace cannot be changed when the workspace has pending changes.
Public property PermissionProfile If set, the workspace permissions for this workspace will be set to the values in the provided workspace permission profile. A workspace permission profile is a template fo the workspace's access control list.
Public property RemoveUnparentedCloaks If true, any cloaks in the working folders set (this.Folders) which are not parented by a mapping are removed silently. The default value is false.
Public property WorkspaceName If set, the name of the workspace will be changed to this value.
Public property WorkspaceOptions If set, the options for the workspace are replaced with these options.

Top

Methods

  Name Description
Public method Equals Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method ToString Returns a string that represents the current object. (Inherited from Object.)

Top

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Reference

Microsoft.TeamFoundation.VersionControl.Client Namespace