Mudanças entre as edições de "Funções"
 
(132 revisões intermediárias por 6 usuários não estão sendo mostradas)
Linha 1: Linha 1:
 +
Bem-vindo à nossa documentação de funções. Este guia foi criado para auxiliar desenvolvedores e analistas a entender e utilizar eficientemente as diversas funções disponíveis em nossa aplicação. Aqui você encontrará descrições detalhadas, exemplos de uso e melhores práticas para cada função.
 +
 +
A documentação está detalhada por função para facilitar a navegação e a consulta rápida. Nosso objetivo é fornecer um recurso claro e compreensível que possa servir como referência contínua durante o desenvolvimento e manutenção de projetos.
 +
 +
Explore as seções abaixo para descobrir como nossas funções podem ajudá-lo a otimizar suas tarefas e projetos. Caso tenha dúvidas ou precise de mais informações, não hesite em consultar nossa equipe.
 +
 
{| class="wikitable" style="width: 100%; table-layout: fixed;"
 
{| class="wikitable" style="width: 100%; table-layout: fixed;"
 
! style="width: 20%;" | Nome
 
! style="width: 20%;" | Nome
Linha 4: Linha 10:
  
 
|-
 
|-
−
|[[Abs|Abs]]
+
|[[Procedimento AbrirPaginaNavegador|AbrirPaginaNavegador]]
−
|
+
|Realiza a abertura de uma URL no navegar padrão do sistema.
 
|-
 
|-
  
 
|-
 
|-
−
|[[Arredondar|Arredondar]]
+
|[[Procedimento AddLog|AddLog]]
−
|Retorna um número inteiro arredondado para o valor mais próximo.
+
|Permite adicionar textos de log durante a execução do script.
 
|-
 
|-
  
 
|-
 
|-
−
|[[Cancelar_transacao|CancelarTransacao]]
+
|[[Procedimento AddMensagemLog|AddMensagemLog]]
−
|Realiza o cancelamento de uma transação em aberto.
+
|Permite adicionar mensagens de log durante a execução do script a partir de um botão do cadastro.
 
|-
 
|-
  
 
|-
 
|-
−
|[[Chr|Chr]]
+
|[[Função Arredondar|Arredondar]]
−
|Converte um código numérico Unicode ou ASCII em seu caractere correspondente.
+
|Retorna um número inteiro arredondado para o valor mais próximo.
 
|-
 
|-
  
 
|-
 
|-
−
|[[Compare_text|CompareText]]
+
|[[Procedimento CancelarTransacao|CancelarTransacao]]
−
|Comparação de strings sem diferenciar maiúsculas de minúsculas.
+
|Realiza o cancelamento de uma transação em aberto.
 
|-
 
|-
  
 
|-
 
|-
−
|[[Completa_Str_Direita|CompletaStrDireta]]
+
|[[Função CompletaStr|CompletaStr]]
−
|
+
|Realiza a manipulação de uma string.
 
|-
 
|-
  
 
|-
 
|-
−
|[[Confirmar_transacao|ConfirmarTransacao]]
+
|[[Procedimento ConfirmarTransacao|ConfirmarTransacao]]
 
|Realiza a confirmação de uma transação em aberto.
 
|Realiza a confirmação de uma transação em aberto.
 
|-
 
|-
  
 
|-
 
|-
−
|[[Criar_cadastro|CriarCadastro]]
+
|[[Função Copy|Copy]]
 +
|Retorna uma substring de uma string ou parte de um array.
 +
|-
 +
 
 +
|-
 +
|[[Função CriarCadastro|CriarCadastro]]
 
|Realiza a abertura de uma tela de cadastro a partir de seu nome.
 
|Realiza a abertura de uma tela de cadastro a partir de seu nome.
 
|-
 
|-
  
 
|-
 
|-
−
|[[Criar_formulario|CriarFormulario]]
+
|[[Função CriarFormulario|CriarFormulario]]
 
|Realiza a abertura de uma tela de formulário a partir de seu nome
 
|Realiza a abertura de uma tela de formulário a partir de seu nome
 
|-
 
|-
  
 
|-
 
|-
−
|[[Date|Date]]
+
|[[Função CriarPasta|CriarPasta]]
 +
|Realiza a criação de uma pasta em um diretório específicado.
 +
|-
 +
 
 +
|-
 +
|[[Função Date|Date]]
 
|Retorna a data correspondente a atual.
 
|Retorna a data correspondente a atual.
 
|-
 
|-
  
 
|-
 
|-
−
|[[DateTimeToStr|DateTimeToStr]]
+
|[[Função DateTimeToStr|DateTimeToStr]]
 
|Converte um valor de data e hora para uma representação em formato de string.
 
|Converte um valor de data e hora para uma representação em formato de string.
 
|-
 
|-
  
 
|-
 
|-
−
|[[DateToStr|DateToStr]]
+
|[[Função DateToStr|DateToStr]]
 
|Converte um valor de data para uma representação em formato de string.
 
|Converte um valor de data para uma representação em formato de string.
 
|-
 
|-
  
 
|-
 
|-
−
|[[Day_of_week|DayOfWeek]]
+
|[[Função DayOfWeek|DayOfWeek]]
 
|Retorna o dia da semana correspondente a uma data específica.
 
|Retorna o dia da semana correspondente a uma data específica.
 
|-
 
|-
  
 
|-
 
|-
−
|[[Days_in_month|DaysInMonth]]
+
|[[Função DaysInMonth|DaysInMonth]]
 
|Retorna o número de dias em um determinado mês de um ano específico.
 
|Retorna o número de dias em um determinado mês de um ano específico.
 
|-
 
|-
  
 
|-
 
|-
−
|[[Decode_date|DecodeDate]]
+
|[[Função DayOf|DayOf]]
−
|
+
|Retorna o número do dia de uma data.
 +
|-
 +
 
 +
|-
 +
|[[Função MonthOf|MonthOf]]
 +
|Retorna o número do mês de uma data.
 +
|-
 +
 
 +
|-
 +
|[[Função YearOf|YearOf]]
 +
|Retorna o número do ano de uma data.
 +
|-
 +
 
 +
|-
 +
|[[Função SecondsBetween|SecondsBetween]]
 +
|Retorna a quantidade de secundos entre duas datas.
 +
|-
 +
 
 +
|-
 +
|[[Função DecodeDate|DecodeDate]]
 +
|Realiza a decomposição um valor TDateTime em seus componentes de data (ano, mês e dia).
 +
|-
 +
 
 +
|-
 +
|[[Função DecodeTime|DecodeTime]]
 +
|Realiza a decomposição de um valor TDateTime em seus componentes de tempo (horas, minutos, segundos e milissegundos).
 +
|-
 +
 
 +
|-
 +
|[[Função DecodeDateTime|DecodeDateTime]]
 +
|Realiza a decomposição de um valor TDateTime em seus componentes de data e tempo (ano, mês, dia, horas, minutos, segundos e milissegundos).
 
|-
 
|-
  
 
|-
 
|-
−
|[[Decode_time|DecodeTime]]
+
|[[Função DiretorioExiste|DiretorioExiste]]
−
|
+
|Utilizada para identificar se um diretório existe na unidade.
 
|-
 
|-
  
 
|-
 
|-
−
|[[Delete|Delete]]
+
|[[Função ExceptionMessage|ExceptionMessage]]
−
|
+
|Retorna o texto de erro gerado na ultima exceção.
 
|-
 
|-
  
 
|-
 
|-
−
|[[Delete_str|DeleteStr]]
+
|[[Função EncodeDate|EncodeDate]]
−
|
+
|Realiza a criação de um objeto TDateTime representando uma data específica.
 
|-
 
|-
  
 
|-
 
|-
−
|[[Encode_date|EncodeDate]]
+
|[[Função EncodeTime|EncodeTime]]
−
|
+
|Realiza a criação de um objeto TDateTime representando uma hora específica.
 
|-
 
|-
  
 
|-
 
|-
−
|[[Encode_time|EncodeTime]]
+
|[[Função EncodeDateTime|EncodeDateTime]]
−
|
+
|Realiza a criação de um objeto TDateTime representando uma data e hora específica.
 
|-
 
|-
  
 
|-
 
|-
−
|[[Erro_validacao|ErroValidacao]]
+
|[[Procedimento ErroValidacao|ErroValidacao]]
 
|Realiza a abertura de uma tela de erro e ocasiona na parada da execução do script.
 
|Realiza a abertura de uma tela de erro e ocasiona na parada da execução do script.
 
|-
 
|-
  
 
|-
 
|-
−
|[[ExecutarArquivo|ExecutarArquivo]]
+
|[[Procedimento ExecutarArquivo|ExecutarArquivo]]
−
|
+
|Utilizado para realizar a execuçaõ de um arquivo a partir de seu diretório.
 
|-
 
|-
  
 
|-
 
|-
−
|[[Exibe_processo|ExibirProcesso]]
+
|[[Procedimento Exibe_processo|ExibirProcesso]]
 
|Realiza a exibição de um status do processo que está sendo realizado.
 
|Realiza a exibição de um status do processo que está sendo realizado.
 
|-
 
|-
  
 
|-
 
|-
−
|[[ExtractFilePath|ExtractFilePath]]
+
|[[Função ExtractFilePath|ExtractFilePath]]
 
|Utilizada para extrair o caminho do diretório de um caminho de arquivo completo.
 
|Utilizada para extrair o caminho do diretório de um caminho de arquivo completo.
 
|-
 
|-
  
 
|-
 
|-
−
|[[Fechar_processo|FecharProcesso]]
+
|[[Procedimento Fechar_processo|FecharProcesso]]
 
|Realiza o fechamento da tela de status do processo que está sendo realizado.
 
|Realiza o fechamento da tela de status do processo que está sendo realizado.
 
|-
 
|-
  
 
|-
 
|-
−
|[[FloatToStr|FloatToStr]]
+
|[[Função FloatToStr|FloatToStr]]
 
|Converte um valor decimal para uma representação em formato de string.
 
|Converte um valor decimal para uma representação em formato de string.
 
|-
 
|-
  
 
|-
 
|-
−
|[[Format|Format]]
+
|[[Função Format|Format]]
 
|Formatação de uma string.
 
|Formatação de uma string.
 
|-
 
|-
  
 
|-
 
|-
−
|[[Format_datetime|FormatDatetime]]
+
|[[Função Format_datetime|FormatDatetime]]
 
|Formatação de um valor data e hora para uma string.
 
|Formatação de um valor data e hora para uma string.
 
|-
 
|-
  
 
|-
 
|-
−
|[[Format_float|FormatFloat]]
+
|[[Função Format_float|FormatFloat]]
 
|Formatação de um valor númerico para uma string.
 
|Formatação de um valor númerico para uma string.
 
|-
 
|-
  
 
|-
 
|-
−
|[[Format_mask_text|FormatMaskText]]
+
|[[Get_body|GetBody]]
−
|Formatação de uma string de acordo com uma máscara específica.
+
|Retorna o body da requisição.
 +
|-
 +
 
 +
|-
 +
|[[Função GetVariavelGlobal|GetVariavelGlobal]]
 +
|Permite recuperar o valor de uma variável global previamente definida para o usuário e sessão atual.
 
|-
 
|-
  
 
|-
 
|-
−
|[[Inc|Inc]]
+
|[[Função Inc|Inc]]
 
|Utilizada para incrementar (adicionar 1) a uma variável numérica.
 
|Utilizada para incrementar (adicionar 1) a uma variável numérica.
 
|-
 
|-
  
 
|-
 
|-
−
|[[Informacao|Informacao]]
+
|[[Função IncDay|IncDay]]
 +
| Utilizada para incrementar ou decrementar uma data específica por um número específico de dias
 +
|-
 +
 
 +
|-
 +
|[[Função IncMinute|IncMinute]]
 +
|Utilizada para incrementar ou decrementar uma data específica por um número específico de minutos.
 +
|-
 +
 
 +
|-
 +
|[[Procedimento Informacao|Informacao]]
 
|Realiza a abertura de uma tela de informação.
 
|Realiza a abertura de uma tela de informação.
 
|-
 
|-
  
 
|-
 
|-
−
|[[Iniciar_transacao|IniciarTransacao]]
+
|[[Procedimento Iniciar_transacao|IniciarTransacao]]
 
|Realiza a inicialização de uma transação.
 
|Realiza a inicialização de uma transação.
 
|-
 
|-
  
 
|-
 
|-
−
|[[Insert|Insert]]
+
|[[Procedimento Insert|Insert]]
 
|Insere uma substring em uma string existente em uma posição específica.
 
|Insere uma substring em uma string existente em uma posição específica.
 
|-
 
|-
  
 
|-
 
|-
−
|[[IntToStr|IntToStr]]
+
|[[Função IntToStr|IntToStr]]
 
|Converte um valor inteiro para uma representação em formato de string.
 
|Converte um valor inteiro para uma representação em formato de string.
 
|-
 
|-
  
 
|-
 
|-
−
|[[Is_leap_year|IsLeapYear]]
+
|[[Função IsLeapYear|IsLeapYear]]
 
|Utilizada para verificar se um determinado ano é bissexto.
 
|Utilizada para verificar se um determinado ano é bissexto.
 
|-
 
|-
  
 
|-
 
|-
−
|[[Left_str|LeftStr]]
+
|[[Função LeftStr|LeftStr]]
 
|Utilizada para extrair uma parte específica da extremidade esquerda de uma string.
 
|Utilizada para extrair uma parte específica da extremidade esquerda de uma string.
 
|-
 
|-
  
 
|-
 
|-
−
|[[Length|Length]]
+
|[[Função Length|Length]]
 
|Retorna um número inteiro correspondente ao tamanho de uma sequência de caracteres.
 
|Retorna um número inteiro correspondente ao tamanho de uma sequência de caracteres.
 
|-
 
|-
  
 
|-
 
|-
−
|[[Letters_to_number|LettersToNumber]]
+
|[[LimparMensagemLog|LimparMensagemLog]]
−
|Converte uma string uma representação em formato de inteiro.
+
|Realiza a limpeza da mensagem de texto de log inserido pelo procedimento AddMensagemLog.
 
|-
 
|-
  
 
|-
 
|-
−
|[[Lower_case|LowerCase]]
+
|[[Função Lower_case|LowerCase]]
 
|Formatação de texto que converte todas as letras de uma string para suas formas minúsculas equivalentes.
 
|Formatação de texto que converte todas as letras de uma string para suas formas minúsculas equivalentes.
 
|-
 
|-
  
 
|-
 
|-
−
|[[Msg_erro|MsgErro]]
+
|[[Função MensagemErro|MensagemErro]]
−
|Realiza a abertura de uma tela de erro e ocasiona na parada da execução do script.
+
|Retorna o texto da mensagem gerada pela exceção.
 
|-
 
|-
  
 
|-
 
|-
−
|[[Name_case|NameCase]]
+
|[[Função NameCase|NameCase]]
 
|Formatação de texto que converte a primeira letra das palavras de uma string para suas formas maiúsculas equivalentes.
 
|Formatação de texto que converte a primeira letra das palavras de uma string para suas formas maiúsculas equivalentes.
 
|-
 
|-
  
 
|-
 
|-
−
|[[New_ph_boleto|NewPHBoleto]]
+
|[[Função NewPHArquivoTexto|NewPHArquivoTexto]]
 +
|
 +
|-
 +
 
 +
|-
 +
|[[NewPHBoleto|NewPHBoleto]]
 
|Realiza a criação de um objeto da classe de boleto.
 
|Realiza a criação de um objeto da classe de boleto.
 
|-
 
|-
  
 +
|-
 +
|[[NewPHConexaoRest|NewPHConexaoRest]]
 +
|
 +
|-
  
 
|-
 
|-
−
|[[New_ph_connection|NewPHConnection]]
+
|[[NewPHConnection|NewPHConnection]]
 
|Realiza a conexão com banco de dados e base de dados.
 
|Realiza a conexão com banco de dados e base de dados.
 
|-
 
|-
  
 
|-
 
|-
−
|[[New_ph_email|NewPHEmail]]
+
|[[Função NewPHEmail|NewPHEmail]]
 
|Realiza a criação de um objeto da classe de e-mail.
 
|Realiza a criação de um objeto da classe de e-mail.
 
|-
 
|-
  
 
|-
 
|-
−
|[[New_ph_formulario|NewPHFormulario]]
+
|[[NewPHExcel|NewPHExcel]]
 +
|Realiza a criação de um objeto da classe de excel.
 +
|-
 +
 
 +
|-
 +
|[[Função NewPHFormulario|NewPHFormulario]]
 
|Realiza a criação de um objeto da classe formulário.
 
|Realiza a criação de um objeto da classe formulário.
 
|-
 
|-
  
 
|-
 
|-
−
|[[New_ph_notificacoes|NewPHNotificacoes]]
+
|[[NewPHNotificacoes|NewPHNotificacoes]]
 
|Realiza a criação de um objeto da classe de notificações.
 
|Realiza a criação de um objeto da classe de notificações.
 
|-
 
|-
  
 
|-
 
|-
−
|[[New_ph_query|NewPHQuery]]
+
|[[NewPHProc|NewPHProc]]
 +
|Realiza a criação de um objeto da classe de procedimentos.
 +
|-
 +
 
 +
|-
 +
|[[NewPHXML|NewPHXML]]
 +
|Realiza a criação de um objeto da classe de XML.
 +
|-
 +
 
 +
|-
 +
|[[Procedimento NewPHQuery|NewPHQuery]]
 
|Realiza a criação de um objeto da classe de query que permite que sejam executados comandos SQL (Structured Query Language).
 
|Realiza a criação de um objeto da classe de query que permite que sejam executados comandos SQL (Structured Query Language).
 
|-
 
|-
  
 
|-
 
|-
−
|[[Now|Now]]
+
|[[Função Now|Now]]
 
|Retorna a data e hora atual.
 
|Retorna a data e hora atual.
 
|-
 
|-
  
 
|-
 
|-
−
|[[Number_to_letter|NumberToLetter]]
+
|[[Procedimento ParamByName|ParamByName]]
−
|Converte um valor inteiro para uma representação em formato de string.
+
|Realiza a inclusão de um parâmetro na query SQL.
 +
|-
 +
 
 +
|-
 +
|[[Função Pergunta|Pergunta]]
 +
|Realiza a abertura de uma tela de pergunta.
 
|-
 
|-
  
 
|-
 
|-
−
|[[PH_contador_new|PHContadorNew]]
+
|[[Função PHContadorNew|PHContadorNew]]
 
|Retorna um número de ID com base em um contador.
 
|Retorna um número de ID com base em um contador.
 
|-
 
|-
  
 
|-
 
|-
−
|[[PH_new_id|PHNewID]]
+
|[[Função PHNewID|PHNewID]]
 
|Retorna um número de ID com base em uma tabela.
 
|Retorna um número de ID com base em uma tabela.
 
|-
 
|-
  
 
|-
 
|-
−
|[[Pos|Pos]]
+
|[[Função Pos|Pos]]
 
|Retorna o índice da primeira string encontrada.
 
|Retorna o índice da primeira string encontrada.
 
|-
 
|-
  
 
|-
 
|-
−
|[[Raise_exception|RaiseException]]
+
|[[Função Power|Power]]
 +
|Retorna o resultado do cálculo exponencial.
 +
|-
 +
 
 +
|-
 +
|[[Procedimento RaiseException|RaiseException]]
 
|Realiza a abertura de uma tela de erro e ocasiona na parada da execução do script.
 
|Realiza a abertura de uma tela de erro e ocasiona na parada da execução do script.
 
|-
 
|-
  
 
|-
 
|-
−
|[[Replace_str|ReplaceStr]]
+
|[[Função Random|Random]]
 +
|Realiza a geração um número inteiro aleatório dentro de uma faixa específica
 +
|-
 +
 
 +
|-
 +
|[[Função ReplaceStr|ReplaceStr]]
 
|Substitui uma parte específica de uma string por outra.
 
|Substitui uma parte específica de uma string por outra.
 
|-
 
|-
Linha 281: Linha 381:
 
|-
 
|-
 
|[[Retorna_id_registro|RetornaIDRegistro]]
 
|[[Retorna_id_registro|RetornaIDRegistro]]
−
|
+
|Retorna o número de ID de um registro de uma tabela com base no filtro passado por parâmetro.
 
|-
 
|-
  
 
|-
 
|-
−
|[[Retorna_texto_campo|RetornaTextoCampo]]
+
|[[Função Retorna_texto_campo|RetornaTextoCampo]]
 
|Retorna o conteúdo de um campo de um determinado registro de uma tabela.
 
|Retorna o conteúdo de um campo de um determinado registro de uma tabela.
 
|-
 
|-
  
 
|-
 
|-
−
|[[Right_str|RightStr]]
+
|[[RibbonBotaoDoNome|RibbonBotaoDoNome]]
 +
|
 +
|-
 +
 
 +
|-
 +
|[[Função Right_str|RightStr]]
 
|Utilizada para extrair uma parte específica da extremidade direita de uma string.
 
|Utilizada para extrair uma parte específica da extremidade direita de uma string.
 
|-
 
|-
  
 
|-
 
|-
−
|[[Round|Round]]
+
|[[Função Round|Round]]
 
|Retorna um número inteiro arredondado para o valor mais próximo.
 
|Retorna um número inteiro arredondado para o valor mais próximo.
 +
|-
 +
 +
|-
 +
|[[SetEmpresaCorrente|SetEmpresaCorrente]]
 +
|
 +
|-
 +
 +
|-
 +
|[[SetFiliaisCorrente|SetFiliaisCorrente]]
 +
|
 
|-
 
|-
  
Linha 305: Linha 420:
  
 
|-
 
|-
−
|[[Sqrt|Sqrt]]
+
|[[Procedimento SetVariavelGlobal|SetVariavelGlobal]]
−
|
+
|Permite definir ou atualizar o valor de uma variável global, associada ao usuário e à sessão atual.
 +
|-
 +
 
 +
|-
 +
|[[Procedimento ShowMessage|ShowMessage]]
 +
|Realiza a abertura de uma tela, na qual, é exibida a mensagem.
 +
|-
 +
 
 +
|-
 +
|[[Procedimento Sleep|Sleep]]
 +
|Utilizada para pausar a execução de um script por um determinado período de tempo
 
|-
 
|-
  
 
|-
 
|-
−
|[[StrToDate|StrToDate]]
+
|[[Função StrToDate|StrToDate]]
 
|Converte um valor string para data.
 
|Converte um valor string para data.
 
|-
 
|-
  
 
|-
 
|-
−
|[[StrToDatetime|StrToDatetime]]
+
|[[Função StrToDatetime|StrToDatetime]]
 
|Converte um valor string para data e hora.
 
|Converte um valor string para data e hora.
 
|-
 
|-
  
 
|-
 
|-
−
|[[StrToFloat|StrToFloat]]
+
|[[Função StrToFloat|StrToFloat]]
 
|Converte um valor string para decimal.
 
|Converte um valor string para decimal.
 
|-
 
|-
  
 
|-
 
|-
−
|[[StrToInt|StrToInt]]
+
|[[Função StrToInt|StrToInt]]
 
|Converte um valor string para inteiro.
 
|Converte um valor string para inteiro.
 
|-
 
|-
  
 
|-
 
|-
−
|[[StrToTime|StrToTime]]
+
|[[Função StrToTime|StrToTime]]
 
|Converte um valor string para time.
 
|Converte um valor string para time.
 
|-
 
|-
  
 
|-
 
|-
−
|[[Time|Time]]
+
|[[Função Time|Time]]
 
|Retorna o tempo correspondente a atual.
 
|Retorna o tempo correspondente a atual.
 
|-
 
|-
  
 
|-
 
|-
−
|[[TimeToStr|TimeToStr]]
+
|[[Função TimeToStr|TimeToStr]]
 
|Converte um valor de time para uma representação em formato de string.
 
|Converte um valor de time para uma representação em formato de string.
 
|-
 
|-
  
 
|-
 
|-
−
|[[Tira_acentos|TiraAcentos]]
+
|[[Função Tirar_acentos|TirarAcentos]]
−
|
+
|Remove a acentuação de uma string.
 
|-
 
|-
  
 
|-
 
|-
−
|[[Trim|Trim]]
+
|[[Função Trim|Trim]]
 
|Remove espaços em branco do início e do final da string.  
 
|Remove espaços em branco do início e do final da string.  
 
|-
 
|-
  
 
|-
 
|-
−
|[[Trunc|Trunc]]
+
|[[Função Trunc|Trunc]]
 
|Remove a parte fracionária de um número de ponto flutuante e mantém apenas a parte inteira.
 
|Remove a parte fracionária de um número de ponto flutuante e mantém apenas a parte inteira.
 
|-
 
|-
  
 
|-
 
|-
−
|[[Upper_case|UpperCase]]
+
|[[Função UpperCase|UpperCase]]
 
|Formatação de texto que converte todas as letras de uma string para suas formas maiúsculas equivalentes.
 
|Formatação de texto que converte todas as letras de uma string para suas formas maiúsculas equivalentes.
 
|-
 
|-
  
 
|-
 
|-
−
|[[ValidDate|ValidDate]]
+
|[[Função ValidDate|ValidDate]]
 
|Retorna verdadeiro se o valor passado para o parâmetro for data e falso caso contrário.
 
|Retorna verdadeiro se o valor passado para o parâmetro for data e falso caso contrário.
 
|-
 
|-
  
 
|-
 
|-
−
|[[ValidFloat|ValidFloat]]
+
|[[Função ValidFloat|ValidFloat]]
 
|Retorna verdadeiro se o valor passado para o parâmetro for decimal e falso caso contrário.
 
|Retorna verdadeiro se o valor passado para o parâmetro for decimal e falso caso contrário.
 
|-
 
|-
  
 
|-
 
|-
−
|[[ValidInt|ValidInt]]
+
|[[Função ValidInt|ValidInt]]
 
|Retorna verdadeiro se o valor passado para o parâmetro for inteiro e falso caso contrário.
 
|Retorna verdadeiro se o valor passado para o parâmetro for inteiro e falso caso contrário.
 
|-
 
|-
  
 
|-
 
|-
−
|[[VarArrayCreate|VarArrayCreate]]
+
|[[Função VarToStr|VarToStr]]
−
|Utilizada na criação de matrizes variantes.
 
−
|-
 
−
 
 
−
|-
 
−
|[[VarToStr|VarToStr]]
 
 
|Converte um valor variante para uma representação em formato de string.
 
|Converte um valor variante para uma representação em formato de string.
 
|-
 
|-
  
 
|}
 
|}

Edição atual tal como às 17h11min de 13 de agosto de 2026

Bem-vindo à nossa documentação de funções. Este guia foi criado para auxiliar desenvolvedores e analistas a entender e utilizar eficientemente as diversas funções disponíveis em nossa aplicação. Aqui você encontrará descrições detalhadas, exemplos de uso e melhores práticas para cada função.

A documentação está detalhada por função para facilitar a navegação e a consulta rápida. Nosso objetivo é fornecer um recurso claro e compreensível que possa servir como referência contínua durante o desenvolvimento e manutenção de projetos.

Explore as seções abaixo para descobrir como nossas funções podem ajudá-lo a otimizar suas tarefas e projetos. Caso tenha dúvidas ou precise de mais informações, não hesite em consultar nossa equipe.

Nome Descrição
AbrirPaginaNavegador Realiza a abertura de uma URL no navegar padrão do sistema.
AddLog Permite adicionar textos de log durante a execução do script.
AddMensagemLog Permite adicionar mensagens de log durante a execução do script a partir de um botão do cadastro.
Arredondar Retorna um número inteiro arredondado para o valor mais próximo.
CancelarTransacao Realiza o cancelamento de uma transação em aberto.
CompletaStr Realiza a manipulação de uma string.
ConfirmarTransacao Realiza a confirmação de uma transação em aberto.
Copy Retorna uma substring de uma string ou parte de um array.
CriarCadastro Realiza a abertura de uma tela de cadastro a partir de seu nome.
CriarFormulario Realiza a abertura de uma tela de formulário a partir de seu nome
CriarPasta Realiza a criação de uma pasta em um diretório específicado.
Date Retorna a data correspondente a atual.
DateTimeToStr Converte um valor de data e hora para uma representação em formato de string.
DateToStr Converte um valor de data para uma representação em formato de string.
DayOfWeek Retorna o dia da semana correspondente a uma data específica.
DaysInMonth Retorna o número de dias em um determinado mês de um ano específico.
DayOf Retorna o número do dia de uma data.
MonthOf Retorna o número do mês de uma data.
YearOf Retorna o número do ano de uma data.
SecondsBetween Retorna a quantidade de secundos entre duas datas.
DecodeDate Realiza a decomposição um valor TDateTime em seus componentes de data (ano, mês e dia).
DecodeTime Realiza a decomposição de um valor TDateTime em seus componentes de tempo (horas, minutos, segundos e milissegundos).
DecodeDateTime Realiza a decomposição de um valor TDateTime em seus componentes de data e tempo (ano, mês, dia, horas, minutos, segundos e milissegundos).
DiretorioExiste Utilizada para identificar se um diretório existe na unidade.
ExceptionMessage Retorna o texto de erro gerado na ultima exceção.
EncodeDate Realiza a criação de um objeto TDateTime representando uma data específica.
EncodeTime Realiza a criação de um objeto TDateTime representando uma hora específica.
EncodeDateTime Realiza a criação de um objeto TDateTime representando uma data e hora específica.
ErroValidacao Realiza a abertura de uma tela de erro e ocasiona na parada da execução do script.
ExecutarArquivo Utilizado para realizar a execuçaõ de um arquivo a partir de seu diretório.
ExibirProcesso Realiza a exibição de um status do processo que está sendo realizado.
ExtractFilePath Utilizada para extrair o caminho do diretório de um caminho de arquivo completo.
FecharProcesso Realiza o fechamento da tela de status do processo que está sendo realizado.
FloatToStr Converte um valor decimal para uma representação em formato de string.
Format Formatação de uma string.
FormatDatetime Formatação de um valor data e hora para uma string.
FormatFloat Formatação de um valor númerico para uma string.
GetBody Retorna o body da requisição.
GetVariavelGlobal Permite recuperar o valor de uma variável global previamente definida para o usuário e sessão atual.
Inc Utilizada para incrementar (adicionar 1) a uma variável numérica.
IncDay Utilizada para incrementar ou decrementar uma data específica por um número específico de dias
IncMinute Utilizada para incrementar ou decrementar uma data específica por um número específico de minutos.
Informacao Realiza a abertura de uma tela de informação.
IniciarTransacao Realiza a inicialização de uma transação.
Insert Insere uma substring em uma string existente em uma posição específica.
IntToStr Converte um valor inteiro para uma representação em formato de string.
IsLeapYear Utilizada para verificar se um determinado ano é bissexto.
LeftStr Utilizada para extrair uma parte específica da extremidade esquerda de uma string.
Length Retorna um número inteiro correspondente ao tamanho de uma sequência de caracteres.
LimparMensagemLog Realiza a limpeza da mensagem de texto de log inserido pelo procedimento AddMensagemLog.
LowerCase Formatação de texto que converte todas as letras de uma string para suas formas minúsculas equivalentes.
MensagemErro Retorna o texto da mensagem gerada pela exceção.
NameCase Formatação de texto que converte a primeira letra das palavras de uma string para suas formas maiúsculas equivalentes.
NewPHArquivoTexto
NewPHBoleto Realiza a criação de um objeto da classe de boleto.
NewPHConexaoRest
NewPHConnection Realiza a conexão com banco de dados e base de dados.
NewPHEmail Realiza a criação de um objeto da classe de e-mail.
NewPHExcel Realiza a criação de um objeto da classe de excel.
NewPHFormulario Realiza a criação de um objeto da classe formulário.
NewPHNotificacoes Realiza a criação de um objeto da classe de notificações.
NewPHProc Realiza a criação de um objeto da classe de procedimentos.
NewPHXML Realiza a criação de um objeto da classe de XML.
NewPHQuery Realiza a criação de um objeto da classe de query que permite que sejam executados comandos SQL (Structured Query Language).
Now Retorna a data e hora atual.
ParamByName Realiza a inclusão de um parâmetro na query SQL.
Pergunta Realiza a abertura de uma tela de pergunta.
PHContadorNew Retorna um número de ID com base em um contador.
PHNewID Retorna um número de ID com base em uma tabela.
Pos Retorna o índice da primeira string encontrada.
Power Retorna o resultado do cálculo exponencial.
RaiseException Realiza a abertura de uma tela de erro e ocasiona na parada da execução do script.
Random Realiza a geração um número inteiro aleatório dentro de uma faixa específica
ReplaceStr Substitui uma parte específica de uma string por outra.
RetornaIDRegistro Retorna o número de ID de um registro de uma tabela com base no filtro passado por parâmetro.
RetornaTextoCampo Retorna o conteúdo de um campo de um determinado registro de uma tabela.
RibbonBotaoDoNome
RightStr Utilizada para extrair uma parte específica da extremidade direita de uma string.
Round Retorna um número inteiro arredondado para o valor mais próximo.
SetEmpresaCorrente
SetFiliaisCorrente
SetLength Utilizada para ajustar o comprimento de uma string dinâmica ou de um array dinâmico.
SetVariavelGlobal Permite definir ou atualizar o valor de uma variável global, associada ao usuário e à sessão atual.
ShowMessage Realiza a abertura de uma tela, na qual, é exibida a mensagem.
Sleep Utilizada para pausar a execução de um script por um determinado período de tempo
StrToDate Converte um valor string para data.
StrToDatetime Converte um valor string para data e hora.
StrToFloat Converte um valor string para decimal.
StrToInt Converte um valor string para inteiro.
StrToTime Converte um valor string para time.
Time Retorna o tempo correspondente a atual.
TimeToStr Converte um valor de time para uma representação em formato de string.
TirarAcentos Remove a acentuação de uma string.
Trim Remove espaços em branco do início e do final da string.
Trunc Remove a parte fracionária de um número de ponto flutuante e mantém apenas a parte inteira.
UpperCase Formatação de texto que converte todas as letras de uma string para suas formas maiúsculas equivalentes.
ValidDate Retorna verdadeiro se o valor passado para o parâmetro for data e falso caso contrário.
ValidFloat Retorna verdadeiro se o valor passado para o parâmetro for decimal e falso caso contrário.
ValidInt Retorna verdadeiro se o valor passado para o parâmetro for inteiro e falso caso contrário.
VarToStr Converte um valor variante para uma representação em formato de string.
Disponível em "http://wiki.phsys.com.br/index.php?title=Funções&oldid=7070"