PdhGetDefaultPerfObjectHA-Funktion (pdh.h)

Artikel
11/20/2024

Ruft den Namen des Standardobjekts ab. Dieser Name kann verwendet werden, um die anfängliche Objektauswahl im Dialogfeld "Suchindikator" festzulegen.

Diese Funktion ist identisch mit der PdhGetDefaultPerfObject--Funktion, mit der Ausnahme, dass sie die Verwendung von Handles für Datenquellen unterstützt.

Syntax

PDH_FUNCTION PdhGetDefaultPerfObjectHA(
  [in]      PDH_HLOG hDataSource,
  [in]      LPCSTR   szMachineName,
  [out]     LPSTR    szDefaultObjectName,
  [in, out] LPDWORD  pcchBufferSize
);

Parameter

[in] hDataSource

Sollte NULL-sein.

Wenn Sie ein Protokolldateihandle angeben, ist szDefaultObjectName- eine NULL- Zeichenfolge.

[in] szMachineName

Null--terminated-Zeichenfolge, die den Namen des Computers angibt, der zum Überprüfen des Objektnamens verwendet wird. Wenn NULL-, wird der lokale Computer verwendet, um den Namen zu überprüfen.

[out] szDefaultObjectName

Vom Aufrufer zugewiesener Puffer, der den NULL--terminated-Standardobjektnamen empfängt. Wird auf NULL- festgelegt, wenn pcchBufferSize null ist.

Beachten Sie, dass PDH immer Prozessor für den Standardobjektnamen zurückgibt.

[in, out] pcchBufferSize

Größe des szDefaultObjectName Puffers in TCHARs. 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.

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_MORE_DATA	Der szDefaultObjectName Puffer ist zu klein, um den Objektnamen zu enthalten. Dieser Rückgabewert wird erwartet, wenn pcchBufferSize für die Eingabe 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.
PDH_INVALID_ARGUMENT	Ein erforderlicher Parameter ist ungültig. 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_MEMORY_ALLOCATION_FAILURE	Speicher kann nicht zugeordnet werden, um die Funktion abzuschließen.
PDH_CSTATUS_NO_MACHINE	Der angegebene Computer ist offline oder nicht verfügbar.
PDH_CSTATUS_NO_COUNTERNAME	Der Standardobjektname kann nicht gelesen oder gefunden werden.

Bemerkungen

Sie sollten diese Funktion zweimal aufrufen, zum ersten Mal, um die erforderliche Puffergröße abzurufen (szDefaultObjectName auf NULL- und pcchBufferSize auf 0 festgelegt) und das zweite Mal, um die Daten abzurufen.

Anmerkung

Der pdh.h-Header definiert PdhGetDefaultPerfObjectH 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

PdhBindInputDataSource-

PdhBrowseCountersH

PdhGetDefaultPerfCounterH

Freigeben über