Compartilhar via

Função SetupWriteTextLog (setupapi.h)

  • Artigo

A função SetupWriteTextLog grava uma entrada de log em um log de texto SetupAPI.

Sintaxe

WINSETUPAPI VOID SetupWriteTextLog(
  [in] SP_LOG_TOKEN LogToken,
  [in] DWORD        Category,
  [in] DWORD        Flags,
  [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] Flags

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 setupAPI.
  • 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] 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. A lista de parâmetros separada por vírgulas que segue MessageStr deve corresponder aos especificadores de formato na cadeia de caracteres de formato.

...

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 o valor de LogToken foi retornado por uma chamada para SetupGetThreadLogToken e a seção de log de texto correspondente puder ser encontrada, SetupWriteTextLog gravará a entrada de log nessa seção de log de texto. Se SetupWriteTextLog não puder localizar a seção, SetupWriteTextLog gravará a entrada de log no log de texto correspondente, mas não incluirá a entrada de log em uma seção.

Se o valor de LogToken for um dos tokens de log definidos pelo sistema listados na tabela a seguir, SetupWriteTextLog executará a operação de gravação indicada para esse token de log.

Token de log definido pelo sistema Operação de gravação
LOGTOKEN_NOLOG A entrada de log não é gravada em nenhum log de texto.
LOG_TOKEN_UNSPECIFIED A entrada de log é gravada no log de texto de instalação do aplicativo. A entrada de log não está incluída em uma seção de log de texto.
LOGTOKEN_SETUPAPI_APPLOG A entrada de log é gravada no log de texto de instalação do aplicativo. A entrada de log não está incluída em uma seção de log de texto.
LOGTOKEN_SETUPAPI_DEVLOG A entrada de log é gravada no log de texto de instalação do dispositivo. A entrada de log não está incluída em uma seção de log de texto.
 
Nota Definir o valor de LogToken como um dos tokens de log definidos pelo sistema não altera o valor do token de log atual para o thread.
 
Além disso, SetupWriteTextLog não grava uma entrada de log quando qualquer uma das seguintes opções é verdadeira: O comprimento máximo, em caracteres, de uma entrada de log é 336.

Para escrever informações sobre um erro específico de SetupAPI ou um erro Win32 em um log de texto, um aplicativo pode usar SetupWriteTextLogError.

Para obter informações gerais sobre como gravar entradas de log nos logs de texto SetupAPI, consulte SetupAPI Logging (Windows Vista e Posterior).

Para obter mais informações sobre a operação de SetupWriteTextLog, consulte Chamando SetupWriteTextLog.

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
Conjunto de APIs ext-ms-win-setupapi-logging-l1-1-0 (introduzido em Windows 8)

Confira também

SetupGetThreadLogToken

SetupWriteTextLogError