XmlTextReader.ReadContentAsBase64 Method
Reads the content and returns the Base64 decoded binary bytes.
Assembly: System.Xml (in System.Xml.dll)
abstract ReadContentAsBase64 : buffer:byte[] * index:int * count:int -> int override ReadContentAsBase64 : buffer:byte[] * index:int * count:int -> int
Parameters
- buffer
- Type: System.Byte[]
The buffer into which to copy the resulting text. This value cannot be a null reference (Nothing in Visual Basic).
- index
- Type: System.Int32
The offset into the buffer where to start copying the result.
- count
- Type: System.Int32
The maximum number of bytes to copy into the buffer. The actual number of bytes copied is returned from this method.
| Exception | Condition |
|---|---|
| ArgumentNullException | The buffer value is a null reference (Nothing in Visual Basic). |
| InvalidOperationException | ReadContentAsBase64 is not supported in the current node. |
| ArgumentOutOfRangeException | The index into the buffer or index + count is larger than the allocated buffer size. |
.gif?cs-save-lang=1&cs-lang=fsharp "Note") Note |
|---|
In the .NET Framework 2.0 release, the recommended practice is to create XmlReader instances using the 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 ReadContentAsBase64 method until the method returns the value 0. |
This method has the following behavior:
ReadContentAsBase64 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.
ReadContentAsBase64 is not supported on the following XML node types: Element, XmlDeclaration, None, Document, DocumentType, Notation, Entity, DocumentFragment.
Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
