TeamFoundationVersionControlService.QueryLabels Method (TeamFoundationRequestContext, String, String, String, String, String, String, VersionSpec, Boolean, Boolean)

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

public:
TeamFoundationDataReader^ QueryLabels(
    TeamFoundationRequestContext^ requestContext, 
    String^ workspaceName, 
    String^ workspaceOwner, 
    String^ labelName, 
    String^ labelScope, 
    String^ owner, 
    String^ filterItem, 
    VersionSpec^ versionFilterItem, 
    bool includeItems, 
    bool generateDownloadUrls
)

member QueryLabels : 
        requestContext:TeamFoundationRequestContext * 
        workspaceName:string * 
        workspaceOwner:string * 
        labelName:string * 
        labelScope:string * 
        owner:string * 
        filterItem:string * 
        versionFilterItem:VersionSpec * 
        includeItems:bool * 
        generateDownloadUrls:bool -> TeamFoundationDataReader

public function QueryLabels(
    requestContext : TeamFoundationRequestContext, 
    workspaceName : String, 
    workspaceOwner : String, 
    labelName : String, 
    labelScope : String, 
    owner : String, 
    filterItem : String, 
    versionFilterItem : VersionSpec, 
    includeItems : boolean, 
    generateDownloadUrls : boolean
) : TeamFoundationDataReader

Parameters

• requestContext
  Type: Microsoft.TeamFoundation.Framework.Server.TeamFoundationRequestContext

  The request context.

• workspaceName
  Type: System.String

• workspaceOwner
  Type: System.String

• labelName
  Type: System.String

  Name of label or wildcard to match it.

• labelScope
  Type: System.String

  Item specifying scope of label. All labels at or under item are returned.

• owner
  Type: System.String

  Owner of label.

• filterItem
  Type: System.String

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

• versionFilterItem
  Type: Microsoft.TeamFoundation.VersionControl.Server.VersionSpec

  Versionspec for filterItem. Ignored if filterItem is null.

• includeItems
  Type: System.Boolean

  If true, the returned VersionControlLabel objects Items member will be populated.

• generateDownloadUrls
  Type: System.Boolean

  If true, the server will include the information that is required to download files. Only set this to true if you will be downloading the files that use the objects that are returned. The call will be faster and require less bandwidth when this parameter is false (default for overloads that do not specify it).

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.

See Also

Reference

TeamFoundationVersionControlService Class

QueryLabels Overload

Microsoft.TeamFoundation.VersionControl.Server Namespace