Socket.EndSendFile Method

Ends a pending asynchronous send of a file.

Namespace:  System.Net.Sockets
Assembly:  System (in System.dll)

member EndSendFile : 
        asyncResult:IAsyncResult -> unit

Parameters

asyncResult
Type: System.IAsyncResult

An IAsyncResult object that stores state information for this asynchronous operation.

ExceptionCondition
NotSupportedException

Windows NT is required for this method.

ObjectDisposedException

The Socket object has been closed.

ArgumentNullException

asyncResult is empty.

ArgumentException

asyncResult was not returned by a call to the BeginSendFile method.

InvalidOperationException

EndSendFile was previously called for the asynchronous BeginSendFile.

SocketException

An error occurred when attempting to access the socket. See remarks section below.

EndSendFile 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 EndSendFile method to successfully complete the send operation.

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.

NoteNote

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.

NoteNote

This member outputs trace information when you enable network tracing in your application. For more information, see Network Tracing in the .NET Framework.

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 EndSendFile to complete the transmission.

No code example is currently available or this language may not be supported.

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

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.

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft