System.Xml.XmlReader.ReadElementContentAsBase64 Method

Reads the element and decodes the Base64 content.

Syntax

public virtual int ReadElementContentAsBase64 (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

This method reads the element content, decodes it using Base64 encoding, and returns the decoded binary bytes (for example, an inline Base64-encoded GIF image) into the buffer. 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 tp://go.microsoft.com/fwlink/?LinkId=37119.

XmlReader.ReadElementContentAsBase64(Byte[], int, int) can only read simple-content elements. The element can contain text, white space, significant white space, CDATA sections, comments and processing instructions. It can also contain entity references, which are automatically expanded. The element cannot have child elements.

This method is very similar to the XmlReader.ReadContentAsBase64(Byte[], int, int) method except that it can only be called on element node types.

If the count value is higher than the number of bytes in the document, or if it is equal to the number of bytes in the document, the System.Xml.XmlReader reads all the remaining bytes in the document and returns the number of bytes read. The next System.Xml.XmlReader method call returns a zero and moves the reader to the node following the EndElement.

If you call XmlReader.Read before all of the element content is consumed, the reader may behave as if the first content was consumed and then the XmlReader.Read method was called. This means that the reader will read all the text until the end element is encountered. It will then read the end tag node, read the next node, and then position itself on the next subsequent node.

For the asynchronous version of this method, see XmlReader.ReadElementContentAsBase64Async(Byte[], int, int).

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