Función SetupWriteTextLogError (setupapi.h)

La función SetupWriteTextLogError escribe información sobre un error específico de SetupAPI o un error del sistema Win32 en un registro de texto setupAPI.

Sintaxis

WINSETUPAPI VOID SetupWriteTextLogError(
  [in] SP_LOG_TOKEN LogToken,
  [in] DWORD        Category,
  [in] DWORD        LogFlags,
  [in] DWORD        Error,
  [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 de tipo DWORD que indica la categoría de evento de 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] LogFlags

Valor de 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.
• Si se debe incluir una marca de tiempo en la entrada de registro. El valor de la marca de tiempo es TXTLOG_TIMESTAMP.
• El cambio, si existe, a la profundidad de sangría de la sección y 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] Error

Un código de error específico de SetupAPI o un código de error win32. Los códigos de error específicos de SetupAPI se enumeran en Setupapi.h. Los códigos de error de Win32 se muestran en Winerror.h.

[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.

...

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 una aplicación de instalación tiene un código de error específico de SetupAPI o un código de error de Win32 asociado a un error de instalación, la aplicación puede llamar a SetupWriteTextLogError en lugar de SetupWriteTextLog para escribir dos entradas en un registro de texto. La primera entrada será la misma que la escrita por SetupWriteTextLog y la segunda entrada registrará el código de error y una descripción fácil de usar del error.

El token de registro, la categoría de eventos y las marcas que proporciona un autor de llamada afectan al funcionamiento de SetupWriteTextLogError es la misma manera que se describe para SetupWriteTextLog.

SetupWriteTextLogError escribe la primera entrada de registro en el siguiente formato:

entry-prefixtime_stamp categoryindentationformatted-message

SetupWriteTextLogError escribe la segunda entrada de registro en el formato siguiente:

entry-prefixtime_stampcategoryindentationError:error-numbererror-description

Donde:

• Los campos de prefijo de entrada, marca de tiempo, categoría, sangría y mensaje con formato son los mismos que los descritos en Formato de un cuerpo de sección de registro de texto.
• El campo número de error contiene el número de error.
• El campo error-description contiene una descripción fácil de usar del error.

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

Para obtener más información sobre el funcionamiento de SetupWriteTextLogError, vea Calling SetupWriteTextLogError.

Para 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

Consulte también

SetupGetThreadLogToken

SetupWriteTextLog