Versões comparadas

Chave

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

Índice

Índice
include[A/C/B/D/E].*

Índice
exclude[A//C//B//D//E//F//G//H//I//J//K//L//M//N//O//P//Q].*

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çãoABS
Descriçã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çãoANODT
DescriçãoRetorna o ano de uma data.

Sintaxe

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

ANODT('24/10/2018')

Retorno2018

ARRED

OBJETIVO

       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:

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ção

ARREDVALOR
ARRED
Descrição

Arredonda um valor

Independente de Sistema

sem casas decimais.

Sintaxe

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

    ARRED(24.73)
    ARRED(24.33)
    ARRED(24.50

    ExemploARREDVALOR(24.33,1

    )

    Retorno

    25
    24

    ASCII

    25

    ARREDONDA


           

    Função
    ASCII
    ARREDONDA
    Descrição
    Retorna o valor que representa um determinado caractere na tabela ASCII

    Arredonda um valor.

    Sintaxe

    ASCII( ' CHAR '
    ARREDONDA( NUM A, NUM B )
    Parâmetros
    CHAR → Caracteres que se deseja retirar.
    • NUM A → Número para Operação
    • NUM B → Quantidade de casas decimais
    Exemplo
    ASCII('o'

    ARREDONDA(24.33568784,3)

    Retorno
    111

    24,336

    ATRIBUI

    ARREDVALOR


           

    Função
    ATRIBUI
    ARREDVALOR
    Descrição
    Atribui

    Arredonda um valor

    à uma memoria

    Independente de Sistema.

    Sintaxe

    ATRIBUI
    ARREDVALOR(
    CHAVE
    NUM A,
    CONTEUDO
    NUM B )
    Parâmetros
  • CHAVE → Chave da memória
    • NUM A → Número para Operação
    • NUM B → Fator
    CONTEUDO → Conteúdo para atribuir
    Exemplo
    ATRIBUI('MEMORIA001','Mundo bonito'

    ARREDVALOR(24.33,1)

    Retorno
    Mundo Bonito

    25

    COLIGADACORRENTE

    ASCII


           

    Função
    COLIGADACORRENTE
    ASCII
    DescriçãoRetorna
    a coligada corrente
    o valor que representa um determinado caractere na tabela ASCII.

    Sintaxe

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

    ASCII('o')

    Retorno
    1
    111
    CONCAT

    ATRIBUI


           

    Função
    CONCAT
    ATRIBUI
    Descrição
    Concatena os textos A e B

    Atribui um valor à uma memoria.

    Sintaxe

    CONCAT( ' TEXTO A ' , ' TEXTO B '
    ATRIBUI( CHAVE , CONTEUDO)
    Parâmetros
  • TEXTO A → Primeiro Texto
    • CHAVE → Chave da memória
    • CONTEUDO → Conteúdo para atribuir
    TEXTO B → Segundo Texto
    Exemplo
    CONCAT

    ATRIBUI('

    Mundo

    MEMORIA001','

    Bonito

    Mundo bonito')

    Retorno
    MundoBonito

    Mundo Bonito

    CONCAT2

    COLIGADACORRENTE


           

    Função
    CONCAT2
    COLIGADACORRENTE
    Descrição
    Concatena as strings A e B com um espaço entre elas

    Retorna a coligada corrente.

    Sintaxe

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

    Exemplo
    CONCAT2('Mundo','Bonito'

    COLIGADACORRENTE()

    Retorno
    Mundo Bonito

    1

    CONTEMVALOR

    CONCAT


           

    Função
    CONTEMVALOR
    CONCAT
    Descrição
    Procura um determinado valor em um conjunto de dados.
    Concatena os textos A e B

    Sintaxe

    CONTEMVALOR
    CONCAT( '
    CONJUNTO
    TEXTO A '
    , VALOR
    , '
    TIPO
    TEXTO B ' )
    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

    • TEXTO A → Primeiro Texto
    • TEXTO B → Segundo Texto
    Exemplo

    CONCAT('Mundo','Bonito

    ExemploCONTEMVALOR( 'casa/geladeira/mesa/gato/gaiola ', 'gato', 'S

    ')

    Retorno
    1
    MundoBonito
    COTACAOMOEDA

    CONCAT2


           

    Função
    COTACAOMOEDA
    CONCAT2
    Descrição
    Cotação de uma moeda
    Concatena as strings A e B com um espaço entre elas.

    Sintaxe

    COTACAOMOEDA
    CONCAT2( '
    SIMBOLO
    TEXTO A ' , '
    DATA
    TEXTO B ' )
    Parâmetros
  • SIMBOLO → Símbolo da moeda
    • TEXTO A → Primeiro Texto
    • TEXTO B → Segundo Texto
    DATA→ Data da cotação
    Exemplo
    COTACAOMOEDA

    CONCAT2('

    US$

    Mundo','

    25/10/2018

    Bonito')

    Retorno

    3,724

    Mundo Bonito

    CONTEMVALOR

    DATANULA


           

    Função

    DATANULADescriçãoRetorna a data mínima do sistema.

    Sintaxe

    DATANULA()Parâmetros

    N/A

    Exemplo

    DATANULA()

    Retorno01/01/2000
    CONTEMVALOR
    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

    DECANO


           

    Função

    DECANO
    COTACAOMOEDA
    Descrição
    Subtrai um número de meses de um mês/ano e retorna o ano do resultado

    Cotação de uma moeda.

    Sintaxe

    DECANO
    COTACAOMOEDA(
    INTEIRO1,INTEIRO2,INTEIRO3
    ' SIMBOLO ' , 'DATA' )
    Parâmetros
    INTEIRO1
    • SIMBOLO
    Mês
    • Símbolo da
    data inicial
  • INTEIRO2 → Ano da data inicial
    • moeda
    • DATA→ Data da cotação
    INTEIRO3 → Quantidade de meses para subtrair da data inicial
    Exemplo
    DECANO(2,2018,26

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

    Retorno
    2015

    3,724

    DECMES

    DATANULA


           

    Função
    DECMES
    DATANULA
    Descrição
    Subtrai uma quantidade de meses ( X meses) de um mês inicial (1 a 12)
    Retorna a data mínima do sistema.

    Sintaxe

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

    N/A

    Exemplo
    DECMES

    DATANULA(

    11,5

    )

    Retorno
    6DIADT
    01/01/2000

    DECANO


           

    Função
    DIADT
    DECANO
    Descrição
    Retorna o dia de uma data
    Subtrai um número de meses de um mês/ano e retorna o ano do resultado.

    Sintaxe

    DIADT( ' DATA ' )Parâmetros
    • DATA → Data para selecionar o dia
    ExemploDIADT('24/10/2018'
    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)

    Retorno
    24
    2015
    DIASEMANA

    DECMES


           

    Função
    DIASEMANA
    DECMES
    Descrição
    Retorna o dia da semana de uma data. (1= Domingo | 2= Segunda | 3= Terça | 4=Quarta | 5=Quinta | 6=Sexta | 7= Sábado)
    Subtrai 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

    Sintaxe

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

    DIASEMANA('24/10/2018')

    Retorno4ESCREVELOG


           

    Função

    ESCREVELOG
    DIADT
    Descrição
    Escreve Log
    Retorna o dia de uma data.

    Sintaxe

    ESCREVELOG
    DIADT( '
    TEXTO
    DATA ' )
    Parâmetros
    TEXTO → Texto a ser inserido no Log.
    • DATA → Data para selecionar o dia
    Exemplo
    ESCREVELOG

    DIADT('

    Log Adicionado

    24/10/2018')

    Retorno
    Log Adicionado
    24
    EXECSQL

    DIASEMANA


           

    Função
    EXECSQLDescrição

    Executa uma Consulta SQL.

    DIASEMANA
    Descriçã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

    Sintaxe

    EXECSQL( ' CÓDIGO
    ' )
    Parâmetros
    CÓDIGO → Código da Consulta SQL.
    • DATA → Data para selecionar o dia da semana
    Exemplo
    EXECSQL('CON001

    DIASEMANA('24/10/2018')

    Retorno

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

    4

    ESCREVELOG

    FALSO


           

    Função

    FALSO
    ESCREVELOG
    Descrição
    Retorna 0.

    Escreve Log

    Sintaxe

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

    ESCREVELOG(' Log Adicionado')

    Retorno
    0

    Log Adicionado

    FOR

    EXECSQL


           

    Função
    FOR
    EXECSQL
    Descrição

    Executa uma

    fórmula

    Consulta SQL.

    Sintaxe

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

    EXECSQL('

    FOR001

    CON001' )

    Retorno

    Será o retorno

    da fórmula 'FOR001

    (Se tiver) da Consulta SQL 'CON001'.

    FRAC

    FALSO


           

    Função
    FRAC
    FALSO
    Descrição

    Retorna

    a parte fracionada de um valor

    0.

    Sintaxe

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

    N/A

    Exemplo
    FRAC

    FALSO(

    24.73

    )

    Retorno

    0

    ,73

    HOJE

    FOR


           

    Função
    HOJE
    FOR
    Descrição
    Retorna a data de hoje

    Executa uma fórmula.

    Sintaxe

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

    FOR('FOR001' )

    Retorno
    24/10/2018

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

    FRAC

    INCANO


           

    Função

    INCANO
    FRAC
    Descrição
    Adiciona um número de meses a um mês/ano e retorna o ano do resultado

    Retorna a parte fracionada de um valor.

    Sintaxe

    INCANO(INTEIRO1,INTEIRO2,INTEIRO3INTEIRO3 → Quantidade de meses para adicionar na data inicial
    FRAC( NUM )
    Parâmetros
  • INTEIRO1 → Mês da data inicial
  • INTEIRO2 → Ano da data inicial
    • NUM → Número para Operação
    Exemplo
    INCANO(2,2018,26

    FRAC(24.73)

    Retorno
    2019

    0,73

    INCMES

    HOJE


           

    Função
    INCMES
    HOJE
    Descrição
    Adiciona uma quantidade de meses ( X meses) à um mês inicial (1 a 12)
    Retorna a data de hoje.

    Sintaxe

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

    N/A

    Exemplo
    INCMES

    HOJE(

    2,19

    )

    Retorno
    9INTTOSTRFORMAT
    24/10/2018

    INCANO


           

    Função
    INTTOSTRFORMAT
    INCANO
    Descrição
    Converte um valor inteiro para string (texto) preenchendo com zeros
    Adiciona um número de meses a um mês/ano e retorna o ano do resultado.

    Sintaxe

    INTTOSTRFORMAT
    INCANO(
    INTEIRO
    INTEIRO1,INTEIRO2,
    ZEROS
    INTEIRO3)
    Parâmetros
    • INTEIRO → Valor a ser convertido.
    • ZEROS→ Quantidade de Zeros.
    • 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

    ExemploINTTOSTRFORMAT(27,5

    )

    Retorno
    00027
    2019
    MAX

    INCMES


           

    Função
    MAX
    INCMES
    Descrição
    Retorna o maior número
    Adiciona uma quantidade de meses ( X meses) à um mês inicial (1 a 12).

    Sintaxe

    MAX
    INCMES(
    NUM A
    INTEIRO1,
    NUM B
    INTEIRO2)
    Parâmetros
  • NUM A → Número para comparação
    • INTEIRO1 → Mês inicial
    • INTEIRO2 → Quantidade de meses para adicionar ao mês inicial
    NUM B → Número para comparação
    Exemplo
    MAX

    INCMES(

    17

    2,

    12

    19)

    Retorno
    17'
    9
    MEMORIA

    INTTOSTRFORMAT


           

    Função
    MEMORIA
    INTTOSTRFORMAT
    Descrição
    Retorna o valor de uma memória

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

    Sintaxe

    MEMORIA
    INTTOSTRFORMAT(
    CHAVE
    INTEIRO , ZEROS )
    Parâmetros
    CHAVE → Chave da memória
    • INTEIRO → Valor a ser convertido.
    • ZEROS→ Quantidade de Zeros.
    Exemplo
    MEMORIA('MEMORIA001'

    INTTOSTRFORMAT(27,5)

    Retorno
    Mundo Bonito

    00027

    MESDT

    MAX


           

    Função
    MESDT
    MAX
    Descrição

    Retorna o

    mês de uma data

    maior número.

    Sintaxe

    MESDT( ' DATA '
    MAX( NUM A , NUM B )
    Parâmetros
    DATA → Data para selecionar o mês
    • NUM A → Número para comparação
    • NUM B → Número para comparação
    Exemplo
    MESDT('24/10/2018'

    MAX(17,12)

    Retorno
    10

    17'

    MIN

    MEMORIA


           

    Função
    MIN
    MEMORIA
    Descrição

    Retorna o

    menor número

    valor de uma memória.

    Sintaxe

    MIN( NUM A , NUM B NUM B → Número para comparação
    MEMORIA( CHAVE )
    Parâmetros
  • NUM A → Número para comparação
    • CHAVE → Chave da memória
    Exemplo
    MIN(17,12

    MEMORIA('MEMORIA001')

    Retorno
    12

    Mundo Bonito

    MTDATA

    MESDT


           

    Função
    MTDATA
    MESDT
    Descrição
    Monta
    Retorna o mês de uma data
    a partir de um dia, mês e ano
    .

    Sintaxe

    MTDATA(INTEIRO1,INTEIRO2,INTEIRO3INTEIRO3 → Ano da data
    MESDT( ' DATA ' )
    Parâmetros
  • INTEIRO1 → Dia da data
  • INTEIRO2 → Mês da data
    • DATA → Data para selecionar o mês
    Exemplo
    MTDATA(17,11,1989

    MESDT('24/10/2018')

    Retorno
    17/11/1989
    10

    MIN

    PAR


           

    Função

    PAR
    MIN
    Descrição

    Retorna o

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

    menor número.

    Sintaxe

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

    MIN(17,12)

    Retorno

    Conteúdo do parâmetro armazenado

    12

    MTDATA

    PARMQRY


           

    Função

    PARMQRY
    MTDATA
    Descrição
    Retorna o conteúdo de um campo.
    Utilizada no Gerador de Relatórios (RMGerador.dll)
    Monta uma data a partir de um dia, mês e ano.

    Sintaxe

    PARMQRY( ' CAMPO '
    MTDATA(INTEIRO1,INTEIRO2,INTEIRO3)
    Parâmetros
    CAMPO → Nome do Campo
    • INTEIRO1 → Dia da data
    • INTEIRO2 → Mês da data
    • INTEIRO3 → Ano da data
    Exemplo
    PARMQRY('CODUSUARIO'

    MTDATA(17,11,1989)

    Retorno

    IgorMC

    POTENCIA
    17/11/1989

    PAR


           

    Função
    POTENCIADescriçãoRetorna a potência
    PAR
    Descrição

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

    Sintaxe

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

    Exemplo
    POTENCIA

    PAR(

    2,4

    )

    Retorno

    16

    PROXREGSQL

    Conteúdo do parâmetro armazenado

    PARMQRY


           

    Função
    PROXREGSQL
    PARMQRY
    Descrição
    Avança um registro na Consulta SQL executada

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

    Sintaxe

    PROXREGSQL
    PARMQRY( '
    CÓDIGO
    CAMPO ' )
    Parâmetros
    CÓDIGO → Código da Consulta SQL.
    • CAMPO → Nome do Campo
    Exemplo
    PROXREGSQL

    PARMQRY('

    CON001

    CODUSUARIO')

    Retorno

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

    IgorMC

    POTENCIA

    RAIZ


           

    Função

    RAIZ
    POTENCIA
    Descrição

    Retorna a

    raiz quadrada de um valor

    potência.

    Sintaxe

    RAIZ
    POTENCIA( NUM A , NUM
    )Parâmetros
    B )
    Parâmetros
    • NUM A→ Base da potência
    • NUM B→ Expoente da potência
    NUM → Número para Operação
    Exemplo
    RAIZ

    POTENCIA(

    25

    2,4)

    Retorno
    5

    16

    RESULTSQL

    PROXREGSQL


           

    Função
    RESULTSQL
    PROXREGSQL
    Descrição
    Retorna o valor de um campo de um resultado da

    Avança um registro na Consulta SQL executada.

    Sintaxe

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

    PROXREGSQL('CON001

    ',

    '

    CODUSUARIO'

    )

    Retorno
    Retorna o valor do campo CODUSUARIO do resultado da

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

    RETIRACARACTERES

    RAIZ


           

    Função
    RETIRACARACTERES
    RAIZ
    Descrição
    Retira do texto todas as ocorrências dos caracteres da string chars

    Retorna a raiz quadrada de um valor.

    Sintaxe

    RETIRACARACTERES( ' CHAR ' , ' TEXTO ' TEXTO → String que é desejado retirar os caracteres
    RAIZ( NUM )
    Parâmetros
  • CHAR → Caracteres que se deseja retirar.
    • NUM → Número para Operação
    Exemplo
    RETIRACARACTERES('o','Mundo Bonito'

    RAIZ(25)

    Retorno
    Mund Bnit

    5

    SETVAR

    RESULTSQL


           

    Função
    SETVAR
    RESULTSQL
    Descrição
    Atribui um valor a uma variável

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

    Sintaxe

    SETVAR
    RESULTSQL( '
    VAR
    CÓDIGO ' ,
    CONTEUDO
    ' CAMPO ' )
    Parâmetros
  • VAR → Variável
  • CONTEUDO → Conteúdo para adicionar na variável
    • CÓDIGO → Código da Consulta SQL
    • CAMPO → Campo desejado
    Exemplo
    SETVAR

    RESULTSQL('

    var1

    CON001',

    200

    'CODUSUARIO' )

    Retorno

    200

    STR

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

    RETIRACARACTERES


           

    Função
    STRDescriçã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

    RETIRACARACTERES
    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çãoSTR
    Descriçã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

    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 BoniSUBSTR


           

    Função

    SUBSTR
    STRLEFT
    DescriçãoCopia
    a partir da posição início
    o lado DIREITO de um string (texto) um número de caracteres
    de texto
    (quantidade).

    Sintaxe

    SUBSTR
    STRLEFT( ' TEXTO ' ,
    INTEIRO1, INTEIRO2
    INTEIRO )
    Parâmetros
    • TEXTO →
    Texto onde é desejado selecionar uma parte para cópia
  • INTEIRO1 → Caracter início
    • String para fazer a cópia iniciando pelo lado Direito
    • INTEIRO →
    INTEIRO2 →
    • Quantidade de caracteres que
    você
    • deseja
    selecionar.
    • -se copiar
    Exemplo
    SUBSTR

    STRLEFT('

    Alô

    Mundo Bonito',

    2,5

    10)

    Retorno
    lô mu

    ndo Bonito

    SUBTRAIDATAS

    STRRIGHT


           

    Função
    SUBTRAIDATASDescriçãoRetorna a subtração entre duas datas
    STRRIGHT
    DescriçãoCopia o lado ESQUERDO de um string (texto) um número de caracteres (quantidade).

    Sintaxe

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

    STRRIGHT('

    24/10/2018

    Mundo Bonito',

    '21/09/2018'

    10)

    Retorno
    33
    Mundo Boni
    TABCOLIG

    SUBSTR


           

    Função
    TABCOLIG
    SUBSTR
    Descrição
    Retorna o valor de um campo da coligada
    Copia a partir da posição início um número de caracteres de texto.

    Sintaxe

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

    SUBSTR('

    NOMEFANTASIA'

    Alô Mundo', 2,5)

    Retorno
    TOTVS SA
    lô mu
    TABCOLIGADA

    SUBTRAIDATAS


           

    Função
    TABCOLIGADA
    SUBTRAIDATAS
    Descrição

    Retorna

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

    a subtração entre duas datas

    Sintaxe

    TABCOLIGADA( ' CAMPO '
    SUBTRAIDATAS( DATA1 , DATA2 )
    Parâmetros
    CAMPO → Nome do Campo
    • DATA1 → Data inicial
    • DATA2 → Data para subtrair
    Exemplo
    TABCOLIGADA

    SUBTRAIDATAS('

    Numero

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

    Retorno
    2664

    33

    TAMSTR

    TABCOLIG


           

    Função
    TAMSTR
    TABCOLIG
    Descrição

    Retorna o

    tamanho da string

    valor de um campo da coligada.

    Sintaxe

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

    TABCOLIG('

    Mundo Bonito

    NOMEFANTASIA')

    Retorno
    12

    TOTVS SA

    TETO

    TABCOLIGADA


           

    Função
    TETO
    TABCOLIGADA
    Descrição

    Retorna o valor

    truncado mais um

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

    Sintaxe

    TETO
    TABCOLIGADA(
    NUM
    ' CAMPO ' )
    Parâmetros
    NUM → Número para Operação
    • CAMPO → Nome do Campo
    Exemplo
    TETO(24.03

    TABCOLIGADA('Numero')

    Retorno
    25

    2664

    TRUNCVALOR

    TAMSTR


           

    Função
    TRUNCVALOR
    TAMSTR
    Descrição
    Trunca um valor com casas decimaisTRUNCVALOR( NUM A , NUM B
    Retorna o tamanho da string.

    Sintaxe

    TRUNCVALOR( NUM A ) ou
    TAMSTR( ' TEXTO ' )
    Parâmetros
    • NUM A→ Número para Operação
    • NUM B→ Quantidade de casas Decimais
    • TEXTO → String que é desejado saber a quantidade de caracteres
    Exemplo

    TAMSTR('Mundo Bonito'

    ExemploTRUNCVALOR(24.83)
    TRUNCVALOR(24.83, 1

    )

    Retorno

    24
    24,8

    12

    TETO

    ULTDIAMES


           

    Função

    ULTDIAMES
    TETO
    Descrição

    Retorna o

    último dia do mês de uma data

    valor truncado mais um.

    Sintaxe

    ULTDIAMES
    TETO(
    ' DATA '
    NUM )
    Parâmetros
    DATA
    • NUM
    Data para selecionar o último dia do mês
    • Número para Operação
    Exemplo
    ULTDIAMES

    TETO(

    '24/10/2018'

    24.03)

    Retorno
    31/10/2018

    25

    TRUNCVALOR

    USUARIOCORRENTE


           

    Função

    USUARIOCORRENTE
    TRUNCVALOR
    Descrição
    Retorna o usuário corrente

    Trunca um valor com casas decimais.

    Sintaxe

    USUARIOCORRENTE(
    TRUNCVALOR( NUM A ) ou TRUNCVALOR( NUM A , NUM B )
    Parâmetros

    N/A

    Exemplo

    USUARIOCORRENTE()

    Retorno

    IgorMC

    • 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

    VAL


           

    Função

    VAL
    ULTDIAMES
    Descrição
    Converte um string para valor
    Retorna o último dia do mês de uma data.

    Sintaxe

    VAL
    ULTDIAMES( '
    VALOR
    DATA ' )
    Parâmetros
    VALOR
    • DATA
    String para se converter em valor
    • Data para selecionar o último dia do mês
    Exemplo
    VAL

    ULTDIAMES('

    12,65

    24/10/2018')

    Retorno
    12,65VERDADE
    31/10/2018

    USUARIOCORRENTE


           

    Função
    VERDADE
    USUARIOCORRENTE
    Descrição

    Retorna

    1

    o usuário corrente.

    Sintaxe

    VERDADE
    USUARIOCORRENTE( )
    Parâmetros

    N/A

    Exemplo
    VERDADE

    USUARIOCORRENTE()

    Retorno
    1

    IgorMC

    Informações
    iconfalse
    Informações
    iconfalse

    Produto: Framework

    Informações
    iconfalse

    Versão: 12.01.XX

    Informações
    iconfalse

    Processo: Filtros de Visão

    Informações
    iconfalse
    Informações
    iconfalse

    Status: Finalizado

    Informações
    iconfalse

    Data: 25/10/2018

    Informações
    iconfalse

    Autores:

    Carlos Philippe de Farias Marques

    Carlos Roberto Pereira Garcia

    Diogo Damiani Ferreira

    Fábio Augusto Amaral Melo Nunes

    Igor Macedo Cardoso

    Karina Dos Santos Costa

    Stella Gleyse Macedo Vilaca

    TIAGO ANDRADE GOMES SILVEIRA

    VAL


           

    FunçãoVAL
    Descriçã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çãoVERDADE
    Descrição

    Retorna 1.

    Sintaxe

    VERDADE ( )
    Parâmetros

    N/A

    Exemplo

    VERDADE()

    Retorno

    1

    Informações
    iconfalse

    Versão: 12.01.XX