PdhVbOpenLog-Funktion
Die PdhVbOpenLog-Funktion öffnet die angegebene Protokolldatei zum Lesen und Schreiben. Diese Funktion ruft PdhOpenLog auf.
Wichtig
Die in diesem Thema beschriebene Funktion kann in Zukunft geändert oder nicht mehr verfügbar sein. Stattdessen empfiehlt Microsoft, die unter Leistungsindikatorenfunktionen beschriebenen Funktionen zu verwenden.
Function PdhVbOpenLog( _ ByVal szLogFileName As LPCTSTR, _ ByVal dwAccessFlags As DWORD, _ ByVal lpdwLogType As LPDWORD, _ ByVal hQuery As PDH_HQUERY, _ ByVal dwMaxSize As DWORD, _ ByVal szUserCaption As LPCSTR, _ ByRef phLog As PDH_HLOG _ ) As DWORD
Parameter
-
szLogFileName [in]
-
Zeiger auf eine Zeichenfolge, die den Namen der zu öffnenden Protokolldatei angibt.
Wenn die Protokolldatei SQL-Daten enthält, lautet das Format des Namens der Protokolldatei **SQL:DataSourceName!**LogFileName. In diesem Fall ist der Wert des lpdwLogType-Parameters PDH_LOG_TYPE_SQL.
-
dwAccessFlags [in]
-
Der Typ des Zugriffs, der beim Öffnen der Protokolldatei angegeben werden soll. Dieser Parameter kann einen der folgenden Werte annehmen.
Wert Bedeutung - PDH_LOG_READ_ACCESS
Eine Protokolldatei wird für einen Lesevorgang geöffnet. - PDH_LOG_WRITE_ACCESS
Eine neue Protokolldatei wird für einen Schreibvorgang geöffnet. - PDH_LOG_UPDATE_ACCESS
Eine vorhandene Protokolldatei wird für einen Schreibvorgang geöffnet. Der aus der vorherigen Tabelle ausgewählte Wert kann mithilfe des OR-Operators mit einem der folgenden Create-Zugriffsflags kombiniert werden.
Wert Bedeutung - PDH_LOG_CREATE_NEW
Es wird eine neue Protokolldatei mit dem angegebenen Namen erstellt. - PDH_LOG_CREATE_ALWAYS
Eine neue Protokolldatei mit dem angegebenen Namen wird erstellt, und jede vorhandene Protokolldatei mit demselben Namen wird gelöscht. - PDH_LOG_OPEN_EXISTING
Eine vorhandene Protokolldatei mit dem angegebenen Namen wird geöffnet. Wenn keine Protokolldatei mit dem angegebenen Namen vorhanden ist, entspricht dies PDH_LOG_CREATE_NEW. - PDH_LOG_OPEN_ALWAYS
Eine vorhandene Protokolldatei mit dem angegebenen Namen wird geöffnet oder eine neue Protokolldatei mit dem angegebenen Namen erstellt. -
lpdwLogType [in]
-
Zeiger auf eine Variable, die den Typ der zu öffnenden Protokolldatei angibt. Dieser Parameter kann einen der folgenden Werte annehmen.
Wert Bedeutung - PDH_LOG_TYPE_UNDEFINED
Nicht definiertes Protokolldateiformat. - PDH_LOG_TYPE_CSV
Textdateien mit Spaltenüberschriften in der ersten Zeile und einzelne Datenbeispiele in jeder nachfolgenden Zeile. - PDH_LOG_TYPE_SQL
Die Daten in der Protokolldatei befinden sich in SQL. - PDH_LOG_TYPE_TSV
Identisch mit PDH_LOG_TYPE_CSV. - PDH_LOG_TYPE_BINARY
Binärprotokolldateiformat. Enthält Zirkelprotokolldateien. - PDH_LOG_TYPE_PERFMON
Perfmon-Protokolldateiformat. -
hQuery [in]
-
Abfragehandle. Dieses Handle wird von der PdhVbOpenQuery-Funktion zurückgegeben.
Dieser Parameter kann NULL sein, wenn die Protokolldatei zum Lesen geöffnet werden soll.
-
dwMaxSize [in]
-
Maximale Größe der Protokolldatei in Bytes. Dieser Wert wird nur verwendet, wenn die Protokolldatei eine begrenzte Größe oder eine Rundprotokolldatei ist.
-
szUserCaption [in]
-
Zeiger auf eine Zeichenfolge, die die benutzerdefinierte Untertitel der Protokolldatei angibt. Eine Protokolldatei Untertitel beschreibt im Allgemeinen den Inhalt der Protokolldatei. Wenn eine vorhandene Protokolldatei geöffnet wird, wird der Wert dieses Parameters ignoriert.
-
phLog [in, ref]
-
Zeiger auf einen Puffer, der ein Handle auf die geöffnete Protokolldatei empfängt.
Rückgabewert
Wenn die Funktion erfolgreich ist, gibt sie 0 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 |
|---|---|
|
Die angeforderten Daten sind größer als der bereitgestellte Puffer. Die angeforderten Daten können nicht zurückgegeben werden. |
|
Mindestens einer der Zeichenfolgenpuffer ist nicht die richtige Größe. |
|
Das Handle ist kein gültiges PDH-Objekt. |
|
Die angegebene Protokolldatei kann nicht geöffnet werden. |
|
Die angegebene Datei konnte nicht gefunden werden. |
Bemerkungen
Wenn Sie diese Funktion zum Schreiben von Leistungsdaten in eine Protokolldatei verwenden, muss zunächst eine Abfrage mit PdhVbOpenQuery geöffnet werden.
Es muss eine aktuell geöffnete Abfrage vorhanden sein, und die gewünschten Leistungsindikatoren müssen hinzugefügt werden, bevor diese Funktion aufgerufen wird.
Beachten Sie, dass Protokolldateien im Perfmon-Format nur zum Lesen geöffnet werden können.
Anforderungen
| Anforderung | Wert |
|---|---|
| Unterstützte Mindestversion (Client) |
Windows XP [nur Desktop-Apps] |
| Unterstützte Mindestversion (Server) |
Windows Server 2003 [nur Desktop-Apps] |
| Bibliothek |
|
| DLL |
|