ReportingService2005.PrepareQuery Method

Article
12/03/2008

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

Namespace: Microsoft.WSSUX.ReportingServicesWebService.RSManagementService2005
Assembly: ReportService2005 (in reportingservice2005.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

[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
)

/** @attribute 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) */ 
/** @attribute SoapHeaderAttribute("ServerInfoHeaderValue", Direction=SoapHeaderDirection.Out) */ 
/** @attribute SoapHeaderAttribute("BatchHeaderValue") */ 
public DataSetDefinition PrepareQuery (
    DataSource DataSource, 
    DataSetDefinition DataSet, 
    /** @attribute OutAttribute() */ /** @ref */ boolean Changed, 
    /** @attribute OutAttribute() */ /** @ref */ String[] ParameterNames
)

JScript does not support passing value-type arguments by reference.

Parameters

DataSource
The data source for the delivery query.

DataSet
The dataset containing the delivery query and fields for a data-driven subscription.

Changed
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
A parameters element that provides information about parameters in the query. This argument is only used when the DataSource references a model.

Return Value

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

Remarks

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 Introducing Data Processing Extensions.

Thread Safety

Any public static (Shared in Microsoft Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms

Development Platforms

For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.

Target Platforms