Windows apps
Collapse the table of content
Expand the table of content
Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

XmlValidatingReader::ReadElementContentAsBase64 Method (array<Byte>^, Int32, Int32)

 

Reads the element and decodes the Base64 content.

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

public:
virtual int ReadElementContentAsBase64(
	array<unsigned char>^ buffer,
	int index,
	int count
) override

Parameters

buffer
Type: array<System::Byte>^

The buffer into which to copy the resulting text. This value cannot be null.

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.

Return Value

Type: System::Int32

The number of bytes written to the buffer.

Exception Condition
ArgumentNullException

The buffer value is null.

InvalidOperationException

The current node is not an element node.

ArgumentOutOfRangeException

The index into the buffer or index + count is larger than the allocated buffer size.

NotSupportedException

The XmlValidatingReader implementation does not support this method.

XmlException

The element contains mixed-content.

FormatException

The content cannot be converted to the requested type.

System_CAPS_noteNote

The XmlValidatingReader class is obsolete in .NET Framework 2.0. You can create a validating XmlReader instance by using the XmlReaderSettings class and the Create method. For more information, see the Remarks section of the XmlReader reference page.

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 Request for Comments Web site at http://www.rfc-editor.org.

This method can read only 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 ReadContentAsBase64 method except that it can be called only 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 XmlValidatingReader reads all the remaining bytes in the document and returns the number of bytes read. The next XmlValidatingReader method call returns a zero and moves the reader to the node following the EndElement.

If you call Read before all of the element content is consumed, the reader may behave as if the first content was consumed and then the 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.

.NET Framework
Available since 2.0
Return to top
Show:
© 2017 Microsoft