PdhGetDefaultPerfCounterHW-Funktion (pdh.h)

  • Artikel

Ruft den Namen des Standardindikators für das angegebene Objekt ab. Dieser Name kann verwendet werden, um die anfängliche Zählerauswahl im Dialogfeld Zähler durchsuchen festzulegen.

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

Syntax

PDH_FUNCTION PdhGetDefaultPerfCounterHW(
  [in]      PDH_HLOG hDataSource,
  [in]      LPCWSTR  szMachineName,
  [in]      LPCWSTR  szObjectName,
  [out]     LPWSTR   szDefaultCounterName,
  [in, out] LPDWORD  pcchBufferSize
);

Parameter

[in] hDataSource

Sollte NULL sein.

Wenn Sie ein Protokolldateihandle angeben, ist szDefaultCounterName 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.

[in] szObjectName

Null-terminierte Zeichenfolge, die den Namen des Objekts angibt, dessen Standardindikatorname Sie abrufen möchten.

[out] szDefaultCounterName

Vom Aufrufer zugewiesener Puffer, der den Standardzählernamen mit NULL-Beendigung empfängt. Legen Sie auf NULL fest, wenn pcchBufferSize null ist.

[in, out] pcchBufferSize

Größe des szDefaultCounterName-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 szDefaultCounterName ist zu klein, um den Zählernamen 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.
PDH_CSTATUS_NO_COUNTERNAME
 Der Standardindikatorname kann nicht gelesen oder gefunden werden.
PDH_CSTATUS_NO_OBJECT
 Das angegebene Objekt konnte nicht gefunden werden.
PDH_CSTATUS_NO_COUNTER
 Das -Objekt hat keinen Standardindikator angegeben.

Hinweise

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

Hinweis

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

PdhBindInputDataSource

PdhBrowseCountersH

PdhGetDefaultPerfObjectH