Stream.BeginWrite(Byte[], Int32, Int32, AsyncCallback, Object) Метод

Определение

Начинает операцию асинхронной записи.Begins an asynchronous write operation. (Рекомендуется использовать WriteAsync(Byte[], Int32, Int32).)(Consider using WriteAsync(Byte[], Int32, Int32) instead.)

public:
 virtual IAsyncResult ^ BeginWrite(cli::array <System::Byte> ^ buffer, int offset, int count, AsyncCallback ^ callback, System::Object ^ state);
public virtual IAsyncResult BeginWrite (byte[] buffer, int offset, int count, AsyncCallback callback, object state);
abstract member BeginWrite : byte[] * int * int * AsyncCallback * obj -> IAsyncResult
override this.BeginWrite : byte[] * int * int * AsyncCallback * obj -> IAsyncResult
Public Overridable Function BeginWrite (buffer As Byte(), offset As Integer, count As Integer, callback As AsyncCallback, state As Object) As IAsyncResult

Параметры

buffer
Byte[]

Буфер, из которого записываются данные.The buffer to write data from.

offset
Int32

Смещение байтов в буфере buffer, с которого начинается запись.The byte offset in buffer from which to begin writing.

count
Int32

Максимальное число байтов для записи.The maximum number of bytes to write.

callback
AsyncCallback

Дополнительный асинхронный обратный вызов по завершении записи.An optional asynchronous callback, to be called when the write is complete.

state
Object

Предоставляемый пользователем объект, являющийся отличительным признаком данного конкретного запроса на асинхронную запись от других запросов.A user-provided object that distinguishes this particular asynchronous write request from other requests.

Возвращаемое значение

IAsyncResult представляет асинхронную запись, которая может все еще быть отложена.An IAsyncResult that represents the asynchronous write, which could still be pending.

Исключения

Попытка выполнить запись в асинхронном режиме за пределами конца потока или ошибка диска.Attempted an asynchronous write past the end of the stream, or a disk error occurs.

Один или несколько аргументов являются недопустимыми.One or more of the arguments is invalid.

Методы были вызваны после закрытия потока.Methods were called after the stream was closed.

Текущая реализация класса Stream не поддерживает операцию записи.The current Stream implementation does not support the write operation.

Комментарии

В платформе .NET Framework 4 и более ранних версий для реализации операций асинхронного ввода-вывода необходимо использовать такие методы, как BeginWrite и EndWrite .In the .NET Framework 4 and earlier versions, you have to use methods such as BeginWrite and EndWrite to implement asynchronous I/O operations. Эти методы по-прежнему доступны в .NET Framework 4.5.NET Framework 4.5 для поддержки устаревшего кода; Однако новые асинхронные методы, такие как ReadAsync, WriteAsync, CopyToAsyncи FlushAsync, упрощают реализацию асинхронных операций ввода-вывода.These methods are still available in the .NET Framework 4.5.NET Framework 4.5 to support legacy code; however, the new async methods, such as ReadAsync, WriteAsync, CopyToAsync, and FlushAsync, help you implement asynchronous I/O operations more easily.

Реализация BeginWrite в потоке по умолчанию вызывает метод Write синхронно, то есть Write может блокироваться в некоторых потоках.The default implementation of BeginWrite on a stream calls the Write method synchronously, which means that Write might block on some streams. Однако экземпляры классов, такие как FileStream и NetworkStream, полностью поддерживают асинхронные операции, если экземпляры были открыты асинхронно.However, instances of classes such as FileStream and NetworkStream fully support asynchronous operations if the instances have been opened asynchronously. Таким образом, вызовы BeginWrite не будут блокироваться в этих потоках.Therefore, calls to BeginWrite will not block on those streams. Можно переопределить BeginWrite (например, с помощью асинхронных делегатов) для обеспечения асинхронного поведения.You can override BeginWrite (by using async delegates, for example) to provide asynchronous behavior.

Передайте IAsyncResult, возвращенные текущим методом, в EndWrite, чтобы убедиться, что запись завершается и освобождает ресурсы соответствующим образом.Pass the IAsyncResult returned by the current method to EndWrite to ensure that the write completes and frees resources appropriately. EndWrite необходимо вызывать один раз для каждого вызова BeginWrite.EndWrite must be called once for every call to BeginWrite. Это можно сделать с помощью того же кода, который вызывал BeginWrite, или в обратном вызове, переданном BeginWrite.You can do this either by using the same code that called BeginWrite or in a callback passed to BeginWrite. Если во время асинхронной записи возникает ошибка, исключение не будет вызываться, пока EndWrite не вызван с IAsyncResult, возвращаемым этим методом.If an error occurs during an asynchronous write, an exception will not be thrown until EndWrite is called with the IAsyncResult returned by this method.

Если поток доступен для записи, запись в конце потока расширяет поток.If a stream is writable, writing at the end of the stream expands the stream.

Текущая позицией в потоке обновляется при выдаче асинхронного чтения или записи, а не после завершения операции ввода-вывода.The current position in the stream is updated when you issue the asynchronous read or write, not when the I/O operation completes. Несколько одновременных асинхронных запросов отрабатывают порядок выполнения запроса неопределенным образом.Multiple simultaneous asynchronous requests render the request completion order uncertain.

Используйте свойство CanWrite, чтобы определить, поддерживает ли текущий экземпляр запись.Use the CanWrite property to determine whether the current instance supports writing.

Если поток закрыт или передан недопустимый аргумент, исключения немедленно создаются из BeginWrite.If a stream is closed or you pass an invalid argument, exceptions are thrown immediately from BeginWrite. Ошибки, возникающие при асинхронном запросе записи, такие как сбой диска во время запроса ввода-вывода, происходят в потоке пула потоков и вызывают исключения при вызове EndWrite.Errors that occur during an asynchronous write request, such as a disk failure during the I/O request, occur on the thread pool thread and throw exceptions when calling EndWrite.

Применяется к

Дополнительно