Export (0) Print
Expand All
Expand Minimize

XmlReader::ReadValueChunkAsync Method

.NET Framework 4.5

Asynchronously reads large streams of text embedded in an XML document.

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

public:
virtual Task<int>^ ReadValueChunkAsync(
	array<wchar_t>^ buffer, 
	int index, 
	int count
)

Parameters

buffer
Type: array<System::Char>

The array of characters that serves as the buffer to which the text contents are written. This value cannot be nullptr.

index
Type: System::Int32

The offset within the buffer where the XmlReader can start to copy the results.

count
Type: System::Int32

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

Return Value

Type: System.Threading.Tasks::Task<Int32>
The number of characters read into the buffer. The value zero is returned when there is no more text content.

ExceptionCondition
InvalidOperationException

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.”

InvalidOperationException

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.”

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

.NET Framework

Supported in: 4.5

.NET for Windows Store apps

Supported in: Windows 8

.NET for Windows Phone apps

Supported in: Windows Phone 8.1, Windows Phone Silverlight 8.1, Windows Phone Silverlight 8

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.

Show:
© 2014 Microsoft