Функция PdhVbOpenLog
Функция PdhVbOpenLog открывает указанный файл журнала для чтения и записи. Эта функция вызывает PdhOpenLog.
Важно!
Функция, описываемая в этом разделе, может быть изменена или недоступна в будущем. Вместо этого корпорация Майкрософт рекомендует использовать функции, описанные в разделе Функции счетчиков производительности.
Функция 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
Параметры
-
szLogFileName [in]
-
Указатель на строку, указывающую имя открываемого файла журнала.
Если файл журнала содержит данные SQL, формат имени файла журнала — **SQL:DataSourceName!*Имя_logFileName. В этом случае значение параметра lpdwLogType равно PDH_LOG_TYPE_SQL.
-
dwAccessFlags [in]
-
Тип доступа, который необходимо указать при открытии файла журнала. Этот параметр может принимать одно из указанных ниже значений.
Значение Значение - PDH_LOG_READ_ACCESS
Файл журнала открывается для операции чтения. - PDH_LOG_WRITE_ACCESS
Откроется новый файл журнала для операции записи. - PDH_LOG_UPDATE_ACCESS
Для операции записи открывается существующий файл журнала. Значение, выбранное из предыдущей таблицы, можно объединить с помощью оператора OR с одним из следующих флагов создания доступа.
Значение Значение - PDH_LOG_CREATE_NEW
Создается новый файл журнала с указанным именем. - PDH_LOG_CREATE_ALWAYS
Создается новый файл журнала с указанным именем, а все существующие файлы журнала с тем же именем удаляются. - PDH_LOG_OPEN_EXISTING
Откроется существующий файл журнала с указанным именем. Если файл журнала с указанным именем не существует, это равно PDH_LOG_CREATE_NEW. - PDH_LOG_OPEN_ALWAYS
Открывается существующий файл журнала с указанным именем или создается новый файл журнала с указанным именем. -
lpdwLogType [in]
-
Указатель на переменную, указывающую тип открываемого файла журнала. Этот параметр может принимать одно из указанных ниже значений.
Значение Значение - PDH_LOG_TYPE_UNDEFINED
Неопределенный формат файла журнала. - PDH_LOG_TYPE_CSV
Текстовые файлы, содержащие заголовки столбцов в первой строке и отдельные примеры данных в каждой последующей строке. - PDH_LOG_TYPE_SQL
Данные в файле журнала находится в SQL. - PDH_LOG_TYPE_TSV
То же, что и PDH_LOG_TYPE_CSV. - PDH_LOG_TYPE_BINARY
Формат двоичного файла журнала. Включает циклические файлы журналов. - PDH_LOG_TYPE_PERFMON
Формат файла журнала perfmon. -
hQuery [in]
-
Дескриптор запроса. Этот дескриптор возвращается функцией PdhVbOpenQuery .
Этот параметр может иметь значение NULL , если файл журнала должен быть открыт для чтения.
-
dwMaxSize [in]
-
Максимальный размер файла журнала в байтах. Это значение используется только в том случае, если файл журнала является файлом журнала ограниченного размера или циклическим файлом журнала.
-
szUserCaption [in]
-
Указатель на строку, указывающую определяемую пользователем подпись файла журнала. В подпись файла журнала обычно описывается содержимое файла журнала. При открытии существующего файла журнала значение этого параметра игнорируется.
-
phLog [in, ref]
-
Указатель на буфер, который получает дескриптор открытого файла журнала.
Возвращаемое значение
Если функция завершается успешно, она возвращает значение 0.
Если функция завершается сбоем, возвращаемое значение представляет собой код системной ошибки или код ошибки PDH. Ниже приведены возможные значения.
| Код возврата | Описание |
|---|---|
|
Запрошенные данные больше, чем предоставленный буфер. Не удалось вернуть запрошенные данные. |
|
Один или несколько строковых буферов не имеет правильного размера. |
|
Дескриптор не является допустимым объектом PDH. |
|
Не удается открыть указанный файл журнала. |
|
Не удалось найти указанный файл. |
Комментарии
При использовании этой функции для записи данных производительности в файл журнала сначала необходимо открыть запрос с помощью PdhVbOpenQuery.
Перед вызовом этой функции должен быть открыт запрос, и в него должны быть добавлены нужные счетчики.
Обратите внимание, что файлы журналов в формате Perfmon можно открывать только для чтения.
Требования
| Требование | Значение |
|---|---|
| Минимальная версия клиента |
Windows XP [только классические приложения] |
| Минимальная версия сервера |
Windows Server 2003 [только классические приложения] |
| Библиотека |
|
| DLL |
|