XmlWriter.WriteBase64Async(Byte[], Int32, Int32) Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Asynchronously encodes the specified binary bytes as Base64 and writes out the resulting text.
public:
virtual System::Threading::Tasks::Task ^ WriteBase64Async(cli::array <System::Byte> ^ buffer, int index, int count);public virtual System.Threading.Tasks.Task WriteBase64Async (byte[] buffer, int index, int count);abstract member WriteBase64Async : byte[] * int * int -> System.Threading.Tasks.Task
override this.WriteBase64Async : byte[] * int * int -> System.Threading.Tasks.TaskPublic Overridable Function WriteBase64Async (buffer As Byte(), index As Integer, count As Integer) As TaskParameters
- buffer
- Byte[]
Byte array to encode.
- index
- Int32
The position in the buffer indicating the start of the bytes to write.
- count
- Int32
The number of bytes to write.
Returns
The task that represents the asynchronous WriteBase64 operation.
Exceptions
An XmlWriter 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 XmlWriter asynchronous method was called without setting the Async flag to true. In this case, InvalidOperationException is thrown with the message "Set XmlWriterSettings.Async to true if you want to use Async Methods."
Remarks
This is the asynchronous version of WriteBase64, 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 WriteBase64(Byte[], Int32, Int32).
