• Article

ReportExecutionService.RenderStream Method

Gets a secondary rendering stream associated with a processed report.

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

Syntax

'Declaration
<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("ExecutionHeaderValue")> _
<SoapHeaderAttribute("TrustedUserHeaderValue")> _
<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()
'Usage
Dim instance As ReportExecutionService
Dim Format As String
Dim StreamID As String
Dim DeviceInfo As String
Dim Encoding As String
Dim MimeType As String
Dim returnValue As Byte()

returnValue = instance.RenderStream(Format, _
    StreamID, DeviceInfo, Encoding, MimeType)

[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("ExecutionHeaderValue")]
[SoapHeaderAttribute("TrustedUserHeaderValue")]
[SoapHeaderAttribute("ServerInfoHeaderValue", Direction = SoapHeaderDirection.Out)]
public byte[] RenderStream(
    string Format,
    string StreamID,
    string DeviceInfo,
    out string Encoding,
    out string MimeType
)

[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"ExecutionHeaderValue")]
[SoapHeaderAttribute(L"TrustedUserHeaderValue")]
[SoapHeaderAttribute(L"ServerInfoHeaderValue", Direction = SoapHeaderDirection::Out)]
public:
array<unsigned char>^ RenderStream(
    String^ Format, 
    String^ StreamID, 
    String^ DeviceInfo, 
    [OutAttribute] String^% Encoding, 
    [OutAttribute] String^% MimeType
)

[<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("ExecutionHeaderValue")>]
[<SoapHeaderAttribute("TrustedUserHeaderValue")>]
[<SoapHeaderAttribute("ServerInfoHeaderValue", Direction = SoapHeaderDirection.Out)>]
member RenderStream : 
        Format:string * 
        StreamID:string * 
        DeviceInfo:string * 
        Encoding:string byref * 
        MimeType:string byref -> byte[] 

public function RenderStream(
    Format : String, 
    StreamID : String, 
    DeviceInfo : String, 
    Encoding : String, 
    MimeType : String
) : byte[]

Parameters

  • Format
    Type: System.String
    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 Word. A list of supported extensions may be obtained by calling the ListRenderingExtensions method.
  • DeviceInfo
    Type: System.String
    Describes device specific content used by the rendering extension.
  • Encoding
    Type: System.String%
    [out]The .NET Framework encoding class name.
  • MimeType
    Type: System.String%
    [out]The MIME type of the stream.

Return Value

Type: array<System.Byte[]
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

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

SOAP Header Usage

(In) TrustedUserHeaderValue

(In) ExecutionHeaderValue

(Out) ServerInfoHeaderValue

Native Mode Required Permissions

None

SharePoint Mode Required Permissions

None

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, and CSS style sheets.