PdhEnumLogSetNamesA-Funktion (pdh.h)

Artikel
11/20/2024

Listet die Namen der Protokollsätze innerhalb des DSN auf.

Syntax

PDH_FUNCTION PdhEnumLogSetNamesA(
  [in]      LPCSTR  szDataSource,
  [out]     PZZSTR  mszDataSetNameList,
  [in, out] LPDWORD pcchBufferLength
);

Parameter

[in] szDataSource

Null-Zeichenfolge-terminated, die den DSN angibt.

[out] mszDataSetNameList

Vom Aufrufer zugewiesener Puffer, der die Liste der null--terminated log set names empfängt. Die Liste wird mit einem Nullzeichen-terminator beendet. Wird auf NULL- festgelegt, wenn der pcchBufferLength Parameter null ist.

[in, out] pcchBufferLength

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

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	Die Größe des mszLogSetNameList- Puffers ist zu klein, um alle Daten zu enthalten. Dieser Rückgabewert wird erwartet, wenn pcchBufferLength bei eingaben 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. 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 (legen Sie mszLogSetNameList auf null und pcchBufferLength auf 0 fest), und das zweite Mal, um die Daten abzurufen.

Anmerkung

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

Freigeben über