Ends a pending asynchronous send of a file.
Assembly: System (in System.dll)
Windows NT is required for this method.
The Socket object has been closed.
asyncResult is empty.
asyncResult was not returned by a call to the BeginSendFile method.
was previously called for the asynchronous BeginSendFile.
An error occurred when attempting to access the socket. See remarks section below.
completes the asynchronous send operation started in BeginSendFile.
Before calling BeginSendFile, you must create a callback method that implements the AsyncCallback delegate. This callback method executes in a separate thread and is called by the system after BeginSendFile returns. The callback method must accept the IAsyncResult object returned by the BeginSendFile method as a parameter.
Within the callback method, call the AsyncState method of the IAsyncResult parameter to obtain the sending Socket. After obtaining the Socket, you can call the method to successfully complete the send operation.
If you are using a connectionless protocol, blocks until the datagram is sent. If you are using a connection-oriented protocol, 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.
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 in the MSDN library for a detailed description of the error.
This member outputs trace information when you enable network tracing in your application. For more information, see Network Tracing.
The following code example creates and connects a socket for asynchronous communication and begins sending the file "text.txt" asynchronously to the remote host. The callback delegate calls to complete the transmission.
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.