Compartilhar via

Chamando SetupWriteTextLog

  • Artigo

SetupWriteTextLog adiciona uma única entrada com informações sobre um evento de instalação a um log de texto SetupAPI.

Conforme descrito em Formato de um Corpo da Seção de Log de Texto, o formato de uma entrada de log consiste nos seguintes campos:

entry_prefix time_stamp event_category indentation formatted_message

Para chamar SetupWriteTextLog, um aplicativo fornece as seguintes informações:

  • O token de log de uma seção em um log de texto que foi obtido chamando SetupGetThreadLogToken ou um dos tokens de log definidos pelo sistema. Se o token de log estiver associado a uma seção de log de texto, SetupWriteTextLog gravará a entrada de log nessa seção. Caso contrário, SetupWriteTextLog adiciona a entrada de log a uma parte do log que não está incluída em uma seção de log de texto. Além disso, se SetupWriteTextLog grava uma entrada de log e em qual log de texto SetupWriteTextLog grava a entrada, depende do valor do token de log definido pelo sistema.

    Para obter mais informações sobre tokens de log, consulte Configurando e obtendo um token de log para um thread.

  • Uma das categorias de evento descritas em Habilitando categorias de evento para um log de texto. Se a categoria de evento da entrada estiver habilitada para o log de texto, SetupWriteTextLog adicionará a entrada ao log de texto; caso contrário, SetupWriteTextLog não grava a entrada no log de texto.

  • Um valor de sinalizador que é um OR bit a bit de constantes definidas pelo sistema que especificam o nível de evento, a profundidade de recuo e se deve incluir um carimbo de data/hora. Os níveis de evento são descritos em Definindo o nível de evento para um log de texto. Se o nível de evento definido para o log de texto for maior ou igual ao nível de evento da entrada, SetupWriteTextLog gravará uma entrada de log no log de texto; caso contrário, SetupWriteTextLog não grava uma entrada de log no log de texto. Usando o recuo, as mensagens formatadas podem ser organizadas para facilitar a leitura e a compreensão das informações em uma seção. Para obter mais informações, consulte Gravando entradas de log recuadas.

  • Uma cadeia de caracteres de formato compatível com printf que formata a mensagem e a lista de variáveis separadas por vírgulas que seguem a cadeia de caracteres de formato.

  • Uma lista separada por vírgulas de variáveis, cujos valores são formatados pela cadeia de caracteres de formato compatível com printf.

Para obter um exemplo de como chamar SetupWriteTextLog para registrar informações sobre um evento que não é um erro ou um aviso, consulte Escrevendo uma entrada de log de informações.

Para obter um exemplo de como chamar SetupWriteTextLog para registrar informações sobre um erro ou um aviso, consulte Escrevendo uma entrada de log de erro ou aviso.