TeamFoundationVersionControlService.QueryLabels Method (TeamFoundationRequestContext, String, String, String, String, String, String, VersionSpec, Boolean, Boolean, PathLength)
Returns list of labels matching given fields. Null fields are not used as part of the comparison.
Namespace: Microsoft.TeamFoundation.VersionControl.Server
Assembly: Microsoft.TeamFoundation.VersionControl.Server (in Microsoft.TeamFoundation.VersionControl.Server.dll)
Syntax
'Declaration
Public Function QueryLabels ( _
requestContext As TeamFoundationRequestContext, _
workspaceName As String, _
workspaceOwner As String, _
labelName As String, _
labelScope As String, _
owner As String, _
filterItem As String, _
versionFilterItem As VersionSpec, _
includeItems As Boolean, _
generateDownloadUrls As Boolean, _
maxClientPathLength As PathLength _
) As TeamFoundationDataReader
public TeamFoundationDataReader QueryLabels(
TeamFoundationRequestContext requestContext,
string workspaceName,
string workspaceOwner,
string labelName,
string labelScope,
string owner,
string filterItem,
VersionSpec versionFilterItem,
bool includeItems,
bool generateDownloadUrls,
PathLength maxClientPathLength
)
public:
TeamFoundationDataReader^ QueryLabels(
TeamFoundationRequestContext^ requestContext,
String^ workspaceName,
String^ workspaceOwner,
String^ labelName,
String^ labelScope,
String^ owner,
String^ filterItem,
VersionSpec^ versionFilterItem,
bool includeItems,
bool generateDownloadUrls,
PathLength maxClientPathLength
)
member QueryLabels :
requestContext:TeamFoundationRequestContext *
workspaceName:string *
workspaceOwner:string *
labelName:string *
labelScope:string *
owner:string *
filterItem:string *
versionFilterItem:VersionSpec *
includeItems:bool *
generateDownloadUrls:bool *
maxClientPathLength:PathLength -> TeamFoundationDataReader
public function QueryLabels(
requestContext : TeamFoundationRequestContext,
workspaceName : String,
workspaceOwner : String,
labelName : String,
labelScope : String,
owner : String,
filterItem : String,
versionFilterItem : VersionSpec,
includeItems : boolean,
generateDownloadUrls : boolean,
maxClientPathLength : PathLength
) : TeamFoundationDataReader
Parameters
requestContext
Type: Microsoft.TeamFoundation.Framework.Server.TeamFoundationRequestContextThe request context
- workspaceName
Type: System.String
- workspaceOwner
Type: System.String
labelName
Type: System.StringName of label or wildcard to match it.
labelScope
Type: System.StringItem specifying scope of label. All labels at or below item are returned.
owner
Type: System.StringOwner of label.
filterItem
Type: System.StringIf not-null, only returns labels containing this item (server or local path.)
versionFilterItem
Type: Microsoft.TeamFoundation.VersionControl.Server.VersionSpecVersionspec for filterItem. Ignored if filterItem is null.
includeItems
Type: System.BooleanIf true, the returned VersionControlLabel objects Items member will be populated.
generateDownloadUrls
Type: System.BooleanIf true, the server will include the information needed to download files. Only set this 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 this parameter is false (default for overloads that don't specify it.)
maxClientPathLength
Type: Microsoft.TeamFoundation.VersionControl.Common.PathLengthThe maximum client supported server path length.
Return Value
Type: Microsoft.TeamFoundation.Framework.Server.TeamFoundationDataReader
Array of matching VersionControlLabel objects.
.NET Framework Security
- 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.