ReportExecutionService.LoadReport(String, String) Method

Definition

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

public:
 ReportExecution2005::ExecutionInfo ^ LoadReport(System::String ^ Report, System::String ^ HistoryID);
public ReportExecution2005.ExecutionInfo LoadReport (string Report, string HistoryID);
member this.LoadReport : string * string -> ReportExecution2005.ExecutionInfo
Public Function LoadReport (Report As String, HistoryID As String) As ExecutionInfo

Parameters

Report
String

The full name of the report.

HistoryID
String

The history ID of the snapshot.

Returns

An ExecutionInfo object containing information for the loaded report.

Examples

For a code example, please see the Render method.

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: <xref:Microsoft.SharePoint.SPBasePermissions.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.

Applies to