Función FormatPropertyInstance

La función FormatPropertyInstance da formato a los datos de la instancia de propiedad mediante el formateador genérico que proporciona Network Monitor.

Sintaxis

DWORD WINAPIV FormatPropertyInstance(
  _Inout_ LPPROPERTYINST lpPropertyInst
);

Parámetros

lpPropertyInst [in, out]

Puntero a una estructura PROPERTYINST que contiene los datos de instancia.

En la entrada, el formateador genérico toma los datos de instancia de uno de los miembros de unión PROPERTYINST y convierte esos datos en una cadena con formato predefinido.

En la salida, el formateador genérico establece el miembro szPropertyText de la estructura PROPERTYINST en un puntero a la cadena con formato.

Valor devuelto

Si la función se realiza correctamente, se NMERR_SUCCESS el valor devuelto.

Si la función no se realiza correctamente, el valor devuelto es un código de error de NMerr.h.

Comentarios

El archivo DLL del analizador llama indirectamente a la función FormatPropertyInstance cuando se requiere el formateador genérico para dar formato a los datos para mostrarlos en el panel de detalles de la interfaz de usuario del Monitor de red. Para llamar a FormatPropertyInstance , especifíquelo en el miembro InstanceData de la estructura PROPERTYINFO al definir la propiedad .

Nota:

El analizador no reconoce a qué función se llama cuando debe dar formato a una instancia de una propiedad. La función puede ser FormatPropertyInstance o una función de formato personalizado definida por el analizador. El analizador llama a cualquier función de formato especificada por el miembro InstanceData de la estructura PROPERTYINFO de la propiedad .

Para obtener más información y un ejemplo de cómo implementar formatproperties, consulte Implementación de FormatProperties. Para obtener más información sobre cómo el formateador genérico da formato a distintos tipos de datos, vea Salida de formateador genérico.

Requisitos

Requisito	Value
Cliente mínimo compatible	Windows 2000 Professional [solo aplicaciones de escritorio]
Servidor mínimo compatible	Windows 2000 Server [solo aplicaciones de escritorio]
Encabezado	Netmon.h
Biblioteca	Nmapi.lib
Archivo DLL	Nmapi.dll

Consulte también

PROPERTYINFO

PROPERTYINST