FormatPropertyInstance-Funktion

Die FormatPropertyInstance-Funktion formatiert die Eigenschaftsinstanzdaten mithilfe des generischen Formatierungsformatierers, der Netzwerkmonitor bereitstellt.

Syntax

DWORD WINAPIV FormatPropertyInstance(
  _Inout_ LPPROPERTYINST lpPropertyInst
);

Parameter

lpPropertyInst [ in, out]

Ein Zeiger auf eine PROPERTYINST-Struktur, die die Instanzdaten enthält.

Bei der Eingabe übernimmt der generische Formatierungierer die Instanzdaten von einem der PROPERTYINST-Union-Member und konvertiert diese Daten in eine vordefinierte formatierte Zeichenfolge.

Bei der Ausgabe legt das generische Formatierungszeichen den szPropertyText-Member der PROPERTYINST-Struktur auf einen Zeiger auf die formatierte Zeichenfolge fest.

Rückgabewert

Wenn die Funktion erfolgreich ist, lautet der Rückgabewert NMERR _ SUCCESS.

Wenn die Funktion nicht erfolgreich ist, ist der Rückgabewert ein Fehlercode aus "NMerr.h".

Bemerkungen

Die Parser-DLL ruft indirekt die FormatPropertyInstance-Funktion auf, wenn das generische Formatierer daten formatieren muss, um im Detailbereich der Netzwerkmonitor Ui angezeigt zu werden. Um FormatPropertyInstance aufzurufen, geben Sie es beim Definieren der Eigenschaft im InstanceData-Member der PROPERTYINFO-Struktur an.

Hinweis

Der Parser erkennt nicht, welche Funktion aufgerufen wird, wenn er eine Instanz einer Eigenschaft formatieren muss. Die Funktion kann FormatPropertyInstance oder eine vom Parser definierte benutzerdefinierte Formatfunktion sein. Der Parser ruft jede Formatfunktion auf, die vom InstanceData-Member der PROPERTYINFO-Struktur für die Eigenschaft angegeben wird.

Weitere Informationen und ein Beispiel für die Implementierung von Formateigenschaftenfinden Sie unter Implementieren von FormatProperties. Weitere Informationen dazu, wie das generische Formatierungsformatierer verschiedene Datentypen formatiert, finden Sie unter Generic Formatter Output ( Ausgabe des generischen Formatierungsformatierers).

Requirements (Anforderungen)

Anforderung Wert
Unterstützte Mindestversion (Client)
Windows 2000 Professional [nur Desktop-Apps]
Unterstützte Mindestversion (Server)
Windows 2000 Server [nur Desktop-Apps]
Header
Netmon.h
Bibliothek
Nmapi.lib
DLL
Nmapi.dll

Weitere Informationen

PROPERTYINFO

PROPERTYINST