PdhGetCounterInfoA-Funktion (pdh.h)
Ruft Informationen zu einem Leistungsindikator ab, z. B. Datengröße, Indikatortyp, Pfad und vom Benutzer bereitgestellte Datenwerte.
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, aus dem Sie Informationen abrufen möchten. Die PdhAddCounter-Funktion gibt dieses Handle zurück.
[in] bRetrieveExplainText
Bestimmt, ob Explain-Text abgerufen wird. Wenn Sie diesen Parameter auf TRUE festlegen, 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 Bytes. Wenn null bei der Eingabe, 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 bei der Eingabe größer als null, aber kleiner als die erforderliche Größe ist, sollten Sie sich nicht auf die zurückgegebene Größe verlassen, um den Puffer neu zuzuweisen.
[out] lpBuffer
Vom Aufrufer zugewiesener Puffer, der eine PDH_COUNTER_INFO-Struktur empfängt. Die Struktur hat eine variable Länge, da die Zeichenfolgendaten an das Ende des Fester-Format-Teils der Struktur angefügt werden. Dies erfolgt, sodass alle Daten in einem einzelnen Puffer zurückgegeben werden, der vom Aufrufer zugeordnet wird. Legen Sie 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. Die folgenden Werte sind möglich.
| Rückgabecode | Beschreibung |
|---|---|
|
Ein Parameter ist ungültig oder falsch formatiert. Bei einigen Releases kann dieser Fehler beispielsweise angezeigt werden, wenn die angegebene Größe bei der Eingabe größer als null, aber kleiner als die erforderliche Größe ist. |
|
Das Zählerhandle ist ungültig. |
|
Der lpBuffer-Puffer ist zu klein, um die Zählerinformationen zu speichern. Dieser Rückgabewert wird erwartet, wenn pdwBufferSize bei der Eingabe null ist. Wenn die angegebene Größe bei der Eingabe größer als null, aber kleiner als die erforderliche Größe ist, sollten Sie sich nicht auf die zurückgegebene Größe verlassen, um den Puffer neu zuzuweisen. |
Hinweise
Sie sollten diese Funktion zweimal aufrufen, das erste Mal, um die erforderliche Puffergröße abzurufen (legen Sie lpBuffer auf NULL und pdwBufferSize auf 0 fest), und beim zweiten Mal, um die Daten abzurufen.
Hinweis
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 |
|---|---|
| Unterstützte Mindestversion (Client) | Windows XP [nur Desktop-Apps] |
| Unterstützte Mindestversion (Server) | Windows Server 2003 [nur Desktop-Apps] |
| Zielplattform | Windows |
| Kopfzeile | pdh.h |
| Bibliothek | Pdh.lib |
| DLL | Pdh.dll |