Share via

  • Article

ReportingService2005.PrepareQuery Method

Returns a dataset containing the fields retrieved by the delivery query for a data-driven subscription.

Namespace:  ReportService2005
Assembly:  ReportService2005 (in ReportService2005.dll)

Syntax

'Declaration
<SoapDocumentMethodAttribute("https://schemas.microsoft.com/sqlserver/2005/06/30/reporting/reportingservices/PrepareQuery", RequestNamespace := "https://schemas.microsoft.com/sqlserver/2005/06/30/reporting/reportingservices",  _
    ResponseNamespace := "https://schemas.microsoft.com/sqlserver/2005/06/30/reporting/reportingservices",  _
    Use := SoapBindingUse.Literal, ParameterStyle := SoapParameterStyle.Wrapped)> _
<SoapHeaderAttribute("ServerInfoHeaderValue", Direction := SoapHeaderDirection.Out)> _
<SoapHeaderAttribute("BatchHeaderValue")> _
Public Function PrepareQuery ( _
    DataSource As DataSource, _
    DataSet As DataSetDefinition, _
    <OutAttribute> ByRef Changed As Boolean, _
    <OutAttribute> ByRef ParameterNames As String() _
) As DataSetDefinition
'Usage
Dim instance As ReportingService2005
Dim DataSource As DataSource
Dim DataSet As DataSetDefinition
Dim Changed As Boolean
Dim ParameterNames As String()
Dim returnValue As DataSetDefinition

returnValue = instance.PrepareQuery(DataSource, _
    DataSet, Changed, ParameterNames)

[SoapDocumentMethodAttribute("https://schemas.microsoft.com/sqlserver/2005/06/30/reporting/reportingservices/PrepareQuery", RequestNamespace = "https://schemas.microsoft.com/sqlserver/2005/06/30/reporting/reportingservices", 
    ResponseNamespace = "https://schemas.microsoft.com/sqlserver/2005/06/30/reporting/reportingservices", 
    Use = SoapBindingUse.Literal, ParameterStyle = SoapParameterStyle.Wrapped)]
[SoapHeaderAttribute("ServerInfoHeaderValue", Direction = SoapHeaderDirection.Out)]
[SoapHeaderAttribute("BatchHeaderValue")]
public DataSetDefinition PrepareQuery(
    DataSource DataSource,
    DataSetDefinition DataSet,
    out bool Changed,
    out string[] ParameterNames
)

[SoapDocumentMethodAttribute(L"https://schemas.microsoft.com/sqlserver/2005/06/30/reporting/reportingservices/PrepareQuery", RequestNamespace = L"https://schemas.microsoft.com/sqlserver/2005/06/30/reporting/reportingservices", 
    ResponseNamespace = L"https://schemas.microsoft.com/sqlserver/2005/06/30/reporting/reportingservices", 
    Use = SoapBindingUse::Literal, ParameterStyle = SoapParameterStyle::Wrapped)]
[SoapHeaderAttribute(L"ServerInfoHeaderValue", Direction = SoapHeaderDirection::Out)]
[SoapHeaderAttribute(L"BatchHeaderValue")]
public:
DataSetDefinition^ PrepareQuery(
    DataSource^ DataSource, 
    DataSetDefinition^ DataSet, 
    [OutAttribute] bool% Changed, 
    [OutAttribute] array<String^>^% ParameterNames
)

[<SoapDocumentMethodAttribute("https://schemas.microsoft.com/sqlserver/2005/06/30/reporting/reportingservices/PrepareQuery", RequestNamespace = "https://schemas.microsoft.com/sqlserver/2005/06/30/reporting/reportingservices", 
    ResponseNamespace = "https://schemas.microsoft.com/sqlserver/2005/06/30/reporting/reportingservices", 
    Use = SoapBindingUse.Literal, ParameterStyle = SoapParameterStyle.Wrapped)>]
[<SoapHeaderAttribute("ServerInfoHeaderValue", Direction = SoapHeaderDirection.Out)>]
[<SoapHeaderAttribute("BatchHeaderValue")>]
member PrepareQuery : 
        DataSource:DataSource * 
        DataSet:DataSetDefinition * 
        Changed:bool byref * 
        ParameterNames:string[] byref -> DataSetDefinition 

public function PrepareQuery(
    DataSource : DataSource, 
    DataSet : DataSetDefinition, 
    Changed : boolean, 
    ParameterNames : String[]
) : DataSetDefinition

Parameters

  • Changed
    Type: System.Boolean%
    [out] A Boolean value that indicates whether the dataset that was passed to the method is different from the one returned by the method. Use this property to determine whether the input dataset is different from the output dataset.
  • ParameterNames
    Type: array<System.String[]%
    [out] The names of the query parameters used in the underlying semantic query. This out parameter is only used when the DataSource references a model.

Return Value

Type: ReportService2005.DataSetDefinition
A DataSetDefinition object that contains the fields and the delivery query that are retrieved from the given data source.

Remarks

The table below shows header and permissions information on this operation.

SOAP Headers

(In) BatchHeaderValue

(Out) ServerInfoHeaderValue

Required Permissions

Depends on the item type:

Pass the DataSetDefinition object that is returned by the PrepareQuery method as input to the CreateDataDrivenSubscription and SetDataDrivenSubscriptionProperties methods.

The delivery query returns a set of fields that can be mapped to report parameter values and delivery extension settings for data-driven subscriptions. Each row in the result set contains values for a single recipient, such as an e-mail address to which the report is delivered.

The delivery query must be valid for one of the data processing extensions that are installed on the report server. For more information, see Data Processing Extensions Overview.