Поделиться через


Функция FormatPropertyInstance

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

Синтаксис

DWORD WINAPIV FormatPropertyInstance(
  _Inout_ LPPROPERTYINST lpPropertyInst
);

Параметры

lpPropertyInst [in, out]

Указатель на структуру PROPERTYINST , содержащую данные экземпляра.

При входе универсальный модуль форматирования принимает данные экземпляра из одного из членов объединения PROPERTYINST и преобразует эти данные в предопределенную форматированную строку.

В выходных данных универсальный модуль форматирования задает элемент szPropertyText структуры PROPERTYINST в качестве указателя на форматированную строку.

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

Если функция выполнена успешно, возвращаемое значение будет NMERR_SUCCESS.

Если функция завершается неудачно, возвращаемое значение представляет собой код ошибки из NMerr.h.

Комментарии

Библиотека DLL средства синтаксического анализа косвенно вызывает функцию FormatPropertyInstance , когда универсальный модуль форматирования требуется для форматирования данных для отображения в области сведений пользовательского интерфейса сетевого монитора. Чтобы вызвать FormatPropertyInstance , укажите его в элементе InstanceData структуры PROPERTYINFO при определении свойства .

Примечание

Средство синтаксического анализа не распознает, какая функция вызывается при форматировании экземпляра свойства. Функция может быть FormatPropertyInstance или пользовательской функцией форматирования, определенной синтаксический анализатор. Средство синтаксического анализа вызывает любую функцию формата, заданную элементом InstanceData структуры PROPERTYINFO для свойства .

Дополнительные сведения и пример реализации свойств formatproperties см. в разделе Реализация атрибутов formatProperties. Дополнительные сведения о том, как универсальный модуль форматирования форматирует различные типы данных, см. в разделе Выходные данные универсального модуля форматирования.

Требования

Требование Значение
Минимальная версия клиента
Windows 2000 Professional [только классические приложения]
Минимальная версия сервера
Windows 2000 Server [только классические приложения]
Заголовок
Netmon.h
Библиотека
Nmapi.lib
DLL
Nmapi.dll

См. также раздел

PROPERTYINFO

PROPERTYINST