ReportingService2010.PrepareQuery Method

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

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

Syntax

'Declaration
<SoapHeaderAttribute("TrustedUserHeaderValue")> _
<SoapHeaderAttribute("ServerInfoHeaderValue", Direction := SoapHeaderDirection.Out)> _
<SoapDocumentMethodAttribute("https://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer/PrepareQuery", RequestNamespace := "https://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer",  _
    ResponseNamespace := "https://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer",  _
    Use := SoapBindingUse.Literal, ParameterStyle := SoapParameterStyle.Wrapped)> _
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 ReportingService2010 
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)

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

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

[<SoapHeaderAttribute("TrustedUserHeaderValue")>]
[<SoapHeaderAttribute("ServerInfoHeaderValue", Direction = SoapHeaderDirection.Out)>]
[<SoapDocumentMethodAttribute("https://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer/PrepareQuery", RequestNamespace = "https://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer", 
    ResponseNamespace = "https://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer", 
    Use = SoapBindingUse.Literal, ParameterStyle = SoapParameterStyle.Wrapped)>]
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

• DataSource
  Type: ReportService2010.DataSource
  The data source for the delivery query. This can be a shared data source or a model.

• DataSet
  Type: ReportService2010.DataSetDefinition
  The dataset that contains the delivery query and fields for a data-driven subscription.

• Changed
  Type: System.Boolean%
  [out] A Boolean value that indicates whether the dataset that was passed to the method differs from the one returned by the method. Use this property to determine whether the input dataset differs 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: ReportService2010.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 Header Usage	(In) TrustedUserHeaderValue (Out) ServerInfoHeaderValue
Native Mode Required Permissions	Depends on the item type: DataSource: ReadProperties Model: ReadProperties
SharePoint Mode Required Permissions	ViewListItems on DataSource

See Also

Reference

ReportingService2010 Class

ReportService2010 Namespace