PdhLookupPerfNameByIndexA-Funktion (pdh.h)

  • Artikel

Gibt den Leistungsobjektnamen oder den Leistungsindikatornamen zurück, der dem angegebenen Index entspricht.

Syntax

PDH_FUNCTION PdhLookupPerfNameByIndexA(
  [in]      LPCSTR  szMachineName,
  [in]      DWORD   dwNameIndex,
  [out]     LPSTR   szNameBuffer,
  [in, out] LPDWORD pcchNameBufferSize
);

Parameter

[in] szMachineName

Null-terminierte Zeichenfolge, die den Namen des Computers angibt, auf dem sich das angegebene Leistungsobjekt oder leistungsindikator befindet. Der Computername kann durch den DNS-Namen oder die IP-Adresse angegeben werden. Wenn NULL, verwendet die Funktion den lokalen Computer.

[in] dwNameIndex

Index des Leistungsobjekts oder Leistungsindikators.

[out] szNameBuffer

Vom Aufrufer zugewiesener Puffer, der den NULL-endendten Namen des Leistungsobjekts oder Leistungsindikators empfängt. Legen Sie auf NULL fest, wenn pcchNameBufferSize null ist.

[in, out] pcchNameBufferSize

Größe des szNameBuffer-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 szNameBuffer ist nicht groß genug, um den Zählernamen zu enthalten. Dieser Rückgabewert wird erwartet, wenn pcchNameBufferSize 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 Parameter ist ungültig oder falsch formatiert. 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.

Hinweise

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

Windows XP: Sie müssen einen Puffer und eine Puffergröße angeben. Die Funktion legt pcchNameBufferSize entweder auf die erforderliche Größe oder die Größe des verwendeten Puffers fest. Wenn der Puffer zu klein ist, gibt die Funktion PDH_INSUFFICIENT_BUFFER anstelle von PDH_MORE_DATA zurück. Die maximale Zeichenfolgengröße in Byte beträgt PDH_MAX_COUNTER_NAME * sizeof(TCHAR).

Der von Ihnen angegebene Indexwert muss mit einem der Indexwerte übereinstimmen, die den auf dem Computer geladenen Objekten oder Leistungsindikatoren zugeordnet sind. Die Index-/Name-Wertpaare werden im Registrierungswert Counters am folgenden Registrierungsspeicherort gespeichert.

HKEY_LOCAL_MACHINE
   \SOFTWARE
      \Microsoft
         \Windows NT
            \CurrentVersion
               \Perflib
                  Last Counter = highest counter index
                  Last Help = highest help index
                  \009
                     Counters = 2 System 4 Memory...
                     Help = 3 The System Object Type...
                  \supported language, other than English
                     Counters = ...
                     Help = ...

Hinweis

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

PdhLookupPerfIndexByName