XmlTextReader.ReadContentAsBinHex(Byte[], Int32, Int32) XmlTextReader.ReadContentAsBinHex(Byte[], Int32, Int32) XmlTextReader.ReadContentAsBinHex(Byte[], Int32, Int32) XmlTextReader.ReadContentAsBinHex(Byte[], Int32, Int32) Method

Definition

Reads the content and returns the BinHex decoded binary bytes.

public:
 override int ReadContentAsBinHex(cli::array <System::Byte> ^ buffer, int index, int count);
public override int ReadContentAsBinHex (byte[] buffer, int index, int count);
override this.ReadContentAsBinHex : byte[] * int * int -> int
Public Overrides Function ReadContentAsBinHex (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 Int32 Int32 Int32

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

count
Int32 Int32 Int32 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 index into the buffer or index + count is larger than the allocated buffer size.

Remarks

Note

Starting with the .NET Framework 2.0, we recommend that you create XmlReader instances by using the XmlReader.Create method to take advantage of new functionality.

This method streams the content, decodes the BinHex content, and returns the decoded binary bytes (for example, an inline BinHex encoded GIF image) into the buffer. This method can be called successively to read large streams of embedded text.

Note

You should not access any of the reader properties between calls to the ReadContentAsBinHex method until the method returns the value 0.

This method has the following behavior:

  • ReadContentAsBinHex 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.

  • ReadContentAsBinHex is not supported on the following XML node types: Element, XmlDeclaration, None, Document, DocumentType, Notation, Entity, DocumentFragment.

Applies to

See also