FileExtensions.ReadAllTextAsync - метод |
Возвращает контент текстового файла или версии файла в виде строки. Контент должен быть уже загружен методом
EnsureContentDownloadedAsync(IFileObject, Func<IFileObject, FileContentDownloadState> , Func<FileContentDownloadState, CancellationToken, ValueTask> , Func<IFileObject, CancellationToken, ValueTask<IFileContent> > , CancellationToken) или
EnsureContentDownloadedInUIAsync(IFileObject, Func<IFileObject, CancellationToken, ValueTask<IFileContent>>, 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.Files.IFileObject
Файл или версия файла, контент которого требуется загрузить. - cancellationToken (Optional)
- Тип: System.Threading.CancellationToken
Объект, посредством которого можно отменить асинхронную задачу.
Возвращаемое значение
Тип:
Task<String>Загруженный текст. Не равен
null.
Примечание об использовании
В Visual Basic и C# этот метод можно вызывать как метод экземпляра для любого объекта типа
IFileObject. При вызове метода для экземпляра следует опускать первый параметр. Дополнительные сведения см. в разделе
Методы расширения (Visual Basic) или
Методы расширения (Руководство по программированию в C#).
ИсключенияИсключение | Условие |
---|
InvalidOperationException |
Контент файла не загружен. Используйте методы EnsureContentDownloadedAsync(IFileObject, Func<IFileObject, FileContentDownloadState> , Func<FileContentDownloadState, CancellationToken, ValueTask> , Func<IFileObject, CancellationToken, ValueTask<IFileContent> > , CancellationToken)
или EnsureContentDownloadedInUIAsync(IFileObject, Func<IFileObject, CancellationToken, ValueTask<IFileContent>>, CancellationToken), прежде чем вызвать этот метод.
|
См. также