This documentation is archived and is not being maintained.

UpdateWorkspaceParameters Class

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


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

public class UpdateWorkspaceParameters

The UpdateWorkspaceParameters type exposes the following members.

Public methodUpdateWorkspaceParametersInitializes a new instance of the UpdateWorkspaceParameters class.

Public propertyCommentIf set, the comment of the workspace will be changed to this value.
Public propertyComputerIf set, the computer name of the workspace will be changed to this value.
Public propertyFoldersIf set, the working folders (mappings) of the workspace will be replaced with these working folders.
Public propertyLocationIf 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 propertyOwnerNameIf 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 propertyPermissionProfileIf 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 propertyRemoveUnparentedCloaksIf 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 propertyWorkspaceNameIf set, the name of the workspace will be changed to this value.
Public propertyWorkspaceOptionsIf set, the options for the workspace are replaced with these options.

Public methodEqualsDetermines whether the specified object is equal to the current object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)

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