This documentation is archived and is not being maintained.

SoapExtension::ChainStream Method

When overridden in a derived class, allows a SOAP extension access to the memory buffer containing the SOAP request or response.

Namespace:  System.Web.Services.Protocols
Assembly:  System.Web.Services (in System.Web.Services.dll)

public:
virtual Stream^ ChainStream(
	Stream^ stream
)

Parameters

stream
Type: System.IO::Stream

A memory buffer containing the SOAP request or response.

Return Value

Type: System.IO::Stream
A Stream representing a new memory buffer that this SOAP extension can modify.

ChainStream ensures that SOAP extensions with the highest priority can modify the actual data closest to the SOAP message sent or returned over the wire.

SOAP extensions should save references of the Stream passed into ChainStream and the Stream returned from ChainStream. If the SOAP extension is configured to run with a XML Web service method, the Stream passed into ChainStream contains the serialized SOAP request at the BeforeDeserialize SoapMessageStage. Similarily, the Stream reference returned from ChainStream is written into when the serialization occurs and thus contains the serialized SOAP response in the AfterSerialize SoapMessageStage.

The following example saves both the Stream passed into ChainStream and the Stream returned from ChainStream in the member variables oldStream and newStream, respectively.

public:
   virtual Stream^ ChainStream( Stream^ stream ) override
   {
      oldStream = stream;
      newStream = gcnew MemoryStream;
      return newStream;
   }
public:
   Stream* ChainStream( Stream* stream ){
      oldStream = stream;
      newStream = new MemoryStream();
      return newStream;
   }

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98, Windows CE, Windows Mobile for Smartphone, Windows Mobile for Pocket PC

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

.NET Framework

Supported in: 3.5, 3.0, 2.0, 1.1, 1.0

.NET Compact Framework

Supported in: 3.5, 2.0, 1.0
Show: