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)
Syntax
'Declaration
Public Function DeleteLabel ( _
labelName As String, _
labelScope As String _
) As LabelResult()
'Usage
Dim instance As VersionControlServer
Dim labelName As String
Dim labelScope As String
Dim returnValue As LabelResult()
returnValue = instance.DeleteLabel(labelName, _
labelScope)
public LabelResult[] DeleteLabel(
string labelName,
string labelScope
)
public:
array<LabelResult^>^ DeleteLabel(
String^ labelName,
String^ labelScope
)
public function DeleteLabel(
labelName : String,
labelScope : String
) : LabelResult[]
Parameters
labelName
Type: System.StringThe name of the label that you want to delete.
labelScope
Type: System.StringThe server path that denotes the scope at which the label is defined.
Return Value
Type: array<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.
Remarks
Throws an exception if the delete request failed on the server.
.NET Framework Security
- Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.