Export (0) Print
Expand All

XmlTextReader.ReadContentAsBinHex Method

Reads the content and returns the BinHex decoded binary bytes.

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

public override int ReadContentAsBinHex(
	byte[] buffer,
	int index,
	int count
)

Parameters

buffer
Type: 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.

ExceptionCondition
ArgumentNullException

The buffer value is null.

InvalidOperationException

ReadContentAsBinHex is not supported on the current node.

ArgumentOutOfRangeException

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

NotSupportedException

The XmlTextReader implementation does not support this method.

NoteNote:

In the .NET Framework version 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 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.

NoteNote:

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.

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98, Windows CE, Windows Mobile for Smartphone, Windows Mobile for Pocket PC, Xbox 360, Zune

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

.NET Framework

Supported in: 3.5, 3.0, 2.0

.NET Compact Framework

Supported in: 3.5, 2.0

XNA Framework

Supported in: 3.0, 2.0, 1.0

Community Additions

ADD
Show:
© 2014 Microsoft