Метод ITraceDataProvider::get_KeywordsAny (pla.h)
Извлекает список ключевых слов, определяющих категорию событий, которые требуется записать поставщику.
Это свойство доступно только для чтения.
Синтаксис
HRESULT get_KeywordsAny(
IValueMap **ppKeywords
);
Параметры
ppKeywords
Возвращаемое значение
None
Remarks
Ключевые слова определяют категорию событий, которые требуется записать поставщику. Поставщик записывает событие, если какой-либо из битов ключевое слово события соответствует любому из битов, заданных в этой маске KeywordsAny.
Чтобы включить все события, которые предоставляет поставщик, присвойте этому свойству нулевое значение. Чтобы включить только определенные события, задайте для этого ключевое слово маски эти события. Например, если поставщик определяет событие для процедур инициализации и очистки (бит 0), событие для операций с файлами (бит 1) и событие для операций вычисления (бит 2), можно включить только два из этих событий, установив для этой маски значение 5 (установите биты 0 и 2) для получения событий инициализации и очистки и вычислений.
Чтобы дополнительно ограничить категорию событий, которые будет записывать поставщик, также задайте свойство ITraceDataProvider::KeywordsAll .
Если поставщик определяет более сложные ключевые слова событий (например, поставщик определяет событие, которое задает бит 0 для чтения и бит 1 для локального доступа и второе событие, которое задает бит 0 для чтения и бит 2 для удаленного доступа), можно задать для этой маски значение 1, чтобы получать все события чтения, или задать для этой маски значение 1, а маску KeywordsAll — значение 3, чтобы получать только локальные операции чтения.
Если ключевое слово события равно нулю, поставщик запишет событие в сеанс независимо от этой маски или маски KeywordsAll.
Для поставщиков, которые были написаны в операционной системе до Windows Vista, значение ключевое слово будет сопоставлено с флагами включения.
Для получения или задания значения ключевых слов используется интерфейс IValueMap . Свойство IValueMap::Value можно использовать для получения значения ключевых слов (значения всех элементов карты в сочетании с оператором OR) или перечислить каждый элемент на карте, чтобы получить отдельные значения ключевое слово.
Аналогичным образом, при установке значения ключевых слов вызывается свойство IValueMap::Value, чтобы задать значение ключевых слов, или метод IValueMap::Add, чтобы добавить каждое отдельное значение ключевое слово.
Если вы используете IValueMap::Value для задания ключевых слов, а карта значений содержит один или несколько элементов, PLA выполняет поиск совпадающих значений в коллекции, включает их и отключает остальные. Если значение не существует в списке, PLA добавляет ключевое слово (элемент не называется).
Свойство IValueMapItem::Key содержит строковое представление ключевое слово. Свойство IValueMapItem::Value содержит значение ключевое слово. Свойство IValueMapItem::Enabled указывает, включена ли ключевое слово. Интерфейс IValueMapItem необходимо использовать только в том случае, если вы хотите присвоить имя ключевое слово или включить или отключить ключевые слова без добавления или удаления.
Требования
Требование | Значение |
---|---|
Минимальная версия клиента | Windows Vista [только классические приложения] |
Минимальная версия сервера | Windows Server 2008 [только классические приложения] |
Целевая платформа | Windows |
Header | pla.h |
DLL | Pla.dll |