TeamFoundationVersionControlService.UnlabelItem Method (TeamFoundationRequestContext, String, String, String, String, array<ItemSpec , VersionSpec, PathLength)

Removes the given item(s) from a named label.

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

Syntax

'Declaration
Public Function UnlabelItem ( _
    requestContext As TeamFoundationRequestContext, _
    workspaceName As String, _
    workspaceOwner As String, _
    labelName As String, _
    labelScope As String, _
    items As ItemSpec(), _
    version As VersionSpec, _
    maxClientPathLength As PathLength _
) As TeamFoundationDataReader

public TeamFoundationDataReader UnlabelItem(
    TeamFoundationRequestContext requestContext,
    string workspaceName,
    string workspaceOwner,
    string labelName,
    string labelScope,
    ItemSpec[] items,
    VersionSpec version,
    PathLength maxClientPathLength
)

public:
TeamFoundationDataReader^ UnlabelItem(
    TeamFoundationRequestContext^ requestContext, 
    String^ workspaceName, 
    String^ workspaceOwner, 
    String^ labelName, 
    String^ labelScope, 
    array<ItemSpec^>^ items, 
    VersionSpec^ version, 
    PathLength maxClientPathLength
)

member UnlabelItem : 
        requestContext:TeamFoundationRequestContext * 
        workspaceName:string * 
        workspaceOwner:string * 
        labelName:string * 
        labelScope:string * 
        items:ItemSpec[] * 
        version:VersionSpec * 
        maxClientPathLength:PathLength -> TeamFoundationDataReader

public function UnlabelItem(
    requestContext : TeamFoundationRequestContext, 
    workspaceName : String, 
    workspaceOwner : String, 
    labelName : String, 
    labelScope : String, 
    items : ItemSpec[], 
    version : VersionSpec, 
    maxClientPathLength : PathLength
) : TeamFoundationDataReader

Parameters

• requestContext
  Type: Microsoft.TeamFoundation.Framework.Server.TeamFoundationRequestContext

  The request context.

• workspaceName
  Type: System.String

  Name of workspace if local itemspecs are used.

• workspaceOwner
  Type: System.String

  Owner of workspace if local itemspecs are used.

• labelName
  Type: System.String

  Name of label to remove items from.

• labelScope
  Type: System.String

  The repository path denoting the scope at which the label is defined.

• items
  Type: array<Microsoft.TeamFoundation.VersionControl.Server.ItemSpec[]

  Items to remove.

• version
  Type: Microsoft.TeamFoundation.VersionControl.Server.VersionSpec

  Version specs used to match item names.

• maxClientPathLength
  Type: Microsoft.TeamFoundation.VersionControl.Common.PathLength

  The maximum client supported server path length.

Return Value

Type: Microsoft.TeamFoundation.Framework.Server.TeamFoundationDataReader
TeamFoundationDataReader with results in the following order: LabelResult[] - List of labels affected Failure[] - List of failures encountered expanding itemSpecs.

.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.

See Also

Reference

TeamFoundationVersionControlService Class

UnlabelItem Overload

Microsoft.TeamFoundation.VersionControl.Server Namespace