Freigeben über


FormatPropertyInstance-Funktion

Die FormatPropertyInstance-Funktion formatiert die Eigenschaft instance Daten mithilfe des generischen Formatierungsprogramms, den Network Monitor bereitstellt.

Syntax

DWORD WINAPIV FormatPropertyInstance(
  _Inout_ LPPROPERTYINST lpPropertyInst
);

Parameter

lpPropertyInst [in, out]

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

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

In der Ausgabe legt der generische Formatierer das element szPropertyText der PROPERTYINST-Struktur auf einen Zeiger auf die formatierte Zeichenfolge fest.

Rückgabewert

Wenn die Funktion erfolgreich ist, wird der Rückgabewert NMERR_SUCCESS.

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

Bemerkungen

Die Parser-DLL ruft indirekt die FormatPropertyInstance-Funktion auf, wenn der generische Formatierer erforderlich ist, um Daten für die Anzeige im Detailbereich der Benutzeroberfläche des Netzwerkmonitors zu formatieren. Um FormatPropertyInstance aufzurufen, geben Sie es im InstanceData-Member der PROPERTYINFO-Struktur an, wenn Sie die Eigenschaft definieren.

Hinweis

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

Weitere Informationen und ein Beispiel zum Implementieren von Formateigenschaften finden Sie unter Implementieren von FormatEigenschaften. Weitere Informationen dazu, wie der generische Formatierer verschiedene Datentypen formatiert, finden Sie unter Generic Formatter Output.

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

Siehe auch

PROPERTYINFO

PROPERTYINST