Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

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

[This documentation is for preview only, and is subject to change in later releases. Blank topics are included as placeholders.]

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)
public function QueryLabels(
	labelName : String, 
	labelScope : String, 
	owner : String, 
	includeItems : boolean, 
	filterItem : String, 
	versionFilterItem : VersionSpec, 
	includeDownloadInfo : boolean
) : 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.

includeDownloadInfo
Type: System.Boolean

True to get the information needed to download files. Specify false to save bandwidth if not necessary.

Return Value

Type: Microsoft.TeamFoundation.VersionControl.Client.VersionControlLabel[]
An array of VersionControlLabel objects applied to items in the repository.

Only set includeDownloadInfo to true if you are going to be downloading the files using the objects that are returned. The call will be faster and require less bandwidth when includeDownloadInfo is false (default for overloads that don't specify it).

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.