NetworkStream.EndWrite(IAsyncResult) 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.
Handles the end of an asynchronous write.
public:
override void EndWrite(IAsyncResult ^ asyncResult);public override void EndWrite (IAsyncResult asyncResult);override this.EndWrite : IAsyncResult -> unitPublic Overrides Sub EndWrite (asyncResult As IAsyncResult)Parameters
- asyncResult
- IAsyncResult
The IAsyncResult that represents the asynchronous call.
Exceptions
The asyncResult parameter is null.
The underlying Socket is closed.
-or-
An error occurred while writing to the network.
-or-
An error occurred when accessing the socket.
The NetworkStream is closed.
Remarks
Important
This is a compatibility API, we don't recommend to use the APM (Begin / End) methods for new development. Instead, use the Task-based equivalents.
The EndWrite method completes the read operation started by the BeginWrite method. You need to pass the IAsyncResult created by the matching BeginWrite call. EndWrite will block the calling thread until the operation is completed.
The operation reads as much data as is available, up to the number of bytes specified by the size parameter.
Note
If you receive an IOException, check the InnerException property to determine if it was caused by a SocketException. If so, use the ErrorCode property to obtain the specific error code.
