BuildWebService4.QueryBuildsByUri Method

Queries builds by URI instead of by path with the provided options. A single BuildQueryResult object is returned from the query, with a BuildDetail list the same length as the input URI array. If a particular URI does not match any builds, then the corresponding index in the resulting BuildDetail list will be null. The amount of data returned from the query is controlled by means of the options parameter.

Namespace:  Microsoft.TeamFoundation.Build.Server
Assembly:  Microsoft.TeamFoundation.Build.Server (in Microsoft.TeamFoundation.Build.Server.dll)

Syntax

'Declaration
<WebMethodAttribute> _
<ClientServiceMethodAttribute(AsyncPattern := True, SyncPattern := True)> _
Public Function QueryBuildsByUri ( _
    uris As String(), _
    informationTypes As String(), _
    options As QueryOptions, _
    deletedOption As QueryDeletedOption _
) As BuildQueryResult

[WebMethodAttribute]
[ClientServiceMethodAttribute(AsyncPattern = true, SyncPattern = true)]
public BuildQueryResult QueryBuildsByUri(
    string[] uris,
    string[] informationTypes,
    QueryOptions options,
    QueryDeletedOption deletedOption
)

[WebMethodAttribute]
[ClientServiceMethodAttribute(AsyncPattern = true, SyncPattern = true)]
public:
BuildQueryResult^ QueryBuildsByUri(
    array<String^>^ uris, 
    array<String^>^ informationTypes, 
    QueryOptions options, 
    QueryDeletedOption deletedOption
)

[<WebMethodAttribute>]
[<ClientServiceMethodAttribute(AsyncPattern = true, SyncPattern = true)>]
member QueryBuildsByUri : 
        uris:string[] * 
        informationTypes:string[] * 
        options:QueryOptions * 
        deletedOption:QueryDeletedOption -> BuildQueryResult

public function QueryBuildsByUri(
    uris : String[], 
    informationTypes : String[], 
    options : QueryOptions, 
    deletedOption : QueryDeletedOption
) : BuildQueryResult

Parameters

• uris
  Type: array<System.String[]

  An array of URIs to query.

• informationTypes
  Type: array<System.String[]

• options
  Type: Microsoft.TeamFoundation.Build.Server.QueryOptions

  A mask of options to use in the query.

• deletedOption
  Type: Microsoft.TeamFoundation.Build.Server.QueryDeletedOption

Return Value

Type: Microsoft.TeamFoundation.Build.Server.BuildQueryResult
A BuildQueryResult object that contains the query results.

.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

BuildWebService4 Class

Microsoft.TeamFoundation.Build.Server Namespace