Share via

  • Article

Report.StreamURL Method

Returns the URL needed to retrieve this stream from another. Works with the CreateAndRegisterStream delegate function.

Namespace:  Microsoft.ReportingServices.ReportRendering
Assembly:  Microsoft.ReportingServices.ProcessingCore (in Microsoft.ReportingServices.ProcessingCore.dll)

Syntax

'Declaration
Public Function StreamURL ( _
    useSessionId As Boolean, _
    streamName As String _
) As String
'Usage
Dim instance As Report
Dim useSessionId As Boolean
Dim streamName As String
Dim returnValue As String

returnValue = instance.StreamURL(useSessionId, _
    streamName)

public string StreamURL(
    bool useSessionId,
    string streamName
)

public:
String^ StreamURL(
    bool useSessionId, 
    String^ streamName
)

member StreamURL : 
        useSessionId:bool * 
        streamName:string -> string 

public function StreamURL(
    useSessionId : boolean, 
    streamName : String
) : String

Parameters

  • useSessionId
    Type: System.Boolean
    Indicates whether to use the session ID. If true, the session ID is used.

Return Value

Type: System.String
A string value that contains the URL needed to retrieve this stream from another.

Remarks

The CreateAndRegisterStream delegate function is called by the rendering extension to get the stream to render to. The main body of the report must be the first stream created. To refer to this stream in another stream, use the StreamURL method, concatenated with the name, a period, and the extension. For example, if the StreamURL is XYZ_files and this is stream ABC, and it is a JPEG file type, the stream can be referred to using XYZ_Files/ABC.jpg.

If the rendering extension calls the callback CreateAndRegisterStream to create a stream that it will access using the URL returned by the StreamURL method, both methods must use the same stream name.