System.Xml.XmlTextReader.ReadContentAsBase64 Method

Reads the content and returns the Base64 decoded binary bytes.

Syntax

public override int ReadContentAsBase64 (byte[] buffer, int index, int count)

Parameters

buffer
The buffer into which to copy the resulting text. This value cannot be null.
index
The offset into the buffer where to start copying the result.
count
The maximum number of bytes to copy into the buffer. The actual number of bytes copied is returned from this method.

Returns

The number of bytes written to the buffer.

Remarks

Note:

In the dnprdnext release, the recommended practice is to create System.Xml.XmlReader instances using the erload:System.Xml.XmlReader.Create method. This allows you to take full advantage of the new features introduced in this release. For more information, see Creating XML Readers.

This method streams the content, decodes the Base64 content, and returns the decoded binary bytes (for example, an inline Base64-encoded GIF image) into the buffer. This method can be called successively to read large streams of embedded text. For more information, see RFC 1521, "MIME (Multipurpose Internet Mail Extensions) Part One: Mechanisms for Specifying and Describing the Format of Internet Message Bodies". You can obtain RFCs from the Request for Comments Web site at http://www.rfc-editor.org.

Note:

You should not access any of the reader properties between calls to the XmlTextReader.ReadContentAsBase64(Byte[], int, int) method until the method returns the value 0.

This method has the following behavior:

  • XmlTextReader.ReadContentAsBase64(Byte[], int, int) returns the value 0 when it has reached the end of the byte stream it was operating on. The reader is positioned on the first non-content node.

  • If you ask for fewer, or the exact number, of bytes than are left in the stream the reader remains in its current position.

  • XmlTextReader.ReadContentAsBase64(Byte[], int, int) is not supported on the following XML node types: Element, XmlDeclaration, None, Document, DocumentType, Notation, Entity, DocumentFragment.

Requirements

Namespace: System.Xml
Assembly: System.Xml (in System.Xml.dll)
Assembly Versions: 2.0.0.0, 4.0.0.0
Since: .NET 2.0