ReportExecutionService.LoadReport Method

Loads a report from the report server into a new execution.

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

Syntax

'Declaration
<SoapDocumentMethodAttribute("https://schemas.microsoft.com/sqlserver/2005/06/30/reporting/reportingservices/LoadReport", 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("TrustedUserHeaderValue")> _
<SoapHeaderAttribute("ServerInfoHeaderValue", Direction := SoapHeaderDirection.Out)> _
<SoapHeaderAttribute("ExecutionHeaderValue", Direction := SoapHeaderDirection.Out)> _
Public Function LoadReport ( _
    Report As String, _
    HistoryID As String _
) As ExecutionInfo
'Usage
Dim instance As ReportExecutionService
Dim Report As String
Dim HistoryID As String
Dim returnValue As ExecutionInfo

returnValue = instance.LoadReport(Report, _
    HistoryID)
[SoapDocumentMethodAttribute("https://schemas.microsoft.com/sqlserver/2005/06/30/reporting/reportingservices/LoadReport", 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("TrustedUserHeaderValue")]
[SoapHeaderAttribute("ServerInfoHeaderValue", Direction = SoapHeaderDirection.Out)]
[SoapHeaderAttribute("ExecutionHeaderValue", Direction = SoapHeaderDirection.Out)]
public ExecutionInfo LoadReport(
    string Report,
    string HistoryID
)
[SoapDocumentMethodAttribute(L"https://schemas.microsoft.com/sqlserver/2005/06/30/reporting/reportingservices/LoadReport", 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"TrustedUserHeaderValue")]
[SoapHeaderAttribute(L"ServerInfoHeaderValue", Direction = SoapHeaderDirection::Out)]
[SoapHeaderAttribute(L"ExecutionHeaderValue", Direction = SoapHeaderDirection::Out)]
public:
ExecutionInfo^ LoadReport(
    String^ Report, 
    String^ HistoryID
)
[<SoapDocumentMethodAttribute("https://schemas.microsoft.com/sqlserver/2005/06/30/reporting/reportingservices/LoadReport", 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("TrustedUserHeaderValue")>]
[<SoapHeaderAttribute("ServerInfoHeaderValue", Direction = SoapHeaderDirection.Out)>]
[<SoapHeaderAttribute("ExecutionHeaderValue", Direction = SoapHeaderDirection.Out)>]
member LoadReport : 
        Report:string * 
        HistoryID:string -> ExecutionInfo 
public function LoadReport(
    Report : String, 
    HistoryID : String
) : ExecutionInfo

Parameters

Return Value

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

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

On the main report: ReadProperties AND ExecuteAndView

On all subreports: ReadProperties

SharePoint Mode Required Permissions

On the main report and all subreports: ViewListItems()

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

Depending on the execution properties of the report, the returned ExecutionInfo may either be a snapshot ready to be rendered or a report that needs to be processed. If a HistoryID is specified, the report has already been processed and it will be able to be rendered immediately.

The returned ExecutionInfo object will contain a new ExecutionID.

By default, report edit sessions are set to 7200 seconds (2 hours) from last use, making it possible for users to keep a large amount of data in the cache for a prolonged period of time. In some usage patterns, this could lead to a larger load on the RSTempDB database and the report server. In these cases you should consider using LoadReport.

Examples

For a code example, please see the Render method.