FormatPropertyInstance 函数

FormatPropertyInstance 函数使用网络监视器提供的泛型格式化程序设置属性实例数据的格式。

语法

DWORD WINAPIV FormatPropertyInstance(
  _Inout_ LPPROPERTYINST lpPropertyInst
);

参数

lpPropertyInst [in， out]

指向包含实例数据的 PROPERTYINST 结构的指针。

输入时，泛型格式化程序从其中一个 PROPERTYINST 联合成员获取实例数据，并将该数据转换为预定义的格式化字符串。

在输出时，泛型格式化程序将 PROPERTYINST 结构的 szPropertyText 成员设置为指向格式化字符串的指针。

返回值

如果函数成功，则返回值NMERR_SUCCESS。

如果该函数不成功，则返回值是 NMerr.h 中的错误代码。

备注

当泛型格式化程序需要格式化数据以在网络监视器 UI 的详细信息窗格中显示时，分析器 DLL 间接调用 FormatPropertyInstance 函数。 若要调用 FormatPropertyInstance，请在定义属性时在 PROPERTYINFO 结构的 InstanceData 成员中指定它。

注意

当分析程序必须设置属性实例的格式时，无法识别调用哪个函数。 函数可以是 FormatPropertyInstance ，也可以是分析器定义的自定义格式函数。 分析程序调用由 PROPERTYINFO 结构的 InstanceData 成员为属性指定的任何格式函数。

有关如何实现 formatproperties 的详细信息和示例，请参阅 Implementing FormatProperties。 有关泛型格式化程序如何设置不同类型的数据格式的详细信息，请参阅 泛型格式化程序输出。

要求

要求	值
最低受支持的客户端	Windows 2000 Professional [仅限桌面应用]
最低受支持的服务器	Windows 2000 Server [仅限桌面应用]
标头	Netmon.h
库	Nmapi.lib
DLL	Nmapi.dll

另请参阅

PROPERTYINFO

PROPERTYINST