PdhMakeCounterPathA-Funktion (pdh.h)

  • Artikel

Erstellt einen vollständigen Zählerpfad unter Verwendung 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 Member szObjectName und szCounterName sind erforderlich, die anderen sind optional.

Wenn das instance Namenselement NULL ist, enthält der Pfad keinen instance Verweis, und die Member szParentInstance und dwInstanceIndex werden ignoriert.

[out] szFullPathBuffer

Vom Aufrufer zugewiesener Puffer, der einen null-beendeten Zählerpfad empfängt. Die maximale Länge eines Zählerpfads ist PDH_MAX_COUNTER_PATH. Legen Sie auf NULL fest, wenn pcchBufferSize 0 ist.

[in, out] pcchBufferSize

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

[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 Eigenschaftsnamenformat.
PDH_PATH_WBEM_INPUT
 Konvertiert den Namen der WMI-Klasse und -Eigenschaft 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, 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 szFullPathBuffer-Puffer 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 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 Parameter ist ungültig oder falsch formatiert. 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.

Hinweise

Sie sollten diese Funktion zweimal aufrufen, zum ersten Mal zum Abrufen der erforderlichen Puffergröße (Festlegen von szFullPathBuffer auf NULL und pcchBufferSize auf 0) und beim zweiten Mal zum Abrufen der Daten.

Hinweis

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

PDH_COUNTER_PATH_ELEMENTS

PdhParseCounterPath