Función PdhVbOpenLog

La función PdhVbOpenLog abre el archivo de registro especificado para leer y escribir. Esta función llama a PdhOpenLog.

Importante

La función que describe este tema puede modificarse o no estar disponible en el futuro. En su lugar, Microsoft recomienda usar las funciones descritas en Funciones de contadores de rendimiento.

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

Parámetros

szLogFileName [in]

Puntero a una cadena que especifica el nombre del archivo de registro que se va a abrir.

Si el archivo de registro contiene datos SQL, el formato del nombre del archivo de registro es **SQL:DataSourceName!**LogFileName. En este caso, el valor del parámetro lpdwLogType es PDH_LOG_TYPE_SQL.

dwAccessFlags [in]

Tipo de acceso que se va a especificar cuando se abre el archivo de registro. Este parámetro puede ser uno de los valores siguientes.

Valor	Significado
PDH_LOG_READ_ACCESS	Se abre un archivo de registro para una operación de lectura.
PDH_LOG_WRITE_ACCESS	Se abre un nuevo archivo de registro para una operación de escritura.
PDH_LOG_UPDATE_ACCESS	Se abre un archivo de registro existente para una operación de escritura.

El valor seleccionado de la tabla anterior se puede combinar mediante el operador OR con una de las marcas de acceso create siguientes.

Valor	Significado
PDH_LOG_CREATE_NEW	Se crea un nuevo archivo de registro con el nombre especificado.
PDH_LOG_CREATE_ALWAYS	Se crea un nuevo archivo de registro con el nombre especificado y se borra cualquier archivo de registro existente con el mismo nombre.
PDH_LOG_OPEN_EXISTING	Se abre un archivo de registro existente con el nombre especificado. Si no existe un archivo de registro con el nombre especificado, es igual a PDH_LOG_CREATE_NEW.
PDH_LOG_OPEN_ALWAYS	Se abre un archivo de registro existente con el nombre especificado o se crea un nuevo archivo de registro con el nombre especificado.

lpdwLogType [in]

Puntero a una variable que indica el tipo de archivo de registro que se va a abrir. Este parámetro puede ser uno de los valores siguientes.

Valor	Significado
PDH_LOG_TYPE_UNDEFINED	Formato de archivo de registro no definido.
PDH_LOG_TYPE_CSV	Archivos de texto que contienen encabezados de columna en la primera línea y muestras de datos individuales en cada línea posterior.
PDH_LOG_TYPE_SQL	Los datos del archivo de registro están en SQL.
PDH_LOG_TYPE_TSV	Igual que PDH_LOG_TYPE_CSV.
PDH_LOG_TYPE_BINARY	Formato de archivo de registro binario. Incluye archivos de registro circulares.
PDH_LOG_TYPE_PERFMON	Formato de archivo de registro de Perfmon.

hQuery [in]

Identificador de consulta. La función PdhVbOpenQuery devuelve este identificador.

Este parámetro puede ser NULL si se va a abrir el archivo de registro para su lectura.

dwMaxSize [in]

Tamaño máximo del archivo de registro, en bytes. Este valor solo se usa si el archivo de registro es un archivo de registro de tamaño limitado o circular.

szUserCaption [in]

Puntero a una cadena que especifica el subtítulo definido por el usuario del archivo de registro. Un archivo de registro subtítulo generalmente describe el contenido del archivo de registro. Cuando se abre un archivo de registro existente, se omite el valor de este parámetro.

phLog [in, ref]

Puntero a un búfer que recibe un identificador para el archivo de registro abierto.

Valor devuelto

Si la función se ejecuta correctamente, devuelve 0.

Si se produce un error en la función, el valor devuelto es un código de error del sistema o un código de error PDH. A continuación se muestran los valores posibles.

Código devuelto	Descripción
PDH_INSUFFICIENT_BUFFER	Los datos solicitados son mayores que el búfer proporcionado. No se pueden devolver los datos solicitados.
PDH_INVALID_ARGUMENT	Uno o varios de los búferes de cadena no son el tamaño correcto.
PDH_INVALID_HANDLE	El manipulador no es un objeto PDH válido.
PDH_LOG_FILE_OPEN_ERROR	No se puede abrir el archivo de registro especificado.
PDH_FILE_NOT_FOUND	No se encuentra el archivo especificado.

Comentarios

Al usar esta función para escribir datos de rendimiento en un archivo de registro, primero se debe abrir una consulta mediante PdhVbOpenQuery.

Debe haber una consulta abierta actualmente y los contadores deseados deben agregarse a ella antes de llamar a esta función.

Tenga en cuenta que los archivos de registro en formato Perfmon solo se pueden abrir para su lectura.

Requisitos

Requisito	Value
Cliente mínimo compatible	Windows XP [solo aplicaciones de escritorio]
Servidor mínimo compatible	Windows Server 2003 [solo aplicaciones de escritorio]
Biblioteca	Pdh.lib
Archivo DLL	Pdh.dll

Consulte también

PdhOpenLog

PdhVbGetLogFileSize

PdhVbUpdateLog