Socket.SendFileAsync Метод
Определение
Важно!
Некоторые сведения относятся к предварительной версии продукта, в которую до выпуска могут быть внесены существенные изменения. Майкрософт не предоставляет никаких гарантий, явных или подразумеваемых, относительно приведенных здесь сведений.
Перегрузки
SendFileAsync(String, CancellationToken) |
Отправляет файл |
SendFileAsync(String, ReadOnlyMemory<Byte>, ReadOnlyMemory<Byte>, TransmitFileOptions, CancellationToken) |
Отправляет файл |
SendFileAsync(String, CancellationToken)
- Исходный код:
- Socket.Tasks.cs
- Исходный код:
- Socket.Tasks.cs
- Исходный код:
- Socket.Tasks.cs
Отправляет файл fileName
в подключенный Socket объект.
public System.Threading.Tasks.ValueTask SendFileAsync (string? fileName, System.Threading.CancellationToken cancellationToken = default);
member this.SendFileAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.ValueTask
Public Function SendFileAsync (fileName As String, Optional cancellationToken As CancellationToken = Nothing) As ValueTask
Параметры
- fileName
- String
Параметр типа String, содержащий имя отправляемого файла и путь к нему. Этот параметр может иметь значение null
.
- cancellationToken
- CancellationToken
Маркер отмены, который можно использовать для отмены асинхронной операции.
Возвращаемое значение
Задача со значением, представляющая асинхронную операцию отправки файла.
Исключения
Объект Socket закрыт.
Объект Socket не подключен к удаленному узлу.
Файл fileName
не найден.
Произошла ошибка при попытке доступа к сокету.
Маркер отмены был отменен. Это исключение сохраняется в возвращаемой задаче.
Комментарии
Этот метод сохраняет в задаче все исключения, не относящиеся к использованию, которые может создавать синхронный аналог метода. Если исключение сохраняется в возвращаемой задаче, это исключение будет создано при ожидании задачи. Исключения использования, такие как ArgumentException, по-прежнему создаются синхронно. Хранимые исключения см. в разделе исключения, создаваемые SendFile(String).
Применяется к
SendFileAsync(String, ReadOnlyMemory<Byte>, ReadOnlyMemory<Byte>, TransmitFileOptions, CancellationToken)
- Исходный код:
- Socket.Tasks.cs
- Исходный код:
- Socket.Tasks.cs
- Исходный код:
- Socket.Tasks.cs
Отправляет файл fileName
и буферы данных в подключенный объект Socket, используя указанное значение TransmitFileOptions.
public System.Threading.Tasks.ValueTask SendFileAsync (string? fileName, ReadOnlyMemory<byte> preBuffer, ReadOnlyMemory<byte> postBuffer, System.Net.Sockets.TransmitFileOptions flags, System.Threading.CancellationToken cancellationToken = default);
member this.SendFileAsync : string * ReadOnlyMemory<byte> * ReadOnlyMemory<byte> * System.Net.Sockets.TransmitFileOptions * System.Threading.CancellationToken -> System.Threading.Tasks.ValueTask
Public Function SendFileAsync (fileName As String, preBuffer As ReadOnlyMemory(Of Byte), postBuffer As ReadOnlyMemory(Of Byte), flags As TransmitFileOptions, Optional cancellationToken As CancellationToken = Nothing) As ValueTask
Параметры
- fileName
- String
Параметр типа String, содержащий имя отправляемого файла и путь к нему. Этот параметр может иметь значение null
.
- preBuffer
- ReadOnlyMemory<Byte>
Массив Byte, содержащий данные, отправляемые перед передачей файла. Этот параметр может иметь значение null
.
- postBuffer
- ReadOnlyMemory<Byte>
Массив Byte, содержащий данные, отправляемые после передачи файла. Этот параметр может иметь значение null
.
- flags
- TransmitFileOptions
Одно или несколько значений TransmitFileOptions.
- cancellationToken
- CancellationToken
Маркер отмены, который можно использовать для отмены асинхронной операции.
Возвращаемое значение
Задача со значением, представляющая асинхронную операцию отправки файла.
Исключения
Объект Socket закрыт.
Объект Socket не подключен к удаленному узлу.
Файл fileName
не найден.
Произошла ошибка при попытке доступа к сокету.
Маркер отмены был отменен. Это исключение сохраняется в возвращаемой задаче.