This documentation is archived and is not being maintained.

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

Queries for an array of VersionControlLabel objects applied to items in the repository.

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

member QueryLabels : 
        labelName:string * 
        labelScope:string * 
        owner:string * 
        includeItems:bool * 
        filterItem:string * 
        versionFilterItem:VersionSpec -> VersionControlLabel[] 

Parameters

labelName
Type: System.String

The name of the label being queried.

labelScope
Type: System.String

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

owner
Type: System.String

The user who created the label. Specify null to match all owners.

includeItems
Type: System.Boolean

True to include items in the labels. False to not include.

filterItem
Type: System.String

If not-null, returns only labels containing this item (server or local path).

versionFilterItem
Type: Microsoft.TeamFoundation.VersionControl.Client.VersionSpec

VersionSpec for filterItem. Ignored if filterItem is null.

Return Value

Type: Microsoft.TeamFoundation.VersionControl.Client.VersionControlLabel[]
An array of VersionControlLabel objects resulting from the query.

Show: