This documentation is archived and is not being maintained.

VersionControlServer.DeleteLabel Method

Deletes the label with the specified name and label scope.

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

public LabelResult[] DeleteLabel(
	string labelName,
	string labelScope
)

Parameters

labelName
Type: System.String

The name of the label that you want to delete.

labelScope
Type: System.String

The server path that denotes the scope at which the label is defined.

Return Value

Type: Microsoft.TeamFoundation.VersionControl.Client.LabelResult[]
The returned array will never contain more than one item. (If the passed label matches no items, or multiple items, an exception occurs.) The LabelResult object contains a status that will be set to LabelResultStatus. It will show as deleted if the deletion was successful.

Throws an exception if the delete request failed on the server.

Show: