VersionControlServer.QueryLabels Method (String, String, String, Boolean)

Gets a list of labels matching the specified filter parameters. A label in Team Foundation Server designates a collection of specific versions of files and folders. For example, the label Beta 1 may refer to the files server.cs, client.cs, om.cs, and command.cs as they were on March 3, and the file server.cs as it was on March 5. Internally, the label Beta 1 is stored as "server.cs version 12, client.cs version 26" and continues in this pattern. When you apply a label, it does not freeze development, but it does allow you to rebuild your project at a designated point in the past. Every label has a scope, and its name must be unique within that scope. Most commonly a label is scoped by Team Project. This means that within a given Team Project, there can be only one label called Beta 1. However, you can choose to scope a label at a lower level. If Beta 1 is scoped at $/CmdLine/shell, then there can be no other label called Beta 1 in $/CmdLine/shell or any folder below it; however, $/CmdLine/parser may use the same label.

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


Public Function QueryLabels ( _
    labelName As String, _
    labelScope As String, _
    owner As String, _
    includeItems As Boolean _
) As VersionControlLabel()
Dim instance As VersionControlServer 
Dim labelName As String 
Dim labelScope As String 
Dim owner As String 
Dim includeItems As Boolean 
Dim returnValue As VersionControlLabel()

returnValue = instance.QueryLabels(labelName, _
    labelScope, owner, includeItems)
public VersionControlLabel[] QueryLabels(
    string labelName,
    string labelScope,
    string owner,
    bool includeItems
array<VersionControlLabel^>^ QueryLabels(
    String^ labelName, 
    String^ labelScope, 
    String^ owner, 
    bool includeItems
public function QueryLabels(
    labelName : String, 
    labelScope : String, 
    owner : String, 
    includeItems : boolean
) : VersionControlLabel[]


  • labelName
    Type: System.String

    The name of the label that you want to query. Wildcards may be used.

    If null is passed, all labels are returned.

  • labelScope
    Type: System.String

    The function will look for labels which are scoped at, or below, this path. If null is passed, labels are returned no matter where they are scoped (this is equivalent to passing in $/).

  • owner
    Type: System.String

    The person who created the label. This option can be null to match all owners.

  • includeItems
    Type: System.Boolean

    If this parameter is set to false, the Items array in the VersionControlLabel objects will be left empty, only metadata about the label itself will be returned. If this parameter is set to true, the function will return information about each item within the label.

Return Value

Type: array<Microsoft.TeamFoundation.VersionControl.Client.VersionControlLabel[]
A VersionControlLabel object that contains the label information for each label selected by the query.

.NET Framework Security

See Also


VersionControlServer Class

VersionControlServer Members

QueryLabels Overload

Microsoft.TeamFoundation.VersionControl.Client Namespace