XmlValidatingReader.ReadElementContentAsBinHex(Byte[], Int32, Int32) Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Reads the element and decodes the BinHex content.
public:
override int ReadElementContentAsBinHex(cli::array <System::Byte> ^ buffer, int index, int count);
public override int ReadElementContentAsBinHex (byte[] buffer, int index, int count);
override this.ReadElementContentAsBinHex : byte[] * int * int -> int
Public Overrides Function ReadElementContentAsBinHex (buffer As Byte(), index As Integer, count As Integer) As Integer
Parameters
- buffer
- Byte[]
The buffer into which to copy the resulting text. This value cannot be null
.
- index
- Int32
The offset into the buffer where to start copying the result.
- count
- Int32
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.
Exceptions
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 XmlValidatingReader implementation does not support this method.
The element contains mixed-content.
The content cannot be converted to the requested type.
Remarks
Note
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 BinHex encoding, and returns the decoded binary bytes (for example, an inline BinHex encoded GIF image) into the buffer.
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 ReadContentAsBinHex 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.