ISettingsUnitHistoryManagerGetReportDigest - метод

Generates a digest string for a specific settings unit or category.

Definition

Пространство имён: Tessa.SettingsUnits
Сборка: Tessa (в Tessa.dll) Версия: 4.2.0+ffad8363f63902f18b3b3f4cfa533a14b2fb19a6
C#
string GetReportDigest(
	SettingsUnitKey? key = null,
	string? category = null
)

Параметры

key  SettingsUnitKey  (Optional)
Key for identifying a settings unit or fragment.
If provided, the digest will include the unit name or identifier.
category  String  (Optional)
Path to the category where the settings unit is located. The value must satisfy the CategoryPattern pattern.
The "/" symbol is used to separate categories:
  • Categorycategory
  • Subcategorycategory/subcategory
If no key is provided, the digest will represent the category.

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

String
A string suitable for use as a digest or description in logs, action history, or error reports.

Заметки

The digest is intended to be used in action history records and error reporting to provide context about the affected entity.

См. также