PdhGetDefaultPerfObjectA-Funktion (pdh.h)

Artikel
03/01/2024

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

Um Handles für Datenquellen zu verwenden, verwenden Sie die PdhGetDefaultPerfObjectH-Funktion .

Syntax

PDH_FUNCTION PdhGetDefaultPerfObjectA(
  [in]      LPCSTR  szDataSource,
  [in]      LPCSTR  szMachineName,
  [out]     LPSTR   szDefaultObjectName,
  [in, out] LPDWORD pcchBufferSize
);

Parameter

[in] szDataSource

Sollte NULL sein.

Wenn Sie eine Protokolldatei angeben, ist der szDefaultObjectName-Parameter eine NULL-Zeichenfolge .

[in] szMachineName

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

[out] szDefaultObjectName

Vom Aufrufer zugewiesener Puffer, der den Null-Endungsstandardobjektnamen empfängt. Legen Sie auf NULL fest, wenn der parameter pcchBufferSize 0 ist.

Beachten Sie, dass PDH immer Prozessor als Standardobjektnamen zurückgibt.

[in, out] pcchBufferSize

Größe des Puffers "szDefaultObjectName" in TCHARs. Wenn bei der Eingabe null angegeben wird, 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 0, aber kleiner als die erforderliche Größe ist, sollten Sie sich nicht auf die zurückgegebene Größe verlassen, um den Puffer neu zuzurücken.

Rückgabewert

Wenn die Funktion erfolgreich ist, gibt sie ERROR_SUCCESS zurück.

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 Puffer szDefaultObjectName ist zu klein, um den Objektnamen zu enthalten. Dieser Rückgabewert wird erwartet, wenn pcchBufferSize bei der Eingabe null ist. Wenn die angegebene Größe für die Eingabe größer als 0, aber kleiner als die erforderliche Größe ist, sollten Sie sich nicht auf die zurückgegebene Größe verlassen, um den Puffer neu zuzurücken.
PDH_INVALID_ARGUMENT	Ein erforderlicher Parameter ist ungültig. Bei einigen Releases kann dieser Fehler beispielsweise angezeigt werden, 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.

Hinweise

Sie sollten diese Funktion zweimal aufrufen, zum ersten Mal zum Abrufen der erforderlichen Puffergröße (festlegen sie szDefaultObjectName auf NULL und pcchBufferSize auf 0), und beim zweiten Mal, um die Daten abzurufen.

Hinweis

Der pdh.h-Header definiert PdhGetDefaultPerfObject als Alias, der automatisch die ANSI- oder Unicode-Version dieser Funktion basierend auf der Definition der UNICODE-Präprozessorkonstante auswählt. Das Mischen der Verwendung des codierungsneutralen Alias mit nicht codierungsneutralem Code 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

Weitere Informationen

PdhGetDefaultPerfCounter

PdhGetDefaultPerfObjectH

Share via