PdhGetDefaultPerfObjectW-Funktion (pdh.h)

  • Artikel

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 PdhGetDefaultPerfObjectW(
  [in]      LPCWSTR szDataSource,
  [in]      LPCWSTR szMachineName,
  [out]     LPWSTR  szDefaultObjectName,
  [in, out] LPDWORD pcchBufferSize
);

Parameter

[in] szDataSource

Sollte NULL sein.

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

[in] szMachineName

Null-terminierte 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-Endungsstandardobjektnamen empfängt. Legen Sie auf NULL fest, wenn der parameter 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 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.

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
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 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.
PDH_INVALID_ARGUMENT
 Ein erforderlicher Parameter ist ungültig. 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.
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, beim ersten 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 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

Weitere Informationen

PdhGetDefaultPerfCounter

PdhGetDefaultPerfObjectH