Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

Índice
exclude(CONTEÚDO|0.*)

CONTEÚDO

  1. Visão Geral
  2. Funções

01. VISÃO GERAL 

   As fórmulas globais são aquelas apresentadas para todos os módulos do sistema, e são passíveis de uso em qualquer um deles. O objetivo deste documento é apresentar as Fórmulas Globais, com sua descrição, sintaxe, parâmetros e apresentar um breve exemplo com seu respectivo retorno.

       Conheça as fórmulas globais:

02. FUNÇÕES 

ABS

       

FunçãoABSDescrição

Retorna o valor absoluto de um número.

Sintaxe

ABS( NUM )Parâmetros
  • NUM → Número para Operação
Exemplo

ABS(-17)

Retorno

17

ANODT

    

FunçãoANODTDescriçãoRetorna o ano de uma data.

Sintaxe

ANODT( ' DATA ' )Parâmetros
  • DATA → Data para selecionar o ano
Exemplo

ANODT('24/10/2018')

Retorno2018

ARRED

       

FunçãoARRED
Descrição

Arredonda um valor sem casas decimais.

Sintaxe

ARRED( NUM )Parâmetros
  • NUM → Número para Operação
Exemplo

ARRED(24.73)
ARRED(24.33)
ARRED(24.50)

Retorno

25
24
25

ARREDONDA

       

FunçãoARREDONDA
Descrição

Arredonda um valor.

Sintaxe

ARREDONDA( NUM A, NUM B )Parâmetros
  • NUM A → Número para Operação
  • NUM B → Quantidade de casas decimais
Exemplo

ARREDONDA(24.33568784,3)

Retorno

24,336

ARREDVALOR

       

FunçãoARREDVALORDescrição

Arredonda um valor Independente de Sistema.

Sintaxe

ARREDVALOR( NUM A, NUM B )Parâmetros
  • NUM A → Número para Operação
  • NUM B → Fator
Exemplo

ARREDVALOR(24.33,1)

Retorno

25

ASCII

       

FunçãoASCIIDescriçãoRetorna o valor que representa um determinado caractere na tabela ASCII.

Sintaxe

ASCII( ' CHAR ' )Parâmetros
  • CHAR → Caracteres que se deseja retirar.
Exemplo

ASCII('o')

Retorno111

ATRIBUI

       

FunçãoATRIBUI
Descrição

Atribui um valor à uma memoria.

Sintaxe

ATRIBUI( CHAVE , CONTEUDO)Parâmetros
  • CHAVE → Chave da memória
  • CONTEUDO → Conteúdo para atribuir
Exemplo

ATRIBUI('MEMORIA001','Mundo bonito')

Retorno

Mundo Bonito

COLIGADACORRENTE

       

FunçãoCOLIGADACORRENTEDescrição

Retorna a coligada corrente.

Sintaxe

COLIGADACORRENTE( )Parâmetros

N/A

Exemplo

COLIGADACORRENTE()

Retorno

1

CONCAT

       

FunçãoCONCATDescriçãoConcatena os textos A e B

Sintaxe

CONCAT( ' TEXTO A ' , ' TEXTO B ' )Parâmetros
  • TEXTO A → Primeiro Texto
  • TEXTO B → Segundo Texto
Exemplo

CONCAT('Mundo','Bonito')

RetornoMundoBonito

CONCAT2

       

FunçãoCONCAT2DescriçãoConcatena as strings A e B com um espaço entre elas.

Sintaxe

CONCAT2( ' TEXTO A ' , ' TEXTO B ' )Parâmetros
  • TEXTO A → Primeiro Texto
  • TEXTO B → Segundo Texto
Exemplo

CONCAT2('Mundo','Bonito')

RetornoMundo Bonito

CONTEMVALOR

       

FunçãoCONTEMVALOR
Descrição

Procura um determinado valor em um conjunto de dados.

Sintaxe

CONTEMVALOR( ' CONJUNTO ' , VALOR , ' TIPO ' )Parâmetros
  • CONJUNTO → Conjunto de valores separados por /
  • VALOR → Valor a ser procurado
  • TIPO → Tipo de dado a ser tratado

    D = Data
    S = String
    Vazio/Outros → Decimal

Exemplo

CONTEMVALOR( 'casa/geladeira/mesa/gato/gaiola ', 'gato', 'S')

Retorno

1

COTACAOMOEDA

       

FunçãoCOTACAOMOEDADescrição

Cotação de uma moeda.

Sintaxe

COTACAOMOEDA( ' SIMBOLO ' , 'DATA' )Parâmetros
  • SIMBOLO → Símbolo da moeda
  • DATA→ Data da cotação
Exemplo

COTACAOMOEDA('US$','25/10/2018')

Retorno

3,724

DATANULA

       

FunçãoDATANULADescriçãoRetorna a data mínima do sistema.

Sintaxe

DATANULA()Parâmetros

N/A

Exemplo

DATANULA()

Retorno01/01/2000

DECANO

       

FunçãoDECANODescriçãoSubtrai um número de meses de um mês/ano e retorna o ano do resultado.

Sintaxe

DECANO(INTEIRO1,INTEIRO2,INTEIRO3)Parâmetros
  • INTEIRO1 → Mês da data inicial
  • INTEIRO2 → Ano da data inicial
  • INTEIRO3 → Quantidade de meses para subtrair da data inicial
Exemplo

DECANO(2,2018,26)

Retorno2015

DECMES

       

FunçãoDECMESDescriçãoSubtrai uma quantidade de meses ( X meses) de um mês inicial (1 a 12).

Sintaxe

DECMES(INTEIRO1,INTEIRO2)Parâmetros
  • INTEIRO1 → Mês inicial
  • INTEIRO2 → Quantidade de meses para diminuir do mês inicial
Exemplo

DECMES(11,5)

Retorno6

DIADT

       

FunçãoDIADTDescriçãoRetorna o dia de uma data.

Sintaxe

DIADT( ' DATA ' )Parâmetros
  • DATA → Data para selecionar o dia
Exemplo

DIADT('24/10/2018')

Retorno24

DIASEMANA

       

FunçãoDIASEMANADescriçãoRetorna o dia da semana de uma data. (1= Domingo | 2= Segunda | 3= Terça | 4=Quarta | 5=Quinta | 6=Sexta | 7= Sábado)

Sintaxe

DIASEMANA( ' DATA ' )Parâmetros
  • DATA → Data para selecionar o dia da semana
Exemplo

DIASEMANA('24/10/2018')

Retorno4

ESCREVELOG

       

FunçãoESCREVELOG
Descrição

Escreve Log

Sintaxe

ESCREVELOG( ' TEXTO ' )Parâmetros
  • TEXTO → Texto a ser inserido no Log.
Exemplo

ESCREVELOG(' Log Adicionado')

Retorno

Log Adicionado

EXECSQL

       

FunçãoEXECSQLDescrição

Executa uma Consulta SQL.

Sintaxe

EXECSQL( ' CÓDIGO ' )Parâmetros
  • CÓDIGO → Código da Consulta SQL.
Exemplo

EXECSQL('CON001' )

Retorno

Será o retorno (Se tiver) da Consulta SQL 'CON001'.

FALSO

       

FunçãoFALSO
Descrição

Retorna 0.

Sintaxe

FALSO( )Parâmetros

N/A

Exemplo

FALSO()

Retorno

0

FOR

       

FunçãoFORDescrição

Executa uma fórmula.

Sintaxe

FOR( ' CÓDIGO ' )Parâmetros
  • CÓDIGO → Código da fórmula.
Exemplo

FOR('FOR001' )

Retorno

Será o retorno da fórmula 'FOR001'.

FRAC

       

FunçãoFRACDescrição

Retorna a parte fracionada de um valor.

Sintaxe

FRAC( NUM )Parâmetros
  • NUM → Número para Operação
Exemplo

FRAC(24.73)

Retorno

0,73

HOJE

       

FunçãoHOJEDescriçãoRetorna a data de hoje.

Sintaxe

HOJE()Parâmetros

N/A

Exemplo

HOJE()

Retorno24/10/2018

INCANO

       

FunçãoINCANODescriçãoAdiciona um número de meses a um mês/ano e retorna o ano do resultado.

Sintaxe

INCANO(INTEIRO1,INTEIRO2,INTEIRO3)Parâmetros
  • INTEIRO1 → Mês da data inicial
  • INTEIRO2 → Ano da data inicial
  • INTEIRO3 → Quantidade de meses para adicionar na data inicial
Exemplo

INCANO(2,2018,26)

Retorno2019

INCMES

       

FunçãoINCMESDescriçãoAdiciona uma quantidade de meses ( X meses) à um mês inicial (1 a 12).

Sintaxe

INCMES(INTEIRO1,INTEIRO2)Parâmetros
  • INTEIRO1 → Mês inicial
  • INTEIRO2 → Quantidade de meses para adicionar ao mês inicial
Exemplo

INCMES(2,19)

Retorno9

INTTOSTRFORMAT

       

FunçãoINTTOSTRFORMATDescrição

Converte um valor inteiro para string (texto) preenchendo com zeros.

Sintaxe

INTTOSTRFORMAT( INTEIRO , ZEROS )Parâmetros
  • INTEIRO → Valor a ser convertido.
  • ZEROS→ Quantidade de Zeros.
Exemplo

INTTOSTRFORMAT(27,5)

Retorno

00027

MAX

       

FunçãoMAX
Descrição

Retorna o maior número.

Sintaxe

MAX( NUM A , NUM B )Parâmetros
  • NUM A → Número para comparação
  • NUM B → Número para comparação
Exemplo

MAX(17,12)

Retorno

17'

MEMORIA

       

FunçãoMEMORIA
Descrição

Retorna o valor de uma memória.

Sintaxe

MEMORIA( CHAVE )Parâmetros
  • CHAVE → Chave da memória
Exemplo

MEMORIA('MEMORIA001')

Retorno

Mundo Bonito

MESDT

       

FunçãoMESDTDescriçãoRetorna o mês de uma data.

Sintaxe

MESDT( ' DATA ' )Parâmetros
  • DATA → Data para selecionar o mês
Exemplo

MESDT('24/10/2018')

Retorno10

MIN

       

FunçãoMINDescrição

Retorna o menor número.

Sintaxe

MIN( NUM A , NUM B )Parâmetros
  • NUM A → Número para comparação
  • NUM B → Número para comparação
Exemplo

MIN(17,12)

Retorno

12

MTDATA

       

FunçãoMTDATADescriçãoMonta uma data a partir de um dia, mês e ano.

Sintaxe

MTDATA(INTEIRO1,INTEIRO2,INTEIRO3)Parâmetros
  • INTEIRO1 → Dia da data
  • INTEIRO2 → Mês da data
  • INTEIRO3 → Ano da data
Exemplo

MTDATA(17,11,1989)

Retorno17/11/1989

PAR

       

FunçãoPARDescrição

Retorna o que foi armazenado na propriedade de parâmetros genéricos de fórmula.

Sintaxe

PAR( )Parâmetros

N/A

Exemplo

PAR()

Retorno

Conteúdo do parâmetro armazenado

PARMQRY

       

FunçãoPARMQRY
Descrição

Retorna o conteúdo de um campo.
Utilizada no Gerador de Relatórios (RMGerador.dll).

Sintaxe

PARMQRY( ' CAMPO ' )Parâmetros
  • CAMPO → Nome do Campo
Exemplo

PARMQRY('CODUSUARIO')

Retorno

IgorMC

POTENCIA

       

FunçãoPOTENCIADescrição

Retorna a potência.

Sintaxe

POTENCIA( NUM A , NUM B )Parâmetros
  • NUM A→ Base da potência
  • NUM B→ Expoente da potência
Exemplo

POTENCIA(2,4)

Retorno

16

PROXREGSQL

       

FunçãoPROXREGSQL
Descrição

Avança um registro na Consulta SQL executada.

Sintaxe

PROXREGSQL( ' CÓDIGO ' )Parâmetros
  • CÓDIGO → Código da Consulta SQL.
Exemplo

PROXREGSQL('CON001' )

Retorno

Avança um registro na Consulta SQL 'CON001'.

RAIZ

       

FunçãoRAIZ
Descrição

Retorna a raiz quadrada de um valor.

Sintaxe

RAIZ( NUM )Parâmetros
  • NUM → Número para Operação
Exemplo

RAIZ(25)

Retorno

5

RESULTSQL

       

FunçãoRESULTSQLDescrição

Retorna o valor de um campo de um resultado da Consulta SQL.

Sintaxe

RESULTSQL( ' CÓDIGO ' , ' CAMPO ' )Parâmetros
  • CÓDIGO → Código da Consulta SQL
  • CAMPO → Campo desejado
Exemplo

RESULTSQL('CON001','CODUSUARIO' )

Retorno

Retorna o valor do campo CODUSUARIO do resultado da Consulta SQL 'CON001'.

RETIRACARACTERES

       

FunçãoRETIRACARACTERES
DescriçãoRetira do texto todas as ocorrências dos caracteres da string chars.

Sintaxe

RETIRACARACTERES( ' CHAR ' , ' TEXTO ' )Parâmetros
  • CHAR → Caracteres que se deseja retirar.
  • TEXTO → String que é desejado retirar os caracteres
Exemplo

RETIRACARACTERES('o','Mundo Bonito')

RetornoMund Bnit

SETVAR

       

FunçãoSETVAR
Descrição

Atribui um valor a uma variável.

Sintaxe

SETVAR( ' VAR ' , CONTEUDO)Parâmetros
  • VAR → Variável
  • CONTEUDO → Conteúdo para adicionar na variável
Exemplo

SETVAR('var1', 200)

Retorno

200

STR

       

FunçãoSTRDescrição

Retorna número de acordo com máscara informada, que pode ser composta da seguinte forma:
• com noves: o número será completado com espaços brancos à esquerda;
• com zeros ou 'z' (minúsculo ou maiúsculo): o número será completado com zeros à esquerda.
• Pode-se usar separador de decimais: '.' (ponto) ou ',' (vírgula)
• No caso da máscara contiver ':' será formatado do tipo hora.

Sintaxe

STR( VALOR , ' MASK ' )Parâmetros
  • VALOR → Valor decimal a ser formatado.
  • MASK → Máscara que será aplicada no valor.
Exemplo

STR(27, '000')
STR(12,'99,99')
STR(5, '00.00')
STR(320, '00:00')
STR(22222, '000:00')

Retorno

027
12,00
05.00
05:20
370:20

STRLEFT

       

FunçãoSTRLEFTDescriçãoCopia o lado DIREITO de um string (texto) um número de caracteres (quantidade).

Sintaxe

STRLEFT( ' TEXTO ' , INTEIRO )Parâmetros
  • TEXTO → String para fazer a cópia iniciando pelo lado Direito
  • INTEIRO → Quantidade de caracteres que deseja-se copiar
Exemplo

STRLEFT('Mundo Bonito',10)

Retorno

ndo Bonito

STRRIGHT

       

FunçãoSTRRIGHT
DescriçãoCopia o lado ESQUERDO de um string (texto) um número de caracteres (quantidade).

Sintaxe

STRRIGHT( ' TEXTO ' , INTEIRO )Parâmetros
  • TEXTO → String para fazer a cópia iniciando pelo lado Esquerdo
  • INTEIRO → Quantidade de caracteres que deseja-se copiar
Exemplo

STRRIGHT('Mundo Bonito',10)

RetornoMundo Boni

SUBSTR

       

FunçãoSUBSTRDescriçãoCopia a partir da posição início um número de caracteres de texto.

Sintaxe

SUBSTR( ' TEXTO ' , INTEIRO1, INTEIRO2 )Parâmetros
  • TEXTO → Texto onde é desejado selecionar uma parte para cópia
  • INTEIRO1 → Caracter início
  • INTEIRO2 → Quantidade de caracteres que você deseja selecionar.
Exemplo

SUBSTR('Alô Mundo', 2,5)

Retornolô mu

SUBTRAIDATAS

       

FunçãoSUBTRAIDATASDescrição

Retorna a subtração entre duas datas

Sintaxe

SUBTRAIDATAS( DATA1 , DATA2 )Parâmetros
  • DATA1 → Data inicial
  • DATA2 → Data para subtrair
Exemplo

SUBTRAIDATAS('24/10/2018','21/09/2018')

Retorno

33

TABCOLIG

       

FunçãoTABCOLIGDescrição

Retorna o valor de um campo da coligada.

Sintaxe

TABCOLIG( ' CAMPO ' )Parâmetros
  • CAMPO → Nome do Campo
Exemplo

TABCOLIG('NOMEFANTASIA')

Retorno

TOTVS SA

TABCOLIGADA

       

FunçãoTABCOLIGADADescrição

Retorna o valor de uma Coluna da tabela GCOLIGADA da coligada corrente que o usuário tem acesso na GPERMISS.

Sintaxe

TABCOLIGADA( ' CAMPO ' )Parâmetros
  • CAMPO → Nome do Campo
Exemplo

TABCOLIGADA('Numero')

Retorno

2664

TAMSTR

       

FunçãoTAMSTRDescriçãoRetorna o tamanho da string.

Sintaxe

TAMSTR( ' TEXTO ' )Parâmetros
  • TEXTO → String que é desejado saber a quantidade de caracteres
Exemplo

TAMSTR('Mundo Bonito')

Retorno12

TETO

       

FunçãoTETODescrição

Retorna o valor truncado mais um.

Sintaxe

TETO( NUM )Parâmetros
  • NUM → Número para Operação
Exemplo

TETO(24.03)

Retorno

25

TRUNCVALOR

       

FunçãoTRUNCVALOR
Descrição

Trunca um valor com casas decimais.

Sintaxe

TRUNCVALOR( NUM A ) ou TRUNCVALOR( NUM A , NUM B )Parâmetros
  • NUM A→ Número para Operação
  • NUM B→ Quantidade de casas Decimais
Exemplo

TRUNCVALOR(24.83)
TRUNCVALOR(24.83, 1)

Retorno

24
24,8

ULTDIAMES

       

FunçãoULTDIAMESDescriçãoRetorna o último dia do mês de uma data.

Sintaxe

ULTDIAMES( ' DATA ' )Parâmetros
  • DATA → Data para selecionar o último dia do mês
Exemplo

ULTDIAMES('24/10/2018')

Retorno31/10/2018

USUARIOCORRENTE

       

FunçãoUSUARIOCORRENTE
Descrição

Retorna o usuário corrente.

Sintaxe

USUARIOCORRENTE( )Parâmetros

N/A

Exemplo

USUARIOCORRENTE()

Retorno

IgorMC

VAL

       

FunçãoVALDescriçãoConverte um string para valor.

Sintaxe

VAL( ' VALOR ' )Parâmetros
  • VALOR → String para se converter em valor
Exemplo

VAL('12,65')

Retorno12,65

VERDADE

       

FunçãoVERDADEDescrição

Retorna 1.

Sintaxe

VERDADE ( )Parâmetros

N/A

Exemplo

VERDADE()

Retorno

1

Informações
iconfalse

Versão: 12.01.XX