PdhGetCounterInfoA-Funktion (pdh.h)

Artikel
11/20/2024

Ruft Informationen zu einem Leistungsindikator ab, z. B. Datengröße, Zählertyp, Pfad und vom Benutzer bereitgestellten Datenwerten.

Syntax

PDH_FUNCTION PdhGetCounterInfoA(
  [in]      PDH_HCOUNTER        hCounter,
  [in]      BOOLEAN             bRetrieveExplainText,
  [in, out] LPDWORD             pdwBufferSize,
  [out]     PPDH_COUNTER_INFO_A lpBuffer
);

Parameter

[in] hCounter

Handle des Zählers, von dem Sie Informationen abrufen möchten. Die PdhAddCounter--Funktion gibt diesen Handle zurück.

[in] bRetrieveExplainText

Bestimmt, ob Erläuterungstext abgerufen wird. Wenn Sie diesen Parameter auf TRUEfestlegen, wird der Erläuterungstext für den Zähler abgerufen. Wenn Sie diesen Parameter auf FALSE-festlegen, ist das Feld im zurückgegebenen Puffer NULL-.

[in, out] pdwBufferSize

Größe des lpBuffer- Puffers in Byte. Wenn null bei eingaben, gibt die Funktion PDH_MORE_DATA zurück und legt diesen Parameter auf die erforderliche Puffergröße fest. Wenn der Puffer größer als die erforderliche Größe ist, legt die Funktion diesen Parameter auf die tatsächliche Größe des verwendeten Puffers fest. Wenn die angegebene Größe für die Eingabe größer als null, aber kleiner als die erforderliche Größe ist, sollten Sie nicht auf die zurückgegebene Größe zurückgreifen, um den Puffer neu zuzuweisen.

[out] lpBuffer

Vom Aufrufer zugewiesener Puffer, der eine PDH_COUNTER_INFO Struktur empfängt. Die Struktur ist variable Länge, da die Zeichenfolgendaten am Ende des Teiles mit fester Formatierung der Struktur angefügt werden. Dies geschieht, damit alle Daten in einem einzelnen Puffer zurückgegeben werden, der vom Aufrufer zugewiesen wird. Legen Sie diesen Wert auf NULL- fest, wenn pdwBufferSize null ist.

Rückgabewert

Wenn die Funktion erfolgreich ist, wird ERROR_SUCCESS zurückgegeben.

Wenn die Funktion fehlschlägt, ist der Rückgabewert ein Systemfehlercode oder ein PDH-Fehlercode. Im Folgenden sind mögliche Werte aufgeführt.

Rückgabecode	Beschreibung
PDH_INVALID_ARGUMENT	Ein Parameter ist ungültig oder falsch formatiert. Bei einigen Versionen können Sie diesen Fehler z. B. erhalten, wenn die angegebene Größe für die Eingabe größer als 0, aber kleiner als die erforderliche Größe ist.
PDH_INVALID_HANDLE	Der Zählerziehpunkt ist ungültig.
PDH_MORE_DATA	Der lpBuffer- Puffer ist zu klein, um die Leistungsindikatorinformationen zu speichern. Dieser Rückgabewert wird erwartet, wenn pdwBufferSize bei eingaben null ist. Wenn die angegebene Größe für die Eingabe größer als null, aber kleiner als die erforderliche Größe ist, sollten Sie nicht auf die zurückgegebene Größe zurückgreifen, um den Puffer neu zuzuweisen.

Bemerkungen

Sie sollten diese Funktion zweimal aufrufen, zum ersten Mal die erforderliche Puffergröße abrufen (legen Sie lpBuffer auf NULL- und pdwBufferSize auf 0 fest), und das zweite Mal, um die Daten abzurufen.

Anmerkung

Der pdh.h-Header definiert PdhGetCounterInfo als Alias, der die ANSI- oder Unicode-Version dieser Funktion basierend auf der Definition der UNICODE-Präprozessorkonstante automatisch auswählt. Das Mischen der Verwendung des codierungsneutralen Alias mit Code, der nicht codierungsneutral ist, kann zu Nichtübereinstimmungen führen, die zu Kompilierungs- oder Laufzeitfehlern führen. Weitere Informationen finden Sie unter Konventionen für Funktionsprototypen.

Anforderungen

Anforderung	Wert
mindestens unterstützte Client-	Windows XP [nur Desktop-Apps]
mindestens unterstützte Server-	Windows Server 2003 [Nur Desktop-Apps]
Zielplattform-	Fenster
Header-	pdh.h
Library	Pdh.lib
DLL-	Pdh.dll

Siehe auch

PDH_COUNTER_INFO

Freigeben über