Função SetupWriteTextLogError (setupapi.h)
A função SetupWriteTextLogError grava informações sobre um erro específico de SetupAPI ou um erro do sistema Win32 em um log de texto SetupAPI.
Sintaxe
WINSETUPAPI VOID SetupWriteTextLogError(
[in] SP_LOG_TOKEN LogToken,
[in] DWORD Category,
[in] DWORD LogFlags,
[in] DWORD Error,
[in] PCSTR MessageStr,
...
);
Parâmetros
[in] LogToken
Um token de log que é um token de log definido pelo sistema ou que foi retornado por SetupGetThreadLogToken.
[in] Category
Um valor do tipo DWORD que indica a categoria de evento para a entrada de log. As categorias de evento que podem ser especificadas para uma entrada de log são as mesmas que podem ser habilitadas para um log de texto. Para obter uma lista de categorias de eventos, consulte Habilitando categorias de evento para um log de texto SetupAPI.
[in] LogFlags
Um valor do tipo DWORD que é um OR bit a bit de valores de sinalizador, que especificam o seguinte:
- O nível de evento para a entrada de log. Os níveis de evento que podem ser especificados para uma entrada de log são os mesmos que podem ser habilitados para um log de texto. Para obter uma lista de sinalizadores de nível de evento, consulte Definindo o nível de evento para um log de texto.
- Se deve incluir um carimbo de data/hora na entrada de log. O valor do sinalizador de carimbo de data/hora é TXTLOG_TIMESTAMP.
- A alteração, se houver, para a profundidade de recuo da seção e a entrada de log atual. Para obter informações sobre como usar os sinalizadores de recuo, consulte Gravando entradas de log recuadas.
[in] Error
Um código de erro específico de SetupAPI ou um código de erro Win32. Os códigos de erro específicos de SetupAPI são listados em Setupapi.h. Os códigos de erro win32 estão listados em Winerror.h.
[in] MessageStr
Um ponteiro para uma cadeia de caracteres constante terminada em NULL que contém uma cadeia de caracteres de formato compatível com printf, que especifica a mensagem formatada a ser incluída na entrada de log.
...
Uma lista de parâmetros separada por vírgulas que corresponde aos especificadores de formato na cadeia de caracteres de formato fornecida por MessageStr.
Retornar valor
Nenhum
Comentários
Se um aplicativo de instalação tiver um código de erro específico de SetupAPI ou um código de erro Win32 associado a um erro de instalação, o aplicativo poderá chamar SetupWriteTextLogError em vez de SetupWriteTextLog para gravar duas entradas em um log de texto. A primeira entrada será a mesma escrita por SetupWriteTextLog e a segunda entrada registrará o código de erro e uma descrição amigável do erro.
O token de log, a categoria de evento e os sinalizadores que um chamador fornece afetam a operação de SetupWriteTextLogError é a mesma maneira descrita para SetupWriteTextLog.
SetupWriteTextLogError grava a primeira entrada de log no seguinte formato:
entry-prefixtime_stamp categoryindentationformatted-message
SetupWriteTextLogError grava a segunda entrada de log no seguinte formato:
entry-prefixtime_stampcategoryindentationError:error-numbererror-description
Em que:
- Os campos entry-prefix, time-stamp, category, indentation e formatted-message são os mesmos descritos em Formato de um Corpo da Seção de Log de Texto.
- O campo número de erro contém o número de erro.
- O campo de descrição de erro contém uma descrição amigável do erro.
Para obter mais informações sobre a operação de SetupWriteTextLogError, consulte Chamando SetupWriteTextLogError.
Para obter mais informações sobre tokens de log, consulte Tokens de log.
Para obter mais informações sobre como usar tokens de log, consulte Configurando e obtendo um token de log para um thread.
Requisitos
| Requisito | Valor |
|---|---|
| Cliente mínimo com suporte | Disponível no Windows Vista e versões posteriores do Windows. |
| Plataforma de Destino | Área de Trabalho |
| Cabeçalho | setupapi.h (inclua Setupapi.h) |
| Biblioteca | Setupapi.lib |