Export (0) Print
Expand All

ReportExecutionService.Render Method

Processes a specific report and renders it in the specified format.

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

public function Render(
	Format : String, 
	DeviceInfo : String, 
	Extension : String, 
	MimeType : String, 
	Encoding : String, 
	Warnings : Warning[], 
	StreamIds : String[]
) : byte[]

Parameters

Format
Type: String
The format in which to render the report. This argument maps to a rendering extension. Supported extensions include XML, NULL, CSV, IMAGE, PDF, HTML4.0, HTML3.2, MHTML, EXCEL, and Word. A list of supported extensions may be obtained by calling the ListRenderingExtensions method.
DeviceInfo
Type: String
An XML string that contains the device-specific content that is required by the rendering extension specified in the Format parameter. DeviceInfo settings must be passed as internal elements of a DeviceInfo XML element. For more information about device information settings for specific output formats, see Passing Device Information Settings to Rendering Extensions.
Extension
Type: String
[out] The file extension corresponding to the output stream.
MimeType
Type: String
[out] The MIME type of the rendered report.
Encoding
Type: String
[out] The encoding used when report server renders the contents of the report.
Warnings
Type: ReportExecution2005.Warning[]
[out] An array of Warning objects that describes any warnings that occurred during report processing.
StreamIds
Type: String[]
[out] The stream identifiers. These IDs are passed to the RenderStream method. You can use them to render the external resources (images, etc.) that are associated with a given report.If the IMAGE rendering extension is used, the method outputs an empty array in StreamIds.

Return Value

Type: Byte[]
A Byte[] array of the report in the specified format.

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

SOAP Header Usage

(In) TrustedUserHeaderValue

(In) ExecutionHeaderValue

(Out) ServerInfoHeaderValue

Native Mode Required Permissions

On the main report and all subreports: ReadProperties AND ExecuteAndView

SharePoint Mode Required Permissions

On the main report and all subreports: ViewListItems

Render renders a processed report associated with the report execution identified in the ExecutionInfo header. If no temporary snapshot exists for the processed report in the execution state, this method will execute the report (if all credential and parameter requirements are met), resulting in a temporary snapshot being created for the execution state. If the report is reprocessed because non-query parameter values have changed, a new temporary snapshot is created. For more information on execution state, see Identifying Execution State.

If the execution options are set to cache or execution snapshot, the call to Render may use an existing snapshot.

If the report is set to cache and the supplied parameter values and credentials match, the cached copy of the snapshot may be loaded instead of actually processing the report.

If credential and parameter requirements are not met, this method will return an error.

Subsequent calls to Render can be used to fetch additional pages of the report if the rendering extension supports specifying multiple pages.

A limitation of the Render method is that the output cannot be streamed, so the entire file must be in-memory.

Please see Identifying Execution State for a discussion of the execution life cycle, which includes a description of the steps necessary to load and render a report.

To compile the following code example, you must reference the Reporting Services WSDL and import certain namespaces. For more information, see Compiling and Running Code Examples. The following code example renders a report in MHTML and saves it as an .mht file to disk.

No code example is currently available or this language may not be supported.

Community Additions

ADD
Show:
© 2014 Microsoft