This documentation is archived and is not being maintained.

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

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[]


Type: System.String

The name of the label being queried.

Type: System.String

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

Type: System.String

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

Type: System.Boolean

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

Type: System.String

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

Type: Microsoft.TeamFoundation.VersionControl.Client.VersionSpec

VersionSpec for filterItem. Ignored if filterItem is null.

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).