Share via


TeamFoundationVersionControlService.DeleteAnnotation Method

Deleting an annotation removes it from the system. This method can be used to remove annotations based on the filter. They are removed based on the name and item/version combination. If a value is specified only instances with this value are removed. If a null value is supplied than all instances of this annotation are removed.

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

Syntax

'Declaration
Public Sub DeleteAnnotation ( _
    requestContext As TeamFoundationRequestContext, _
    annotationName As String, _
    annotatedItem As String, _
    version As Integer, _
    annotationValue As String _
)
public void DeleteAnnotation(
    TeamFoundationRequestContext requestContext,
    string annotationName,
    string annotatedItem,
    int version,
    string annotationValue
)
public:
void DeleteAnnotation(
    TeamFoundationRequestContext^ requestContext, 
    String^ annotationName, 
    String^ annotatedItem, 
    int version, 
    String^ annotationValue
)
member DeleteAnnotation : 
        requestContext:TeamFoundationRequestContext * 
        annotationName:string * 
        annotatedItem:string * 
        version:int * 
        annotationValue:string -> unit
public function DeleteAnnotation(
    requestContext : TeamFoundationRequestContext, 
    annotationName : String, 
    annotatedItem : String, 
    version : int, 
    annotationValue : String
)

Parameters

  • annotationName
    Type: System.String

    Value to match when you delete. NULL will delete all instances of this annotation.

  • annotatedItem
    Type: System.String

    Item this annotation is associated with. NULL means global object.

  • version
    Type: System.Int32

    Version of the item the annotation is associated with.

  • annotationValue
    Type: System.String

    Name of the annotation being deleted.

.NET Framework Security

See Also

Reference

TeamFoundationVersionControlService Class

Microsoft.TeamFoundation.VersionControl.Server Namespace