Sintaxe de comandos e operadores

Sinal	Descrição
=	Sinal Igual: Utilizado em comparações/operações aritméticas.
>	Maior que.
<	Menor que.
<>	Diferente de.
>=	Maior ou igual a.
<=	Menor ou igual a.
e	E. Utilizado com o comando "Se" para ligar várias condições, em que todas devem ser verdadeiras para que o resultado da comparação seja verdadeira.
ou	OU. Utilizado com o comando "Se" para ligar várias condições, devendo apenas uma condição ser verdadeira para que o resultado da comparação seja verdadeiro.

 

Sinal	Descrição
=	Sinal igual: Utilizado em comparações/operações aritméticas
+	Sinal de adição: Utilizado nas operações aritméticas de somar
-	Sinal de Subtrair: Utilizado operações aritméticas de subtrair
/	Sinal dividir: Utilizado nas operações aritméticas de divisão.
*	Asterisco: Utilizado nas operações aritméticas de multiplicação.
++	Incremento de +1: Utilizado para aumentar o valor de uma variável, de um em um.
--	Decremento de -1: Utilizado para diminuir o valor de uma variável, de um em um.

 

Sinal	Descrição
/*	Inicio de comentário
*/	Final de Comentário
@	Comentário de uma linha

Como pode ser visto no exemplo acima, está sendo passado um endereço de um arquivo que normalmente seria: \\Servidor\teste.txt. Entretanto ao passar literalmente nas regras é necessário colocar uma \ (barra) antes das "" (aspas) e da \ (barra) para que estes caracteres não funcionem como caracteres especiais.

Se a barra não fosse adicionada antes destes caracteres, eles funcionariam de forma especial, ou seja, a \ (barra) é usada para quebra de linha quando o texto é muito extenso para ser visualizado em tela e as "" (aspas) são usadas para passar (entre as mesmas) expressões literais.

Abre o arquivo informado em nome do arquivo para o modo de abertura informado (Ler/Gravar). Se o arquivo não existir, ele é criado. Ele retorna um manipulador de arquivos.

Sintaxe

Exemplo

Usado com o comando Definir para definir uma variável Alfanumérica com o tamanho determinado.

Sintaxe

Exemplo

Atualiza os dados de todos os campos de uma tela de cadastramento.

Exemplo

Cancel (n)
Utilizado para cancelar a execução da regra. Possui diferentes ações de acordo com o recurso que executou a regra. Ao usar a função Cancel(n) em regras que são executadas por eventos de tela, a única ação tomada será o cancelamento da execução da regra, independentemente do valor passado como parâmetro.

Para que seja gerado um erro, deve-se usar a função Mensagem(Erro, "mensagem") ou então a equipe de desenvolvimento do sistema deve tratar via código de sistema o retorno de Cancel(n).

 

No Gerador de Relatórios, o comando Cancel pode ser usado das seguintes formas:

Cancel(1)

• Em controles: Cancela a execução da regra e a impressão do mesmo.
• Nas regras: Definição\Seleção e Detalhe\Antes_de_Imprimir, exclui o registro atual do relatório (detalhe);
• Na regra: Definição\Pré-Seleção cancela a execução do relatório.

Cancel(2)
Utilizado para imprimir o conteúdo da variável ValStr em controles do tipo descrição e depois sair da regra;

Cancel(3)
Utilizado apenas em controles do tipo fórmula (na ordenação por fórmula) para excluir o registro atual do relatório (semelhante a executar o Cancel(1) nas regras: Definição\Seleção, Detalhe\Antes_de_Imprimir e Detalhe\Depois_de_Imprimir).

 

Continua a execução de um loop feito pelo comando Para.

Sintaxe

Exemplo

Os cursores nada mais são que um SELECT em uma regra, retornando registros que satisfaçam a condição informada na propriedade SQL de um Cursor.

O SELECT utilizado no cursor não possui relacionamento direto com o SELECT utilizado pelo gerador de relatórios. Os cursores são utilizados em conjunto com determinados cursores.

Não é possível utilizar dois SQLs no mesmo cursor em uma regra LSP que retorne quantidade diferentes de campos. Ou seja, se for necessário criar dois ou mais selects que retornem diferentes quantidades de campos, deve-se criar um cursor para cada select.

SQL

Usado para definir um comando SQL para o cursor.

Sintaxe

Exemplo

AbrirCursor (OpenCursor)

Sintaxe

Exemplo

FecharCursor (CloseCursor)

Sintaxe

Exemplo

Proximo

Lê o próximo registro do cursor.

Sintaxe

Exemplo

<campos>

Os campos pertencentes ao cursor e que podem ser acessados diretamente, porém são somente Leitura, ou seja, não podem ser alterados.

Sintaxe

Exemplo

Achou (Found)

Retorna verdadeiro se achou alguma linha do cursor.

Sintaxe

Exemplo

NaoAchou (NotFound)

Retorna verdadeiro se não achou alguma linha do cursor.

Sintaxe

Exemplo

 

Outros exemplos

Cursor retornando apenas uma linha, quando tem-se a chave completa, este cursor deve retornar apenas uma linha:

Cursor retornando várias linhas, quando não tem-se a chave completa, este cursor pode retornar várias linhas:

Variável que guarda apenas datas.

Exemplo

Define o tipo (Alfa, Numero, Tabela, Data, Funcao ou Cursor) de uma variável ou função. Caso a variável não seja definida, esta será considerada como tipo Numero.

Sintaxe

Exemplos

Declaração de uma variável alfanumérica chamada Nome_da_Cidade com tamanho de 20 posições:

Declaração de uma variável numérica chamada Valor_Salario ocorrendo 12 vezes, ou seja, haverá 12 números Valor_Salario. Por exemplo, os 12 salários dos meses do ano:

Declaração de uma uma tabela de 12 ocorrências tendo como nome Acumulador, e como variáveis numéricas Media_Mensal e Movimento ocorrendo 31 vezes uma para cada dia do mês e a alfanumérica Nome_Mes com 14 posições:

Desfaz uma transação iniciada anteriormente.

Exemplo

Comando lógico para formular uma condição geral com dependência entre as condições individuais. Para que a condição geral seja verdadeira, todas as condições individuais ligadas pelo E, devem ser verdadeiras.

Sintaxe

Exemplo

Indica que o parâmetro de uma função é passado na chamada da mesma.

Sintaxe

Exemplo

Comando utilizado para que um bloco de comandos seja executado repetidamente até que a condição definida deixe de ser atendida.

Sintaxe

Exemplo

Executa um comando SQL no banco. Nessa função podem ser usadas para as operações Insert , Update , Delete.

Exemplo

Insert:

Update:

Delete:

Executa um comando SQL no banco. Nessa função podem ser usadas para as operações Insert , Update , Delete, retornando 0 (zero) no parâmetro Numero sucesso se o comando executou corretamente ou 1 seguido da mensagem de erro no parâmetro Alfa Mensagem em caso de falha na execução.

Sintaxe

Exemplo

Insert:

Update:

Delete:

Utilização com campos Blob:

Fecha um arquivo aberto anteriormente pelo comando Abrir.

Sintaxe

Exemplo

Indica o fim de um bloco de comandos.

Exemplo

Finaliza a transação no banco de dados.

Exemplo

Formata números de acordo com os parâmetros definidos. O formato é o mesmo usado no Borland Delphi 2.0.

Sintaxe

Parâmetros

• Valor: Variável tipo numérica a ser convertida;
• Formato: Formato de conversão. Por exemplo, %3.0f para converter o valor 354 e %3.2f para converter o valor 345,43.

Exemplo

Formata números com casas decimais de acordo com os parâmetros definidos. O formato é o mesmo usado no Borland Delphi 2.0.

Parâmetros

• Valor: Variável tipo numérica a ser convertida;
• Formato: Formato de conversão;
• Separador decimal: Qual será o separador de casas decimais;
• Variável: armazena o resultado da formatação.

Sintaxe

Exemplo

É um conjunto de comandos, que tem como objetivo calcular um ou mais valores e retorná-los para uso na regra. Havendo uma operação que se repita, pode-se criar a função e chamá-la em cada regra, sem precisar reimplementá-la.

A definição e o uso das funções seguem um padrão específico dentro das regras LSP. Para mais detalhes, consulte o tópico acima sobre Definição de funções - Funcao (Function).

Grava o valor de uma constante ou de uma variável, e uma quantidade de caracteres especificados em tamanho no arquivo especificado no manipulador de arquivo.

Sintaxe

Exemplo

Grava uma linha no arquivo indicado pelo manipulador de arquivo com o valor de uma variável ou constante, passada como parâmetro.

Sintaxe

Exemplo

Usado com o comando definir para declarar uma variável do tipo grade.

Sintaxe

Exemplo

Inicia a transação no banco de dados.

Exemplo

Indica o início de um bloco de comandos, que permite a inclusão de outros blocos internos.

Exemplo

Usado para inserir um outro texto na posição onde está o comando.

Exemplo

Lê uma quantidade de caracteres especificados em tamanho do arquivo especificado no manipulador de arquivo e joga o valor lido na variável especificada.

Sintaxe

Exemplo

Lê uma linha do arquivo indicado pelo manipulador de arquivo e joga o valor lido para a variável indicada.

Sintaxe

Exemplo

Exibe uma mensagem para o usuário. As mensagens possuem características de acordo com o seu tipo.

• Retorna: Mostra uma mensagem de aviso, com os botões especificados entre colchetes. O símbolo & indica tecla de aceleração (atalho);
• Erro: Gera uma exceção, mostrando uma mensagem de erro e abortando a execução da regra;
• Refaz: Gera uma exceção, mostrando uma mensagem de erro e abortando a execução da regra.

Sintaxe

Exemplo

 

Mensagem em ambiente web

No ambiente web, Não é permitida a função Mensagem nas regras. Quando esta função aparece nas regras e está sendo executada na web, internamente é gerado uma exceção e em determinados casos , como no SGI por exemplo, causa a perda das alterações realizadas no banco de dados.

Foi criada então uma variável que ficará disponível aos sistemas para que indiquem se desejam que seja ignorada na WEB as mensagens que forem do tipo Retorna. A variável se chama vIgnoreRuleMsgInEnvWeb e está no fonte RtBaseUtil.pas. Por padrão, ela virá marcada como falso, ou seja, sempre irá gerar uma exceção caso apareça o comando mensagem na regra, como é o comportamento padrão.

Se a vIgnoreRuleMsgInEnvWeb tiver seu valor alterado para verdadeiro e a mensagem sendo do tipoRetorn,a mensagem será ignorada e a regra continuará a executar normalmente.

Se a vIgnoreRuleMsgInEnvWeb tiver seu valor alterado para verdadeiro e a mensagem sendo do tipoErro, será gerada uma exceção e será abortada a execução da regra.

 

Usado com o comando definir para definir uma variável Numérica.

Sintaxe

Exemplo

Comando lógico para formular uma condição geral sem dependência entre as condições individuais. Para que a condição geral seja verdadeira, ao menos umas das condições individuais ligadas pelo ou, deve ser verdadeira.

Sintaxe

Exemplo

Comando utilizado para que um bloco de comandos seja executado determinado número de vezes, a partir de um valor inicial que é incrementado pelo valor do contador, até que a condição definida deixe de ser atendida.

Sintaxe

Exemplo

Interrompe a execução de um bloco do comando enquanto ou para. O sistema abandona o bloco de comandos e continua a execução do restante das regras.

Exemplo

Chama uma outra regra identificada pelo número da regra.

Sintaxe

Exemplo

Regra 5;

Executa o bloco a seguir se a condição for atendida.

Sintaxe

Exemplo

Usado com o comando se, caso a condição não for atendida, o bloco após o senao será executado.

Sintaxe

Exemplo

Usado com o comando definir para declarar uma variável do tipo Tabela, com linhas e colunas. Cada coluna é um nome com um tipo específico de informação e as linhas são indexadas de 1 até N.

Sintaxe

Exemplo

Retorna um valor numérico para a aplicação.

Sintaxe

Exemplo

Retorna um valor alfanumérico para a aplicação.

Sintaxe

Exemplo

Desvia a execução do programa para um ponto específico da regra onde estiver localizado o identificador determinado. Assim, ao ser declarado o identificador, este poderá ser chamado a um ponto de regra, movendo a execução do procedimento a partir do ponto específico em que foi chamado.

O uso desse comando deve ser analisado e aplicado com cautela, associando lógica e/ou validações que, ao atenderem a determinados resultados, avancem a um ponto especifico da regra.

Sintaxe

Exemplos

No exemplo fictício abaixo, será criada uma porta de serviço para inserção de duas pessoas com um contato no banco de dados:

Definir xServico.xPorta wsPorta;

wsPorta.DesatLimpezaParamEnt();

wsPorta.codPessoa = 1;

wsPorta.nomPessoa = "Pessoa 1";

wsPorta.dadosContato.CriarLinha();

wsPorta.dadosContato.telContato = "99999999";

wsPorta.dadosContato.nomContato = "Contato 1";

wsPorta.Executar();@ Primeira Execução @

wsPorta.codPessoa= 2;

wsPorta.nomPessoa = "Pessoa 2";

wsPorta.Executar();@ Segunda Execução @

wsPorta.LimparParamsEntrada();

wsPorta.AtivaLimpezaParamEnt();

Foram criados os parâmetros de entrada "codPessoa" e "nomPessoa" juntamente com parâmetros de entrada do tipo tabela "telContato" e "nomContato" para realizar a inserção de duas pessoas com o mesmo contato em comum.

Ao desativar a Limpeza dos Parâmetros de Entrada com a função DesatLimpezaParamEnt(), a primeira chamada da execução do serviço vai inserir a Pessoa 1 com o Contato 1 mantendo esses parâmetros alimentados para uma próxima execução.

Sobrescrevendo a "Pessoa 1" por "Pessoa 2" na segunda execução do serviço, resultará na inserção da Pessoa 2 com o Contato 1 pois os parâmetros de entrada do tipo tabela "telContato" e "nomContato" ainda estarão alimentados.

A chamada da função LimparParamsEntrada() realizará a limpeza de todos os parâmetros de entrada ao final.

A chamada da função AtivaLimpezaParamEnt() indica o retorno da Limpeza Automática dos Parâmetros de Entrada após a Execução para quaisquer execuções posteriores da mesma porta na regra atual.