BuildWebService.QueryBuildsByUri Method

Queries builds by URI instead of by path with the provided options. A single [BuildQueryResult] objects 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.Compatibility
Assembly:  Microsoft.TeamFoundation.Build.Server (in Microsoft.TeamFoundation.Build.Server.dll)

Syntax

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

[ClientServiceMethodAttribute(AsyncPattern = true, SyncPattern = true)]
[WebMethodAttribute]
public BuildQueryResult2010 QueryBuildsByUri(
    string[] uris,
    string[] informationTypes,
    QueryOptions2010 options,
    QueryDeletedOption2010 deletedOption
)

[ClientServiceMethodAttribute(AsyncPattern = true, SyncPattern = true)]
[WebMethodAttribute]
public:
BuildQueryResult2010^ QueryBuildsByUri(
    array<String^>^ uris, 
    array<String^>^ informationTypes, 
    QueryOptions2010 options, 
    QueryDeletedOption2010 deletedOption
)

[<ClientServiceMethodAttribute(AsyncPattern = true, SyncPattern = true)>]
[<WebMethodAttribute>]
member QueryBuildsByUri : 
        uris:string[] * 
        informationTypes:string[] * 
        options:QueryOptions2010 * 
        deletedOption:QueryDeletedOption2010 -> BuildQueryResult2010

public function QueryBuildsByUri(
    uris : String[], 
    informationTypes : String[], 
    options : QueryOptions2010, 
    deletedOption : QueryDeletedOption2010
) : BuildQueryResult2010

Parameters

• uris
  Type: array<System.String[]

  An array of URIs to query.

• informationTypes
  Type: array<System.String[]

• options
  Type: Microsoft.TeamFoundation.Build.Server.Compatibility.QueryOptions2010

  A mask of options to use in the query.

• deletedOption
  Type: Microsoft.TeamFoundation.Build.Server.Compatibility.QueryDeletedOption2010

Return Value

Type: Microsoft.TeamFoundation.Build.Server.Compatibility.BuildQueryResult2010
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

BuildWebService Class

Microsoft.TeamFoundation.Build.Server.Compatibility Namespace