TeamFoundationVersionControlService.LabelItem Method (TeamFoundationRequestContext, String, String, VersionControlLabel, array<LabelItemSpec , LabelChildOption, PathLength)

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
Public Function LabelItem ( _
    requestContext As TeamFoundationRequestContext, _
    workspaceName As String, _
    workspaceOwner As String, _
    label As VersionControlLabel, _
    labelSpecs As LabelItemSpec(), _
    children As LabelChildOption, _
    maxClientPathLength As PathLength _
) As TeamFoundationDataReader

public TeamFoundationDataReader LabelItem(
    TeamFoundationRequestContext requestContext,
    string workspaceName,
    string workspaceOwner,
    VersionControlLabel label,
    LabelItemSpec[] labelSpecs,
    LabelChildOption children,
    PathLength maxClientPathLength
)

public:
TeamFoundationDataReader^ LabelItem(
    TeamFoundationRequestContext^ requestContext, 
    String^ workspaceName, 
    String^ workspaceOwner, 
    VersionControlLabel^ label, 
    array<LabelItemSpec^>^ labelSpecs, 
    LabelChildOption children, 
    PathLength maxClientPathLength
)

member LabelItem : 
        requestContext:TeamFoundationRequestContext * 
        workspaceName:string * 
        workspaceOwner:string * 
        label:VersionControlLabel * 
        labelSpecs:LabelItemSpec[] * 
        children:LabelChildOption * 
        maxClientPathLength:PathLength -> TeamFoundationDataReader

public function LabelItem(
    requestContext : TeamFoundationRequestContext, 
    workspaceName : String, 
    workspaceOwner : String, 
    label : VersionControlLabel, 
    labelSpecs : LabelItemSpec[], 
    children : LabelChildOption, 
    maxClientPathLength : PathLength
) : TeamFoundationDataReader

Parameters

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

  The request context

• 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: 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 and their associated actions Failure[] - List of failures encountered while 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

LabelItem Overload

Microsoft.TeamFoundation.VersionControl.Server Namespace