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

  • [アーティクル]

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)

Syntax

'宣言
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()

public VersionControlLabel[] QueryLabels(
    string labelName,
    string labelScope,
    string owner,
    bool includeItems,
    string filterItem,
    VersionSpec versionFilterItem,
    bool includeDownloadInfo
)

public:
array<VersionControlLabel^>^ QueryLabels(
    String^ labelName, 
    String^ labelScope, 
    String^ owner, 
    bool includeItems, 
    String^ filterItem, 
    VersionSpec^ versionFilterItem, 
    bool includeDownloadInfo
)

member QueryLabels : 
        labelName:string * 
        labelScope:string * 
        owner:string * 
        includeItems:bool * 
        filterItem:string * 
        versionFilterItem:VersionSpec * 
        includeDownloadInfo:bool -> VersionControlLabel[] 

public function QueryLabels(
    labelName : String, 
    labelScope : String, 
    owner : String, 
    includeItems : boolean, 
    filterItem : String, 
    versionFilterItem : VersionSpec, 
    includeDownloadInfo : boolean
) : 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).
  • includeDownloadInfo
    Type: System.Boolean
    True to get the information needed to download files. Specify false to save bandwidth if not necessary.

Return Value

Type: array<Microsoft.TeamFoundation.VersionControl.Client.VersionControlLabel[]
An array of VersionControlLabel objects applied to items in the repository.

Remarks

Only set includeDownloadInfo 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 includeDownloadInfo is false (default for overloads that don't specify it).

.NET Framework Security

See Also

Reference

VersionControlServer Class

QueryLabels Overload

Microsoft.TeamFoundation.VersionControl.Client Namespace