Función SetupWriteTextLog (setupapi.h)

  • Artículo

La función SetupWriteTextLog escribe una entrada de registro en un registro de texto setupAPI.

Sintaxis

WINSETUPAPI VOID SetupWriteTextLog(
  [in] SP_LOG_TOKEN LogToken,
  [in] DWORD        Category,
  [in] DWORD        Flags,
  [in] PCSTR        MessageStr,
       ...          
);

Parámetros

[in] LogToken

Token de registro que es un token de registro definido por el sistema o que ha devuelto SetupGetThreadLogToken.

[in] Category

Valor con tipo DWORD que indica la categoría de evento para la entrada de registro. Las categorías de eventos que se pueden especificar para una entrada de registro son las mismas que las que se pueden habilitar para un registro de texto. Para obtener una lista de categorías de eventos, consulte Habilitación de categorías de eventos para un registro de texto setupAPI.

[in] Flags

Valor con tipo DWORD que es un OR bit a bit de valores de marca, que especifica lo siguiente:

  • Nivel de evento de la entrada de registro. Los niveles de evento que se pueden especificar para una entrada de registro son los mismos que los que se pueden habilitar para un registro de texto. Para obtener una lista de marcas de nivel de evento, consulte Establecimiento del nivel de evento para un registro de texto setupAPI.
  • Si se debe incluir una marca de tiempo en la entrada de registro. El valor de marca de marca de tiempo es TXTLOG_TIMESTAMP.
  • Cambio, si existe, a la profundidad de sangría de la sección y a la entrada de registro actual. Para obtener información sobre cómo usar las marcas de sangría, vea Escribir entradas de registro con sangría.

[in] MessageStr

Puntero a una cadena constante terminada en NULL que contiene una cadena de formato compatible con printf, que especifica el mensaje con formato que se va a incluir en la entrada de registro. La lista de parámetros separados por comas que sigue a MessageStr debe coincidir con los especificadores de formato en la cadena de formato.

...

Lista de parámetros separados por comas que coincide con los especificadores de formato en la cadena de formato proporcionada por MessageStr.

Valor devuelto

None

Observaciones

Si se devolvió el valor de LogToken mediante una llamada a SetupGetThreadLogToken y se puede encontrar la sección de registro de texto correspondiente, SetupWriteTextLog escribe la entrada de registro en esa sección de registro de texto. Si SetupWriteTextLog no encuentra la sección, SetupWriteTextLog escribe la entrada de registro en el registro de texto correspondiente, pero no incluye la entrada de registro en una sección.

Si el valor de LogToken es uno de los tokens de registro definidos por el sistema enumerados en la tabla siguiente, SetupWriteTextLog realiza la operación de escritura que se indica para ese token de registro.

Token de registro definido por el sistema Operación de escritura
LOGTOKEN_NOLOG La entrada de registro no se escribe en ningún registro de texto.
LOG_TOKEN_UNSPECIFIED La entrada de registro se escribe en el registro de texto de instalación de la aplicación. La entrada de registro no se incluye en una sección de registro de texto.
LOGTOKEN_SETUPAPI_APPLOG La entrada de registro se escribe en el registro de texto de instalación de la aplicación. La entrada de registro no se incluye en una sección de registro de texto.
LOGTOKEN_SETUPAPI_DEVLOG La entrada de registro se escribe en el registro de texto de instalación del dispositivo. La entrada de registro no se incluye en una sección de registro de texto.
 
Nota Establecer el valor de LogToken en uno de los tokens de registro definidos por el sistema no cambia el valor del token de registro actual para el subproceso.
 
Además, SetupWriteTextLog no escribe una entrada de registro cuando se cumple alguna de las siguientes condiciones: La longitud máxima, en caracteres, de una entrada de registro es de 336.

Para escribir información sobre un error específico de SetupAPI o un error win32 en un registro de texto, una aplicación puede usar SetupWriteTextLogError.

Para obtener información general sobre cómo escribir entradas de registro en los registros de texto setupAPI, vea SetupAPI Logging (Windows Vista y Later).

Para obtener más información sobre la operación de SetupWriteTextLog, vea Calling SetupWriteTextLog.

Para obtener más información sobre los tokens de registro, consulte Tokens de registro.

Para obtener más información sobre el uso de tokens de registro, consulte Configuración y obtención de un token de registro para un subproceso.

Requisitos

Requisito Value
Cliente mínimo compatible Disponible en Windows Vista y versiones posteriores de Windows.
Plataforma de destino Escritorio
Encabezado setupapi.h (incluya Setupapi.h)
Library Setupapi.lib
Conjunto de API ext-ms-win-setupapi-logging-l1-1-0 (introducido en Windows 8)

Consulte también

SetupGetThreadLogToken

SetupWriteTextLogError