ReportExecutionService.RenderStream Method

Article
12/03/2008

Gets a secondary rendering stream associated with a processed report.

Namespace: Microsoft.WSSUX.ReportingServicesWebService.RSExecutionService2005
Assembly: ReportExecution2005 (in reportexecutionservice.dll)

Syntax

'Declaration
<SoapHeaderAttribute("ExecutionHeaderValue")> _
<SoapDocumentMethodAttribute("https://schemas.microsoft.com/sqlserver/2005/06/30/reporting/reportingservices/RenderStream", 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)> _
Public Function RenderStream ( _
    Format As String, _
    StreamID As String, _
    DeviceInfo As String, _
    <OutAttribute> ByRef Encoding As String, _
    <OutAttribute> ByRef MimeType As String _
) As Byte()

[SoapHeaderAttribute("ExecutionHeaderValue")] 
[SoapDocumentMethodAttribute("https://schemas.microsoft.com/sqlserver/2005/06/30/reporting/reportingservices/RenderStream", 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)] 
public byte[] RenderStream (
    string Format,
    string StreamID,
    string DeviceInfo,
    out string Encoding,
    out string MimeType
)

[SoapHeaderAttribute(L"ExecutionHeaderValue")] 
[SoapDocumentMethodAttribute(L"https://schemas.microsoft.com/sqlserver/2005/06/30/reporting/reportingservices/RenderStream", 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)] 
public:
array<unsigned char>^ RenderStream (
    String^ Format, 
    String^ StreamID, 
    String^ DeviceInfo, 
    [OutAttribute] String^% Encoding, 
    [OutAttribute] String^% MimeType
)

/** @attribute SoapHeaderAttribute("ExecutionHeaderValue") */ 
/** @attribute SoapDocumentMethodAttribute("https://schemas.microsoft.com/sqlserver/2005/06/30/reporting/reportingservices/RenderStream", 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) */ 
/** @attribute SoapHeaderAttribute("ServerInfoHeaderValue", Direction=SoapHeaderDirection.Out) */ 
public byte[] RenderStream (
    String Format, 
    String StreamID, 
    String DeviceInfo, 
    /** @attribute OutAttribute() */ /** @ref */ String Encoding, 
    /** @attribute OutAttribute() */ /** @ref */ String MimeType
)

JScript does not support passing value-type arguments by reference.

Parameters

Format
The format in which to render the stream. This argument maps to a rendering extension. Supported extensions include XML, NULL, CSV, IMAGE, PDF, HTML4.0, HTML3.2, MHTML, EXCEL, and HTMLOWC. A list of supported extensions may be obtained by calling the ListRenderingExtensions method.

StreamID
The stream identifier.

DeviceInfo
Describes device specific content used by the rendering extension.

Encoding
[out]The .NET Framework encoding class name.

MimeType
[out]The MIME type of the stream.

Return Value

A Byte[] array of the stream in the specified format. For more information about this data type, see "Byte Structure" in the Microsoft .NET Framework documentation.

Remarks

Secondary streams are available to provide additional resources that may be needed by a custom rendering extension to render a report.

Examples of secondary streams can include images and charts, individual report pages, and CSS stylesheets.

Thread Safety

Any public static (Shared in Microsoft Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms

Development Platforms

For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.

Target Platforms