XmlValidatingReader::ReadContentAsBinHex Method (array<Byte>^, Int32, Int32)

 

Reads the content and returns the BinHex decoded binary bytes.

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

public:
virtual int ReadContentAsBinHex(
	array<unsigned char>^ buffer,
	int index,
	int count
) override

Parameters

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

Exception Condition
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.

System_CAPS_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 the Remarks section of the XmlReader reference page..

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.

System_CAPS_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
Available since 2.0
Return to top
Show: