FUNçãOEm revisão

ShowLog

ShowLog( <cTexto> )

Exibe um texto em uma janela de log, sendo útil para inspeção visual de consultas, mensagens e informações de apoio durante testes.

Funções AdvPLInterfaceDepuraçãoLogSQLEm revisão

01 · VISÃO GERAL

Visão geral

ShowLog é uma função usada com frequência em rotinas AdvPL para apresentar textos longos ou dados de diagnóstico em uma janela de log. Na prática, costuma ser aplicada durante desenvolvimento e homologação para visualizar consultas SQL montadas dinamicamente, conteúdos de variáveis ou mensagens de apoio. Por segurança e organização, recomenda-se condicionar seu uso a perfis administrativos e evitar exibição para usuários finais em produção.

02 · SINTAXE

Sintaxe

ShowLog( <cTexto> )

Parâmetros

cTexto

CaractereObrigatório

Texto que será exibido na janela de log. Pode conter uma query, uma mensagem técnica ou outro conteúdo de apoio à análise.

Retorno

A referência usada não documenta retorno para ShowLog. Use a função com foco em exibição de informação, não como parte de uma regra de decisão.

03 · EXEMPLO PRÁTICO

Exibir uma query somente para administrador

#Include "TOTVS.ch"

User Function ExibeQuery()
    Local cConsulta := ""

    cConsulta := " SELECT * "
    cConsulta += " FROM " + RetSQLName("SBM") + " SBM "
    cConsulta += " WHERE BM_FILIAL = '" + FWxFilial("SBM") + "' "
    cConsulta += " AND SBM.D_E_L_E_T_ = ' ' "

    If FWIsAdmin()
        ShowLog(cConsulta)
    EndIf
Return

Resultado esperado

Quando o usuário for administrador, a query montada será exibida em uma janela de log para conferência visual.

04 · EXEMPLO PRÁTICO

Criar uma função auxiliar para visualizar queries

#Include "TOTVS.ch"

User Function VisualizaConsulta(cConsulta)
    Default cConsulta := ""

    If ! IsBlind() .And. ! Empty(cConsulta) .And. FWIsAdmin()
        If FWAlertYesNo("Deseja visualizar a consulta?", "Atenção (" + FunName() + ")")
            ShowLog(cConsulta)
        EndIf
    EndIf
Return

Resultado esperado

A função auxiliar centraliza as validações: não executa em modo sem interface, ignora texto vazio, restringe a administradores e pede confirmação antes de abrir o log.

BOAS PRÁTICAS

Use ShowLog como ferramenta de apoio em desenvolvimento, homologação ou diagnóstico controlado.
Ao exibir queries SQL, prefira restringir o uso a administradores com FWIsAdmin().
Evite mostrar dados sensíveis, tokens, senhas, chaves ou informações pessoais em logs visíveis.
Em rotinas automáticas ou sem interface, valide o contexto antes de abrir janelas para o usuário.
Para necessidades mais controladas de título, barras de rolagem e confirmação, avalie a função AtShowLog quando disponível no ambiente.

ARMADILHAS COMUNS

Exibir ShowLog diretamente para qualquer usuário pode expor detalhes técnicos ou informações sensíveis.
Deixar logs visuais em produção pode interromper o fluxo da rotina e confundir usuários finais.
Uma query exibida em tela pode revelar nomes de tabelas, filtros, aliases e regras internas do sistema.
Não use ShowLog como substituto de log estruturado quando for necessário guardar histórico técnico.

Conteúdos relacionados

REFERÊNCIAS

ATILIO, Daniel. Como usar a função ShowLog. Terminal de Informação, 22 dez. 2021; atualização mencionada em dez. 2022.

Situação: Em revisão
Página criada em: 20/08/2026 às 22:45
Última revisão em: 20/08/2026 às 22:45
Idioma original: Português
Revisão: Usina.BR