Report.StreamURL Method

Article
12/03/2008

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

public string StreamURL (
    bool useSessionId,
    string streamName
)

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

public String StreamURL (
    boolean useSessionId, 
    String streamName
)

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

Parameters

useSessionId
Indicates whether to use the session ID. If true, the session ID is used.

streamName
The name of the stream.

Return Value

A String value containing the URL needed to retrieve this stream from another.

Remarks

New:5 December 2005

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.

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