This documentation is archived and is not being maintained.
VersionControlServer.QueryLabels Method (String, String, String, Boolean, String, VersionSpec, Boolean)
Visual Studio 2013
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)
'Declaration Public Function QueryLabels ( _ labelName As String, _ labelScope As String, _ owner As String, _ includeItems As Boolean, _ filterItem As String, _ versionFilterItem As VersionSpec, _ includeDownloadInfo As Boolean _ ) As 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.
- Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.
Show: