Collapse the table of content
Expand the table of content
Expand Minimize

XmlReader::ReadElementContentAsBinHex Method (array<Byte>^, Int32, Int32)


Reads the element and decodes the BinHex content.

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

virtual int ReadElementContentAsBinHex(
	array<unsigned char>^ buffer,
	int index,
	int count


Type: array<System::Byte>^

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

Type: System::Int32

The offset into the buffer where to start copying the result.

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

The buffer value is null.


The current node is not an element node.


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


The XmlReader implementation does not support this method.


The element contains mixed-content.


The content cannot be converted to the requested type.


An XmlReader method was called before a previous asynchronous operation finished. In this case, InvalidOperationException is thrown with the message “An asynchronous operation is already in progress.”

This method reads the element content, decodes it using BinHex encoding, and returns the decoded binary bytes (for example, an inline BinHex-encoded GIF image) into the buffer.

This method 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 ReadContentAsBinHex 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 XmlReader reads all the remaining bytes in the document and returns the number of bytes read. The next XmlReader 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.

For the asynchronous version of this method, see ReadElementContentAsBinHexAsync.

The following example reads an inline BinHex encoded image. The BinHex data is embedded within the <image> element. A BinaryWriter is used to create a new binary data file.

No code example is currently available or this language may not be supported.

Universal Windows Platform
Available since 4.5
.NET Framework
Available since 2.0
Portable Class Library
Supported in: portable .NET platforms
Available since 2.0
Windows Phone Silverlight
Available since 7.0
Windows Phone
Available since 8.1
Return to top
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
© 2015 Microsoft