Repository5.QueryLabels Method

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
<WebMethodAttribute> _
Public Function QueryLabels ( _
    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 Integer _
) As StreamingCollection(Of VersionControlLabel)

[WebMethodAttribute]
public StreamingCollection<VersionControlLabel> QueryLabels(
    string workspaceName,
    string workspaceOwner,
    string labelName,
    string labelScope,
    string owner,
    string filterItem,
    VersionSpec versionFilterItem,
    bool includeItems,
    bool generateDownloadUrls,
    int maxClientPathLength
)

[WebMethodAttribute]
public:
StreamingCollection<VersionControlLabel^>^ QueryLabels(
    String^ workspaceName, 
    String^ workspaceOwner, 
    String^ labelName, 
    String^ labelScope, 
    String^ owner, 
    String^ filterItem, 
    VersionSpec^ versionFilterItem, 
    bool includeItems, 
    bool generateDownloadUrls, 
    int maxClientPathLength
)

[<WebMethodAttribute>]
member QueryLabels : 
        workspaceName:string * 
        workspaceOwner:string * 
        labelName:string * 
        labelScope:string * 
        owner:string * 
        filterItem:string * 
        versionFilterItem:VersionSpec * 
        includeItems:bool * 
        generateDownloadUrls:bool * 
        maxClientPathLength:int -> StreamingCollection<VersionControlLabel> 

public function QueryLabels(
    workspaceName : String, 
    workspaceOwner : String, 
    labelName : String, 
    labelScope : String, 
    owner : String, 
    filterItem : String, 
    versionFilterItem : VersionSpec, 
    includeItems : boolean, 
    generateDownloadUrls : boolean, 
    maxClientPathLength : int
) : StreamingCollection<VersionControlLabel>

Parameters

• 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 below item are returned.

• owner
  Type: System.String

  Owner of label.

• filterItem
  Type: System.String

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

• includeItems
  Type: System.Boolean

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

• generateDownloadUrls
  Type: System.Boolean

• maxClientPathLength
  Type: System.Int32

  The maximum client supported server path length.

Return Value

Type: Microsoft.TeamFoundation.Framework.Server.StreamingCollection<VersionControlLabel>
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

Repository5 Class

Microsoft.TeamFoundation.VersionControl.Server Namespace