PdhMakeCounterPathA-Funktion (pdh.h)

Artikel
11/20/2024

Erstellt einen vollständigen Zählerpfad mithilfe der elemente, die in der PDH_COUNTER_PATH_ELEMENTS-Struktur angegeben sind.

Syntax

PDH_FUNCTION PdhMakeCounterPathA(
  [in]      PPDH_COUNTER_PATH_ELEMENTS_A pCounterPathElements,
  [out]     LPSTR                        szFullPathBuffer,
  [in, out] LPDWORD                      pcchBufferSize,
  [in]      DWORD                        dwFlags
);

Parameter

[in] pCounterPathElements

Eine PDH_COUNTER_PATH_ELEMENTS Struktur, die die Elemente enthält, die zum Erstellen des Pfads verwendet werden. Nur die szObjectName und szCounterName Member sind erforderlich, die anderen sind optional.

Wenn der Instanznamemember NULL-ist, enthält der Pfad keinen Instanzverweis, und die szParentInstance und dwInstanceIndex Member werden ignoriert.

[out] szFullPathBuffer

Vom Aufrufer zugewiesener Puffer, der einen null--terminated counter path empfängt. Die maximale Länge eines Zählerpfads ist PDH_MAX_COUNTER_PATH. Wird auf NULL- festgelegt, wenn pcchBufferSize null ist.

[in, out] pcchBufferSize

Größe des szFullPathBuffer 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.

[in] dwFlags

Format der Eingabe- und Ausgabezählerwerte. Sie können einen der folgenden Werte angeben.

Wert	Bedeutung
PDH_PATH_WBEM_RESULT	Konvertiert einen PDH-Pfad in das WMI-Klassen- und Eigenschaftennamenformat.
PDH_PATH_WBEM_INPUT	Konvertiert die WMI-Klasse und den Eigenschaftennamen in einen PDH-Pfad.
0	Gibt den Pfad im PDH-Format zurück, z. B. \\computer\object(parent/instance#index)\counter.

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 szFullPathBuffer Puffer ist zu klein, um den Zählernamen 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 Parameter ist ungültig oder falsch formatiert. 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.

Bemerkungen

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

Anmerkung

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

PDH_COUNTER_PATH_ELEMENTS

PdhParseCounterPath

Freigeben über