FileExtensionsReadAllTextAsync - метод |
Возвращает контент текстового файла или версии файла в виде строки. Контент должен быть уже загружен методом
EnsureContentDownloadedAsync(IFileObject, FuncIFileObject, FileContentDownloadState, FuncFileContentDownloadState, CancellationToken, ValueTask, FuncIFileObject, CancellationToken, ValueTaskIFileContent, CancellationToken) или
EnsureContentDownloadedInUIAsync(IFileObject, FuncIFileObject, CancellationToken, ValueTaskIFileContent, CancellationToken).
Этот метод оптимизирован по потреблению памяти, поэтому для получения данных рекомендуется использовать именно его.
Пространство имён:
Tessa.Files
Сборка:
Tessa (в Tessa.dll) Версия: 3.5.0.19
Синтаксис public static Task<string> ReadAllTextAsync(
this IFileObject obj,
CancellationToken cancellationToken = default
)
<ExtensionAttribute>
Public Shared Function ReadAllTextAsync (
obj As IFileObject,
Optional cancellationToken As CancellationToken = Nothing
) As Task(Of String)
public:
[ExtensionAttribute]
static Task<String^>^ ReadAllTextAsync(
IFileObject^ obj,
CancellationToken cancellationToken = CancellationToken()
)
[<ExtensionAttribute>]
static member ReadAllTextAsync :
obj : IFileObject *
?cancellationToken : CancellationToken
(* Defaults:
let _cancellationToken = defaultArg cancellationToken new CancellationToken()
*)
-> Task<string>
Параметры
- obj
- Тип: Tessa.FilesIFileObject
Файл или версия файла, контент которого требуется загрузить. - cancellationToken (Optional)
- Тип: System.ThreadingCancellationToken
Объект, посредством которого можно отменить асинхронную задачу.
Возвращаемое значение
Тип:
TaskStringЗагруженный текст. Не равен
null.
Примечание об использовании
В Visual Basic и C# этот метод можно вызывать как метод экземпляра для любого объекта типа
IFileObject. При вызове метода для экземпляра следует опускать первый параметр. Дополнительные сведения см. в разделе
Методы расширения (Visual Basic) или
Методы расширения (Руководство по программированию в C#).
Исключения Исключение | Условие |
---|
InvalidOperationException |
Контент файла не загружен. Используйте методы EnsureContentDownloadedAsync(IFileObject, FuncIFileObject, FileContentDownloadState, FuncFileContentDownloadState, CancellationToken, ValueTask, FuncIFileObject, CancellationToken, ValueTaskIFileContent, CancellationToken)
или EnsureContentDownloadedInUIAsync(IFileObject, FuncIFileObject, CancellationToken, ValueTaskIFileContent, CancellationToken), прежде чем вызвать этот метод.
|
См. также