PluginExtensionsTryLoadConfigAsync(IPlugin, CancellationToken) - метод

Загружает первый используемый конфигурационный файл для заданного плагина, и возвращает загруженный XML-документ или null, если файл отсутствовал по заданному пути.

Definition

Пространство имён: Chronos.Plugins
Сборка: Chronos.Plugins (в Chronos.Plugins.dll) Версия: 4.0.4
C#
public static ValueTask<XElement> TryLoadConfigAsync(
	this IPlugin plugin,
	CancellationToken cancellationToken = default
)

Параметры

plugin  IPlugin
Плагин, для которого необходимо загрузить конфигурационный файл, указанный в атрибутах.
cancellationToken  CancellationToken  (Optional)
Объект, посредством которого можно отменить асинхронную задачу.

Возвращаемое значение

ValueTaskXElement
Корневой элемент конфигурационного файла или null, если файл отсутствовал по заданному пути.

Примечание об использовании

В Visual Basic и C# этот метод можно вызывать как метод экземпляра для любого объекта типа IPlugin. При вызове метода для экземпляра следует опускать первый параметр. Дополнительные сведения см. в разделе Методы расширения (Visual Basic) или Методы расширения (Руководство по программированию в C#).

Заметки

Если плагин имеет несколько конфигурационных файлов, то рекомендуется использовать перегрузку метода, принимающую относительный путь к файлу.

Исключения

InvalidOperationException Конфигурационный файл не был указан в атрибутах плагина PluginAttribute или PluginTriggerAttribute.

См. также