This documentation is archived and is not being maintained.

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

Queries for a list of labels applied to items in the database.

Namespace: Microsoft.TeamFoundation.VersionControl.Client
Assembly: Microsoft.TeamFoundation.VersionControl.Client (in microsoft.teamfoundation.versioncontrol.client.dll)

public VersionControlLabel[] QueryLabels (
	string labelName,
	string labelScope,
	string owner,
	bool includeItems,
	string filterItem,
	VersionSpec versionFilterItem
public VersionControlLabel[] QueryLabels (
	String labelName, 
	String labelScope, 
	String owner, 
	boolean includeItems, 
	String filterItem, 
	VersionSpec versionFilterItem
public function QueryLabels (
	labelName : String, 
	labelScope : String, 
	owner : String, 
	includeItems : boolean, 
	filterItem : String, 
	versionFilterItem : VersionSpec
) : VersionControlLabel[]



The name of the label being queried.


The database path that indicates the scope at which the label is defined.


The person who created the label. This option can be a null reference (Nothing in Visual Basic) to match all owners.


If true, the items in the labels will be included.


If not-a null reference (Nothing in Visual Basic), only returns labels that contain this item from the server path or local path.


VersionSpec for filterItem. Ignored if filterItem is a null reference (Nothing in Visual Basic).

Return Value

The label information for each label selected by the query.