This topic has not yet been rated - Rate this topic

XmlValidatingReader.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 XmlValidatingReader implementation does not support this method.

NoteNote

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 NIB: Validating XML Data with XmlReader.

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, and DocumentFragment.

.NET Framework

Supported in: 4.5.1, 4.5, 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows Phone 8.1, Windows Phone 8, Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

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

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.