Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
ReadContentAsBinHex Method

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
)
public int ReadContentAsBinHex (
	byte[] buffer, 
	int index, 
	int count
)
public override function ReadContentAsBinHex (
	buffer : byte[], 
	index : int, 
	count : int
) : int
Not applicable.

Parameters

buffer

The buffer into which to copy the resulting text. This value cannot be a null reference (Nothing in Visual Basic).

index

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

count

The maximum number of bytes to copy into the buffer. The actual number of bytes copied is returned from this method.

Return Value

The number of bytes written to the buffer.

Exception typeCondition

ArgumentNullException

The buffer value is a null reference (Nothing in Visual Basic).

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 Microsoft .NET Framework version 2.0 release, the recommended practice is to create XmlReader instances using the System.Xml.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 98, Windows Server 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0

.NET Compact Framework

Supported in: 2.0

XNA Framework

Supported in: 1.0

Community Additions

ADD
Show:
© 2015 Microsoft