Message.CreateBufferedCopy(Int32) Method

Definition

Namespace:

System.ServiceModel.Channels

Assembly:

System.ServiceModel.Primitives.dll

Package:

System.ServiceModel.Primitives v8.1.0

Source:

Message.cs

Stores an entire Message into a memory buffer for future access.

public:
 System::ServiceModel::Channels::MessageBuffer ^ CreateBufferedCopy(int maxBufferSize);

public System.ServiceModel.Channels.MessageBuffer CreateBufferedCopy (int maxBufferSize);

member this.CreateBufferedCopy : int -> System.ServiceModel.Channels.MessageBuffer

Public Function CreateBufferedCopy (maxBufferSize As Integer) As MessageBuffer

Parameters

maxBufferSize

Int32

The maximum size of the buffer to be created.

Returns

MessageBuffer

A newly created MessageBuffer object.

Exceptions

ArgumentOutOfRangeException

maxBufferSize is smaller than zero.

ObjectDisposedException

The message is closed.

InvalidOperationException

The message has been copied, read or written.

Remarks

The body of a Message instance can only be accessed or written once. If you want to access a Message instance more than once, you should use the MessageBuffer class to completely store an entire Message instance into memory. A MessageBuffer instance is constructed by calling CreateBufferedCopy of a Message instance.

Note

If Version is equal to None, this method only stores the body of the message, not the entire message into the memory buffer.