Funções

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.