Socket.EndSendFile(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.
Ends a pending asynchronous send of a file.
public:
void EndSendFile(IAsyncResult ^ asyncResult);public void EndSendFile (IAsyncResult asyncResult);member this.EndSendFile : IAsyncResult -> unitPublic Sub EndSendFile (asyncResult As IAsyncResult)Parameters
- asyncResult
- IAsyncResult
An IAsyncResult object that stores state information for this asynchronous operation.
Exceptions
.NET 8+ only: The socket is not connected to a remote host.
.NET Framework, .NET Core, and .NET 5-6 only: The Socket has been closed.
asyncResult is empty.
asyncResult was not returned by a call to the BeginSendFile(String, AsyncCallback, Object) method.
EndSendFile(IAsyncResult) was previously called for the asynchronous BeginSendFile(String, AsyncCallback, Object).
An error occurred when attempting to access the socket.
-or-
.NET 7+ only: The Socket has been closed.
Remarks
Important
This is a compatibility API. We don't recommend using the APM (Begin* and End*) methods for new development. Instead, use the Task-based equivalents.
EndSendFile completes the operation started by BeginSend. You need to pass the IAsyncResult created by the matching BeginSend call.
If you are using a connectionless protocol, EndSendFile blocks until the datagram is sent. If you are using a connection-oriented protocol, EndSendFile blocks until the entire file is sent. There is no guarantee that the data you send will appear on the network immediately. To increase network efficiency, the underlying system may delay transmission until a significant amount of outgoing data is collected. A successful completion of the BeginSendFile method means that the underlying system has had room to buffer your data for a network send.
Note
If you receive a SocketException, use the SocketException.ErrorCode property to obtain the specific error code. After you have obtained this code, refer to the Windows Sockets version 2 API error code documentation for a detailed description of the error.
Note
This member outputs trace information when you enable network tracing in your application. For more information, see Network Tracing in .NET Framework.
