PdhParseInstanceNameA-Funktion (pdh.h)

Artikel
03/01/2024

Analysiert die Elemente einer instance Zeichenfolge.

Syntax

PDH_FUNCTION PdhParseInstanceNameA(
  [in]      LPCSTR  szInstanceString,
  [out]     LPSTR   szInstanceName,
  [in, out] LPDWORD pcchInstanceNameLength,
  [out]     LPSTR   szParentName,
  [in, out] LPDWORD pcchParentNameLength,
  [out]     LPDWORD lpIndex
);

Parameter

[in] szInstanceString

Null-terminierte Zeichenfolge, die die instance Zeichenfolge angibt, die in einzelne Komponenten analysiert werden soll. Diese Zeichenfolge kann die folgenden Formate enthalten und ist kleiner als MAX_PATH Zeichen:

instance
instance#index
parent/instance
parent/instance#index

[out] szInstanceName

Vom Aufrufer zugewiesener Puffer, der den null-endigen instance Namen empfängt. Legen Sie auf NULL fest, wenn pcchInstanceNameLength null ist.

[in, out] pcchInstanceNameLength

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

[out] szParentName

Vom Aufrufer zugewiesener Puffer, der den NULL-Endnamen des übergeordneten instance empfängt, sofern angegeben. Legen Sie auf NULL fest, wenn pcchParentNameLength null ist.

[in, out] pcchParentNameLength

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

[out] lpIndex

Indexwert des instance. Wenn in der Zeichenfolge kein Indexeintrag vorhanden ist, ist dieser Wert null. Dieser Parameter kann NULL sein.

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_INVALID_ARGUMENT	Ein Parameter ist nicht gü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_MORE_DATA	Einer oder beide Zeichenfolgenpuffer sind zu klein, um die Daten zu enthalten. Dieser Rückgabewert wird erwartet, wenn der entsprechende Größenpuffer 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_INSTANCE	Die instance Zeichenfolge ist falsch formatiert, überschreitet MAX_PATH Zeichen oder kann nicht analysiert werden.

Hinweise

Sie sollten diese Funktion zweimal aufrufen, das erste Mal, um die erforderliche Puffergröße abzurufen (legen Sie die Puffer auf NULL und die Puffergrößen auf 0 fest), und beim zweiten Mal, um die Daten abzurufen.

Hinweis

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

PdhMakeCounterPath

Share via