XmlReader.ReadContentAsBinHexAsync(Byte[], Int32, Int32) Method

Definition

Asynchronously reads the content and returns the BinHex decoded binary bytes.

public:
 virtual System::Threading::Tasks::Task<int> ^ ReadContentAsBinHexAsync(cli::array <System::Byte> ^ buffer, int index, int count);
public virtual System.Threading.Tasks.Task<int> ReadContentAsBinHexAsync (byte[] buffer, int index, int count);
abstract member ReadContentAsBinHexAsync : byte[] * int * int -> System.Threading.Tasks.Task<int>
override this.ReadContentAsBinHexAsync : byte[] * int * int -> System.Threading.Tasks.Task<int>
Public Overridable Function ReadContentAsBinHexAsync (buffer As Byte(), index As Integer, count As Integer) As Task(Of Integer)

Parameters

buffer
Byte[]

The buffer into which to copy the resulting text. This value cannot be null.

index
Int32

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

count
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

An XmlReader method was called before a previous asynchronous operation finished. In this case, InvalidOperationException is thrown with the message "An asynchronous operation is already in progress."

-or-

An XmlReader asynchronous method was called without setting the Async flag to true. In this case, InvalidOperationException is thrown with the message "Set XmlReaderSettings.Async to true if you want to use Async Methods."

Remarks

This is the asynchronous version of ReadContentAsBinHex, with the same functionality. To use this method, you must set the Async flag to true.

This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as ArgumentException, are still thrown synchronously. For the stored exceptions, see the exceptions thrown by ReadContentAsBinHex(Byte[], Int32, Int32).

Applies to

See also