XmlDictionaryReaderQuotas.MaxBytesPerRead Property (System.Xml)

MaxBytesPerRead Property

Switch on low bandwidth view

Collapse All

Language Filter

This page is specific to

Microsoft Visual Studio 2008/.NET Framework 3.5

Other versions are also available for the following:

.NET Framework Class Library

XmlDictionaryReaderQuotas..::.MaxBytesPerRead Property

Gets and sets the maximum allowed bytes returned for each read.

Namespace: System.Xml
Assembly: System.Runtime.Serialization (in System.Runtime.Serialization.dll)

Syntax

Visual Basic (Declaration)

Public Property MaxBytesPerRead As Integer

Visual Basic (Usage)

Dim instance As XmlDictionaryReaderQuotas
Dim value As Integer

value = instance.MaxBytesPerRead

instance.MaxBytesPerRead = value

public int MaxBytesPerRead { get; set; }

Visual C++

public:
property int MaxBytesPerRead {
    int get ();
    void set (int value);
}

JScript

public function get MaxBytesPerRead () : int
public function set MaxBytesPerRead (value : int)

Property Value

Type: System..::.Int32
The maximum allowed bytes returned for each read. The default is 4096.

Exceptions

Exception	Condition
InvalidOperationException	Trying to set the value, but quota values are read-only for this instance.
ArgumentException	Trying to set the value to less than zero.

Remarks

This quota limits the number of bytes that can be consumed by the reader during a single call to Read().

This quota is an approximation, because transformations in the encoding layer happen before this quota is applied. This quota is closely tied to the number of bytes received on the wire at the transport level, but its purpose is to control the quantity of data we receive for each read. In practice, it is used to limit the size of start tags. Because the entire start tag must be buffered to be processed (attributes uniqueness must be verified), the size must be limited to mitigate DOS attacks.

Instances created with the public constructor have properties that can be set.

.NET Framework Security

Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.

Platforms

Windows 7, Windows Vista, Windows XP SP2, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003

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.

Version Information

.NET Framework

Supported in: 3.5, 3.0

Reference

XmlDictionaryReaderQuotas Class

XmlDictionaryReaderQuotas Members

System.Xml Namespace