Функция TdhCleanupPayloadEventFilterDescriptor (tdh.h)

Статья
03/05/2024

Функция TdhCleanupPayloadEventFilterDescriptor освобождает агрегированную структуру фильтров полезных данных, созданных с помощью функции TdhAggregatePayloadFilters .

Синтаксис

TDHSTATUS TdhCleanupPayloadEventFilterDescriptor(
  [in, out] PEVENT_FILTER_DESCRIPTOR EventFilterDescriptor
);

Параметры

[in, out] EventFilterDescriptor

Указатель на структуру EVENT_FILTER_DESCRIPTOR , содержащую агрегированные фильтры, в которых должна быть освобождена выделенная память. Переданная EVENT_FILTER_DESCRIPTOR структура была создана путем вызова функции TdhAggregatePayloadFilters .

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

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

В случае успешного выполнения возвращает ERROR_SUCCESS. В противном случае эта функция возвращает один из следующих кодов возврата в дополнение к другим.

Код возврата	Описание
ERROR_INVALID_PARAMETER	Один или несколько параметров недопустимы.

В Windows 8.1,Windows Server 2012 R2 и более поздних версий функцией EnableTraceEx2 можно использовать фильтры полезных данных событий для фильтрации определенного содержимого события в сеансе средства ведения журнала.

Функция TdhCleanupPayloadEventFilterDescriptor используется для освобождения выделенной памяти, возвращаемой функцией TdhAggregatePayloadFilters .

Примеры

Пример использования функции TdhCleanupPayloadEventFilterDescriptor для освобождения памяти, используемой агрегатными фильтрами полезных данных, см. в примере функции EnableTraceEx2 .

Требования

Требование	Значение
Минимальная версия клиента	Windows 8.1 [только классические приложения]
Минимальная версия сервера	Windows Server 2012 R2 [только классические приложения]
Целевая платформа	Windows
Header	tdh.h
Библиотека	Tdh.lib
DLL	Tdh.dll