Repository5.LabelItem Method

Creates or updates a label. Associates the given versions of the given items.

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

Syntax

'Declaration
<WebMethodAttribute> _
Public Function LabelItem ( _
    workspaceName As String, _
    workspaceOwner As String, _
    label As VersionControlLabel, _
    labelSpecs As LabelItemSpec(), _
    children As LabelChildOption, _
    maxClientPathLength As Integer, _
    <OutAttribute> ByRef failures As List(Of Failure) _
) As List(Of LabelResult)

[WebMethodAttribute]
public List<LabelResult> LabelItem(
    string workspaceName,
    string workspaceOwner,
    VersionControlLabel label,
    LabelItemSpec[] labelSpecs,
    LabelChildOption children,
    int maxClientPathLength,
    out List<Failure> failures
)

[WebMethodAttribute]
public:
List<LabelResult^>^ LabelItem(
    String^ workspaceName, 
    String^ workspaceOwner, 
    VersionControlLabel^ label, 
    array<LabelItemSpec^>^ labelSpecs, 
    LabelChildOption children, 
    int maxClientPathLength, 
    [OutAttribute] List<Failure^>^% failures
)

[<WebMethodAttribute>]
member LabelItem : 
        workspaceName:string * 
        workspaceOwner:string * 
        label:VersionControlLabel * 
        labelSpecs:LabelItemSpec[] * 
        children:LabelChildOption * 
        maxClientPathLength:int * 
        failures:List<Failure> byref -> List<LabelResult> 

public function LabelItem(
    workspaceName : String, 
    workspaceOwner : String, 
    label : VersionControlLabel, 
    labelSpecs : LabelItemSpec[], 
    children : LabelChildOption, 
    maxClientPathLength : int, 
    failures : List<Failure>
) : List<LabelResult>

Parameters

• workspaceName
  Type: System.String

  Name of workspace if itemSpecs are local.

• workspaceOwner
  Type: System.String

  Owner of workspace if itemSpecs are local.

• label
  Type: Microsoft.TeamFoundation.VersionControl.Server.VersionControlLabel

  Object containing label meta-data. Only Name, Comment, and Category are used.

• labelSpecs
  Type: array<Microsoft.TeamFoundation.VersionControl.Server.LabelItemSpec[]

  Items to add to the label.

• children
  Type: Microsoft.TeamFoundation.VersionControl.Server.LabelChildOption

  Determines how child labels are to be handled.

• maxClientPathLength
  Type: System.Int32

  The maximum client supported server path length.

• failures
  Type: System.Collections.Generic.List<Failure>%

  List of failures encountered while expanding itemSpecs.

Return Value

Type: System.Collections.Generic.List<LabelResult>
List of labels and their associated actions.

.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

Repository5 Class

Microsoft.TeamFoundation.VersionControl.Server Namespace