• Article

ReportExecutionService.LoadReportDefinition Method

Creates a report execution from a report definition supplied by the client.

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

Syntax

'Declaration
<SoapHeaderAttribute("TrustedUserHeaderValue")> _
<SoapDocumentMethodAttribute("https://schemas.microsoft.com/sqlserver/2005/06/30/reporting/reportingservices/LoadReportDefinition", 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("ExecutionHeaderValue", Direction := SoapHeaderDirection.Out)> _
Public Function LoadReportDefinition ( _
    Definition As Byte(), _
    <OutAttribute> ByRef warnings As Warning() _
) As ExecutionInfo
'Usage
Dim instance As ReportExecutionService
Dim Definition As Byte()
Dim warnings As Warning()
Dim returnValue As ExecutionInfo

returnValue = instance.LoadReportDefinition(Definition, _
    warnings)

[SoapHeaderAttribute("TrustedUserHeaderValue")]
[SoapDocumentMethodAttribute("https://schemas.microsoft.com/sqlserver/2005/06/30/reporting/reportingservices/LoadReportDefinition", 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("ExecutionHeaderValue", Direction = SoapHeaderDirection.Out)]
public ExecutionInfo LoadReportDefinition(
    byte[] Definition,
    out Warning[] warnings
)

[SoapHeaderAttribute(L"TrustedUserHeaderValue")]
[SoapDocumentMethodAttribute(L"https://schemas.microsoft.com/sqlserver/2005/06/30/reporting/reportingservices/LoadReportDefinition", 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"ExecutionHeaderValue", Direction = SoapHeaderDirection::Out)]
public:
ExecutionInfo^ LoadReportDefinition(
    array<unsigned char>^ Definition, 
    [OutAttribute] array<Warning^>^% warnings
)

[<SoapHeaderAttribute("TrustedUserHeaderValue")>]
[<SoapDocumentMethodAttribute("https://schemas.microsoft.com/sqlserver/2005/06/30/reporting/reportingservices/LoadReportDefinition", 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("ExecutionHeaderValue", Direction = SoapHeaderDirection.Out)>]
member LoadReportDefinition : 
        Definition:byte[] * 
        warnings:Warning[] byref -> ExecutionInfo 

public function LoadReportDefinition(
    Definition : byte[], 
    warnings : Warning[]
) : ExecutionInfo

Parameters

  • Definition
    Type: array<System.Byte[]
    A byte stream containing the Report Definition Language (RDL) for the report.

Return Value

Type: ReportExecution2005.ExecutionInfo
An ExecutionInfo object containing information for the report execution.

Remarks

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

SOAP Header Usage

(In) TrustedUserHeaderValue

(Out) ExecutionHeaderValue

(Out) ServerInfoHeaderValue

Native Mode Required Permissions

ReadProperties on all subreports AND ExecuteReportDefinition (System)

SharePoint Mode Required Permissions

ViewListItems() on all subreports AND UseRemoteAPIs()

This method should be called prior to calling the Render method for a report.

The returned report execution will need to be processed before it is rendered. A new execution is created and the ExecutionInfo is returned with a new ExecutionID value.

Reports instantiated with the LoadReportDefinition method are temporary. They are not represented in the report server namespace, and are discarded when the server session expires.

Reports instantiated with the LoadReportDefinition method are not securable, and may not be shared with other users; the person who created the execution with LoadReportDefinition is the only user who may access them.

Subreports and data source references with relative paths are not supported using this method. However, absolute paths to catalog items can be used.

Examples

Please see Render for an example.