Você está na página 1de 186

ADVPL

MICROSIGA Software S/A Av. Braz Leme, 1399/1631 02511-000 - So Paulo - Brasil Telefone (011) 3981-7000 http://www.microsiga.com.br

Copyright MICROSIGA Software S/A Todos os direitos reservados e protegidos pela Lei de Direitos Autorais n. 9.610 de 19/02/1.998. Nenhuma parte deste documento pode ser reproduzida, publicada ou transmitida por impresso, fotocpia, microfilme, fita de udio, eletronicamente, mecanicamente, ou qualquer outro meio, ou armazenado em um sistema de informao recuperado, sem a permisso prvia, por escrito do proprietrio destes direitos. Em funo do contnuo desenvolvimento dos produtos da MICROSIGA Software S/A, este documento est sujeito a modificaes que sero atualizadas nas subseqentes revises de novas verses. Portanto, toda informao contida neste documento de natureza geral e nunca poder ser utilizada em qualquer obrigao contratual. Elaborao:

MICROSIGA Educao Corporativa


Apoio e Reviso:

Auditoria de Cursos MICROSIGA

SUMRIO
ADVPL ............................................................................................................................. 1
Linguagem de Programao ADVPL........................................................................................ 7 Variveis ................................................................................................................................ 11 Rotinas Abordadas ............................................................................................................... 11 O que voc aprendeu neste captulo .............................................................................. 20 Prximo Passo ....................................................................................................................... 20

ESTRUTURA DE CONTROLE ..................................................................................................... 21


O que voc ir aprender neste captulo ...................................................................... Rotinas Abordadas ............................................................................................................... For Next ................................................................................................................................. O que voc aprendeu neste captulo .............................................................................. Prximo Passo ....................................................................................................................... O que voc ir aprender neste captulo ...................................................................... Rotinas Abordadas ............................................................................................................... Macro ....................................................................................................................................... O que voc aprendeu neste captulo .............................................................................. Prximo Passo ....................................................................................................................... Comandos definidos pelo usurio (UDCs) ...................................................................... Chaves Primrias ................................................................................................................. Chaves Estrangeiras ........................................................................................................... Integridade Referencial ................................................................................................... O que voc ir aprender neste captulo ...................................................................... Rotinas Abordadas ............................................................................................................... Funes em Gatilhos ........................................................................................................... Significado dos campos da tela de cadastro de gatilhos ...................................... O que voc aprendeu neste captulo .............................................................................. Prximo Passo ....................................................................................................................... 21 21 21 28 28 29 29 29 32 32 37 38 38 39 40 40 40 42 49 49

MACRO SUBSTITUIO ........................................................................................................... 29

VALIDAO DE CAMPO .......................................................................................................... 33

FUNES APLICADAS EM GATILHOS ........................................................................................... 40

FUNES PARA CADASTROS ................................................................................................... 50


O que voc ir aprender neste captulo ...................................................................... 50 Rotinas Abordadas ............................................................................................................... 50

DESENVOLVENDO TELAS ........................................................................................................ 51


AxCadastro() Cadastro Padro ...................................................................................... MBrowse() ............................................................................................................................... Sintaxe da Funo Modelo2() ........................................................................................... Modelo3() ............................................................................................................................... O que voc aprendeu neste captulo .............................................................................. Prximo Passo ....................................................................................................................... 56 62 69 80 92 92

CRIAO DE RELATRIOS CONSULTAS PADRO .......................................................................... 93


O que voc ir aprender neste captulo ...................................................................... 93 Rotinas Abordadas ............................................................................................................... 93 O que voc ir aprender neste captulo ...................................................................... 93 Rotinas abordadas ............................................................................................................... 93 Variveis de Relatrios ................................................................................................... 93 S e t P r i n t ( ) ............................................................................................................................. 94 S e t D e f a u l t ( ) ......................................................................................................................... 95 P e r g u n t e ( ) ......................................................................................................................... . 96 S e t R e g u a ( ) ............................................................................................................................. 96 R p t S t a t u s ( ) ........................................................................................................................... 96 IncRegua() ............................................................................................................................. 97 R e l a t r i o s ............................................................................................................................. 97 Perguntas e Respostas ..................................................................................................... 102 O que voc aprendeu neste captulo ............................................................................ 110 Prximo Passo ..................................................................................................................... 111

IMPORTAO DE DADOS ........................................................................................................ 111


O que voc ir aprender neste captulo .................................................................... Rotinas abordadas ............................................................................................................. O que voc aprendeu neste captulo ............................................................................ Prximo Passo ..................................................................................................................... O que voc ir aprender neste captulo .................................................................... Rotinas Abordadas ............................................................................................................. Pontos de Entrada ............................................................................................................. AbreExcl ............................................................................................................................... Activate Dialog ................................................................................................................. AADD() ................................................................................................................................... A l l T r i n ( ) ............................................................................................................................. ASCAN() ................................................................................................................................. A l e a t o r i o ............................................................................................................................. Avalimp ................................................................................................................................. A L I A S ( ) ................................................................................................................................. Aviso ..................................................................................................................................... @ n1,n2 BmpButton ............................................................................................................. @ . . . T o . . . B r o w s e ................................................................................................................. @ . . . B u t t o n ........................................................................................................................... Cabec ..................................................................................................................................... C C ......................................................................................................................................... G @...CheckBox...Var ........................................................................................................... CTOD() ................................................................................................................................... ChkFile ................................................................................................................................. Close ..................................................................................................................................... CloseOpen ............................................................................................................................. C l o s e s F i l e ........................................................................................................................... 111 111 114 114 115 115 115 120 121 121 121 122 122 123 125 125 126 127 127 128 129 129 130 130 131 132 132

PONTOS DE ENTRADAS .........................................................................................................115

Anotaes:

4 - SIGAADVPL Protheus - APL8110401061027

@ . . . C o m b o B o x . . . I t e n s . . . S i z e ......................................................................................... 133 ConfirmSX8 ........................................................................................................................... 134 Contar ................................................................................................................................... 134 CriaTrab ............................................................................................................................... 134 CriaVar ................................................................................................................................. 135 DTOS() ................................................................................................................................. 136 DataValida ........................................................................................................................... 137 @ . . . T o . . . D i a l o g ................................................................................................................. 138 ExistChav ............................................................................................................................. 139 EVAL() ................................................................................................................................. 140 ExistCpo ............................................................................................................................... 140 E x i s t I n i ............................................................................................................................... 141 Extenso ................................................................................................................................. 142 EMPTY() ............................................................................................................................... 142 FOUND( ) ............................................................................................................................... 143 FCOUNT() ............................................................................................................................. 143 Formula ................................................................................................................................. 144 @... GET ............................................................................................................................... 144 GetAdvFval ........................................................................................................................... 145 GetMV ..................................................................................................................................... 146 GetSX8Num ............................................................................................................................. 147 G e t A r e a ( ) ............................................................................................................................. 148 Help ....................................................................................................................................... 148 ImpCadast ............................................................................................................................. 149 IncRegua ............................................................................................................................... 149 IncProc ................................................................................................................................. 150 INDEXORD() ......................................................................................................................... 150 IndRegua ............................................................................................................................... 151 LEN() ................................................................................................................................... 151 LetterOrNum ......................................................................................................................... 152 MarkBrowse ........................................................................................................................... 152 MBrowse ................................................................................................................................. 153 MesExtenso ........................................................................................................................... 153 Modelo2 ................................................................................................................................. 154 Modelo3 ................................................................................................................................. 155 MontaF3 ................................................................................................................................. 155 MsgBox ................................................................................................................................... 156 MsUnLock() ........................................................................................................................... 157 @ . . T o . . . M u l t i L i n e ............................................................................................................. 157 NaoVazio ............................................................................................................................... 158 Ms_Flush() ........................................................................................................................... 158 Negativo ............................................................................................................................... 158 OpenFile ............................................................................................................................... 159 OurSpool ............................................................................................................................... 160 O b r i g a t o r i o ......................................................................................................................... 160 Pergunte ............................................................................................................................... 161
Anotaes:

APL8110401061027 - SIGAADVPL Protheus - 5

Pertence ............................................................................................................................... 161 P e s q P i c t ............................................................................................................................... 161 PesqPictQt ........................................................................................................................... 162 Posicione ............................................................................................................................. 162 P o s i t i v o ............................................................................................................................... 163 PswAdmin( ) ......................................................................................................................... 163 ProcRegua ............................................................................................................................. 164 ProxReg ................................................................................................................................. 164 P r o c e s s a ( ) ........................................................................................................................... 165 @...Radio ............................................................................................................................. 166 RecLock ................................................................................................................................. 167 RollBackSX8 ......................................................................................................................... 167 RestArea ............................................................................................................................... 168 RetASC ................................................................................................................................... 169 RetIndex ............................................................................................................................... 169 RECNO() ............................................................................................................................... 170 R p t S t a t u s ............................................................................................................................. 170 RegToMemory ......................................................................................................................... 171 S e t D e f a u l t ........................................................................................................................... 171 SetDlg ................................................................................................................................... 172 SUBSTR() ............................................................................................................................. 173 S e t P r i n t ............................................................................................................................... 173 SET FILTER ......................................................................................................................... 174 SetRegua ............................................................................................................................... 176 Somar ..................................................................................................................................... 176 Tabela ................................................................................................................................... 177 TamSX3 ................................................................................................................................... 178 Texto ..................................................................................................................................... 179 @ ...TO ................................................................................................................................. 179 T ........................................................................................................................................... 180 M UPPER() ................................................................................................................................. 181 Vazio ..................................................................................................................................... 181 X3Picture ............................................................................................................................. 182 X F i l i a l ................................................................................................................................. 182 X3USO ..................................................................................................................................... 183 X3Picture ............................................................................................................................. 184 X3Cbox() ............................................................................................................................... 184 X 3 D e s c r i ( ) ........................................................................................................................... 185 X 3 T i t u l o ( ) ........................................................................................................................... 185 Prximo Passo ..................................................................................................................... 186

Anotaes:

6 - SIGAADVPL Protheus - APL8110401061027

Linguagem de Programao ADVPL


O AdvPl (Advanced Protheus Language) uma linguagem de programao desenvolvida pela Microsiga e que contem todas as instrues e funes necessrias ao desenvolvimento de um sistema, independente de sua complexidade. Para rodar um programa desenvolvido em AdvPl preciso antes de mais nada escrevlo e compil-lo. Isto feito no IDE (Integrated Development Environment, ou Ambiente Integrado de Desenvolvimento). O objetivo do IDE facilitar a tarefa de escrever programas: atravs de cores indica se a palavra escrita uma instruo, uma varivel ou um comentrio; organiza a biblioteca de programas em projetos; gera modelos de programas de cadastramento, relatrios, consultas, etc; faz o debug, ou seja, permite que se teste o programa passo a passo, verificando o contedo das variveis, marcando pontos de parada, etc. Aps compilar interpretado, ou seja, seja, para rodar um memria. O Protheus, Server e Dados. o programa, o resultado um objeto. Este objeto ento carregado na memria e o Protheus passa a execut-lo. Ou programa necessrio que o Protheus esteja presente na por sua vez, um sistema multi-camada. dividido em Remote,

O Remote processa a parte da estao, basicamente tela e teclado. Pode estar gravado no Servidor e ser carregado via rede para a memria da estao. Ou, de preferncia, deve ficar armazenado no HD da estao. Pode tambm ser carregado pelo Internet Explorer, rodando dentro do Browser. O Server o responsvel pelo processamento dos objetos chamados pelo usurio. ele que se comunica com o Banco de Dados, seja diretamente se for DBFs ou Ctree, ou via Top Connect em caso de SQL. Uma vez terminado o processamento do objeto chamado, o mesmo descartado da memria. Ou seja, o Protheus um sistema que pode crescer de forma ilimitada pois os objetos, armazenados em um repositrio de objetos, praticamente no ocupam espao no HD.

A LINGUAGEM PROPRIAMENTE DITA


Como sabido, uma linguagem de programao um conjunto de comandos e funes que definem ao computador o passo a passo de uma tarefa. Basicamente os comandos se dividem em trs tipos: - aritmticos: + - / * somar subtrair dividir e multiplicar. - entrada e sada: leitura e gravao em uma mdia eletrnica (disco, memory key, etc), da tela e impresso (papel ou tela) e tambm o comando de atribuio, que move os dados na memria de um campo para outro, atravs do := - comandos lgicos, que so na verdade, aqueles que do inteligncia ao compuAnotaes:

APL8110401061027 - SIGAADVPL Protheus - 7

tador. Liderados pelo IF, podem-se apresentar de outras formas: While, For e Do Case. Os operadores usados no AdvPl so os seguintes:

Matemticos ** ou ^ Exponenciao. * Multiplicao. / Diviso. % Mdulo (resto da diviso). + Adio ou sinal positivo. Subtrao ou sinal negativo.

Relacionais < > == <= >= <> ou Menor que. Maior que. Igual a. Menor que ou igual a. Maior que ou igual a. # ou != Diferente.

Lgicos .Not. ou ! No lgico. .And. E lgico. . O r . Ou lgico.

Atribuio := += -= *= /= Permite atribuir um valor a uma varivel. Adiciona antes de atribuir. Subtrai antes de atribuir. Multiplica antes de atribuir. Divide antes de atribuir. Eleva antes de atribuir.

^= ou **=
Anotaes:

8 - SIGAADVPL Protheus - APL8110401061027

% =

Calcula o mdulo antes de atribuir.

Incremento/Decremento ++x X++ --x x-Soma um ao valor de x e ento retorna o valor de x j atualizado. Retorna o valor de x e ento soma um ao valor de x. Subtrai um do valor de x e ento retorna o valor de x j atualizado. Retorna o valor de x e ento subtrai um do valor de x.

Strings x+y Concatenao dos strings x e y. x-y Concatenao dos strings, mas os espaos em branco direita do primeiro operando (x) sero transferidos para o fim do string resultante da concatenao. x $ y Retorna verdadeiro se o contedo da varivel x estiver contido no contedo da varivel y.

Especiais &cVariavel Operador macro . | | Indica uma lista de argumento em um bloco de cdigo. ( ) Funo ou agrupamento em frmula numrica ou macro operador. [ ] Referncia a um elemento de uma matriz. { } Delimitador do bloco de cdigo ou atribuio de valores literais para uma matriz. -> Referncia a um alias, sendo um indicador. @ Passagem de parmetros por referncia. ; Separa instrues numa mesma linha. : Usando como operador send quando acessa nova classe de objeto, atribuio a objeto.

Anotaes:

APL8110401061027 - SIGAADVPL Protheus - 9

O que voc aprendeu neste captulo


Neste captulo ns ficamos sabendo sobre alguns conceitos bsicos do Advpl e seus operadores.

Prximo
No prximo captulo, iremos aprender: variveis, arrays e funes

Passo

Anotaes:

10 - SIGAADVPL Protheus - APL8110401061027

V ARIVEIS
O que voc ir aprender neste captulo
Neste captulo, veremos 3 conceitos importantes: variveis, arrays e funes.

Rotinas
Variveis. Arrays(Matriz). Funes.

Abordadas

Variveis
So campos na memria manipulados pelo programa. No AdvPl estes campos no so rigorosamente tipados, ou seja, mesmo que um campo seja numrico ele pode receber um texto. De qualquer forma ao se definir as variveis, elas podem assumir os seguintes tipos: Numricas: para clculos, podendo ter at 14 inteiros e 8 decimais. Caractere: para textos.

Lgicas: podem assumir a condio de Verdadeiro (.T.) ou Falso (.F.). So usadas como chaves de deciso. Data: devido ao tratamento especifico dado aos dias/meses/anos h um tipo prprio que permite somar e subtrair um certo nmero de dias uma data ou mesmo fazer comparaes entre elas. A notao hngara sugere que iniciemos o nome do campo com uma letra minscula indicando seu tipo. Ex: cTexto, nValor, dVencimento, lAchou. Para atribuir um valor varivel usa-se := Ex: cTexto := casa nValor := 123,45 as aspas indicam que se trata de um texto

Anotaes:

APL8110401061027 - SIGAADVPL Protheus - 11

dVencimento := lAchou := .T.

CtoD(25/12/05)

CtoD converte o texto em data

lAchou fica verdadeiro.

O nome da varivel deve ser absolutamente significativo. Exemplo: um campo para armazenar o custo mdio deve ter uma nomenclatura similar a esta: nCustoMedio Importante - Embora o Protheus possua a limitao de dez posies para o nome da varivel, esta pode ser desprezada nos programas, desde que no gerem duplicidade de smbolos. Exemplo: nCustoMedio1 e nCustoMedio2 ambas sero truncadas em dez posies e sero entendidas como nCustoMedio.

O AdvPl no uma linguagem de tipos rgidos para variveis, ou seja, no necessrio informar o tipo de dados que determinada varivel ir conter no momento de sua declarao, e o seu valor pode mudar durante a execuo do programa. Tambm no h necessidade de declarar variveis em uma seo especfica do seu cdigo fonte, embora seja aconselhvel declarar todas as variveis necessrias no comeo, tornando a manuteno mais fcil e evitando a declarao de variveis desnecessrias. Para declarar uma varivel, deve-se utilizar um identificador de escopo, seguido de uma lista de variveis separadas por vrgula (,). Um identificador de escopo uma palavra-chave que indica a que contexto do programa a varivel declarada pertence. O contexto de variveis pode ser local (visualizadas apenas dentro do programa atual funo), pblico (visualizadas por qualquer outro programa), entre outros.

Mais

detalhes:

Escopo das Variveis Um programa, que sempre tem como sufixo de seu nome a sigla .prw, na verdade um conjunto de funes e de dentro dele so chamadas outras, que esto no Repositrio. Para organizar este ambiente e, de um lado, impedir que uma funo destrua as variveis de outra e, por outro, permitir que haja uma integrao entre elas, cada varivel tem o seu escopo.

Anotaes:

12 - SIGAADVPL Protheus - APL8110401061027

Variveis Locais: so definidas dentro da funo e somente so visualizadas e podem ser atualizadas por comandos internos funo. Variveis Privadas: podem ser visualizadas e alteradas pela funo que a definiu e por todas as outras que ela chamar. Neste caso no h necessidade de pass-la como parmetro. Variveis Pblicas: Podem ser visualizadas e atualizadas em qualquer funo. So normalmente variveis definidas na chamada do sistema para uso geral. Ex: dDataBase, a data digitada pelo usurio na chamada do sistema. O mesmo com cFilial. Variveis Estticas: Podem ser visualizadas e atualizadas dentro do PRW. Seu uso raro.

Exerccio 01 Digite no Ide o cdigo abaixo, salve o arquivo com o nome de Exerc01, compile e execute a funo Exerc01. Obs.: Dentro de um arquivo, possvel ter vrias funes. Portanto, depois do arquivo compilado, quem dever ser executado a funo, que pode ter o mesmo nome do arquivo. Prw. Porem, no se esquea que se executa a funo e no o arquivo. Obs.02: No Advpl, para comentar uma linha usa-se // Para comentar vrias linhas seguidas usa-se: /* User Function Exerc01 nResultado := 250 * (1 + (nPercentual / 100)) Alert(nResultado) Return( ) */ //Considere as linhas de cdigo de exemplo: #Include Rwmake.ch User Function Exerc01 nResultado := 250 * (1 + (nPercentual / 100)) Alert(nResultado) Return( )

Anotaes:

APL8110401061027 - SIGAADVPL Protheus - 13

Se esta funo for executada, ocorrer um erro de execuo com a mensagem variable does not exist: nPercentual, pois esta varivel est sendo utilizada em uma expresso de clculo sem ter sido declarada. Para solucionar este erro, deve-se declarar a varivel previamente: Local nPercentual, nResultado nResultado := 250 * (1 + (nPercentual / 100)) Neste exemplo, as variveis so declaradas previamente utilizando o identificador de escopo local. Quando a linha de clculo for executada, o erro de varivel no existente no ocorrer. Porm, variveis no inicializadas tm sempre o valor default nulo (Nil) e este valor no pode ser utilizado em um clculo, pois tambm gerar erros de execuo (nulo no pode ser dividido por 100). A resoluo deste problema efetuada inicializando-se a varivel por meio de uma das formas: Local nPercentual, nResultado nPercentual := 10 nResultado := 250 * (1 + (nPercentual / 100)) ou Local nPercentual := 10, nResultado nResultado := 250 * (1 + (nPercentual / 100)) A diferena entre o ltimo exemplo e os dois anteriores que a varivel inicializada no momento da declarao. Nos dois primeiros exemplos, a varivel primeiro declarada e ento inicializada em uma outra linha de cdigo. Deve-se utilizar o operador de atribuio (:= ou somente =). aconselhvel optar pelo operador de atribuio composto de dois pontos e sinal de igual, pois o operador de atribuio utilizando somente o sinal de igual pode ser facilmente confundido com o operador relacional (para comparao) durante a criao do programa. Uma vez que um valor lhe seja atribudo, o tipo de dado de uma varivel igual ao tipo de dado do valor atribudo. Ou seja, uma varivel passa a ser numrica se um nmero lhe atribudo, passa a ser caracter se uma string de texto lhe for atribuda, etc. Porm, mesmo que uma varivel seja de determinado tipo de dado, pode-se mudar o tipo da varivel atribuindo outro tipo a ela:

Anotaes:

14 - SIGAADVPL Protheus - APL8110401061027

Exerccio

02

Exercitando

declarao

de

variveis

Obs.: Debug o programa juntamente com o Watchs. #Include Rwmake.ch User Function Exerc02 Local xVariavel // Declara a varivel inicialmente com valor nulo. xVariavel := Agora a varivel caracter... Alert(Valor do Texto: + xVariavel) xVariavel := 22 // Agora a varivel numrica. Alert(cValToChar(xVariavel)) xVariavel := .T. // Agora a varivel lgica. If xVariavel Alert(A varivel tem valor verdadeiro...) Else Alert(A Endif Set Date British xVariavel := Date() // Agora a varivel data. Alert(Hoje : + DtoC(xVariavel)) xVariavel := nil // Nulo novamente. Alert(Valor nulo: + xVariavel) Return( ) Este programa troca os valores da varivel e exibe seu contedo para o usurio por meio da funo alert. Essa funo recebe um parmetro que deve ser do tipo string de caracter, por isso dependendo do tipo de dado da varivel xVariavel necessrio fazer uma converso antes. Apesar dessa flexibilidade de utilizao de variveis, deve-se tomar cuidado na
Anotaes:

varivel

tem

valor

falso...)

APL8110401061027 - SIGAADVPL Protheus - 15

passagem de parmetros para funes ou comandos e na concatenao (ou soma) de valores. A tentativa de soma de tipos de dados diferentes gera erro de execuo do programa. type mismatch on +. Executando o caso do valor nulo, para os demais se deve sempre utilizar funes de converso quando se necessita concatenar tipos de dados diferentes. Note tambm que quando uma varivel do tipo de dado lgico, ela pode ser utilizada diretamente para checagem (linha 10): If xVariavel o mesmo que If xVariavel = .T. A declarao de variveis para os demais tipos de dados, matrizes e blocos de cdigo, exatamente igual ao descrito at agora. Apenas existem algumas diferenas quanto a inicializao que podem ser consultadas na documentao de inicializao de matrizes e blocos de cdigo. Obs.: Durante o curso ser abordado funes com detalhes. MATRIZES - ARRAYS ARRAYS O array, matriz ou vetor tambm um tipo de varivel. Nele pode-se armazenar uma seqncia de dados, identificados por um nome do array e o nmero do elemento. Cada elemento, por sua vez, pode ser um novo array. como se tivssemos um arquivo ou uma planilha Excel na memria, com um processamento extremamente rpido. Considerando o tamanho das memrias hoje em dia pode-se criar arrays bastante grandes. O array definido com tamanho fixo ou varivel: Ex: aTabela := Array(30) aTabela tem 30 elementos. aTabela := {} array de tamanho indefinido ou seja pode receber tantos elementos quantos couberem na memria. aTabela := {1,2,4) aTabela := array com 3 elementos e seus respectivos valores. os elementos podem ser de tipos diferentes. o array ter 3 linhas, cada uma com 2 colunas. aTabela := {1,2,casa) Array(3,2)

aTabela := Array(3,2,2) um array multidimensional, cada linha tem 2 colunas, que por sua vez tem mais 2 elementos cada: aTabela:=
Anotaes:

{{{L1,C1,X1},{L1,C1,X2}},{{L1,C2,XA},{L1,C2,XB}},;

16 - SIGAADVPL Protheus - APL8110401061027

{{L2,C1,XC},{L2,C1,XD}},{{L2,C2,XE},{L2,C2,XF}}...... Para evocar um elemento usa-se colchetes: aTabela[1] aTabela[i] o primeiro elemento de um array simples. um elemento identificado pela varivel i.

Exerccio 03 Exercitando o uso de Local aLetras // Declarao da varivel.

Matriz

aLetras:={A, B, C } // Atribuio da matriz varivel. Alert(aLetras[2]) //Exibe o segundo elemento da matriz. //Exibe o tamanho da matriz. o IDE, para compilar e debugar o seu Alert(cValtoChar(Len(aLetras))) Obs.: Lembre-se programa. de utilizar

Obs. 02: Enquanto em outras linguagens como C ou Pascal necessrio alocar memria para cada elemento de uma matriz (o que tornaria a utilizao de ponteiros necessria), o Advpl encarrega-se de gerenciar a memria e torna simples a adio de elementos a uma matriz, utilizando a funo aAdd: aAdd(aLetras, D) //Adiciona o quarto elemento ao final da matriz. //Exibe o quarto elemento. //Erro! No h um quinto elemento na matriz.

Alert(aLetras[4]) Alert(aLetras[5])

Matrizes como Estruturas Uma caracterstica interessante do AdvPl que uma matriz pode conter qualquer coisa: nmeros, datas, lgicos, caracteres, objetos etc. e ao mesmo tempo, em outras palavras, os elementos de uma matriz no precisam ser necessariamente do
Anotaes:

APL8110401061027 - SIGAADVPL Protheus - 17

mesmo tipo de dado, em contraste com outras linguagens como C e Pascal. aFunct1 := {Pedro,32,.T.} Esta matriz contem uma string, um nmero e um valor lgico. Em outras linguagens como C ou Pascal, este pacote de informaes pode ser chamado como um struct (estrutura em C, por exemplo) ou um record (registro em Pascal, por exemplo). Como se fosse na verdade um registro de um banco de dados, um pacote de informaes construdo com diversos campos, cada campo tendo um pedao diferente de dado. Suponha-se que, no exemplo anterior, o array aFunct1 contenha informaes sobre o nome de uma pessoa, sua idade e sua situao matrimonial. Os seguintes #defines podem ser criados para indicar cada posio dos valores dentro da matriz: #define FUNCT_NOME 1 #define FUNCT_IDADE 2 #define FUNCT_CASADO 3 E considere mais algumas matrizes para representar mais pessoas: aFunct2 := {Maria , 22, .T.} aFunct3 := {Antnio, 42, .F.} Os nomes podem ser impressos assim: Alert(aFunct1[FUNCT_NOME]) Alert(aFunct2[FUNCT_NOME]) Alert(aFunct3[FUNCT_NOME]) Agora, ao invs de trabalhar com variveis individuais, pode-se agrup-las em uma outra matriz, do mesmo modo que muitos registros so agrupados em uma tabela de banco de dados: aFuncts := {aFunct1, aFunct2, aFunct3} Que equivalente a isso: aFuncts := { {Pedro , 32, .T.}, ; {Maria , 22, .T.}, ; {Antnio, 42, .F.} } aFuncts uma matriz com trs linhas por trs colunas. Uma vez que as variveis
Anotaes:

18 - SIGAADVPL Protheus - APL8110401061027

separadas foram combinadas em uma matriz, os nomes podem ser exibidos assim: For nCount := 1 To Len(aFuncts) Alert(aFuncts[nCount,FUNCT_NOME]) // O acesso a elementos de uma matriz multidimensional // pode ser realizado tambm desta forma: // aFuncts[nCount][FUNCT_NOME] Next nCount A varivel nCount seleciona que funcionrio (ou que linha) de interesse. Ento a constante FUNCT_NOME seleciona a primeira coluna daquela linha. FUNES: a maior parte das rotinas que queremos escrever em programas composta de um conjunto de comandos, rotinas estas que se repetem ao longo de todo o desenvolvimento. Uma Funo nada mais do que um conjunto de comandos. Para ser usada basta cham-la pelo seu nome. Para tornar uma Funo mais flexvel ao cham-la pode-se passar parmetros. Estes parmetros contem dados e informaes que influem no processamento da funo. Os parmetros no AdvPl so posicionais, ou seja, na sua passagem no importa o nome da varivel e sim a sua posio. Assim podemos chamar uma funo escrevendo: Calcula(para,parb,parc) E a funo estar escrita Calcula(x,y,z) Neste caso, x assume o valor de para, y de parb e z de parc. A funo tambm tem a faculdade de retornar uma variavel, podendo inclusive ser um array. Para tal encerra-se a Funo com Return(campo) Assim A := Calcula(para,parb,parc) atribui A o contedo do retorno da funo Calcula. No Advpl existem milhares de Funes escritas pelo pessoal de Tecnologia, pelos analistas de suporte e pelos prprios usurios. Existe um ditado que diz que vale mais um programador que conhece todas as funes disponveis em uma linguagem do que aquele que reinventa a roda a cada novo programa. Mas conhecer todas as funes vem com o tempo. No DEM mais de 500 esto documentadas. Aqui no curso no abordaremos mais do que 100. Cabe a cada um estud-las quando delas necessitar.

No AdvPl at os programas chamados do menu so funes. Num repositrio no pode


Anotaes:

APL8110401061027 - SIGAADVPL Protheus - 19

haver funes com o mesmo nome. Para contornar este problema as funes escritas pelo usurio tm o prefixo U_ de User Function.

O que voc aprendeu neste captulo


Neste captulo aprendemos sobre variveis, arrays(matriz) e falamos sobre funes.

Prximo
No prximo captulo, iremos aprender as estruturas de controle:

Passo

Anotaes:

20 - SIGAADVPL Protheus - APL8110401061027

ESTRUTURA
O que voc ir

DE

CONTROLE
neste captulo

aprender

Neste captulo, ns iremos aprender as estruturas de controle da linguagem.

Rotinas
For ... Next While...End If.Elseif.ElseEndif Do Case...case...Otherwise...End Case

Abordadas

For Next
Permite definir um lao de comandos For nVar := nExpr1 To Expr2 [Step nExpr3] <comandos> [Exit] <comandos> [Loop] Next nVar varivel de comando do lao nExpr1 valor inicial da varivel de controle nExpr2 valor final da varivel de controle nExpr3 incremento (n) ou decremanto (-n) da varivel de controle (default 1)

Anotaes:

APL8110401061027 - SIGAADVPL Protheus - 21

Exerccio 04 Entendendo a estrutura For Next.

User Function TstFor() Local i For i := 1 To 10 MsgAlert(i) Next Return // // User Function TstFor1() Local i Local nIni, nFim nIni := 100 nFim := 120 For i := nIni To nFim Step 2 MsgAlert(i) If i > 110 Exit EndIf Next Return // Break tambm encerra.

Anotaes:

22 - SIGAADVPL Protheus - APL8110401061027

// // User Function TstFor2() Local i Local nIni, nFim nIni := 1 nFim := 10 For i := nFim To nIni Step -1 MsgAlert(i) Next Return // // User Function TstFor3() Local i Local j For i := 20 To 25 MsgAlert(i= + Str(i)) For j := 1 To 5 MsgAlert(i= + Str(i) + Next Next Return j= + Str(j))

Anotaes:

APL8110401061027 - SIGAADVPL Protheus - 23

Obs.: Lembre-se de utilizar o IDE, para compilar e debugar o seu programa. While...End O While um comando de programao estruturada que permite que as instrues contidas entre While e o associado end sejam repetidas enquanto uma determinada condio permanecer verdadeira. While <expresso lgica> <comandos....> [Exit] <comandos...> [Loop] End

Exerccio 05 Entendendo a estrutura While End.

User Function TstWhile() Local i := 1 While i <= 10 MsgAlert(i) i++ End Return

Anotaes:

24 - SIGAADVPL Protheus - APL8110401061027

If.Elseif.ElseEndif O comando if um commando de programao que permite executar condicionalmente um bloco de instrues, tambm conhecido como desvio condicional. Cada if deve obrigatoriamente terminar com um endif. If<Condio> <Comandos> Elseif<Condio> <Comandos> Else <Comandos> Endif

Exerccio 06 Entendendo a estrutura If Elseif e Endif.

User

Function

TstIf()

Local nX := 10 If nX > 5 MsgAlert(Maior) EndIf Return User Function TstElse()

Anotaes:

APL8110401061027 - SIGAADVPL Protheus - 25

Local nX := 10 Local cMsg

If nX < 5 cMsg := Menor Else cMsg := Maior EndIf MsgAlert(cMsg) Return // Avalia a partir do IF e depois os ElseIf. Ao encontrar a primeira // condiao verdadeira, executa vai para o EndIf. -

User

Function

TstElseIf()

Local cRegiao := NE Local nICMS If cRegiao == SE nICMS := 18 ElseIf cRegiao == NE nICMS := 7 Else nICMS := 12 EndIf

Anotaes:

26 - SIGAADVPL Protheus - APL8110401061027

MsgAlert(nICMS) Return Do Case...case...Otherwise...End Case

O comando Do Case..EndCase estruturado e seleciona apenas um caminho entre um conjunto de caminhos alternativos para o curso do fluxo de execuo.

Exerccio 07 Entendendo a estrutura Case EndCase.

User Function TstCase() Local nOpc := 2

Do Case Case nOpc == 1 MsgAlert(Opo 1 selecionada) Case nOpc == 2 MsgAlert(Opo 2 selecionada) Case nOpc == 3 MsgAlert(Opo 3 selecionada) Otherwise // Otherwise opcional. MsgAlert(Nenhuma opo selecionada) EndCase Return

Anotaes:

APL8110401061027 - SIGAADVPL Protheus - 27

O que voc aprendeu neste captulo


Neste captulo aprendemos sobre as estruturas de controle da linguagem.

Prximo

Passo

No prximo captulo, iremos aprender: Macro substituio, lista de expresses e bloco de cdigo.

Anotaes:

28 - SIGAADVPL Protheus - APL8110401061027

MACRO SUBSTITUIO
O que voc ir aprender neste captulo
Neste captulo, ns iremos aprender sobre: Macro substituio, lista de expresses e bloco de cdigo.

Rotinas
Macro Lista Bloco de Cdigo

Abordadas

Macro
MACRO-SUBSTITUIO A Macro-substituio trata o contedo do campo como se ele fosse uma linha de cdigo de um programa. Ocorre que este contedo pode ser lido de um arquivo externo (SX3, SX7, SI5, SM4, etc), arquivo este que pode ser alterado pelo usurio. Estas expresses so encontradas no dicionrio de dados, nos campos de validao e inicializao, nos gatilhos, no arquivo de lanamento padronizado, na folha de pagamento, no arquivo de frmulas, entre outros. Quando se usa a Macro-substituio em um programa deve ela ser sempre precedida pela leitura da expresso em um arquivo. Exemplo User Function TstMacro() Local cCampo Local cCalc

dbSelectArea(SA1) cCampo := A1_Nome MsgAlert(cCampo + : + &cCampo) // Mostra o conteudo do campo A1_Nome.

Anotaes:

APL8110401061027 - SIGAADVPL Protheus - 29

dbSelectArea(SA2) cCampo := A2_Nome MsgAlert(cCampo + : + &cCampo) // Mostra o conteudo do campo A2_Nome.

cCalc := 1 + 1 MsgAlert(cCalc + : + Str(&cCalc)) Return Nil Outro Exemplo User Function Tesmacro( ) A1_MOEDA1:= MOEDA1 A1_MOEDA2:= MOEDA2 A1_MOEDA3:= MOEDA3 cCAMPO:= A1_MOEDA cESCOLHA:= 3 cMacro:=&(cCampo+cEscolha) MsgAlert(cMacro) // Mostra o resultado do caculo 1+1.

LISTA DE EXPRESSES O AdvPL aceita que se escreva vrios comandos em uma nica lista de expresses, abrindo maiores possibilidades no uso de validaes e gatilhos onde s temos o espao de uma linha para escreve-la. Nestes casos quando se tem um cdigo mais extenso, a soluo escrever-se uma funo, que pode ter um tamanho ilimitado, mas por outro lado precisa ser compilada. BLOCO DE CDIGO

O Bloco de Cdigo permite que se execute uma expresso externa em tempo de execuo exatamente da mesma forma que a Macro-substituio, mas com uma vantagem: permite que se passe parmetros, como se fosse uma funo. Para executar um Bloco de Cdigo usa-se a funo Eval, que retorna o resultado do processamento do Bloco. Outra vantagem do uso do Bloco de Cdigo est na existncia das funes aEVAL e DBEval.
A aEval executa o Bloco para todos os elementos do array sem necessidade de nenhum comando adicional. A DBEval processa todos os registros de um arquivo.

Anotaes:

30 - SIGAADVPL Protheus - APL8110401061027

Dica: A funo Eval( ) retorna o valor da ltima expresso dentro do bloco. Um bloco de cdigo pode retornar um valor de qualquer tipo. Exemplo de um Bloco: User Function Bcod() x:=20 y:=24 bBloco:={|x,y|If(x>y, o valor de x maior, o valor de y maior)} MsgAlert(Eval(bBloco, x,y)) Return( )

User Function TstBloco() Local bBloco := {|| 2 * 10} Local nResult nResult := EVal(bBloco) Alert(nResult) Return Nil // // User Function TstBloc3() Local x Local y Local bBloco := {|| x := 10, y := 20} // Executa uma lista de expressao e retorna o resultado // da ultima expressao executada. MsgAlert(EVal(bBloco)) Return Nil // // // Bloco de Codigo em forma de string, armazenado numa variavel de tipo caracter, // e convertido para bloco de codigo por meio de Macro. // Poderia ser tambem: EVal( {|| 2 * 10} )

Anotaes:

APL8110401061027 - SIGAADVPL Protheus - 31

User Function TstBloc4() Local Local Local Local x y cBloco := {|| x := 10, y := 20} bBloco

bBloco := &cBloco MsgAlert(EVal(bBloco)) Return Nil

O que voc aprendeu neste captulo


Neste captulo aprendemos sobre: Macro, lista de expresses e bloco de cdigo.

Prximo
No prximo captulo, iremos aprender: sobre validao de campo.

Passo

Anotaes:

32 - SIGAADVPL Protheus - APL8110401061027

VALIDAO

DE CAMPO

No ambiente Configurador, menu Base de dados/Dicionrio/Bases de dados, possvel ter acesso s configuraes dos campos das tabelas, dentre todas as configuraes vivel criar mecanismos para crticas de campos no momento da digitao. Esta funcionalidade ajuda a impedir a incluso de informaes incorretas no banco de dados, bloqueando o seguimento do preenchimento do cadastro, se a funo for padro Microsiga, ser enviado um aviso de alerta e a no permisso da informao digitada. E importante salientar que este mecanismo semelhante aos mecanismos do gatilho, porm aqui necessrio devolver um valor, sendo verdadeiro (.T.) ou falso (.F.), porque isso que a validao espera. Na configurao de validao para campos, tambm possvel utilizar-se deste recurso no X1_VALID, no qual o objetivo validar a digitao feita na tela de parmetros.

Anotaes:

APL8110401061027 - SIGAADVPL Protheus - 33

Exerccio 08 Criar validao nos campos do cadastro de clientes. Premissa: Faa uma validao no campo A1_NOME, utilizando a funo Texto(). Acesse o ambiente configurador Selecione a opo: Base de dados/Dicionrio/Bases de dados Clique na opo Dicionrio Pesquise a tabela SA1 Clique em Editar Selecione a opo Campos Escolha o campo A1_NOME Clique em Editar Selecione a pasta Validao No campo Validao do Usurio, digite: Texto() Esta funo no permite que o usurio deixe um espao em branco antes da primeira palavra, ou seja, nenhum nome dever comear com espao em branco. Aps a digitao da funo, confirme todas as operaes, com o objetivo de sair do ambiente configurador. Acesse o ambiente faturamento e selecione a opo Clientes localizado no menu Atualizao/Cadastro, clique na opo incluir e tente informar um nome que comece com espao em branco, quando terminar tecle <Entre>, perceba que o Sistema criticar a digitao e no permitir que saia do campo antes de corrigir.

Exerccio 09 Criar validao no campo Armazm padro no cadastro de produtos. Premissa: Faa uma validao para o campo Armazm padro no cadastro de produtos para que aceite somente armazm 01 (zero um) e 10 (dez). Acesse o ambiente configurador Selecione a opo: Base de dados/Dicionrio/Bases de dados Clique na opo Dicionrio Pesquise a tabela SB1 Clique em Editar

Anotaes:

34 - SIGAADVPL Protheus - APL8110401061027

Selecione a opo Campos Escolha o campo B1_LOCPAD Clique em Editar Selecione a pasta Validao No campo Validao do Usurio, digite: Pertence(01/10) Esta funo permite somente que seja digitada a informao configurada. Aps a digitao da funo, confirme todas as operaes, com o objetivo de sair do ambiente configurador. Acesse o ambiente faturamento e selecione a opo Produtos localizado no menu Atualizao/ Cadastro, clique na opo incluir e tente informar um armazm padro que no est configurado na funo, perceba que o sistema criticar a digitao e no permitir que saia do campo antes de corrigir.

Exerccio 10 Criar validao nos campos Tipo de entrada e Tipo de sada padro para o cadastro de produto. Premissa: os campos B1_TE (tipo de entrada padro) e B1_TS (tipo de sada padro), j possuem validao, sendo o campo B1_TE < 500 e no campo B1_TS >= 501, esta definio padro do Sistema, ento vamos melhorar, nestes campos alm desta validao, configure para que est validao permanea porm envie uma mensagem de alerta ao usurio sobre a ocorrncia em cada campo. Acesse o ambiente configurador Selecione a opo: Base de dados/Dicionrio/Bases de dados Clique na opo Dicionrio Pesquise a tabela SB1 Clique em Editar Selecione a opo Campos Escolha o campo B1_TE Clique em Editar Selecione a pasta Validao No campo Validao do Usurio, digite:

Anotaes:

APL8110401061027 - SIGAADVPL Protheus - 35

Iif(M->B1_TE<500,.T.,Eval({||

Help(,1,F4_TIPO),.F.}))

Aps a digitao da funo, confirme todas as operaes com o objetivo de sair do ambiente configurador. Acesse o ambiente faturamento e selecione a opo Produtos localizado no menu Atualizao/ Cadastro, clique na opo incluir e tente informar um TE padro que no seja de entrada, perceba que o Sistema criticar a digitao e no permitir que saia do campo antes de corrigir. Faa o mesmo procedimento para o campo B1_TS, porm na frmula digite: Iif(M->B1_TS >= 501,.T.,Eval({|| Help(,1,F4_TIPO),.F.}))

Exerccio 11 Crie uma validao no campo emisso de ttulo a receber. Premissa: Crie uma validao onde o usurio somente poder incluir um ttulo no contas a receber quando a emisso for posterior a data de limite para realizaes financeira, ou seja, a data definida no parmetro MV_DATAFIN Exemplo: MV_DATAFIN igual a 31/01/2004, ento se ao incluir um ttulo com data inferior a data definida no parmetro, o Sistema deve critic-lo com uma mensagem para o usurio. Acesse o ambiente configurador Selecione a opo: Base de dados/Dicionrio/Bases de dados Clique na opo Dicionrio Pesquise a tabela SE1 Clique em Editar Selecione a opo Campos Escolha o campo E1_EMISSAO Clique em Editar Selecione a pasta Validao No campo Validao do Usurio, digite: Iif(M->E1_EMISSAO>=GetMv(MV_DATAFIN),.T.,Eval({||MsgInfo(Emisso Invlida,Fim),.F.})) Aps a digitao da funo, confirme todas as operaes com o objetivo de sair do ambiente configurador. Acesse o ambiente financeiro e selecione a opo Contas a Receber localizado no menu Atualizao/
Anotaes:

36 - SIGAADVPL Protheus - APL8110401061027

Contas a Receber, clique na opo incluir e tente informar uma emisso anterior a data definida no parmetro MV_DATAFIN, perceba que o Sistema criticar a digitao e no permitir que saia do campo antes de corrigir. Note que se mudar a data base do Sistema para uma data anterior a definida no parmetro MV_DATAFIN, em seguida for incluir um ttulo a receber, o Sistema no far a mesma crtita, isto porque o campo emisso j inicia com um preenchimento automtico, ento para se resolver est inconformidade, volte ao ambiente configurador e no campo em questo coloque no seu inicializador padro a seguinte instruo: Iif(dDataBase<GetMv(MV_DATAFIN),Ctod( / / ),dDataBase), ou seja, se a data base do Sistema for inferior a data definida no parmetro, este campo inicializar sem preenchimento, obrigando o usurio preench-lo.

Comandos
UDC USER DEFINED COMMANDS

definidos

pelo

usurio

(UDCs)

Os UDCs tem como objetivo principal facilitar a Legibilidade e Manutenibilidade do Fonte Eles so lidos apenas pelo compilador que gera o objeto de acordo com suas diretivas. O #DEFINE pode ser usado para permitir que o programador use palavras diferentes daquelas definidas pelo AdvPl e tambm para definir palavras-chave para o UDC #IFDEF ou #IFNDEF. Ex: ver TstUDC As palavras chaves tambm podem ser definidas no ato de compilar na opo O IFDEF permite por exemplo que ao se ter um programa que deva atender as condies do Brasil e do Mxico, tenha no mesmo fonte tudo que for comum aos dois e dependendo do #Define BRASIL ou #Define Mxico sejam compilados apenas as partes referentes a cada um dos paises. O #COMMAND traduz um comando escrito pelo programador de forma simplificada para a forma desejada pelo compilador. Com isso pode-se manter a compatibilidade de fontes escritos em momentos diferentes quando houverem mudanas na sintaxe do AdvPl. O #INCLUDE indica em que arquivo .CH esto os UDCs a serem usados. Estes por sua vez ficam na pasta INCLUDE. Assim, dependendo da situao altera-se o #INCLUDE e tem-se um resultado diferente da compilao. Por exemplo, compilar para o ambiente Windows ou Linux.
Anotaes:

APL8110401061027 - SIGAADVPL Protheus - 37

SEMAFOROS: Alguns campos de numerao do Protheus so fornecidos pelo sistema em ordem ascendente. o caso, por exemplo, do nmero do Pedido de Venda e outros que servem como chave primria de arquivos. preciso ter um controle do fornecimento dos nmeros principalmente que vrios usurios esto trabalhando simultaneamente. O conceito do semforo o seguinte: ao ser fornecido um nmero fica ele reservado at a concluso da digitao da tela. Se confirmada, o nmero indisponibilizado para sempre. Se a tela abandonada o nmero volta a ficar disponvel mesmo que naquele momento nmeros maiores j tenham sido oferecidos. Com isso mesmo que tenhamos vrios usurios digitando, por exemplo, Pedidos de Venda, teremos para cada um nmeros exclusivos e nenhum nmero no utilizado. Se porem, futuramente um Pedido for cancelado, o seu nmero no reaproveitado. So 4 as funes utilizadas neste processo: GETSXENUM(alias): obtm o nmero seqencial do alias especificado no parmetro CONFIRMSXE: confirma o nmero ROLLBACKSXE: descarta o nmero. MAYIUSE(nmero): verifica se aquele nmero pode ser usado. Por exemplo pode-se querer dar um nmero diferente a um Pedido que est sendo digitado. Mas este nmero no pode j ter sido usado.

Chaves

Primrias

Sua funo garantir unicidade. Em toda relao, por definio, tem-se uma ou mais chaves candidatas. Dessas chaves, uma ser primria e se houver mais de uma na relao, essas outras sero definidas como chaves alternadas.

Chaves

Estrangeiras

um atributo cuja funo permitir relacionamento. Em uma tabela na qual o atributo chave externa ou estrangeira, em outra, o atributo deve ser chave primria, e os valores dos campos so necessrios.

Anotaes:

38 - SIGAADVPL Protheus - APL8110401061027

Integridade

Referencial

Todos os valores da chave estrangeira tm, obrigatoriamente, que ter valor correspondente na chave primria que se relaciona, mas nem todos os valores encontrados na chave primria, precisam ter seus correspondentes na chave estrangeira que se relaciona. Por exemplo, na tabela de clientes, o campo A1_COD (cdigo do cliente) vai estar relacionado com outra tabela que indica quais so os pedidos de venda colocados. Desta forma, nem todos os clientes precisam ter pedidos de venda colocados, mas, necessariamente, todos os pedidos de venda precisam de um cliente. Como o PROTHEUS foi projetado para o ambiente SQL, no qual a integridade referencial das tabelas definida no prprio banco de dados por meio de regras internas, devemos tomar algumas precaues com esse tpico: Verificar a integridade da coluna em todas as tabelas relacionadas: no se pode alterar o tamanho do cdigo do cliente em apenas uma tabela, caso esse cdigo seja alterado deve-se verificar as tabelas de cabealho e itens das notas fiscais, de ttulos a pagar e receber etc. O Sistema conta com o recurso de grupos de tabelas relacionadas, que permite alterar o tamanho de diversas colunas de uma vez s , garantindo a integridade das colunas. Verificar a integridade dos cadastros com todas as tabelas relacionadas: no se pode excluir o cdigo do cliente se existe um pedido de vendas em aberto para esse cliente, deve-se verificar todas as tabelas relacionadas antes de atualizar a base de dados. Alm disso, na incluso de cadastros devemos utilizar as funes existchav e existcpo para garantir que as informaes de chave no sejam repetidas e que o acesso a tabelas externas seja validado de maneira consistente. Verificar a atualizao da informao em todas as tabelas relacionadas: a integridade no se resume a validaes de cadastros e tamanho de colunas, deve-se garantir no ato do desenvolvimento que TODOS os pontos relacionados ao tpico envolvido sejam analisados e, se necessrio, atualizados. Por exemplo, ser atualizado o saldo em estoque de determinado produto NO SE DEVE atualizar somente o arquivo de saldos em estoque, deve-se avaliar se o produto utiliza rastreabilidade para, nesse caso, atualizar o arquivo de saldos por lote, deve-se avaliar se o produto utiliza controle de localizao fsica para atualizar o arquivo de saldos por localizao etc. Deve-se fazer um estudo antes de qualquer alterao em atualizao de base de dados.

Anotaes:

APL8110401061027 - SIGAADVPL Protheus - 39

FUNES
O que

APLICADAS EM GATILHOS
ir aprender neste captulo

voc

Neste captulo, aprenderemos como criar Funes em ADVPL e utiliz-las atravs do uso de Gatilhos, ou seja, como disparar um programa customizado atravs do preeenchimento de um determinado Campo em uma tela de digitao de dados, como por exemplo, um cadastro.

Rotinas
Funes em Gatilhos.

Abordadas

Funes

em

Gatilhos

A utilizao de Gatilhos em cadastros muito grande, pois atravs deles poderemos automatizar o preenchimento de muitos Campos durante a digitao de apenas um nico Campo de Origem, considerado o Campo de Disparo. Um Gatilho deve ser utilizado sempre que se fizer necessrio a atualizao automtica de Campos dependentes na tela de digitao (Cadastros ou Movimentaes), atravs do preenchimento de um Campo de Origem.

Dicas: Nunca se esquea que para se Compilar um Programa, ser necessrio a utilizao de um Projeto de Trabalho, sempre; Para facilitar a Visualizao, durante a elaborao de programas, no se esquea de fixar a Caixa de Projetos ao rodap do Protheus IDE;

Anotaes:

40 - SIGAADVPL Protheus - APL8110401061027

Para isto basta clicar sobre o Cabealho da Caixa e arrast-lo at o rodap, juntamente com as pastas de Mensagens e Comandos.

Exerccio 12 Como criar Funes, para utilizao em Gatilhos: 1. 2. Selecione as seguintes opes Arquivo + Novo Arquivo; Na Pgina de Edio, informe o Programa a seguir: #Include Rwmake.ch User Function Exerc01() c_Nome:=Microsiga MsgAlert(Exemplo de Funo em Gatilhos.) Return(c_Nome) 3. 4. 5. Selecione as seguintes opes Arquivo + Salvar; Selecione a pasta C:\xxxxxx, salve o programa como Exerc01 e confir me; Adicione o Programa ao projeto em uso, clicando com o boto direito do mouse sobre a pasta Fontes do mesmo, selecionando a opo Adicionar arquivo, posicionando o cursor sobre o programa e confirmando; Compile-o, clicando com o boto direito do mouse sobre o programa em questo e selecionando a opo Compilar arquivo...; Ser solicitada o Usurio, no caso, Administrador e a Senha, em branco.

6. 7.

Dicas: Existe na MICROSIGA, um padro para a definio da nomenclatura dos Tipos de Variveis, como por exemplo:
c_Var n_Var d_Var l_Var m_Var a_Var Caracter Numrica Data Lgica Memo Array

Toda Funo, utilizada em um Gatilho, sempre dever ter como Parmetro de Retorno, uma Varivel associada ao programa, para que o Gatilho tenha efeito.

Anotaes:

APL8110401061027 - SIGAADVPL Protheus - 41

Significado

dos

campos

da

tela

de

cadastro de gatilhos

Campo nome do campo que ao ser alterado inicia o processo de atualizao. Seqncia nmero seqencial gerado pelo sistema para cada gatilho. Cnt. Domnio nome contra-domnio, ou seja, campo que dever ser atualizado automaticamente. Tipo tipo do gatilho (P/E/X); P primrio: para atualizaes de dados do mesmo arquivo; E estrangeiro: para atualizaes de dados em outros arquivos; X Posicionamento: para posicionar o arquivo mencionado no alias sem efetuar nenhuma atualizao. Utilizado para casos em que o usurio deseja estabelecer um relacionamento entre arquivos. Regra expresso em sintaxe AdvPL a ser transportada para o contra-domnio, ou apenas o nome de campo. Lembre-se sempre que a regra deve retornar um contedo vlido conforme o tipo do campo definido como contra domnio. Posiciona Sim/No movimenta o ponteiro em outro arquivo com base na expresso definida no campo chave. Alias Alias do arquivo. As trs letras iniciais da tabela cujo o ponteiro deve ser movimentado. Ordem nmero da chave do ndice a ser atualizada para movimentao do ponteiro. Chave expresso em sintaxe AdvPl que determina o posicionamento do ponteiro. Condio informe a condio, user function, etc., que iro determinar quando o gatilho deve ser executado.

Exerccio 13 Como criar Gatilhos, para Implementao de Funes: 1. 2. 3. Acesse o Mdulo Configurador; Selecione as seguintes opes Base de Dados + Dicionrio + Gatilhos; Clique na opo Incluir e informe os dados a seguir:

Anotaes:

42 - SIGAADVPL Protheus - APL8110401061027

Campo: Sequncia: Contra Domnio: Tipo Regra:

A1_END 001 A1_ENDCOB 1=Primrio EXECBLOCK("EXERC01") ou U_EXERC01()

4.

Confira os dados e confirme o cadastro de Gatilhos.

Dicas: A Funo Execblock(), uma Funo Master do Advpl, que executa um Programa Customizado que estiver Compilado no RPO em uso pelo ambiente e em seguida retorna execuo normal do sistema; Sempre poderemos utilizar a chamada a uma Funo das duas maneiras descritas acima, ou seja, atravs da Funo Execblock() ou diretamente pelo nome da User Function, que est compilada no RPO em uso.

Exerccio 14 Como Testar o Gatilho: 1. 2. 3. 4. Acesse o Mdulo Financeiro; Selecione as seguintes opes Atualizao + Cadastro + Clientes; Clique na opo Incluir; No Campo Endereo, informe um Endereo sua escolha e pressione a tecla <Enter>;

Obs.: Note que a Mensagem de Aviso ser disparada, isso demonstra que o Gatilho foi disparado. 5 . Em seguida, clique na pasta Adm/Fin. e verifique o Resultado do Gatilho no Campo End. Cobrana, que dever estar preenchido com Microsiga.

Anotaes:

APL8110401061027 - SIGAADVPL Protheus - 43

Exerccio 15 Como criar Funes, para retornar a Varivel em Memria do Campo: 1 . Altere o Programa Exerc01 com as seguintes informaes: #Include Rwmake.ch User Function Exerc01() c_Nome:=M->A1_END MsgAlert(Exemplo de Funo em Gatilhos.) Return(c_Nome) 2. 3. Selecione as seguintes opes Arquivo + Salvar e compile-o novamente; Realize o Teste, acessando novamente o Mdulo Financeiro e executando o Cadastro de Cliente, como no exemplo anterior.

Dica: Lembre-se que quando a informao est sendo digitada, a mesma encontrase no Buffer, ento devemos tratar como M-><campo>, que identifica que a informao de retorno est na memria e quando a informao j est gravada, deveremos ento tratar como <Alias>-><Campo>.

Exerccio 16 Como utilizar Funes com Retorno a partir de uma determinada Condio de Preenchimento do Campo: Crie um programa com o nome de Exerc02, que dever atualizar o Campo Bairro do Cadastro de Clientes, para Centro, quando o Campo CEP, for igual a 00000-000. 1. Digite o programa a seguir: #Include "Rwmake.ch" User Function Exerc02() If M->A1_CEP=="00000000" c_Bairro:="Centro" Else c_Bairro:=M->A1_BAIRRO Endif Return(c_Bairro) 2. Salve o Programa, adicione-o ao Projeto e Compile-o.

Anotaes:

44 - SIGAADVPL Protheus - APL8110401061027

Exerccio 17 Como criar o Gatilho: Agora, crie o Gatilho, para a Funo acima, da seguinte maneira:
Campo: Sequncia: Contra Domnio: Tipo Regra: A1_CEP 001 A1_BAIRRO 1=Primrio U_EXERC02()

1. 2. 3.

Acesse o Mdulo Financeiro; Selecione as seguintes opes Atualizaes + Cadastros + Clientes; Clique na opo Incluir e informe 00000000 no Campo CEP e observe que o retorno no Campo Bairro, foi disparado.

Exerccio 18 Como criar Funes, utilizando mais de uma Condio de Disparo: Crie um programa com o nome de Exerc03, que dever atualizar o Campo Valor do Ttulo do cadastro de Contas a Receber, com 10% a mais sobre o Valor Digitado, quando o Campo Tipo, for igual a DP, o Campo Cliente, for igual a 000001 e o Campo Loja, for igual a 01. 1. Digite o programa a seguir: #Include "Rwmake.ch" User Function Exerc03() If M->E1_TIPO="DP".and.M->E1_CLIENTE="000001".and.M->E1_LOJA="01" n_Valor:=M->E1_VALOR*1.1 Else n_Valor:=M->E1_VALOR Endif Return(n_Valor) 2. Salve o Programa, adicione-o ao Projeto e Compile-o;

Anotaes:

APL8110401061027 - SIGAADVPL Protheus - 45

Exerccio 19 Como Criar o Gatilho: 1. Crie o seguinte Gatilho, para a Funo acima:
Campo: Sequncia: Contra Domnio: Tipo Regra: E1_VALOR 011 E1_VALOR 1=Primrio U_EXERC03()

Exerccio 20 Como Testar o Gatilho: 1. 2. 3. Acesse o Mdulo Financeiro; Selecione as seguintes opes Atualizaes + Contas a Receber + Contas a Receber; Clique na opo Incluir, preencha o Campo Tipo com DP, no Campo Cliente, pressione a tecla <F3> e informe os dados a seguir:
Cdigo: Loja: Nome: N Fantasia: Tipo: Endereo: Municpio: Estado: 000001 01 Cliente 01 Cliente 01 R=Revendedor Avenida Braz Leme, 1631 So Paulo SP

4.

Selecione-o e continue o cadastro, preenchendo o Campo Vlr. Ttulo com 100,00 e verifique que o mesmo ser alterado com 10% a mais sobre o Valor Digitado.

Exerccio 21 Como criar Funes utilizando Matriz: Crie um programa com o nome de Exerc04, que dever atualizar o Campo DDD do Cadastro de Clientes, dependendo da Unidade Federativa, que for preenchida no Campo Estado. Digite o programa a seguir: #Include "Rwmake.ch" User Function Exerc04() Local aFone := {}

1.

Anotaes:

46 - SIGAADVPL Protheus - APL8110401061027

Local nP := 0 Local cRet := "" aAdd( aFone, {"SP","11"} ) aAdd( aFone, {"RJ","21"} ) aAdd( aFone, {"MG","31"} ) aAdd( aFone, {"AM","91"} ) aAdd( aFone, {"BA","71"} ) nP := aScan( aFone, {|x|x[1]==M->A1_EST}) If nP <> 0 cRet := aFone[nP][2] Endif Return( cRet ) 2. Salve o Programa, adicione-o ao Projeto e Compile-o;

Exerccio 22 Como Criar o Gatilho: 1. Crie o Gatilho a seguir, para a Funo acima:
Campo: Sequncia: Contra Domnio: Tipo Regra: A1_EST 001 A1_DDD 1=Primrio U_EXERC04()

Exerccio 23 Como Testar o Gatilho: 1. 2. 3. 4. Acesse o Mdulo Financeiro; Selecione as seguintes opes Atualizaes + Cadastros + Clientes; Clique na opo Incluir e preencha o Campo Estado, com SP; Verfique que o Campo DDD, ser atualizado de acordo com o retorno da Matriz, utilizada na Funo disparada pelo Gatilho.

Anotaes:

APL8110401061027 - SIGAADVPL Protheus - 47

Exerccio 24 Como criar gatilho para atualizar campo que depende da informao de outra tabela. Premissa: no cadastro de complemento de produtos, necessrio digitar o cdigo do produto. Faa um gatilho que aps est digitao o campo nome cientifico seja preenchido automaticamente com o nome do produto, conforme o cdigo selecionado. Campo Seqncia Contra Domnio Tipo Regra Posicione Alias Ordem Chave 1 xFilial(SB1)+M->B5_COD B5_COD 001 B5_CEME 1=Primrio SB1->B1_DESC Sim SB1

Aps a incluso do gatilho, teste-o acessando o ambiente Estoque/Custos. No menu, selecione a opo Complemento de Produtos, localizado no menu Atualizaes/ Cadastro.

Exerccio 25-Utilizando o exerccio anterior, faa que este Gatilho s funcione no Mdulo Estoque. Apenas preencha o campo condio no cadastro do gatilho anterior criado. Condio Cmodulo==EST

Para testar este exerccio, acesse o ambiente Faturamento e inclua um complemento de produto. Repare que a ao do gatilho no funcionar, devido a condio colocada ao gatilho configurado. Em contra partida, se for incluir um complemento de produto pelo ambiente Estoque/Custo, ele ter sua ao funcionando normalmente.

Anotaes:

48 - SIGAADVPL Protheus - APL8110401061027

O que voc aprendeu neste captulo


Neste captulo aprendemos a criar Gatilhos com utilizao de Funes.

Prximo

Passo

No prximo captulo, iremos aprender como criar Telas de Cadastros utilizando as Funes da Microsiga e tambm desenvolver Programas de Validao e Relacionamento entre arquivos.

Anotaes:

APL8110401061027 - SIGAADVPL Protheus - 49

FUNES
O que voc ir

PARA

CADASTROS
neste captulo

aprender

Neste captulo, aprenderemos como criar Telas para Cadastros, utilizando para isso as Funes definidas pela MICROSIGA. Veremos tambm, Funes Customizadas, para Validaes em Arquivos e Relacionamentos.

Rotinas
Funes para Cadastros: AxCadastro(); MBrowse(); Modelo2(); Modelo3().

Abordadas

Anotaes:

50 - SIGAADVPL Protheus - APL8110401061027

DESENVOLVENDO TELAS
A aparncia e a objetividade das telas num sistema base fundamental para a interface Sistema x Usurio. O MP8 j cria, automaticamente, a grande parte das telas de um ambiente, tais como a Browse, a GetDados e Enchoice. Algumas outras telas necessitam de construo manual, ou seja, com a utilizao de comandos, tais como SAY , GET e LABEL na Dialog. Procure sempre colocar em tela as informaes que mais se objetivam com o assunto abordado. Sempre que possvel, d preferncia aos campos obrigatrios. Isso facilita a digitao do usurio, que no precisar passar de campo em campo (no caso de estar utilizando a tecla <TAB>) at chegar ao campo desejado. A ordem dos campos tambm importante para a fcil localizao das informaes. Quando o volume de informaes muito grande, divida os campos em folders, ou seja, pastas, agrupando os campos em assuntos. Isso ir deixar a tela menos poluda e evitar que o usurio navegue por uma tela s. Para fazer essa facilidade, preencha o campo X3_FOLDER no SX3, com um nmero, agrupando-os de acordo com o tipo de informao e no SXA, com o ALIAS do arquivo em pauta, a ordem, que equivale ao nmero informado no X3_FOLDER e a descrio nos trs idiomas. Essa descrio que ser a informao contida na pasta do folder. Exemplo: Os campos SZ1_ENDER, SZ1_NUM e SZ1_BAIRRO devem estar com o campo X3_FOLDER preenchido com o contedo 1. No SXA, o XA_ALIAS dever ser SZ1, o XA_ORDEM = 1 (mesmo valor preenchido no X3_FOLDER), no XA_DESCRIC, Endereo Residencial e, nos demais, o mesmo texto em outros idiomas. O Folder, alm de agrupar e facilitar a procura pelos campos, evita a rolagem vertical da tela, facilitando a visualizao das informaes. Evite tela com muitos botes. Isso poder confundir o usurio e induzi-lo ao erro. Utilize telas seqenciais, conhecidas como Wizard (semelhante aos de instalao de um software). Dessa forma, o usurio ficar mais atento aos fatos, dificultando o erro. Mas, cuidado: no faa disso uma incansvel seqncia de telas, pois isso acabar desmotivando o usurio a utilizar o Sistema. Enfim, as telas devem ser limpas e objetivas, de tal forma que impea o usurio de sair de seu objetivo final. Todo curioso ir apertar todos os botes da tela ou preencher todos os campos com qualquer tipo de informao. Portanto, esteja atento a tamanho dos labels, para que os mesmos no excedam o tamanho da caixa de dilogo definida. Isso, alm de no ser esttico, prejudica o entendimento da informao.

Anotaes:

APL8110401061027 - SIGAADVPL Protheus - 51

Exerccio 26 Utilizando os objetos para criar telas. #Include PROTHEUS.CH User Function Tela1() Local Local Local Local Local Local Local Local Local Local Local Local Local Local Local Local oDlg oBtnOk oBtnCancel aButtons oSayConj oGetConj oSayCivil, cSayCivil oSaySal, cSaySal oRadio, nRadio oChk, lChk cNome := Space(20) cConjuge := Space(20) cEnder := Space(30) cCivil := Space(1) oFont oFolder

Define Font oFont Name Arial Size 0,-12 Bold aButtons := {{BMPPERG, {||MsgInfo(Pergunte)}, Pergunte...},; {BMPCALEN, {||MsgInfo(Calendario)}, Calendario...}}

Define MSDialog oDlg Title Exemplo From 0,0 To 500,600 Pixel @20,10 Say Nome: Pixel Of oDlg @20,50 Get cNome Size 50,10 Pixel Of oDlg @40,10 Say Estado Civil: Pixel Of oDlg @40,50 Get cCivil Size 10,10 Picture @! Valid cCivil$S|C|D u_VldCivil(cCivil, oSayConj, oGetConj, oSayCivil) Pixel Of oDlg

.And.

Anotaes:

52 - SIGAADVPL Protheus - APL8110401061027

@40,80 Say oSayCivil Var cSayCivil Size 20,10 Pixel Of oDlg @60,10 Say oSayConj Var Cnjuge: Pixel Of oDlg @60,50 Get oGetConj Var cConjuge Size 50,10 Pixel Of oDlg @80,10 Say Endereo: Pixel Of oDlg @80,50 Get cEnder Pixel Of oDlg @100,10 Say Salrio: Pixel Font oFont Of oDlg @100,40 Radio oRadio Var nRadio Items 1000, 2000, 3000 Size 50,9 On Change u_Salario(nRadio, oSaySal) Pixel Of oDlg @100,80 Say oSaySal Var cSaySal Size 20,10 Pixel Of oDlg @140,10 CheckBox oChk Var lChk Prompt Check Box Size 70,9 On Change MsgAlert(If(lChk,Marcado,Desmarcado)) Pixel Of oDlg @oDlg:nHeight/2-30,oDlg:nClientWidth/2-70 Button oBtnOk Prompt &Ok Size 30,15 Pixel Action u_Confirma() Message Clique aqui para Confirmar Of oDlg @oDlg:nHeight/2-30,oDlg:nClientWidth/2-35 Button oBtnCancel Prompt &Cancelar Size 30,15 Pixel Action oDlg:End() Cancel Message Clique aqui para Cancelar Of oDlg @160,10 Folder oFolder Prompts Pasta 1,Pasta 2" Size 200,80 Pixel Of oDlg oFolder:aDialogs[2]:oFont := oFont //oFolder:bChange := {||MsgAlert(Mudando de pasta)} @10,10 Say Conteudo da Primeira Pasta Pixel Of oFolder:aDialogs[1] @10,10 Say Conteudo da Segunda Pasta Pixel Of oFolder:aDialogs[2] Activate MSDialog oDlg Centered On Init EnchoiceBar(oDlg, {||u_OK(),oDlg:End()}, {||oDlg:End()},,aButtons) Return Nil

Anotaes:

APL8110401061027 - SIGAADVPL Protheus - 53

// // User Function Confirma() MsgAlert(Voc clicou no boto OK!) // Aqui poderia, por exemplo, gravar os dados num arquivo. Return // // User Function OK() MsgAlert(Voc clicou no boto OK da EnchoiceBar!) // Aqui poderia, por exemplo, gravar os dados num arquivo.

Return
// // User Function VldCivil(cCivil, oSayConj, oGetConj, oSayCivil) If cCivil <> C oSayConj:Hide() oGetConj:Hide() //oSayConj:Disable() //oGetConj:Disable() Else oSayConj:Show() oGetConj:Show() //oSayConj:Enable() //oGetConj:Enable() EndIf If ElseIf cCivil == C oSayCivil:SetText(Casado) cCivil == S oSayCivil:SetText(Solteiro)

Anotaes:

54 - SIGAADVPL Protheus - APL8110401061027

Else oSayCivil:SetText(Divorciado) EndIf

Return .T. // // User Function Salario(nRadio, oSaySal) If nRadio == 1 oSaySal:SetText(Hum mil) ElseIf nRadio == 2 oSaySal:SetText(Dois mil) Else oSaySal:SetText(Tres mil) EndIf Return Importante: Podemos dizer que a criao da tela se divide em duas partes: Definio e Ativao. Na linha Define MsdiAlog oDlg Title : Exemplo From 000,000 to 400,600 pixel. Esta acontecendo a definio da tela. Interpretando o cdigo: Define MsDialog oDlg: estamos definindo uma janela. E o nome objeto responsvel pela criao da mesma o oDlg. Este, simplesmente; um nome de varivel. Poderia ser oJanela, por exemplo. Title : Exemplo. Esta atribuindo como ttulo da janela a expresso : exemplo. From 000,000 to 400,600 pixel. Esta definindo as coordenadas da janela. Na linha Active MsDialog. Esta ativando a janela. Indica que vai ativar o objeto oDlg centralizado na tela. On init Enchoicebar. Este trecho significa que: quando a janela for iniciada ser criada uma Enchoicebar (barra de ferramentas).

Anotaes:

APL8110401061027 - SIGAADVPL Protheus - 55

AxCadastro()

Cadastro

Padro

Esta Funo utilizada para a Criao de Telas de cadastros padronizados da MICROSIGA, onde poderemos ter apenas as opes de Pesquisar, Visualizar, Alterar, Incluir e Excluir, sendo que os mesmo no podero ser modificados. Sintaxe: AxCadastro(cAlias,cTitulo,cDel,cOk); Parmetros: cAlias= Alias do Arquivo para o cadastro, deve obrigatoriamente ter a sua Estrutura definida no SX3; cTitulo = Ttulo da Janela; cDel = Funo para validar a Excluso; cOK = Nome de Funo para Validao da Tela.

Exerccio 27 Como criar Telas de Cadastros, com utilizao de Arquivo Padro: Crie uma Tela de Cadastro Padro, para o arquivo de Cadastro de Produtos e adicione-o ao menu do Mdulo de Faturamento. Utilize para isso um programa com o nome de Exerc05. 1. Crie o Programa a seguir: #Include "Rwmake.ch" User Function Exerc05() Axcadastro("SB1","Exerc05") Return

Obs.: Salve o Programa, adicione ao Projeto e Compile-o, adicione Programas ao Menu acessando o Mdulo Configurador. Lembre-se de que, Jamais, deveremos utilizar um Menu Original, para nossas customizaes, o correto gerarmos uma Cpia, para que no se perca as configuraes do menu original.

Anotaes:

56 - SIGAADVPL Protheus - APL8110401061027

Exerccio 28 Como Testar o Cadastro: 1. 2. 3. Acesse o Mdulo de Faturamento; Selecione as seguintes opes Atualizao + Cadastros + Exerc05; Clique na opo Incluir e cadastre os Produtos a seguir:
Cdigo: Descrio: Tipo: Unidade: Armazem Pad: Cdigo: Descrio: Tipo: Unidade: Armazem Pad: 100.100-01 CANETA AZUL MC PC 01 100.200-01 CANETA VERMELHA MC PC 01

4.

Confira os dados, confirme e saia do Cadastro de Produtos.

Exerccio 29 Como cadastrar a Previso de Vendas: 1. 2. Selecione as seguintes opes Atualizao + Cenrios de Venda + Previso de Vendas; Clique na opo Incluir e informe as Previses a seguir:
Produto: Almoxarifado: Quantidade: 100.100-01 1 1,00

Produto: Almoxarifado: Quantidade:

100.200-01 1 1,00

3.

Confira os dados e confirme o Cadastro de Previso de Vendas.

Exerccio 30 Como Verificar a Integridade Relacional entre os dois Cadastros: 1 . Selecione as seguintes opes Atualizaes + Cadastro + Produtos; 2. 3. Posicione com o cursor sobre o Produto 100.100-01; Clique a opo Excluir;

Anotaes:

APL8110401061027 - SIGAADVPL Protheus - 57

Obs.: Note que o sistema no ir realizar a Excluso, devido a amarrao deste Produto ao cadastro de Previso de Vendas. 4 . Saia deste Cadastro e selecione as seguintes opes Atualizaes + Cadastro + Exerc05; 5. 6. Posicione com o cursor sobre o Produto 100.100-01; Clique na opo Excluir.

Obs.: Observe que desta vez o sistema realizou a Excluso; A Excluso do Registro foi possvel devido ao fato de que ainda no h nenhuma Validao, para verificar a Integridade Relacional entre os dois arquivos no nosso programa.

Exerccio 31 Como criar Programas, para verificar a Excluso de Produtos: Crie um programa para verificar se o registro selecionado para Excluso no Cadastro Exerc05, poder ou no ser Excludo. Para isso, ser necessrio verificar se o mesmo no se encontra relacionado no cadastro de Previso de Vendas. Crie o Programa a seguir com o nome de Vdel: #Include "Rwmake.ch" User Function Vdel() Local c_Area := Alias(), n_Rec:=Recno(), c_ind:=IndexOrd() Local c_Cod:=SB1->B1_COD, l_Del:=.T. Msgbox("Verificando amarracao do produto" + c_Cod,"Atencao!!!") Dbselectarea("SC4") If Dbseek(Xfilial("SC4")+c_Cod) Msgbox("Produto nao pode ser excluido!!!") l_Del:=.F. Endif DbSelectArea(c_Area) DbSetOrder(c_ind) DbGoTo(n_Rec) Return(l_Del)
Anotaes:

1.

58 - SIGAADVPL Protheus - APL8110401061027

2. Salve o Programa, adicione ao Projeto e Compile-o.

Exerccio 32 Como Alterar o Programa, para Validao da Excluso: 1. 2. Faa as seguintes modificaes no Programa Exerc05: AxCadastro(SB1,Exerc05,Execblock(Vdel),.F.) Salve o Programa e Compile-o, novamente.

Exerccio 33 Como Testar Validaes de Excluses: 1. 2. 3. 4. Acesse o Mdulo de Faturamento; Selecione as seguintes opes Atualizao + Cadastros + Exerc05; Posicione com o cursor sobre o Produto 100.200-01; Clique na opo Excluir;

Obs.: Verifique que a Excluso, no ser realizada, pois agora existe uma Validao, para essa rotina; 5 . Saia do cadastro de Produtos; 6. 7. 8. Selecione as seguintes opes Atualizaes + Cenrios de Venda + Previso de Vendas; Posicione com o cursor sobre a Previso 100.200-01, clique na opo Excluir e confirme; Retorne ao Cadastro Exerc05 e execute novamente a Rotina de Excluso.

Verifique que desta vez a rotina ser executada, pois no existe mais nenhuma amarrao deste registro com o cadastro de Previso de Vendas. No poderemos mais incluir registros atravs da opo Exerc05, pois o mesmo foi modificado, para retornar Falso no parmetro responsvel pela incluso.

Anotaes:

APL8110401061027 - SIGAADVPL Protheus - 59

Exerccio 34 Como criar Programas de Excluso de Registros em Sequncia: Crie um Programa que durante a Excluso de um registro no Exerc05 seja verificado se o mesmo est amarrado ao cadastro de Previso de Vendas, caso esteja, dever ocorrer a Excluso deste registro em ambos os cadastros. Realize as seguintes modificaes no Programa Vdel: #Include "RwMake.CH" User Function vDel() //Local Local c_Area aArea := := Alias(), n_Rec:=Recno(), //Substitui a c_ind:=IndexOrd() linha acima GetArea()

1.

Local cCod := SB1->B1_COD, lDel:=.T. MsgBox("Verificando amarracao do produto " + cCod, "Atencao!!!") DbSelectArea("SC4") If DbSeek(xFilial("SC4")+cCod) Vendas If de MsgBox("Deseja Vendas","YESNO") lDel If Else MsgBox("Registro excluido!") lDel EndIf Else MsgBox("Produto no ser excludo!") lDel := .F. EndIf EndIf RestArea(aArea) Return(lDel) // Substitui as 3 linhas acima := .F. em uso, o produto no ser := .T. excluir // a Verifica Previso se existe de Previso de

Vendas","Previso

RecLock("SC4") DbDelete()

Anotaes:

60 - SIGAADVPL Protheus - APL8110401061027

2.

Salve o Programa e Compile-o, novamente.

Exerccio 35 Como Testar a Validao, para Excluso de Registros em Sequncia: 1 . Acesse o Mdulo de Faturamento; 2. 3. Selecione as seguintes opes Atualizao + Cadastros + Produtos; Clique na opo Incluir e informe os dados a seguir:
Cdigo: Descrio: Tipo: Unidade: Armazem Pad: 100.100-01 CANETA AZUL MC PC 01

4. 5. 6.

Confira os dados, confirme e saia do cadastro de Produtos; Selecione as seguintes opes Atualizao + Cenrios de Venda + Previso de Vendas; Clique na opo Incluir e informe os dados a seguir:
Produto: Almoxarifado: Quantidade: 100.100-01 1 1,00

7.

Confira os dados e confirme o cadastro de Previso de Vendas.

Exerccio 36 Como Testar a Excluso de Registros em Sequncia: 1. 2. 3. 4. 5. Selecione as seguintes opes Atualizao + Cadastros + Exerc05; Posicione com o cursor sobre o Produto 100.100-01; Clique na opo Excluir e saia do cadastro de Produtos; Selecione as seguintes opes Atualizaes + Cenrios de Venda + Previso de Vendas; Verifique que a Previso de Vendas, cadastrada para o Produto 100.100-01, tambm foi Excluda.

Obs: Todos os detalhes referentes Criao de Campos e Manuteno das Estruturas de um Arquivo so vistos com maiores detalhes no curso do Mdulo Configurador.

Anotaes:

APL8110401061027 - SIGAADVPL Protheus - 61

Dicas: Caso queira criar mais campos, o procedimento o mesmo, e se desejar Criar Campos que tenham, as caractersticas semelhantes a de outro campo, basta verificar, como est definida a Estrutura do Campo, que se deseja Copiar e cri-la onde desejar; Sempre que confirmamos a Alterao da Estrutura de um Arquivo, o Protheus, gera um Backup, automtico do Dicionrio de Dados, como no exemplo a seguir: SX3990.#DB (Nas verses ADS e Codebase), ou SX3990.BKP (Nas verses SQL).

MBrowse()
Esta Funo utilizada para a criao de telas de cadastros padronizados da MICROSIGA, onde poderemos criar at 10 botes, sem a necessidade de utilizarmos os originais. Tambm possvel a utilizao de Legendas durante o cadastro, sendo que as mesmas podero ser definidas atravs de Cores e Condies. Sintaxe: MBrowse(nT,nL,nB,nR,cAlias,aFixe,cCpo,nPosI,cFun,nDefault, aColors,cTopFun,cBotFun) Parmetros: nT = Linha Inicial; nL = Coluna Inicial; nB = Linha Final; nR = Coluna Final; cAlias = Alias do Arquivo; aFixe = Array, contendo os Campos Fixos (A serem mostrados em primeiro lugar no Browse); cCpo = Campo a ser tratado, quando Empty, para informaes de Linhas com Cores; Prioridade 2 nPosI = (Dummy); cFun = Funo para habilitar semforo; Prioridade 3 na execuo; Prioridade 3 nDefault = Nmero da opo do menu a ser executada quando o <Enter> for pressionado;

Anotaes:

62 - SIGAADVPL Protheus - APL8110401061027

aColors cTopFun cBotFun Obs.:

= = =

Array com os Objetos e Cores; Prioridade 1 Funo para filtrar o TOP do Browse; Funo para filtrar o BOTTOM do Browse.

Lembre-se de utlizar o IDE, para

criar, compilar e debugar o seu programa.

Exerccio 37 Criando uma Janela com a funo MBROWSE: User Function Exerc06 Private aRotina := {{"Pesquisar","AxPesqui",0,1} ,; ,; ,; {"Visualizar","AxVisual",0,2} {"Incluir","AxInclui",0,3}

{"Alterar","AxAltera",0,4} ,; {"Excluir","AxDeleta",0,5},; {"Compl. Produtos","Mata180()",0,6}} Confira os dados, salve o Programa tambm com o nome de Exerc06, adicione ao Projeto e Compile-o.14. Adicione-o ao menu do Modulo Faturamento e teste.

Exerccio 38 Como utilizar Legendas nos Cadastros: Crie um Programa, para o Cadastro de Produtos, sendo que o mesmo dever possuir uma Legenda ao lado de cada Registro informando se o Campo Preo de Venda, est ou no Preenchido. Realize a seguinte alterao no Programa Exerc06: mBrowse( 2. 3. 6,1,22,75,cString,,"B1_PRV1") Confira os dados, salve o Programa e Compile-o novamente. Insira os dados a seguir:
Cdigo: Descrio: Tipo: Unidade: Armazm Pad.: Preo Venda: 000000000000001 PRODUTO 1 PA CX 01 1.00

1.

Anotaes:

APL8110401061027 - SIGAADVPL Protheus - 63

Cdigo: Descrio: Tipo: Unidade: Armazm Pad.:

000000000000002 PRODUTO 2 PA CX 01

4. 5.

Cancele a Prxima Incluso; Verifique que o produto que atende Condio estipulada pelo programa est com uma legenda Vermelha e a outra Verde.

Obs.: As Cores Padres das Legendas, sero sempre Vermelha quando a Condio, for Satisfeita e Verde, quando ainda estiver Pendente.

Exerccio 39 Como utilizar Legendas com Condies de Preenchimento dos Campos: Crie um Programa, para o Cadastro de Produtos, sendo que o mesmo dever possuir uma Legenda ao lado de cada registro informando se o Campo Preo de Venda est ou no preenchido com Valor Igual ou Superior a R$ 100,00. 1. 2. Realize a seguinte alterao no Programa Exerc06: mBrowse( 6,1,22,75,cString,,"B1_PRV1>=100") Confira os dados, salve o Programa e Compile-o novamente e teste.

Obs.: Verifique que a Cor do primeiro registro, foi alterada para Verde, pois a Nova Condio ainda no foi Satisfeita; 3 . Posicione com o cursor sobre esse mesmo Registro e clique na opo Alterar; 4. 5. Preencha o Campo Preo Venda com um Valor Igual ou Superior a R$ 100,00 e confirme; Verifique que agora a Legenda, mudou novamente para Vermelho, pois a Nova Condio, foi Atendida.

Exerccio 40 Como criar Outra Tela de Cadastros: Crie um Programa denominado Exerc601, utilizando o arquivo de Cadastro de Clientes, onde o mesmo dever possuir uma Legenda, informando se o Campo Tipo, est preenchido como Revendedor.

Anotaes:

64 - SIGAADVPL Protheus - APL8110401061027

1. 2. 3. 4. 5. 6. 7. 8. 9.

Acesse a Ferramenta IDE; Selecione as seguintes opes Ferramentas + Assistente de Cdigo; Marque a opo Cadastro; Clique na opo Avanar>>; Marque a opo Arquivo Padro; No Campo Alias, informe o Arquivo SA1; Marque a opo Utiliza ndice padro; Clique na opo Avanar>> + Avanar>>; Marque a opo MBrowse;

1 0 . Na pasta Configuraes, no Campo Ttulo, informe Cadastro de Clientes; 1 1 . Clique na opo Finalizar; 1 2 . Realize as seguintes correes no Programa: User Function Exerc601 mBrowse( 6,1,22,75,cString,,"A1_TIPO== 'R") 1 3 . Confira os dados, salve o Programa, tambm com o nome de Exerc601, adicione ao Projeto e Compile-o. 1 4 . Adicione-o ao menu do Modulo Faturamento e teste. Obs.: Verifique que o Registro existente, possui a legenda em Vermelho, pois a Nova Condio, j se encontra Satisfeita; 1 5 . Clique na opo Alterar, preencha o Campo Tipo, com X=Exportao e confirme; 1 6 . Agora, verifique que a Legenda, passou para a cor Verde, confirmando que a Condio no foi Satisfeita, dessa vez e saia do Cadastro.

Exerccio 41 Como Criar Cadastros com Filtros: Crie um Programa denominado Exerc602, utilizando o Arquivo de Tabelas do Mdulo Configurador, onde o mesmo dever apresentar, apenas os Os Estados da Regio Sudeste, quando o usurio acessar o sistema, porm dever apresentar todos, caso o sistema seja acessado pelo Administrador.

Anotaes:

APL8110401061027 - SIGAADVPL Protheus - 65

1. 2.

Acesse a Ferramenta IDE; Crie o Programa a seguir: #Include "Rwmake.ch" User Function Exerc602() Dbselectarea("SX5") Dbsetorder(1) cCadastro:="Tabelas" aRotina:={{ "Pesquisar","Axpesqui",0,1},; {"Alterar","AxAltera",0,4}} If Upper(Substr(cUsuario,7,15))<>"ADMINISTRADOR" Set Filter To X5_TABELA == 12 .And. Alltrim(X5_CHAVE) $ SP/ RJ/MG/ES Endif Mbrowse(6,1,22,75,"SX5") Set Filter to Return

3. 4.

Confira os dados, salve o Programa, com o nome de Exerc602, adicione ao Projeto e Compile-o. Adicione-o ao menu do Modulo Faturamento e teste.

Obs.: Verifique que apenas os Estados da Regio Sudeste, foram exibidos. 5 . Saia do Sistema e acesse-o novamente como Administrador, repetindo o Teste; 6. Verifique que todos os Estados sero exibidos e saia do Cadastro.

Exerccio 42 Criando Legenda para o Semaforo e ativando o mesmo com a tecla <Enter> Crie um Programa denominado EXERC13, utilizando o Cadastro de Produtos do Mdulo Faturamento, para apresentar uma Legenda do Semaforo, este dever chamar o Programa de Legenda quando pressionado o <Enter>, utilizaremos neste exerccio os parmetros cDefault e aCor es .

Anotaes:

66 - SIGAADVPL Protheus - APL8110401061027

1. 2.

Acesse a ferramenta IDE; Crie o programa a seguir; #INCLUDE rwmake.ch User Function Exerc13() Private cCadastro := Cadastro de Produtos Private aRotina := { {Pesquisar,AxPesqui,0,1} ,; ,; ,; ,; } para a exclusao. Pode-se ,; {Visualizar,AxVisual,0,2} {Incluir,AxInclui,0,3} {Alterar,AxAltera,0,4} {Excluir,AxDeleta,0,5} {Legenda,u_Legenda(),0,6} Private cDelFunc := utilizar ExecBlock .T. // Validacao

aCores := {{B1_PRV1 == 0,BR_VERMELHO},; {B1_PRV1 > 0 .And. B1_PRV1 <= 100,BR_LARANJA},; {B1_PRV1 > 100 .And. B1_PRV1 <= 200,BR_AZUL},; {B1_PRV1 > 200,BR_VERDE}} dbSelectArea(SB1) dbSetOrder(1) mBrowse( Return User Function Legenda() BrwLegenda(cCadastro,Valores, informado},; { {BR_VERMELHO,Preo no 6,1,22,75,SB1",,,,,6,aCores)

{BR_LARANJA,Preo > 0 e <= 100" },; {BR_AZUL,Preo > 100 e <= 200" },; {BR_VERDE,Preo > 200" }} ) Return 3. 4. .T. Confira os dados, salve o programa EXERC13, adicione ao Projeto e Compile-o. Adicione ao menu do Modulo Faturamento

Anotaes:

APL8110401061027 - SIGAADVPL Protheus - 67

Exerccio 43 Como criar telas de cadastros pela funo Mbrowse e fazendo a chamda pela funo MODELO2. Obs.: Lembre-se de utlizar o IDE, para criar, compilar e debugar o seu programa. Tudo que esta entre /* e */ ou // comentrio. Altere somente o que estiver em Negrito #include User Protheus.ch Exerc08()

Function

+ // + //| Declarar as variaveis aRotina e cCadastro como Private, porque a funo mBrowse est esperando | + // + Private aRotina := {} Private cCadastro := Solicitao de Software ++ // //| Montar o vetor aRotina, obrigatorio para a utilizao da fun mBrowse() | ++ // aAdd( aRotina, { Pesquisar aAdd( aRotina, { Incluir aAdd( aRotina, { Alterar aAdd( aRotina, { Excluir , AxPesqui , 0 , 1 }) aAdd( aRotina, { Visualizar , u_Mod2Manut , 0 , 2 }) , u_Mod2Manut , 0 , 3 }) , u_Mod2Manut , 0 , 4 }) , u_Mod2Manut , 0 , 5 })

++ // //| Selecionar a tabela ordem e posicionar no primeiro registro da ordem | ++ // dbSelectArea(SZ4) dbSetOrder(1)
Anotaes:

68 - SIGAADVPL Protheus - APL8110401061027

dbGoTop() + / + / //| Executar a funo mBrowse para a tabela mencionada | + / + / mBrowse(,,,,SZ4) Return

Exerccio 44 Criado a tela de incluso com a funo Modelo2.

Sintaxe

da

Funo

Modelo2()

Esta Funo utilizada para a Criao de Telas de Cadastros onde poderemos trabalhar com um Esquema Cabealho desenvolvido apenas com a utilizao de Variveis de Memria e logo abaixo uma tela com linhas, utilizada para a digitao dos dados, aparentando estarmos trabalhando com dois arquivos em tela, porm na verdade existir apenas um. Como exemplo, podemos citar o cadastro de Controle de Reservas, existente no Mdulo de Faturamento. Sintaxe: Modelo2(cT,aC,aR,aGd,nOp,cLOk,cTOk, aGetsD, bF4, cIniCpos) Parmetros: lRet = Retorno da funo (.T. se confirmou); cT = Ttulo da Janela; aC = Array com os Campos do Cabealho; aR = Array com os Campos do Rodap; aGd = Array com as posies para edio dos tens (GETDADOS); nOp = Modo de operao (3 ou 4 altera e inclui tens, 6 altera mas no inclui tens, qualquer outro nmero s visualiza os tens); cLOk = Funo para validao da linha; cTOk = Funo para validao de tudo (na confirmao); aGetsD = Array com Gets editveis; bF4 = Bloco de Cdigos, para tecla <F4>; cIniCpos = String com Nome dos Campos que devem ser inicializados ao pressionar a tecla de Seta para Baixo.

Anotaes:

APL8110401061027 - SIGAADVPL Protheus - 69

Obs.: Lembre-se de utlizar o IDE, para criar, compilar e debugar o seu programa. Tudo que esta entre /* e */ ou // comentrio. Altere somente o que estiver em Negrito

Exerccio 45- Criando a funo Mod2Manut

User Function Mod2Manut(cAlias,nReg,nOpc) + / + //| Declarao de variveis | + / + Local cChave := Local nCOLS := 0 Local i := 0 Local lRet := .F. ++ / / //| Variveis que serviro de parmetros para a funo Modelo2() | ++ / / Private cTitulo := cCadastro Private aC := {} Private aR := {} Private aCGF := {} Private cLinOk := Private cAllOk := u_Md2TudOk() Private aGetsGD := {} Private bF4 := {|| } Private cIniCpos := +Z4_ITEM Private nMax := 99 Private aCordW := {}

Anotaes:

70 - SIGAADVPL Protheus - APL8110401061027

Private lDelGetD := .T. Private aHeader := {} Private aCOLS := {} Private nCount := 0 Private bCampo := {|nField| FieldName(nField) } / / ) Private dData := Ctod( Private aAlt := {} ++ / //| Cria variaveis de memoria M->??? | ++ / dbSelectArea(cAlias) For i := 1 To FCount() M->&(Eval(bCampo,i)) Next nX ++ / / //| Criar o vetor aHeader conforme o dicionario de dados | ++ / / dbSelectArea(SX3) dbSetOrder(1) dbSeek(cAlias) While !Eof() .And. SX3->X3_ARQUIVO == cAlias If X3Uso(X3_USADO) .And. cNivel !(Trim(X3_CAMPO)$Z4_NUMERO/Z4_EMISSAO) ,; ,; ,; ,; ,; ,; X3_CAMPO X3_PICTURE X3_TAMANHO X3_DECIMAL X3_VALID >= X3_NIVEL .And. := CriaVar(FieldName(i),.T.)

Private cNumero := Space(6)

aAdd(aHeader,{ TRIM(X3_TITULO)

Anotaes:

APL8110401061027 - SIGAADVPL Protheus - 71

X3_USADO X3_TIPO X3_ARQUIVO X3_CONTEXT Endif dbSkip() End dbSelectArea(cAlias) dbSetOrder(1)

,; ,; ,; })

++ // //| Se a opcao for diferente de incluir, entao atribuir os dados no vetor aCOLS | //| Caso contrario criar o vetor aCOLS com a caracteristica de cada campo | ++ // If nOpc <> 3 cNumero := (cAlias)->Z4_NUMERO + / + //| Deve-se posicionar porque nunca se sabe em qual item esta, e necessario pegar todos os itens | + / + dbSeek(xFilial(cAlias)+cNumero) While !Eof() .And. (cAlias)->(Z4_FILIAL+Z4_NUMERO) == Filial(cAlias)+cNumero //++//|Criarovetorcomsua devida dimenso em relao ao dicionrio de dados | ++ / aAdd(aCOLS,Array(Len(aHeader)+1)) nCOLS++ /+ + //| Atribuir o dado para cada coluna do vetor | /+ - + For i := 1 To Len(aHeader)

Anotaes:

72 - SIGAADVPL Protheus - APL8110401061027

If aHeader[i,10]<>V aCOLS[nCOLS,i] Else aCOLS[nCOLS,i] Endif Next i ++ / //| Criar uma ltima coluna para o controle da Getdados, se deletado ou no | ++ / aCOLS[nCOLS,Len(aHeader)+1] := .F. ++ / //| Atribuir o nmero do registro neste vetor para o controle na gravao | ++ / aAdd(aAlt,RecNo()) dbSelectArea(cAlias) dbSkip() End Else + / + //| Atribuir varivel o inicializador padro do campo | + / + cNumero := GetSxeNum(SZ4,Z4_NUMERO) + / + //| Criar o vetor com sua devida dimenso em relao ao dicionrio de dados | + / + aAdd(aCOLS,Array(Len(aHeader)+1)) For i := 1 To Len(aHeader) aCOLS[1,i] Next i + / +
Anotaes:

:= :=

FieldGet(FieldPos(aHeader[i,2])) CriaVar(aHeader[i,2],.T.)

:=

CriaVar(aHeader[i,2])

APL8110401061027 - SIGAADVPL Protheus - 73

//| Criar uma ltima coluna para o controle da Getdados, se deletado ou no | + / + aCOLS[1,Len(aHeader)+1] := .F. ++ / //| Atribuir 01 para a primeira linha da Getdados | ++ / aCOLS[1,aScan(aHeader,{|x|Trim(x[2])==Z4_ITEM})] := 01 Endif ++ / / //| Caracterstica do vetor //| aC[n,1] = Nome da Variavel Ex.:cCliente //| aC[n,3] = Titulo do Campo //| aC[n,4] = Picture //| aC[n,5] = Validacao //| aC[n,6] = F3 //| aC[n,7] = Se campo e editavel .t. se nao .f. ++ / / aAdd(aC,{cNumero ,{15,10},Nmero,@!,,,.F.}) de Emissao,99/99/99,,,(nOpc==3)}) aAdd(aC,{dData,{15,80},Data ++ / //| Coordenada do objeto Getdados | ++ / aCGD:={34,5,128,315} ++ / / //| Validacao na mudanca de linha e quando clicar no botao Ok | ++ / / cLinOk := AllwaysTrue() | | | | | | |

//| aC[n,2] = Array com coordenadas do Get [x,y] em PIXEL |

Anotaes:

74 - SIGAADVPL Protheus - APL8110401061027

++ // //| Atribuir a database do sistema a varivel | ++ // dData := dDataBase + / + //| Executar a funo Modelo2() | + / + lRet := Modelo2(cTitulo,aC,aR,aCGD,nOpc,cLinOk,cAllOk,,,cIniCpos,nMax) / + + //| Se confirmado | / + + If lRet /+ + //| Se opo for inclusao | /+ + If nOpc == 3 If MsgYesNo(Confirma gravao dos dados ?,cTitulo) Processa({|| Endif /+ + //| Se opo for alterao | /+ + Elseif nOpc == 4 If MsgYesNo(Confirma alterao dos dados ?,cTitulo) Processa({|| Endif /+ + //| Se opo for excluso | /+ + Md2Alter(cAlias)},cTitulo,Alterando os dados, aguarde...) Md2Inclu(cAlias)},cTitulo,Gravando os dados, aguarde...)

Anotaes:

APL8110401061027 - SIGAADVPL Protheus - 75

Elseif nOpc == 5 If MsgYesNo(Confirma eliminao dos dados ?,cTitulo) Processa({|| Endif Endif Else + / + //| Se no confirmado, reestabelecer a nmerao automtica do cadastro | + / + RollBackSX8() Endif Return Md2Exclu(cAlias)},cTitulo,Exclundo os dados, aguarde...)

Exerccio 46 Criando a funo Md2Inclu

Rotina de cadastro para a tabela SZ1. Cadastro de software. Funo Desc. Static Md2Inclu Funo para incluir os dados Function Md2Inclu(cAlias)

Local i := 0 Local y := 0 ProcRegua(Len(aCOLS)) dbSelectArea(cAlias) dbSetOrder(1) For i := 1 To Len(aCOLS) IncProc()

Anotaes:

76 - SIGAADVPL Protheus - APL8110401061027

If

!aCOLS[i,Len(aHeader)+1]

RecLock(cAlias,.T.) For y := 1 To Len(aHeader) FieldPut(FieldPos(Trim(aHeader[y,2])),aCOLS[i,y]) Next y (cAlias)->Z4_FILIAL := xFilial(cAlias) (cAlias)->Z4_NUMERO := cNumero (cAlias)->Z4_EMISSAO := dData MsUnLock() Endif Next i Return

Exerccio 47 Criando a funo Md2Alter

Static

Function

Md2Alter(cAlias)

Local i := 0 Local y := 0 ProcRegua(Len(aCOLS)) dbSelectArea(cAlias) dbSetOrder(1) For i:=1 To Len(aCOLS) If i<=Len(aAlt) dbGoTo(aAlt[i]) RecLock(cAlias,.F.) If aCOLS[i,Len(aHeader)+1] dbDelete() Else For y := 1 To Len(aHeader)

Anotaes:

APL8110401061027 - SIGAADVPL Protheus - 77

FieldPut(FieldPos(Trim(aHeader[y,2])),aCOLS[i,y]) Next y Endif MsUnLock() Else If !aCOLS[i,Len(aHeader)+1] RecLock(cAlias,.T.) For y := 1 To Len(aHeader) FieldPut(FieldPos(Trim(aHeader[y,2])),aCOLS[i,y]) Next y (cAlias)->Z4_FILIAL := xFilial(cAlias) (cAlias)->Z4_NUMERO := cNumero (cAlias)->Z4_EMISSAO := dData MsUnLock() Endif Endif Next i Return

Exerccio 48 Criando a funo Md2Exclu.

Static Function Md2Exclu(cAlias) ProcRegua(Len(aCOLS)) dbSelectArea(cAlias) dbSetOrder(1) dbSeek(xFilial(cAlias)+cNumero) While !Eof() .And. (cAlias)->Z4_FILIAL == xFilial(cAlias) .And. (cAlias)>Z4_NUMERO == cNumero IncProc()

Anotaes:

78 - SIGAADVPL Protheus - APL8110401061027

RecLock(cAlias,.F.) dbDelete() MsUnLock() dbSkip() End Return

Exercicio 49- Criando a Funo MD2TUDOK

User Function Md2TudOk() Local lRet := .T. Local i := 0 Local nDel := 0 For i:=1 To Len(aCOLS) If aCOLS[i,Len(aHeader)+1] nDel++ Endif Next i If nDel == Len(aCOLS) MsgInfo(Para excluir todos os itens, utilize a opo EXCLUIR,cTitulo) lRet := .F. Endif Return(lRet) Obs.: Verifique que o Tipo de Cadastro criado totalmente diferente dos utilizados at o momento. 4 . Teste-o, verificando as sua Validaes e saia do Cadastro.

Anotaes:

APL8110401061027 - SIGAADVPL Protheus - 79

Modelo3()
Esta Funo utilizada para a Criao de Telas de Cadastros, onde poderemos trabalhar com um esquema de Dois Arquivos em Tela, ou seja, um para a Criao do Cabealho e outro para a Criao do Corpo do Cadastro, onde iremos utilizar Linhas para a Digitao. Como exemplo, podemos citar o cadastro de Pedidos de Vendas, existente no Mdulo de Faturamento. Sintaxe: Modelo3(cTitulo,cAlias1,cAlias2,aMyEncho,cLinOk,cTudoOk,nOpcE,nOpcG,cFs2,aMyEncho, cLinOk,cTudoOk,nOpcE,nOpcG,cFieldOk,lVirtual,nLinhas,aAltEnchoice) Parmetros: lRet = Retorno .T. Confirma / .F. Abandona; cTitulo = Ttulo da Janela; cAlias1 = Alias da Enchoice; cAlias2 = Alias da GetDados; aMyEncho = Array com campos da Enchoice; cLinOk = LinOk; cTudOk = TudOk; nOpcE = nOpc da Enchoice; nOpcG = nOpc da GetDados; cFieldOk = Validao para todos os campos da GetDados; lVirtual = Permite visualizar campos virtuais na Enchoice; nLinhas = Nmero Mximo de linhas na Getdados; aAltEnchoice = Array com campos da Enchoice Alterveis.

Exerccio 50 Como criar telas de cadastros:

#Include Protheus.Ch User Function Exerc09() ++ // //| | //| Declarar as variaveis aRotina e cCadastro como Private, porque a Declarao de variaveis

Anotaes:

80 - SIGAADVPL Protheus - APL8110401061027

funo mBrowse est esperando | ++ // Private cCadastro := Oramento de venda Private cAlias1 := SZ2 Private cAlias2 := SZ3 Private aRotina := {} ++ // //| Montar o vetor aRotina, obrigatorio para a utilizao da fun mBrowse() | ++ // aAdd( aRotina, { Pesquisar aAdd( aRotina, { Incluir aAdd( aRotina, { Alterar aAdd( aRotina, { Excluir , AxPesqui , 0 , 1 }) aAdd( aRotina, { Visualizar , u_Mod3Manut , 0 , 2 }) , u_Mod3Manut , 0 , 3 }) , u_Mod3Manut , 0 , 4 }) , u_Mod3Manut , 0 , 5 })

++ // //| Selecionar a tabela pai, ordem e posicionar no primeiro registro da ordem | ++ // dbSelectArea(cAlias1) dbSetOrder(1) dbGoTop() + / + / //| Executar a funo mBrowse para a tabela mencionada | + / + / mBrowse(,,,,cAlias1) Return

Anotaes:

APL8110401061027 - SIGAADVPL Protheus - 81

Exerccio 51 Como criar telas de cadastros:

User Function Mod3Manut(cAlias,nRecNo,nOpc) + / + //| Declarao de variaveis | /+ + Local i := 0 Local cLinOk := AllWaysTrue Local cTudoOk := u_Md3TudOk Local nOpcE := nOpc Local nOpcG := nOpc Local cFieldOk := AllWaysTrue Local lVirtual := .T. Local nLinhas := 99 Local nFreeze := 0 Local lRet := .T. Private aCOLS := {} Private aHeader := {} Private aCpoEnchoice := {} Private aAltEnchoice := {} Private aAlt := {} + / + //| Criar as variaveis M->Z2_??? da tabela PAI | + / + RegToMemory(cAlias1,(nOpc==3)) ++ / //| Criar as variaveis M->Z2_??? da tabela FILHO |

Anotaes:

82 - SIGAADVPL Protheus - APL8110401061027

++ / RegToMemory(cAlias2,(nOpc==3)) ++ / //| Criar o vetor aHeader, que eh o vetor que tem as caracteristicas para os campos da Getdados | ++ / CriaHeader() ++ / //| Criar o vetor aCOLS, que eh o vetor que tem os dados preenchidos pelo usuario, relacionado com o vetor aHeader | + / + criaCOLS(nOpc) / + + //| Executar a funo Modelo3() | / + + lRet:=Modelo3(cCadastro,cAlias1,cAlias2,aCpoEnchoice,cLinOk,cTudoOk,nOpcE,; nOpcG,cFieldOk,lVirtual,nLinhas,aAltEnchoice,nFreeze) //++ //| Se confirmado | //++ If lRet //++ //| Se opo for inclusao | //++ If nOpc == 3 If MsgYesNo(Confirma gravao dos dados ?,cCadastro) Processa({||GrvDados()},cCadastro,Gravando Endif os dados, aguarde...)

Anotaes:

APL8110401061027 - SIGAADVPL Protheus - 83

//++ //| Se opo for alterao | //++ Elseif nOpc == 4 If MsgYesNo(Confirma alterao dos dados ?,cCadastro) Processa({||AltDados()},cCadastro,Alterando Endif //++ //| Se opo for excluso | //++ Elseif nOpc == 5 If MsgYesNo(Confirma eliminao dos dados ?,cCadastro) Processa({||ExcluiDados()},cCadastro,Exclundo Endif Endif Else + / + //| Se no confirmado, reestabelecer a nmerao automtica do cadastro | + / + RollBackSX8() Endif Return os dados, aguarde...) os dados, aguarde...)

Exerccio 52 Criando a funo CriaHeader

Static

Function

CriaHeader()

aHeader:={} aCpoEnchoice := {} aAltEnchoice := {}

Anotaes:

84 - SIGAADVPL Protheus - APL8110401061027

dbSelectArea(SX3) dbSetOrder(1) dbSeek(cAlias2) While !Eof() .And. X3_ARQUIVO == cAlias2 If X3USO(X3_USADO) .And. cNivel >= X3_NIVEL aAdd(aHeader,{TRIM(X3_TITULO),; X3_CAMPO,; X3_PICTURE,; X3_TAMANHO,; X3_DECIMAL,; X3_VALID,; X3_USADO,; X3_TIPO,; X3_ARQUIVO,; X3_CONTEXT}) Endif dbSkip() End dbSeek(cAlias1) While !Eof() .And. X3_ARQUIVO == cAlias1 If X3USO(X3_USADO) .And. cNivel >= X3_NIVEL aAdd(aCpoEnchoice,X3_CAMPO) aAdd(aAltEnchoice,X3_CAMPO) Endif dbSkip() End Return

Anotaes:

APL8110401061027 - SIGAADVPL Protheus - 85

Exerccio 53 Criando a funo CriaCols

Static Function CriaCOLS(nOpc) Local nQtdCpo := 0 Local i := 0 Local nCOLS := 0 nQtdCpo := Len(aHeader) aCOLS := {} aAlt := {} If nOpc == 3 aAdd(aCOLS,Array(nQtdCpo+1)) For i := 1 To nQtdCpo aCOLS[1,i] Next i aCOLS[1,nQtdCpo+1] := .F. Else dbSelectArea(cAlias2) dbSetOrder(1) dbSeek(xFilial(cAlias2)+(cAlias1)->Z2_NUMERO) While !Eof() .And. (cAlias2)->Z3_FILIAL == xFilial(cAlias2) .And. (cAlias2)>Z3_NUMERO == (cAlias1)->Z2_NUMERO aAdd(aCOLS,Array(nQtdCpo+1)) nCOLS ++ For i := 1 To nQtdCpo If aHeader[i,10] <> V aCOLS[nCOLS,i] Else aCOLS[nCOLS,i] := CriaVar(aHeader[i,2],.T.) := FieldGet(FieldPos(aHeader[i,2])) := CriaVar(aHeader[i,2])

Anotaes:

86 - SIGAADVPL Protheus - APL8110401061027

Endif Next i aCOLS[nCOLS,nQtdCpo+1] := .F. aAdd(aAlt,RecNo()) dbSelectArea(cAlias2) dbSkip() End Endif Return

Exerccio 54 Criando a funo GrvDados

Rotina de cadastro para a tabela SZ1. Cadastro de software. Funo GrvDados Desc. Funo para incluir os dados na tabela FILHO conforme o vetor aHeader e aCOLS e tambm incluir os dados na tabelaPAI conforme as variveis M->??? Static Function GrvDados()

Local bCampo := { |nField| Field(nField) } Local i := 0 Local y := 0 Local nItem := 0 ProcRegua(Len(aCOLS)+FCount()) dbSelectArea(cAlias1) RecLock(cAlias1,.T.) For i := 1 To FCount() IncProc() If FILIAL $ FieldName(i)
Anotaes:

APL8110401061027 - SIGAADVPL Protheus - 87

FieldPut(i,xFilial(cAlias1)) Else FieldPut(i,M->&(Eval(bCampo,i))) Endif Next i MsUnLock() dbSelectArea(cAlias2) dbSetOrder(1) For i := 1 To Len(aCOLS) IncProc() If !aCOLS[i,Len(aHeader)+1] RecLock(cAlias2,.T.) For y := 1 To Len(aHeader) FieldPut(FieldPos(Trim(aHeader[y,2])),aCOLS[i,y]) Next y nItem++ (cAlias2)->Z3_FILIAL (cAlias2)->Z3_ITEM MsUnLock() Endif Next i Return := xFilial(cAlias2) (cAlias2)->Z3_NUMERO := (cAlias1)->Z2_NUMERO := StrZero(nItem,2,0)

Exerccio 55 Criando a funo AltDados

Rotina de cadastro para a tabela SZ1. Cadastro de software. Funo AltDados

Anotaes:

88 - SIGAADVPL Protheus - APL8110401061027

Desc. Funo para incluir/alterar os dados na tabela FILHO conforme o vetor aHeader e aCOLS e tambm incluir os dados na tabela PAI conforme as variveis M->??? Static Function AltDados()

Local bCampo := { |nField| Field(nField) } Local i := 0 Local y := 0 Local nItem := 0 P r o c R e g u a (Len ( a C O L S ) +F C o u n t( ) ) dbSelectArea(cAlias1) RecLock(cAlias1,.F.) For i := 1 To FCount() IncProc() If FILIAL $ FieldName(i) FieldPut(i,xFilial(cAlias1)) Else FieldPut(i,M->&(Eval(bCampo,i))) Endif Next i MsUnLock() dbSelectArea(cAlias2) dbSetOrder(1) nItem := Len(aAlt)+1 For i:=1 To Len(aCOLS) If i<=Len(aAlt) dbGoTo(aAlt[i]) RecLock(cAlias2,.F.) If aCOLS[i,Len(aHeader)+1] dbDelete()

Anotaes:

APL8110401061027 - SIGAADVPL Protheus - 89

Else For y := 1 To Len(aHeader) FieldPut(FieldPos(Trim(aHeader[y,2])),aCOLS[i,y]) Next y Endif MsUnLock() Else If !aCOLS[i,Len(aHeader)+1] RecLock(cAlias2,.T.) For y := 1 To Len(aHeader) FieldPut(FieldPos(Trim(aHeader[y,2])),aCOLS[i,y]) Next y (cAlias2)->Z3_FILIAL (cAlias2)->Z3_ITEM MsUnLock() nItem++ Endif Endif Next i Return := xFilial(cAlias2) (cAlias2)->Z3_NUMERO := (cAlias1)->Z2_NUMERO := StrZero(nItem,2,0)

Exerccio 56 Criando a funo ExcluiDados

Static

Function

ExcluiDados()

ProcRegua(Len(aCOLS)+1) dbSelectArea(cAlias2)
Anotaes:

90 - SIGAADVPL Protheus - APL8110401061027

dbSetOrder(1) dbSeek(xFilial(cAlias2)+(cAlias1)->Z2_NUMERO) While !Eof() .And. (cAlias2)->Z3_FILIAL == xFilial(cAlias2) .And. (cAlias2)>Z3_NUMERO == (cAlias1)->Z2_NUMERO IncProc() RecLock(cAlias2,.F.) dbDelete() MsUnLock() dbSkip() End dbSelectArea(cAlias1) dbSetOrder(1) IncProc() RecLock(cAlias1,.F.) dbDelete() MsUnLock() Return

Exerccio 57 Criando a funo Md3TudOk

Rotina de cadastro para a tabela SZ1. Cadastro de software. Funo Md3TudOk Desc. Funo para validar se a getdados est liberada para gravar os dados conforme o preenchimento User Function Md3TudOk() Local lRet := .T. Local i := 0 Local nDel := 0

Anotaes:

APL8110401061027 - SIGAADVPL Protheus - 91

For i:=1 To Len(aCOLS) If aCOLS[i,Len(aHeader)+1] nDel++ Endif Next i If nDel == Len(aCOLS) MsgInfo(Para excluir todos os itens, utilize a opo EXCLUIR,cCadastro) lRet := .F. Endif Return(lRet)

O que voc aprendeu neste captulo


Neste captulo aprendemos a utilizar as Funes de Criao de Telas para Cadastros, juntamente com Rotinas de Validaes, utilizadas frequentemente durante a Elaborao de Programas.

Prximo

Passo

Na prxima etapa, aprenderemos como criar Consultas Padres do sistema, ou seja, as consultas acionadas atravs da tecla <F3> nos Campos.

Anotaes:

92 - SIGAADVPL Protheus - APL8110401061027

CRIAO
O

DE

RELATRIOS CONSULTAS PADRO


ir aprender neste captulo

que

voc

Neste captulo, aprenderemos a desenvolver os relatrios utilizando o IDE.

Rotinas
Gerao de Relatrios.

Abordadas

que

voc

ir

aprender

neste

captulo

Neste captulo, aprenderemos a criar Relatrios Customizados.

Rotinas
Funes, para Relatrios: SetPrint(); SetDefault(); Pergunte(); SetRegua(); RptStatus(); IncRegua(). Criao de Relatrios Customizados; Criao de Relatrios com Relacionamento; Configurao do Arquivo de Perguntas e Respostas.

abordadas

Variveis

de

Relatrios

Na criao de um relatrio, algumas variveis e seus tipos so convencionados para a utilizao da biblioteca de funes de relatrio. V a r i v e l Tipo Contedo Wnrel Local Nome default do relatrio em disco CbCont Local Contador
Anotaes:

APL8110401061027 - SIGAADVPL Protheus - 93

Cabec1 Local 1 linha do cabealho do Cabec2 Local 2 linha do cabealho do Cabec3 Local 3 linha do cabealho do Tamanho Local Tamanho do Relatrio (P = Mdio 132 colunas),G = (Grande 220 colunas) L i m i t e Local Quantidade de colunas no

relatrio relatrio relatrio Pequeno 80 Colunas, M= relatrio (80, 132, 220).

Titulo Local Titulo do Relatrio CDesc1 Local 1 linha da descrio do relatrio CDesc2 Local 2 linha da descrio do relatrio CDesc3 Local 3 linha da descrio do relatrio aReturn Private Array com as informaes para a tela de configurao da impresso Nomeprog P r i v a t e Nome do programa do relatrio C s t r i n g Private Alias do arquivo principal do relatrio para o uso de filtro L i Private Controle das linhas de imp.Seu valor inicial a qtda mxima de linhas por pgina utilizada no relatrio. M_Pag Private Controle do nmero de pginas do relatrio. Aord Private Array contendo as ordens de layout para a impresso. Caso no existam vrias ordens este array deve estar vazio. Ex.: aOrd:= {Cdigo, Descrio, Telefone} -> O layout do relatrio vai depender da ordem selecionada na tela de configurao de impresso. nLastKey Private Utilizado para controlar o cancelamento da impresso do relatrio. Cperg Private Nome da pergunte a ser exibida para o usurio. Alinha Private Array que contem informaes para a impresso de relatrios cadastrais

SetPrint()
Essa Funo a responsvel pela criao da tela do dispositivo de impresso dos relatrios, montando a interface com o usurio. Sintaxe: SetPrint(ExpC2, ExpC3, ExpC4, ExpC5, ExpC6, ExpC7, ExpC8, ExpL1, ExpA1, ExpL2, ExpC9). Parmetros: ExpC2 = Alias do Arquivo Principal (Se existir); ExpC3 = Nome Padro do Relatrio; ExpC4 = Nome do Grupo de Perguntas;
Anotaes:

94 - SIGAADVPL Protheus - APL8110401061027

ExpC5 .. ExpC8 = ExpL1 = ImpCadast); ExpA1 pal; ExpL2 = =

Descrio do Relatrio; Habilita o Dicionrio de Dados: .T. => Habilita (S utilizar em conjunto com a Funo .F. => Desabilita. Array contendo as Ordens de Indexao do Arquivo PrinciHabilita a Alterao da Compresso do Relatrio; .T. => Habilita; .F. => Desabilita. Classificao do Relatrio por Tamanho ( "G", "M" ou "P" P M G = = = 80 colunas; 132 colunas; 220 colunas.

ExpC9 ) :

SetDefault()
Esta Funo permite Habilitar os Padres definidos pela Funo Set Print(). Sintaxe: SetDefault(Array,Alias). Parmetros: Array = Array aReturn, preenchido pelo SetPrint; Array1 = Reservado para o Formulrio; Array2 = Reservado para N de Vias; Array3 = Destinatrio; Array4 = Formato (1Comprimido, 2Normal); Array5 = Mdia a ser Descarregada (1Comprimido, 2Normal); Array6 = Porta da Printer ou Arquivo (1LPT1, 4Com1); Array7 = Expresso ou Filtro de Dados; Array8 = Ordem a ser Selecionada; Array9 = 1 Campo a Processar; Array10 = 2 Campo a Processar; Array11 = 3 Campo a Processar; ArrayN = 4 Campo a Processar; Alias = Alias do Arquivo a ser Impresso.

Anotaes:

APL8110401061027 - SIGAADVPL Protheus - 95

Pergunte()
Esta Funo permite acessar e editar um Grupo de Perguntas de Programas, baseandose no Arquivo de Perguntas e Respostas do Sistema (Sx1), conhecido tambm como Parmetros de Relatrios. Mostra uma tela contendo um Lote de Parmetros a serem respondidos e em seguida confirmados pelo usurio. Sintaxe: Pergunte(cPergunta,lAsk). Parmetros: cPergunta = Cdigo da Pergunta no SX1 conforme o Programa / Nome do Grupo de Perguntas; lAsk = Mostrar a Tela de Perguntas ou simplesmente carrega os Valores Default. .F. = Devolve Contedo da Variveis, no apresentando a Janela de Perguntas; .T. = Permite Alterao das Variveis apresentando a Janela.

SetRegua()
Inicializa a Rgua Padro, para acompanhar a Evoluo do Processamento dos Relatrios. Sintaxe: SetRegua(n1). Parmetros: <n1> = Numrico, Nmero de registros que sero processados.

RptStatus()
Executa a Funo de Detalhes do Relatrio, ou seja, a Impresso da Pgina propriamente dita. Sintaxe: RptStatus(b1). Parmetros: <b1> = Bloco de Cdigo que define a Funo a ser executada. Comentrios: Pode ser utilizada com o Parmetro: RptStatus( { | | ("Nome da Funo") } )

Anotaes:

96 - SIGAADVPL Protheus - APL8110401061027

IncRegua()
Incrementa a Rgua Padro de Processamento em Relatrios, ou seja, a responsvel por sincronizar a Barra de Progresso de acordo com o nmero de registros selecionados para a impresso. Sintaxe: IncRegua(). Parmetros: Nil.

Relatrios
A Criao de Relatrios no Protheus muito facilitado pelo Assistente de Cdigo, porm sempre haver a necessidade de Complementos Adicionais, pois a ferrramenta cria apenas o Fonte Padro.

Exerccio 58 Como Criar Relatrios, para Cadastro de Softwares, atravs do Assistente de Cdigo da Ferramenta IDE: 1 . Acesse a Ferramenta IDE; 2. 3. 4. 5. 6. 7. 8. 9. Selecione as seguintes opes Ferramentas + Assistente de Cdigo + Relatrio; Clique na opo Avanar>>; Selecione a opo Arquivo Padro; No Campo Alias, informe SZ1; Selecione a opo Utiliza ndice Padro; No Campo Ordem, informe 1 e clique na opo Avanar>>; No Campo Chave, informe RSZ1; Clique na opo "Avanar>>";

1 0 . No Campo Ttulo, informe Relatrio de Softwares; 1 1 . No Campo Cabec1, informe Cdigo Nome; 1 2 . No Campo Cabec2, informe ------ ---------------;

Anotaes:

APL8110401061027 - SIGAADVPL Protheus - 97

1 3 . Selecione a opo Normal; 1 4 . No Campo Tamanho, selecione 80 Colunas; 1 5 . Na pasta Ordem, posicione com o cursor sobre o Campo Ordem, informe Cdigo e clique na opo adicionar; 1 6 . Na sequncia, informe tambm Nome e clique na opo adicionar; 1 7 . Nas pastas Habilitaes, deixe tudo selecionado e clique na opo Finalizar.

Exerccio 59 Como realizar Alteraes necessrias nos Fontes: 1. Realize as Alteraes necessrias, seguindo o exemplo a seguir, de acordo com o Texto em Negrito: #Include rwmake.ch ***************************************************************************** * Programa 99 | RPAD | Autor | Ferramenta IDE | Data | 99/99/

***************************************************************************** * Descrio | Cdigo gerado pelo Protheus 8 IDE.

***************************************************************************** User Function Exerc18 Private cString := := := := := := { } := Este programa tem como objetivo imprimir Local aOrd Private CbTxt Local cDesc1 relatrios Local cDesc2 usurio. Local cDesc3 Local cPict Private Private lEnd

de acordo com os parmetros informados pelo Cadastro de Software .F. := .F.

lAbortPrint

Anotaes:

98 - SIGAADVPL Protheus - APL8110401061027

Private

limite

:= :=

80 P Exerc18 // Coloque aqui o Nome do Programa

Private tamanho

Private nomeprog := para impresso no cabealho Private nTipo Private aReturn Private Private Local nLastKey cPerg titulo := := := := := 18 := := := 80

{ Zebrado, 1, Administrao, 2, 2, 1, , 1} 0 RSZ1 // Nomo do Grupo de Perguntas de Software

Cadastro

Local nLin Local Cabec1 Local Cabec2 Private cbtxt Private cbcont Private CONTFL Private m_pag Local imprime

Codigo Nome := := := := := Space(10) 00 01 01 .T.

Private wnrel : = Exerc18 // Coloque aqui o Nome do Arquivo usado para impresso em disco. Private cString := SZ1 dbSelectArea(SZ1) dbSetOrder(1) pergunte(cPerg,.F.) ***************************************************************************** * Monta a interface padro com o usurio...

***************************************************************************** wnrel := SetPrint(cString,NomeProg,cPerg,@titulo,cDesc1,cDesc2,cDesc3,.T.,aOrd,.T.,Tamanho,,.T.) If nLastKey == 27 Return

Anotaes:

APL8110401061027 - SIGAADVPL Protheus - 99

Endif SetDefault(aReturn,cString) If nLastKey == 27 Return Endif nTipo := If(aReturn[4]==1,15,18) ***************************************************************************** * Processamento. RPTSTATUS monta janela com a rgua de processamento. ***************************************************************************** RptStatus({|| RETURN ***************************************************************************** * Funo 99/99 | RUNREPORT | Autor | Protheusx IDE | Data | 99/ RunReport(Cabec1,Cabec2,Titulo,nLin) },Titulo)

***************************************************************************** * Descrio | Funo auxiliar chamada pela RPTSTATUS. A funo RPTSTATUS * | monta a janela de processamento

***************************************************************************** Static Function RunReport(Cabec1,Cabec2,Titulo,nLin) Local nOrdem dbSelectArea(cString) dbSetOrder(1) ***************************************************************************** | * SETREGUA -> Indica quantos registros sero processados para a rgua

Anotaes:

100 - SIGAADVPL Protheus - APL8110401061027

***************************************************************************** SetRegua(RecCount()) ***************************************************************************** dbGoTop() DBSEEK(xFilial(SZ1)+mv_par01,.T.) While !EOF() .and. SZ1->Z1_Codigo <= MV_Par02 ***************************************************************************** * Verifica o cancelamento pelo usurio... ***************************************************************************** If lAbortPrint @nLin,00 PSAY *** Cancelado pelo Operador *** Exit Endif ***************************************************************************** * Impresso do cabealho do relatrio. . . ***************************************************************************** If nLin > 55 // Salto de Pgina. Neste caso o formulrio tem 55 linhas... Cabec(Titulo,Cabec1,Cabec2,NomeProg,Tamanho,nTipo) nLin := 8 Endif //* Coloque aqui a lgica da impresso do seu programa.Utilize PSAY para sada na impressora. Por exemplo:* nLin := nLin + 1 // Avana a linha de impresso @ nLin,000 PSay SZ1->Z1_CODIGO @ nLin,008 PSay SZ1->Z1_NOME

Anotaes:

APL8110401061027 - SIGAADVPL Protheus - 101

@ nLin,061 PSay SZ1->Z1_EMISSAO @ nLin,071 PSay SZ1->Z1_DTAQUIS dbSkip() // Avana o ponteiro do registro no arquivo Incregua() EndDo ***************************************************************************** * Finaliza a execucao do relatrio... ***************************************************************************** SET DEVICE TO SCREEN If aReturn[5]==1 impresso... dbCommitAll() SET PRINTER TO OurSpool(wnrel) Endif MS_FLUSH() // Limpa o Buffer de Impresso Return 2. Confira os dados, salve o Programa // Retorna para a Tela // Se impresso em disco, chama o gerenciador de

Perguntas

Respostas

Todos os Relatrios existentes no Protheus necessitam de Perguntas, para imprimir corretamente os dados, ou seja, necessrio Configurarmos um Arquivo, para parametrizar o que desejamos imprimir. O Arquivo responsvel por essa Configurao o (Sx1) e ele servir tanto para as Perguntas e Respostas de Relatrios, quanto para as Rotinas de Processamentos.

Dica: Lembre-se que o mesmo dever criar as Perguntas pelo Mdulo Configurador. Para anular a Impresso dos Parmetros dos Relatrios, acesse o Cadastro de Parmetros, no Mdulo Configurador e configure os Parmetros

Anotaes:

102 - SIGAADVPL Protheus - APL8110401061027

MV_IMPSX1, MV_SALTPAG e MV_CANSALT, com o Contedo igual a N, dessa maneira as Perguntas, no sero mais impressas e tambm no haver Saltos e tampouco emisso de Pginas em Branco.

Exerccio 60 Desenvolvendo o relatrio da tabela SZ1 e SZ2, usando a funo POSICIONE, e criando as perguntas pela funo CRIASX1 Dica: Lembre-se que o mesmo dever utilizar o IDE, para desenvolver o cdigo. User Function Exerc11() + / //| Declaracoes de variaveis + / Local cDesc1 : = Este relatorio ira imprimir informacoes do oramento de software conforme Local cDesc2 Local cDesc3 Private Private Private Private Private Private Private := := parmetros informados pelo usurio [Utilizando Posicionamento e Condies p/ Registros] SZ2 M { Zebrado,1,Administracao,2,2,1,,1 wnrel 0 132 Orcamento de software EXEC11 0 0 } EXERC11

cString : = aReturn : = wnrel :=

Private Tamanho : =

Private NomeProg : = nLastKey : = Limite Titulo cPerg := := := := :=

Private nTipo Private cbCont

Anotaes:

APL8110401061027 - SIGAADVPL Protheus - 103

Private Private

cbTxt Li : =

:= 80 := :=

registro(s) 1 { }

lido(s)

Private m_pag Private aOrd Private Cabec1 Quantidade Private Cabec2 CriaSx1()

: = Cdigo Vlr.Unitario :=

Item Vlr.Total

Descricao

do

Software

+ // //| Disponibiliza para usuario digitar os parametros + // Pergunte(cPerg,.F.) + // //| Solicita ao usuario a parametrizacao do relatorio + // wnrel:=SetPrint(cString,wnrel,cPerg,@Titulo,cDesc1,cDesc2,cDesc3,.F.,aOrd,.F.,; Tamanho,.F.,.F.) +/ / //| Parmetros da funo SetPrint / //| / | SetPrint(cAlias,cNome,cPerg,cDesc,cCnt1,cCnt2,cCnt3,lDic,aOrd,lCompres,; cSize,aFilter,lFiltro,lCrystal,cNameDrv,lNoAsk,lServer,cPortToPrint)

+ / / + / //| Se teclar ESC, sair + / If nLastKey == 27 Return Endif


Anotaes:

104 - SIGAADVPL Protheus - APL8110401061027

+ // //| Estabelece os padroes para impressao, conforme escolha do usuario + // SetDefault(aReturn,cString) + / //| Verificar se sera reduzido ou normal + / nTipo := Iif(aReturn[4] == 1, 15, 18) + / //| Se teclar ESC, sair + / If nLastKey == 27 Return Endif +/ //| Chama funcao que processa os dados +/ RptStatus({|lEnd| Exerc11Imp(@lEnd) dados..., .T.) Return Static Function Exerc11Imp(lEnd) := 0 Local nTPedido },Aguarde...,Imprimindo os

+ / / //| Selecionar e posicionar na tabela principal + / / dbSelectArea(SZ2) dbSetOrder(1)

Anotaes:

APL8110401061027 - SIGAADVPL Protheus - 105

dbSeek(xFilial(SZ2)+mv_par01,.T.) While !Eof() .And. SZ2->(Z2_FILIAL+Z2_NUMERO) <= xFilial(SZ2)+mv_par02 If lEnd @ Li,000 PSay cCancel Exit Endif + / //| Se o registro estiver fora dos parmetros, ir para o prximo registro + / If SZ2->Z2_CLIENTE < mv_par03 .Or. SZ2->Z2_CLIENTE > mv_par04 dbSkip() Loop Endif + / //| Se o registro estiver fora dos parmetros, ir para o prximo registro + / If SZ2->Z2_EMISSAO < mv_par05 .Or. SZ2->Z2_EMISSAO > mv_par06 dbSkip() Loop Endif If Li > 55 Cabec(Titulo,Cabec1,Cabec2,NomeProg,Tamanho,nTipo) Endif @ Li,001 PSay No. Orcamento: +SZ2->Z2_NUMERO @ Li,024 PSay Cliente: +SZ2->(Z2_CLIENTE+ +Z2_LOJA)+ + P o s i c i o n e ( S A 1 , 1 , x F i l i a l ( S A 1 ) + S Z 2 >(Z2_CLIENTE+Z2_LOJA),A1_NOME)

@ Li,093 PSay Emissao: +Dtoc(SZ2->Z2_EMISSAO) @ Li,113 PSay Validade: +Dtoc(SZ2->Z2_DTVALID)


Anotaes:

106 - SIGAADVPL Protheus - APL8110401061027

Li+=2 dbSelectArea(SZ3) dbSetOrder(1) dbSeek(xFilial(SZ3)+SZ2->Z2_NUMERO) While !Eof() .And. SZ3->Z3_FILIAL+SZ3->Z3_NUMERO == xFilial(SZ3)+SZ2>Z2_NUMERO If lEnd @ Li,000 PSay cCancel Exit Endif If Li > 55 Cabec(Titulo,Cabec1,Cabec2,NomeProg,Tamanho,nTipo) Endif @ Li,001 PSay SZ3->Z3_CODSOFT @ Li,013 PSay SZ3->Z3_ITEM @ Li,021 PSay Posicione(SZ1,1,xFilial(SZ1)+SZ3->Z3_CODSOFT,Z1_NOME) @ Li,077 PSay SZ3->Z3_QUANT PICTURE @E 999,999,999.99 @ Li,097 PSay SZ3->Z3_UNIT nTPedido += SZ3->Z3_VLRTOT Li++ dbSelectArea(SZ3) dbSkip() End @ Li,000 PSay __PrtThinLine() Li++ @ Li,000 PSay Total do Pedido: @ Li,117 PSay nTPedido PICTURE @E 999,999,999.99 nTPedido := 0 Li++ @ Li,000 PSay __PrtThinLine() PICTURE @E 999,999,999.99 @ Li,117 PSay SZ3->Z3_VLRTOT PICTURE @E 999,999,999.99

Anotaes:

APL8110401061027 - SIGAADVPL Protheus - 107

Li+=2 dbSelectArea(SZ2) dbSkip() End dbSelectArea(SZ2) dbSetOrder(1) dbGoTop() dbSelectArea(SZ3) dbSetOrder(1) dbGoTop() If aReturn[5] == 1 Set Printer TO dbCommitAll() Ourspool(wnrel) EndIf Ms_Flush() Return Static Function CriaSx1() Local aHelp := {} aAdd( aHelp , {{Informe o nmero do orcamento inicial} , {} , {}} ) aAdd( aHelp , {{Informe o nmero do oramento final} ) aAdd( aHelp , {{Informe o cdigo do cliente de incio} {}} ) aAdd( aHelp , {{Informe o cdigo do cliente para fim} {}} ) aAdd( aHelp , {{Emitir os oramento a partir da data} {}} ) aAdd( aHelp , {{Emitir os oramento at a data} , {}} )
Anotaes:

, , , , ,

{} , {}} {} , {} , {} , {}

108 - SIGAADVPL Protheus - APL8110401061027

//texto do help portugus PutSx1(cPerg,01,Orcamento

ingls

espanhol

de?,,,mv_ch1,C,06,00,00,;

G,,,,,mv_par01,,,,,,,,,,,,,,,,,; aHelp[1,1],aHelp[1,2],aHelp[1,3],) PutSx1(cPerg,02,Orcamento ate?,,,mv_ch2,C,06,00,00,;

G,,,,,mv_par02,,,,,,,,,,,,,,,,,; aHelp[2,1],aHelp[2,2],aHelp[2,3],) PutSx1(cPerg,03,Cliente de?,,,mv_ch3,C,06,00,00,G,,SA1,;

,,mv_par03,,,,,,,,,,,,,,,,,; aHelp[3,1],aHelp[3,2],aHelp[3,3],) PutSx1(cPerg,04,Clienteate?,,,mv_ch4,C,06,00,00,G,,SA1,; ,,mv_par04,,,,,,,,,,,,,,,,,aHelp[4,1],; aHelp[4,2],aHelp[4,3],) P u t S x 1 ( c P e r g , 0 5 , E de?,,,mv_ch5,D,08,00,00,G,,,,,; m i s s a o

mv_par05,,,,,,,,,,,,,,,,,aHelp[5,1],aHelp[5,2],; aHelp[5,3],) P u t S x 1 ( c P e r g , 0 6 , E m ate?,,,mv_ch6,D,08,00,00,G,,,,,; i s s a o

mv_par06,,,,,,,,,,,,,,,,,aHelp[6,1],aHelp[6,2],; aHelp[6,3],) Return

Anotaes:

APL8110401061027 - SIGAADVPL Protheus - 109

O que voc aprendeu neste captulo


Neste captulo, voc aprendeu a criar Relatrios Personalizados com a utilizao de um ou mais Arquivos Relacionados, atravs de Funes da prpria linguagem.

Prximo

Passo

No prximo captulo, iremos abordar o processo de gerar um cdigo para importao de dados.

Anotaes:

110 - SIGAADVPL Protheus - APL8110401061027

IMPORTAO DE DADOS
O que voc ir aprender neste captulo
Neste captulo, iremos abordar as customizaes feitas pelo IDE, para importar dados para tabelas.

Rotinas
Criando o Programa de Importao;

abordadas

Exerccio 61 Desenvolvendo o programa de importao pelo IDE:


// Analise o arquivo CLIENTES.TXT, em sua base de treinamento

#INCLUDE rwmake.ch User Function ImportCli //Declaracao de Variaveis Private oLeTxt Private cString := SA1 dbSelectArea(SA1) dbSetOrder(1) // Montagem da tela de processamento @ 200,1 TO 380,380 DIALOG oLeTxt TITLE OemToAnsi(Leitura de Arquivo Texto) @ 02,10 TO 080,190 @ 10,018 Say Este programa ira ler o conteudo de um arquivo texto, conforme @ 18,018 Say os parametros definidos pelo usuario, com os registros do arquivo @ 26,018 Say SA1 @ 70,128 BMPBUTTON TYPE 01 ACTION OkLeTxt() @ 70,158 BMPBUTTON TYPE 02 ACTION Close(oLeTxt)
Anotaes:

APL8110401061027 - SIGAADVPL Protheus - 111

Activate Dialog oLeTxt Centered Return //Funo OKLETXT Autor AP8 IDE //Executa a leitura do arquivo texto. //Uso Programa principal Static Function OkLeTxt // Abertura do arquivo texto Private cArqTxt := D:\AP8\SYSTEM\CLIENTES.TXT //Verificar onde o arquivo esta gravado Private nHdl Private cEOL If := fOpen(cArqTxt,68) := CHR(13)+CHR(10) Data 10/02/05 //Descrio Funcao chamada pelo botao OK na tela inicial de processamento

Empty(cEOL) cEOL := CHR(13)+CHR(10)

Else cEOL := Trim(cEOL) cEOL := &cEOL Endif If nHdl == -1 MsgAlert(O arquivo de nome +cArqTxt+ nao pode ser aberto! Verifique os parametros.,Atencao!) Return Endif //Inicializa a regua de processamento Processa({|| RunCont() },Processando...) Return //Funo RUNCONT Autor AP8 IDE Data 10/02/05 //Descrio Funcao auxiliar chamada pela PROCESSA. A funcao PROCESSA //monta a janela com a regua de processamento. //Uso
Anotaes:

Programa principal

112 - SIGAADVPL Protheus - APL8110401061027

Static Function RunCont Local nTamFile, nTamLin, cBuffer, nBtLidos // Lay-Out do arquivo Texto gerado: //Campo // A6_FILIAL // A6_COD // A6_LOJA // A6_NOME Inicio 01 02 03 04 02 06 02 40 1 20 40 1 15 Tamanho

// A6_PESSOA 05 // A6_NREDUZ 06 // A6_END // A6_TIPO // A6_MUN 07 08 09

nTamFile := fSeek(nHdl,0,2) fSeek(nHdl,0,0) nTamLin := 127+Len(cEOL) cBuffer := Space(nTamLin) // Variavel para criacao da linha do registro para leitura nBtLidos := fRead(nHdl,@cBuffer,nTamLin) // Leitura da primeira linha do arquivo texto ProcRegua(nTamFile) // Numero de registros a processar While nBtLidos >= nTamLin // Incrementa a regua IncProc() // Grava os campos obtendo os valores da linha lida do arquivo texto. dbSelectArea(cString) RecLock(cString,.T.) SA1->A1_FILIAL := Substr(cBuffer,01,02) //Identificar a posio do arquivo TXT

Anotaes:

APL8110401061027 - SIGAADVPL Protheus - 113

SA1->A1_COD := Substr(cBuffer,05,07) //Identificar a posio do arquivo TXT SA1->A1_LOJA := Substr(cBuffer,11,15)//Identificar a posio do arquivo TXT SA1->A1_NOME := Substr(cBuffer,22,29) //Identificar a posio do arquivo TXT SA1->A1_NREDUZ := Substr(cBuffer,33,44) //Identificar a posio do arquivo TXT SA1->A1_END:=Substr(cBuffer,33,44) //Identificar a posio do arquivo TXT SA1->A1_TIPO:=Substr(cBuffer,33,44) //Identificar a posio do arquivo TXT SA1->A1_MUN:=Substr(cBuffer,33,44) //Identificar a posio do arquivo TXT SA1->A1_EST:=Substr(cBuffer,33,44) //Identificar a posio do arquivo TXT MSUnLock() //Leitura da proxima linha do arquivo texto. nBtLidos := fRead(nHdl,@cBuffer,nTamLin) // Leitura da proxima linha do arquivo texto dbSkip() EndDo //O arquivo texto deve ser fechado, bem como o dialogo criado na funo anterior fClose(nHdl) //Close(oLeTxt) // Gerado pelo IDE Return

O que voc aprendeu neste captulo


Neste captulo, voc aprendeu a criar Relatrios Personalizados com a utilizao de um ou mais Arquivos Relacionados, atravs de Funes da prpria linguagem.

Prximo

Passo

Neste captulo aprenderemos como devero ser criados os Pontos de Entradas e a implementao dos mesmos, junto as rotinas padres do sistema.

Anotaes:

114 - SIGAADVPL Protheus - APL8110401061027

PONTOS
O que voc ir

DE

ENTRADAS
captulo

aprender

neste

Neste captulo, aprenderemos a criar e implementar Pontos de Entradas, junto as rotinas padres do sistemas.

Rotinas

Abordadas

Ferramentas de Auxlio na implementao de Pontos de Entradas (Quark); Criao de Pontos de Entradas; Implementao de Pontos de Entradas, junto as rotinas padres.

Pontos

de

Entrada

O conceito utilizado para a Criao de um Ponto de Entrada o mesmo da herana adotado nas linguagens para Banco de Dados, ou seja, (Store Procedures). So chamadas de Programas colocadas em pontos estratgicos nas funes padres do sistema e que originalmente no fazem nada. Assim que o desenvolvedor identificar a necessidade de uma interveno nestes pontos, basta criar a rotina, dar a ela o nome especfico citado na documentao do Protheus e compil-la. No momento em que a Rotina Padro for disparada e passar pela customizao do Ponto de Entrada, o mesmo tambm ser executado. Podemos dizer que esta a maneira mais prtica de interveno aos Programas Padres do sistema sem a necessidade de alterao dos mesmos, fazendo com que estas implementaes passem despercebidas pelo usurio no momento de sua execuo. Porm necessrio que saibamos muito bem sobre a Lgica do Programa em questo e at mesmo qual a situao de memria utilizada naquele momento.

Exerccio 62 Como Identificar os Nomes dos Pontos de Entradas: Desenvolva um Ponto de Entrada, para o Cadastro de Clientes, sendo que o mesmo dispare uma Mensagem Padro, aps a Confirmao do Cadastro. Atravs de um Editor de Textos, edite o menu do Mdulo de Faturamento e anote o Nome da Funo, utilizada para o Cadastro de Clientes;

1.

Anotaes:

APL8110401061027 - SIGAADVPL Protheus - 115

2. 3.

Na seqncia, execute a Ferramenta Quark.exe, que se encontra na pasta AP7\Rdmake\Quark; Acesse a opo Pontos de Entrada, pressione as teclas <Alt> + P, selecione a opo Pesquisar por Programa e informe o Nome do Programa, responsvel pelo Cadastro de Clientes; Assim que o sistema posicionar sobre os Pontos de Entrada, disponveis para essa rotina, anote o Nome do Responsvel, pela execuo aps a Incluso do Cliente e saia da Ferramenta Quark.

4.

Obs.: A Ferramenta Quark, utilizada em curso de uso interno da MICROSIGA e pelo suporte externo, para a utilizao deste recurso ser necessrio acessar o site que contm todas as informaes disponibilizadas para clientes e apoio Consultorias no seguinte endereo: WWW.MICROSIGA.COM.BR, acessando o link Utilidades + Quark; importante lembrar que para acess-lo necessrio o uso do SenhaP.

Exerccio 63 Como Criar Pontos de Entrada: 1. 2. Acesse a Ferramenta IDE; Crie o seguinte Programa: #Include "Rwmake.ch" User Function m030inc() MsgBox("O Cliente foi cadastrado com sucesso!") Return 3. Confira os dados e salve o Programa na pasta Rdmake com o mesmo nome dado a Funo, para que fique fcil a sua identificao posteriormente; Compile o Programa e saia da Ferramenta IDE.

4.

Exerccio 64 Como Testar Pontos de Entrada: 1. 2. 3. Acesse o Mdulo de Faturamento; Selecione as seguintes opes Atualizao + Cadastros + Clientes; Clique na opo Incluir e informe os dados a seguir:

Anotaes:

116 - SIGAADVPL Protheus - APL8110401061027

Cdigo: Loja: Nome: N Fantasia: Tipo: Endereo: Municpio: Estado:

000002 01 Cliente 02 Cliente 02 R=Revendedor Avenida Braz Leme, 1399 So Paulo SP

4.

Confira os dados, confirme o cadastro de Clientes e verifique que neste momento o Ponto de Entrada ser disparado, trazendo a mensagem definida no programa; Cancele o prximo cadastro e saia do Mdulo de Faturamento.

5.

Exerccio 65 Como criar outro Ponto de Entrada: Desenvolva um Ponto de Entrada, para o Cadastro de Clientes, sendo que o mesmo dispare uma Mensagem Padro, aps a Excluso de um registro no Cadastro de Clientes. Execute os procedimentos utilizados no exerccio anterior, para identificar o Nome do Ponto de Entrada, que se enquadra nesta customizao; Na seqncia, acesse a Ferramenta IDE e crie o seguinte programa: #Include "Rwmake.ch" User Function m030exc() MsgBox("O Cliente foi excluido com sucesso!") Return 3. 4. Confira os dados, salve o programa na pasta Rdmake, com o mesmo nome dado a Funo, para que fique fcil a sua identificao posteriormente; Compile o Programa e saia da Ferramenta IDE.

1.

2.

Exerccio 66 1. 2. 3.

C omo Testar Pontos de Entradas:

Acesse o Mdulo de Faturamento; Selecione as seguintes opes Atualizao + Cadastros + Clientes; Posicione com o cursor sobre o Cliente 000002, clique na opo Excluir e verifique que neste momento o Ponto de Entrada ser disparado, trazendo a mensagem definida no programa; Confira os dados e abandone o Mdulo de Faturamento.

4.
Anotaes:

APL8110401061027 - SIGAADVPL Protheus - 117

Exerccio 67 Como Criar outro Ponto de Entrada: Desenvolva um Ponto de Entrada para o Cadastro de Produtos, sendo que no momento da Confirmao do Cadastro, a rotina dispare uma Atualizao dos Dados, para o Cadastro de Complementos de Produtos. Execute os procedimentos utilizados no exerccio anterior, para identificar o Nome do Ponto de Entrada, que se enquadra nesta customizao; Na seqncia, acesse a Ferramenta IDE e crie o programa a seguir: #Include "Rwmake.ch" User Function mt010inc() Local aArea := GetArea() If MsgBox("Confirma a Gerao do Complemento",Complemento de Produtos",; "YESNO") DbSelectArea("SB5") If RecLock("SB5",.T.) SB5->B5_FILIAL:= SB1->B1_FILIAL SB5->B5_COD SB5->B5_CEME Else MsgAlert("No EndIf MsUnLock("SB5") EndIf RestArea(aArea) Return 3. 4. Confira os dados, salve o programa na pasta Rdmake, com o mesmo nome dado a Funo, para que fique fcil a sua identificao posteriormente; Compile o Programa e saia da Ferramenta IDE. foi possivel travar o registro!") := SB1->B1_COD := SB1->B1_DESC

1.

2.

Anotaes:

118 - SIGAADVPL Protheus - APL8110401061027

Exerccio 68 Como Testar o Ponto de Entrada: 1. 2. 3. Acesse o Mdulo de Faturamento; Selecione as seguintes opes Atualizao + Cadastros + Produtos; Clique na opo Incluir e informe os dados a seguir:
Cdigo: Descrio: Tipo: Unidade: Armazm Pad.: 000003 PRODUTO 3 PA CX 01

4.

Confira os dados, confirme o cadastro de Produtos e verifique que neste momento o Ponto de Entrada ser disparado, trazendo a mensagem definida no programa; Na seqncia, saia do Cadastro de Produtos, acesse a opo Complem. Produtos e verifique que os Dados do Produto cadastrado anteriormente, foram atualizados tambm neste outro arquivo; Saia do Cadastro de Complemento de Produtos e do Mdulo de Faturamento.

5.

6.

Anotaes:

APL8110401061027 - SIGAADVPL Protheus - 119

FUNES PARA O INTERPRETADOR XBASE / ADVPL


A seguir so apresentadas as funes SIGA MP8 para uso junto ao RD-MAKE / Interpretador xBASE. Na linha seguinte ao nome de cada funo, informado onde normalmente ela utilizada, a saber: Processamento: funes usadas em clculos, acesso a arquivos e tratamentos em geral; Impresso: funes usadas exclusivamente na gerao de relatrios; Telas: funes usadas na gerao de telas, seja DOS ou Windows;

AbreExcl
Tipo: Processamento Fecha o arquivo e reabre exclusivo. Esta funo fecha o arquivo cujo alias est expresso em <cAlias> e reabre-o em modo exclusivo para proceder operaes em que isto necessrio, como por exemplo, PACK. Entretanto, prefervel utilizar o depurador do sistema para proceder estas operaes. Se outra estao estiver usando o arquivo, o retorno ser .F.. Sintaxe AbreExcl(cAlias) Parmetros cAlias Nome do Alias do Arquivo. Deve ter obrigatriamente sua estrutura definida no SX3. Exemplo IF AbreExcl(SI2) Pack ENDIF AbreExcl( ) dbGoTop( )

Anotaes:

120 - SIGAADVPL Protheus - APL8110401061027

Activate

Dialog

Tipo: Tela Windows Ativa uma janela previamente definida na funo Dialog e executa os GETs, botes e outros objetos. Sintaxe ACTIVATE DIALOG cVar <CENTERED> [On Init cFuncInit] [Valid cFuncValid] Parmetros cVar Varivel utilizada na funo Dialog para definio da janela. cFuncInit Funo executada automaticamente na abertura do dilogo na tela (Opcional). cFuncValid Funo executada para validar o fechamento da janela de dilogo. Deve retornar um valor lgico (.T. ou .F.) (Opcional) Comentrios A clusula <CENTERED> opcional, se omitida assume as coordenadas definidas na criao da janela. Exemplo Ver exemplo no programa RDDEMO apresentado no final deste Manual. Ver tambm Funo Dialog

AADD()
Adiciona um novo elemento ao final do Vetor Sintaxe: aAdd(aDestino,expValor) aDestino - Vetor ao qual ser armazenado o valor expValor - Valor Atribuido ao novo Vetor.

AllTrin()
Remove os espaos em branco a direita e esquerda de uma cadeia de caracteres. ALLTRIM(cString) cString - expresso caractere cujos os espaos em branco sero eliminados

Anotaes:

APL8110401061027 - SIGAADVPL Protheus - 121

ASCAN()
Varre um vetor procurando um valor ou at que um bloco retorne verdadeiro (.T.) Sintaxe ASCAN(<aDestino>, <ProcuraExp>, [<nInicio>], [<nCont>]) --> nParouEm Argumentos <aDestino> o vetor a ser varrido. <ProcuraExp> pode ser um valor simples a ser procurado, ou um bloco de cdigo. Caso <ProcuraExp> seja um valor simples, este poder ser do tipo numerico, lgico, data, ou caractere. <nInicio> o elemento a partir do qual ter incio a pesquisa. Se este argumento nao for especificado, a posio inicial padro um. <nCont> a quantidade de elementos que serao varridos a partir da posiao inicial. Caso este argumento nao seja especificado, todos os elementos, desde o elemento inicial at o final do vetor, serao varridos. Retorno ASCAN() retorna um valor numrico que representa a posio ocupada no vetor pelo ltimo elemento varrido. Se <ProcuraExp> for um valor simples, ASCAN() retorna a posio do primeiro elemento que corresponder ao valor procurado, ou zero caso nao haja correspondncia. Se <ProcuraExp> for um bloco de cdigo, ASCAN() retorna a posiao do elemento onde o bloco retornou verdadeiro (.T.).

Aleatorio
Tipo: Processamento Gera um nmero aleatrio de acordo com a semente passada. Esta funo retorna um nmero aleatrio menor ou igual ao primeiro parmetro informado, usando como semente o segundo parmetro. recomendado que esta semente seja sempre o ltimo nmero aleatrio gerado por esta funo. Sintaxe

Anotaes:

122 - SIGAADVPL Protheus - APL8110401061027

Aleatorio(nMax,nSeed) Parmetros nMax Nmero mximo para a gerao do nmero aleatrio nSeed Semente para a gerao do nmero aleatrio Retorna nRet Nmero aleatrio retornado Exemplo // Exemplo do uso da funo Aleatorio: nSeed := 0 For i := 1 to 100 nSeed := Aleatorio(100,nSeed) ? Str(i,3)+ numero aleatorio gerado: +Str(nSeed,3) Next i inkey(0) Return

Avalimp
Tipo: Relatrios Configura a impressora por meio dos parmetros. Esta funo usada em relatrios especficos que no se utilizam da funo Cabec. Imprimindo o retorno desta funo na impressora, ela se encarregar de configurar a impressora de acordo com o arquivo de driver escolhido e com as configuraes escolhidas pelo usurio definidas no array aReturn. Sintaxe AvalImp(nLimit) Parmetros nLimit Tamanho do relatrio em colunas. Pode ser 80, 132 ou 220 (respectivamente para relatrios de tamanho P,M e G). Retorna cControl String com caracteres de controle, dependente das configuraes escolhidas pelo usurio e do arquivo de driver especificado. Exemplo // Exemplo de uso da funo AvalImp: #IFNDEF WINDOWS #DEFINE PSAY SAY #ENDIF cCbTxt:=

Anotaes:

APL8110401061027 - SIGAADVPL Protheus - 123

cCbCont:= nOrdem:= 0 nAlfa:= 0 nZ:= 0 nM:= 0 cTamanho:= G cLimite:= 220 cTitulo:= PADC(Nota Fiscal,74) cDesc1:= PADC(Este programa ir emitir a Nota Fiscal de Entrada/Sada,74) cDesc2:= cDesc3:= PADC(da Feeder Industrial Ltda.,74) cNatureza:= aReturn:= {Especial, 1,Administrao, 1, 2, 2,,1} cNomeProg:= NFEEDER cPerg:= ENTSAI nLastKey:= 0 lContinua:= .T. nLi:= 0 wnrel:= NFEEDER nTamNf:=72 // Apenas Informativo Pergunte(cPerg,.F.) // Pergunta no SX1 cString:=SF2 wnrel:= SetPrint(cString,wnrel,cPerg,cTitulo,cDesc1,cDesc2,cDesc3,.T.) SetDefault(aReturn,cString) If nLastKey == 27 Return Endif #IFDEF WINDOWS RptStatus({|| Execute(Relato)}) Return #ENDIF Function Relato SetPrc(0,0) // Aqui est a chamada da funo AvalImp. Configura a // impressora de acordo com as definies em aReturn // escolhidas pelo usurio na funo SetPrint @ 00,00 PSAY AvalImp(220)

Anotaes:

124 - SIGAADVPL Protheus - APL8110401061027

dbSelectArea(SF2) dbSeek(xFilial()+mv_par01+mv_par03,.T.) // O programa segue normalmente... Return

ALIAS()
Retorna o alias de uma rea de trabalho especificada Sintaxe ALIAS([<nAreaTrabalho>]) --> cAlias Argumentos <nAreaTrabalho> o nmero de qualquer rea de trabalho. Retorno ALIAS() retorna o alias da rea de trabalho especificada na forma de uma cadeia de caracteres. Caso <nAreaTrabalho> nao seja especificada, retornado o alias da rea de trabalho corrente. Se nao houver nenhum arquivo de banco de dados em USo na rea de trabalho especificada, ALIAS() retorna uma cadeia de caracteres nula ("").

Aviso
Tipo: Tela DOS/Windows Monta uma janela exibindo o texto desejado e, opcionalmente, disponibilizando opes de escolha para o usurio. Sintaxe Aviso(cTitulo,cMensagem,aOpcoes) Parmetros cTitulo Titulo da janela. cMensagem Mensagem para ser exibida no interior da janela. O tamanho mximo de 90 caracteres. aOpcoes Array de caracteres com as opes para a montagem de menu (na verso DOS) ou dos botes (na verso Windows). Retorna nResp Retorno. Retorna o nmero da opo escolhida pelo usurio. Exemplo // Exemplo de uso da funo Aviso:

Anotaes:

APL8110401061027 - SIGAADVPL Protheus - 125

While .T. GravaArq() // Funo qualquer (apenas p/exemplo) If !File(TESTE.TXT) aOp:= {Sim,Nao,Cancela} cTit:= Atencao! cMsg:= O arquivo TESTE.TXT nao foi gravado! cMsg:= cMsg + Tenta novamente? nOp:= Aviso(cTit,cMsg,aOp) If nOp == 1 // Sim Loop ElseIf nOp == 3 // Cancela Return Else // Nao ou <ESC> Exit Endif Endif Exit EndDo // Faz o processamento... Return

@ n1,n2 BmpButton
Tipo: Tela Windows Cria um boto de bitmap padro do SigaAdv Win. Sintaxe @ nLinha,nColuna BMPBUTTON TYPE nBotao ACTION cFuncao OBJECT oBtn Parmetros nLinha Nmero da linha superior nColuna Nmero da coluna superior nBotao Nmero do boto padronizado cFuncao Funo que ser executada oBtn Objeto associado ao boto Comentrios Para executar funes definidas em um mesmo .PR? utilizar a funo Execute(Nome da funo) ou ExecBlock(Nome do Arquivo) para chamar outro .PR?. Exemplo Ver exemplo no programa RDDEMO apresentado no final deste Manual.
Anotaes:

126 - SIGAADVPL Protheus - APL8110401061027

@...To...Browse
Tipo: Tela Windows Ativa Browse padro SigaAdv Win. Sintaxe @ nLinha1,nColuna1 TO nLInha2,nColuna2 BROWSE cAlias <ENABLE> cCor Parmetros nLinha1 Nmero da linha superior nColuna1 Nmero da coluna superior nLinha2 Nmero da linha inferior nColuna2 Nmero da coluna inferior cAlias Alias do Arquivo (apenas arquivos com estrutura no SX3) cCor Expresso que identifica a cor da marca do registro (opcional) Exemplo Marca Verde - Titulo em aberto Marca Vermelha - Titulo pago Comentrios A clusula <ENABLE> opcional, se for omitida no ser disponibilizada coluna que identifica situao do registro (Cor verde/vermelha).

@...Button
Tipo: Tela Windows Cria um boto com texto. Sintaxe @ nLinha,nColuna BUTTON cTexto SIZE nAltura,nLargura ACTION cFuno Object oBtn Parmetros nLinha Nmero da linha superior nColuna Nmero da coluna superior cTexto Texto que ser apresentado no boto. Deve incluir um _ antes da letra que utilizada como Hot Key. Ex.: ( _Salvar,Edi_Tar) nAltura Altura do boto nLargura Largura do boto cFuno Funo que ser executada Object oBtn Objeto associado ao boto. Comentrios

Anotaes:

APL8110401061027 - SIGAADVPL Protheus - 127

Para executar funes definidas em um mesmo .PR? utilizar a funo Execute(Nome da funo) ou ExecBlock(Nome do Arquivo) para chamar outro .PR?. Exemplo Ver exemplo no programa RDDEMO apresentado no final deste Manual.

Cabec
Tipo: Impresso Esta funo imprime, na impressora selecionada, o cabealho padro dos relatrios do SIGA MP8. Devolve o nmero da ltima linha impressa para que seja dada continuidade ao relatrio. Sintaxe Cabec(cTtulo, cTexto1, cTexto2, cProg, cLargura, cControle) Parmetros cTtulo Ttulo do Relatrio cTexto1 Extenso da primeira linha do cabealho cTexto2 Extenso da segunda linha do cabealho cProg Nome do Programa cLargura Largura do relatrio (P/ M/ G) cControle Caractere de controle da impressora (numrico) Retorna nLinha Nmero da ltima linha impressa no cabealho Exemplo cTitulo := Relao dos Adiantamentos cCabec1 := Cdigo Item Conta Contbil CCusto Projeto Data Valor c a e2 Cbc: = cPrograma := ATRF090 cTamanho := P nCaracter := 15 cRel:=SetPrint(cAlias, cPrograma , , @cTitulo, cDesc1, cDesc2, cDesc3 , .T., aOrd ) SetDefault(aReturn, cString) nLinha:=Cabec(cTitulo, cCabec1, cCabec2, cPrograma, cTamanho, nCaracter) While !EOF() nLinha:=nLinha+1 @nLinha,1 Say SB1->B1_CODIGO

Anotaes:

128 - SIGAADVPL Protheus - APL8110401061027

CGC
Tipo: Processamento Consiste o CGC digitado, tomando como base o algoritmo nacional para verificao do dgito de controle. Esta funo procede um clculo do dgito verificador do nmero do Cadastro Geral de Contribuintes do Ministrio da Fazenda. utilizado o dgito padro mdulo 11 para verificar se as duas ltimas posies da string passada, correspondem a dgitos verificadores vlidos. Calculando primeiro o dgito das 12 primeiras posies e agregando o dgito encontrado ao fim da string, calcula o dgito das 13 posies, obtendo o segundo dgito. Retorna uma expresso lgica verdadeira se as duas ltimas posies do CGC digitado coincidem com o calculado. Sintaxe CGC(ExpC1) Parmetros ExpC1 String de caracteres representando o nmero do C.G.C. sem pontos e traos separadores. Caso este argumento no seja passado para a funo, esta considerar o GET corrente. Retorna ExpL1 Expresso lgica .T. se o CGC vlido (dgito verificador confere) ou .F. se o dgito verificador no confere. Exemplos cCGC:= Space(14): @10,16 GET cCGC Picture @R 99.999.999/9999-99 Valid CGC(cCGC) A mscara do CGC deve vir com @R, para no inserir os pontos e a barra no CGC, o que impossibilita a validao.

@...CheckBox...Var
Tipo: Tela Windows Cria uma caixa de verificao para definir entre Sim/No ou Falso/Verdadeiro. Sintaxe @ nLinha,nColuna CHECKBOX cDesc VAR lSeleo Object oCbx Parmetros nLinha Nmero da linha superior nColuna Nmero da coluna superior cDesc Descrio da caixa. Ex. Atualiza Estoque ? lSeleo Varivel Lgica que identifica se a caixa foi ou no selecionada oCbx Objeto associado ao Checkbox

Anotaes:

APL8110401061027 - SIGAADVPL Protheus - 129

Retorno A varivel <lSeleo> recebe .T. se for selecionada ou .F., se vazia. Comentrios Pode ser utilizada uma seqncia de CHECKBOX para determinar um conjunto de configuraes onde vrios itens podem ser marcados/desmarcados. Deve ser definida uma varivel <lSeleo> para cada CHECKBOX definida. Ex.: Atualiza Estoque - .T./.F. = Marcada/Desmarcada Gera Duplicata - .T./.F. = Marcada/Desmarcada Calcula IPI - .T./.F. = Marcada/Desmarcada

CTOD()
Converte uma cadeia de caracteres em uma data correspondente Sintaxe CTOD(<cData>) Argumentos <cData> uma cadeia de caracteres que contm nmeros representando o ms, dia, e ano separados por qualquer outro caractere que no um nmero. Os dgitos do ms, dia, e ano devem ser especificados de acordo com o formato indicado pelo SET DATE. Para inicializar uma data vazia para uma entrada de dados, especifique a <cData> como sendo uma cadeia de caracteres nula ( ).

ChkFile
Tipo: Processamento Abre um arquivo do sistema, em modo exclusivo ou compartilhado, verificando a sua existncia bem como dos ndices, criando-os caso no existam. Esta funo retorna verdadeiro (.T.) se o arquivo j estiver aberto ou se o Alias no for informado. Sempre que desejar mudar o modo de acesso do arquivo (de compartilhado para exclusivo ou vice-versa), feche-o antes de cham-la. Sintaxe ChkFile(cAlias,lExcl,newAlias) Parmetros cAlias Alias do arquivo a ser aberto. lExcl Se for informado verdadeiro (.T.), o arquivo ser aberto em modo exclusivo, caso contrrio, o arquivo ser aberto em modo compar-tilhado. Se este parmetro no for informado, ser assumido falso (.F.). newAlis Abre o arquivo com outro apelido. Retorna
Anotaes:

130 - SIGAADVPL Protheus - APL8110401061027

lRet Retorna verdadeiro (.T.) caso tenha conseguido abrir o arquivo e falso (.F.) caso contrrio. Exemplo // Exemplo de uso da funo ChkFile: // Tenta abrir o arquivo de clientes como exclusivo: dbSelectArea(SA1) dbCloseArea() lOk := .T. While .T. IF !ChkFile(SA1,.T.) nResp := Alert(Outro usuario usando! Tenta de novo?,{Sim,Nao}) If nResp == 2 lOk := .F. Exit Endif Endif EndDo If lOk // Faz o processamento com o arquivo... Endif // Finaliza If Select(SA1) dbCloseArea() Endif ChkFile(SA1,.F.) Return

Close
Tipo: Tela Windows Desativa uma janela previamente definida e ativa. Sintaxe Close(cVar) Parmetros cVar Varivel criada durante o comando de definio da janela. Exemplo @ 75,158 BmpButton type 02 Action Close(oDlg)

Anotaes:

APL8110401061027 - SIGAADVPL Protheus - 131

CloseOpen
Tipo: Processamento Funo usada para fechar e abrir uma lista de arquivos. Sintaxe CloseOpen(aFecha,aAbre) Parmetros aFecha Array com a lista dos Aliases a serem fechados. aAbre Array com a lista dos Aliases a serem abertos. Retorna lRet Retorna falso (.F.) se no conseguir abrir algum arquivo (se o arquivo estiver em uso exclusivo, por exemplo). Caso contrrio, retorna verdadeiro (.T.). Exemplo // Exemplo de uso da funcao CloseOpen: aFecha := {SA1,SA2,SA3,SB1} aAbre := {SG1,SH8} If CloseOpen(aFecha,aAbre) .. Processamento Endif Return

ClosesFile
Tipo: Processamento Esta funo fecha todos os arquivos, exceto os SXs, o SM2 e o SM4. Permite que se indique tambm outros arquivos que no devem ser fechados. Sintaxe ClosesFile(cAlias) Parmetros cAlias String com os Aliases dos arquivos que no devem ser fechados. Devem ser informados separados por barras (/) Retorna lRet Retorna Verdadeiro (.T.) se fechou os arquivos com sucesso. Retorna Falso (.F.), caso contrrio. Exemplo // Exemplo de uso da funcao CLOSESFILE: // Fecha todos os arquivos menos os cadastros: cEmp := SM0->M0_CODIGO
Anotaes:

132 - SIGAADVPL Protheus - APL8110401061027

ClosesFile(SA1/SA2/SA3/SA4/SA5/SA6/SA7/SA9/SAA/SAB/SAC) // Processamento. . . // Finalizacao dbCloseAll() OpenFile(cEmp) Return

@...ComboBox...Itens...Size
Tipo: Tela Windows Esta funo semelhante a LISTBOX, mas pode ser utilizada em pequenos espaos, pois os itens s sero mostrados quando a caixa for seleciona. Sintaxe @ nLinha,nColuna COMBOBOX cCont ITENS aArray SIZE nAltura,nLargura Object oCbx Parmetros nLinha Nmero da linha superior nColuna Nmero da coluna superior cCont Contedo caracter do item selecionado na Matriz [1] aArray Array, Matriz [1] com os itens para seleo nAltura Altura para definir o tamanho da caixa nLargura Largura para definir o tamanho da caixa oCbx Objeto relacionado ao boto Retorno O item selecionado pode ser obtido por <cCont> Comentrios Os itens da Matriz [1] devem ser tipo C caracter. Exemplo Ver exemplo no programa RDDEMO apresentado no final deste Manual.

Anotaes:

APL8110401061027 - SIGAADVPL Protheus - 133

ConfirmSX8
Tipo: Processamento Permite a confirmao do nmero sugerido pelo Arquivo de Semforo, atravs da funo GETSX8NUM. Verifique a funo GETSX8NUM para maiores detalhes. Sintaxe ConfirmSx8() Exemplo cNumSC5:=GetSX8Num(SC5) Replace C5_NUM with cNumSC5 ConfirmSX8() Verifique os exemplos descritos na funo GETSX8NUM.

Contar
Tipo: Processamento Conta o nmero de registros de acordo com a condio determinada. Sintaxe Contar(cAlias, cCond) Parmetros cALias Alias do arquivo cCond Condio para a contagem Exemplo Contar(SC1,C1_DATPRF < dDataBase)

CriaTrab
Tipo: Processamento Cria arquivo de trabalho. Sintaxe CriaTrab(aArray,lDbf) Parmetros aArray Array multidimensional contendo os campos a criar {Nome, Tipo, Tamanho, Decimal} lDbf Determina se o arquivo de trabalho deve ser criado ( .T.) ou no (.F. ) Retorna ExpC1 Nome do Arquivo gerado pela funo. Comentrios
Anotaes:

134 - SIGAADVPL Protheus - APL8110401061027

Esta funo retorna o nome de um arquivo de trabalho que ainda no exista. Caso lDbf = .T., a funo criar um arquivo DBF com este nome e a estrutura definida em aArray. Caso lDbf = .F., a funo no criar arquivo de nenhum tipo, apenas fornecer um nome vlido. Exemplos // Com lDbf = .F. cArq := CriaTrab(NIL, .F.) cIndice := C9_AGREG++IndexKey() Index on &cIndice To &cArq // Com lDbf = .T. aStru := {} AADD(aStru,{ MARK , C, 1, 0}) AADD(aStru,{ AGLUT , C, 10, 0}) AADD(aStru,{ NUMOP , C, 10, 0}) AADD(aStru,{ PRODUTO, C, 15, 0}) AADD(aStru,{ QUANT , N, 16, 4}) AADD(aStru,{ ENTREGA, D, 8, 0}) AADD(aStru,{ ENTRAJU, D, 8, 0}) AADD(aStru,{ ORDEM , N, 4, 0}) AADD(aStru,{ GERADO , C, 1, 0}) cArqTrab := CriaTrab(aStru, .T.) USE &cArqTrab ALIAS TRB NEW

CriaVar
Tipo: Processamento Esta funo cria uma varivel, retornando o valor do campo de acordo com o dicionrio de dados. Avalia o inicializador padro e retorna o contedo de acordo com o tipo de dado definido no dicionrio. Sintaxe CriaVar(cCampo,lIniPad,cLado) Parametros cCampo Nome do campo lIniPad Indica se considera (.T.) ou no (.F.) o inicializador cLado Se a varivel for caracter, cLado pode ser: C - centralizado, Lesquerdo ou R - direito Retorna

Anotaes:

APL8110401061027 - SIGAADVPL Protheus - 135

uRet Retorno (tipo de acordo com o dicionrio de dados, considerando inicializador padro) Exemplo // Exemplo do uso da funo CriaVar: cNumNota := CriaVar(F2_DOC) // Retorna o contedo do // inicializador padro, // se existir, ou espaos em branco Alert(cNumNota) Return

DTOS()
Converte um valor data para uma cadeia de caracteres com formato aaaammdd Sintaxe DTOS(<dData>) --> cData Argumentos <dData> o valor data que ser convertido. Retorna DTOS() retorna uma cadeia com oito caracteres no formato, aaaammdd. Quando <dData> for uma data nula (CTOD("")), DTOS() retorna uma cadeia de oito caracteres em branco. O valor de retorno nao afetado pelo formato de data corrente. Descrio DTOS() uma funao de conversao de datas utilizada para criar expressoes de ndice que consistem em um valor data e uma expressao caractere. DTOS() converte um valor data para uma cadeia de caracteres que pode ser concatenada a qualquer outra expressao caractere. O valor de retorno estruturado para preservar a ordem de data (ano, ms, e dia). Exemplos Os exemplos a seguir ilustram DTOS() em conjunto com v rias outras funoes: ? DATE() // Resulta: 09/01/90 ? DTOS(DATE()) // Resulta: 19900901 ? LEN(DTOS(CTOD(""))) // Resulta: 8 DATE() Retorna a data do sistema como sendo um valor do tipo data Sintaxe

Anotaes:

136 - SIGAADVPL Protheus - APL8110401061027

DATE() --> dSistema Retorno DATE() retorna a data do sistema como sendo um valor do tipo data. Descrio DATE() uma funo de tratamento de datas que prov um meio de inicializar vari veis de memria com a data corrente, comparando outros valores do tipo data para a data corrente, e realizando operaes aritmticas relativas data corrente. O formato para a exibio de datas controlado pelo comando SET DATE. O formato padrao assumido mm/dd/aa. Exemplos Os exemplos seguintes mostram a funo DATE() utilizada de varias maneiras: ? DATE() // Resulta: 09/01/90 ? DATE() + 30 // Resulta: 10/01/90 ? DATE() - 30 // Resulta: 08/02/90 dDate = DATE() ? CMONTH(dDate) // Resulta: Setembro

DataValida
Tipo: Processamento Retorna uma data vlida que no seja sbado, domingo ou feriado, a partir de uma data qualquer informada. uma funo til para a gerao de vencimentos reais para ttulos, por exemplo. Sintaxe DataValida(dData) Parametros dData Data informada para validao. Retorna dDtVld Retorna a Data validada. Exemplo // Exemplo de uso da funcao DataValida: // Pode-se gravar o campo do vencimento real de um // titulo a partir do vencimento informado. dVencto := cTod() Get dVencto Read
Anotaes:

APL8110401061027 - SIGAADVPL Protheus - 137

dVencRea := DataValida(dVencto) Grava() // Funcao generica. // Um uso interessante, e a obtencao do numero de dias // uteis de determinado mes utilizando-se dessa funcao. // A logica e simples: nDUtil := 0 nMes := 05 nAno := 98 dDtIni := CTOD(01/+StrZero(nMes,2)+/+StrZero(nAno,2) dDtMov := dDtIni While Month(dDtIni) == Month(dDtMov) .And. Year(dDtIni) == Year(dDtMov) If DataValida(dDtMov) == dDtMov nDUtil := nDUtil + 1 Endif dDtMov := dDtMov + 1 EndDo

@...To...Dialog
Tipo: Tela Windows Define uma nova janela na rea de trabalho. Sintaxe @ nLinha1,nColuna1 TO nLinha2,nColuna2 DIALOG cVar TITLE cTtulo Parmetros nLinha1 Nmero da linha superior nColuna1 Nmero da coluna superior nLinha2 Nmero da linha inferior nColuna2 Nmero da coluna inferior cVar Varivel que recebera as definies da nova janela cTtulo Titulo da Janela Comentrios Deve ser utilizada sem conjunto com o comando ACTIVATE DIALOG. Exemplo Ver exemplo no programa RDDEMO apresentado no final deste Manual.

Anotaes:

138 - SIGAADVPL Protheus - APL8110401061027

ExistChav
Tipo: Processamento Verifica se a chave j existe em determinado Alias. Funo para uso em validaes de campos-chave, para no permitir a duplicidade de registros. Sintaxe ExistChav(cAlias,cChave,nOrdem,cHelp) Parametros cAlias Alias do arquivo no qual a consistncia deve ser avaliada cChave Chave para a pesquisa. Opcional. Se no for informada, o contedo ser automaticamente obtido do GET ativo nOrdem Ordem do ndice para a pesquisa no Alias. Se no for especificado, ser assumida a primeira ordem cHelp Opcional chave de help. Se no for informada, o help ser o padro do sistema (JAGRAVADO) Retorna lRet Retorna Verdadeiro (.T.) se a chave no existir (o que significa que pode ser usada para incluir um novo registro). Caso contrrio, retorna Falso (.F.) e executa um help do sistema. Exemplo // Exemplo de uso da funcao ExistChav: // Pode-se utiliza-la em uma validacao de usuario, // definada atraves do Configurador: // Campo -> B1_COD // Validacao do Usuario -> ExistChav(SB1) // Ou em um AdvPL: While .T. cEsp := Space(15) @ 00,00 Say Cadastro de Especialidades @10,00 Say Espec.: Get cEsp Pict @! Read If LastKey() == 27 Exit Endif If ExistChav(SZ1,cEsp,1,ESPEXIST) Loop Endif Grava() // Rotina generica
Anotaes:

APL8110401061027 - SIGAADVPL Protheus - 139

EndDo Return

EVAL()
Avalia um bloco de cdigo Sintaxe EVAL(<bBloco>, [<ListaArgBloco>]) --> UltValorBloco Argumentos <bBloco> o bloco de cdigo a ser avaliado. <ListaArgBloco> uma lista de argumentos a ser enviada ao bloco de cdigo antes que ele seja avaliado. Retorno EVAL() retorna o valor da ltima expressao dentro do bloco. Um bloco de cdigo pode retornar um valor de qualquer tipo. EOF() Determina se o final do arquivo foi atingido. Sintaxe EOF() Retorna verdadeiro(.T.) Quando feita uma tentativa de mover o ponteiro de resgistros para alm do ltimo registro lgico em um arquivo de banco de dados; do contrrio, ela retorna (.F.). Caso no haja nenhum arquivo de banco de dados aberto na rea de trabalho corrente, EOF() retrona falso(.F.). Se o arquivo de banco de dados corretne no possui registros, EOF() retorna (.T.).

ExistCpo
Tipo: Processamento Verifica se determinada chave existe no Alias especificado. Funo utilizada em processamentos no qual o cdigo informado deve existir em determinado cadastro em sua validao. Sintaxe ExistCpo(cAlias,cChave,nOrdem) Parmetros cAlias Alias do arquivo para a pesquisa cChave Chave a ser pesquisada (opcional). Se no for informada, o conte-do obtido automaticamente do GET em uso nOrdem Nmero da ordem do ndice para Pesquisa (Opcional). Se no for informado,
Anotaes:

140 - SIGAADVPL Protheus - APL8110401061027

usa a ordem atual do Alias. Retorna lRet Retorna Verdadeiro (.T.) se a chave existir no Alias especificado, caso contrrio, retorna Falso (.F.) e executa um help padro do sistema (REGNOIS). A ordem utilizada na pesquisa a atualmente selecionada. Se no for informado, usa a ordem atual do lias. Exemplo // Exemplo de uso da funcao ExistCpo: While .T. cProd := Space(15) @10,10 Get cProd Read If LastKey() == 27 Exit Endif If !ExistCpo(SB1,cProd) Loop Endif Grava() // Funcao generica. EndDo Return

ExistIni
Tipo: Processamento Verifica se o campo possui inicializador padro. Sintaxe ExistIni(cCampo) Parmetros cCampo Nome do campo para verificao. Retorna lEx Retorna Verdadeiro (.V.) se o campo possui inicializador padro, caso contrrio, retorna falso (.F.). Exemplo // Exemplo de uso da funo ExistIni: // Se existir inicializador no campo B1_COD: If ExistIni(B1_COD) // Chama o inicializador:

Anotaes:

APL8110401061027 - SIGAADVPL Protheus - 141

cCod := CriaVar(B1_COD) Endif Return

Extenso
Tipo: Processamento Gera o extenso de um valor numrico. Esta funo retorna um valor, dinheiro ou quantidade, por extenso. Usada para a impresso de cheques, valor de duplicatas etc. Sintaxe Extenso(nValor,lQtd,nMoeda) Parametros nValor Valor a ser gerado o extenso. lQtd Verdadeiro (.T.) indica que o valor representa uma quantidade. Falso (.F.) indica que o valor representa dinheiro. Se no for especificado, o default falso (.F.). nMoeda - Qual moeda do sistema deve ser o extenso. Retorna cValor Retorna o valor por extenso. Exemplo // Exemplo de uso da funcao Extenso: nValor := SF2->F2_VALFAT // Gera o extenso do valor, formatando a variavel com // 200 caracteres preenchendo os espacos em branco com * cExtenso := PADR(Extenso(nValor),200,*) // Imprime o extenso em duas linhas (100 caracteres em cada): For nLi := 20 To 21 @nLi,10 Say Substr(cExtenso,(nLi-20)*100+1,100) Next nLi Return

EMPTY()
Determina se o resultado de uma expressao vazio Sintaxe EMPTY(<exp>) --> lVazio Argumentos

Anotaes:

142 - SIGAADVPL Protheus - APL8110401061027

<exp> uma expressao de qualquer tipo de dados. Retorno EMPTY() retorna verdadeiro (.T.) se a expressao resultar em um valor vazio; do contr rio, ela retorna falso (.F.). Os critrios para determinar se um valor considerado vazio dependem do tipo de dados de <exp> de acordo com as seguintes regras:

FOUND( )
Determina se a operao de pesquisa anterior foi bem sucedida. Sintaxe: FOUND() > lSucesso Retorno FOUND() retorna verdadeiro (.T.) se o ltimo comando de pesquisa foi bem sucedido; do contrrio, ela retorna falso (.F.). FOUND() uma funo de tratamento de banco de dados utilizada para determinar se uma operao de pesquisa (isto , FIND, LOCATE, CONTINUE, SEEK, SET RELATION) foi bem sucedida antes que o prximo passo no programa seja executado. FOUND() > lSucesso Retorno FOUND() retorna verdadeiro (.T.) se o ltimo comando de pesquisa foi bem sucedido; do contrrio, ela retorna falso (.F.). FOUND() uma funo de tratamento de banco de dados utilizada para determinar se uma operao de pesquisa (isto , FIND, LOCATE, CONTINUE, SEEK, SET RELATION) foi bem sucedida antes que o prximo passo no programa seja executado.

FCOUNT()
Retorna a quantidade de campos no arquivo (.dbf) corrente. Sintaxe FCOUNT() --> nCampos Retorno FCOUNT() retorna a quantidade de campos no arquivo de banco de dados aberto na rea de trabalho corrente na forma de um valor numrico inteiro. Caso nao haja nenhum arquivo de banco de dados aberto, FCOUNT() retorna zero. Descrio FCOUNT() uma funo de tratamento de banco de dados. Ela til em aplicaes que contm programas independentes de dados os quais podem operar em qualquer arquivo de banco de dados. Nestes incluem-se programas gerais para importar e exportar dados e programas de relatrios. Normalmente, utiliza-se FCOUNT() para estabelecer o limite superior de um lao FOR...NEXT ou DO WHILE que processa um nico campo por vez.

Anotaes:

APL8110401061027 - SIGAADVPL Protheus - 143

Formula
Tipo: Processamento Interpreta uma frmula cadastrada. Esta funo interpreta uma frmula previamente cadastrada no Arquivo SM4 por meio do ambiente Configurador e retorna o resultado com tipo de dado de acordo com a prpria frmula. Sintaxe Formula(cFormula) Parmetros cFormula Cdigo da frmula cadastrada no SM4. Retorna uRet Retorno, com tipo de dado de acordo com a frmula. Exemplo // Exemplo de uso da funcao formula: // Formula cadastrada no SM4: // Codigo: F01 // Regra : Sao Paulo, +StrZero(Day(dDataBase),2)+ // de +MesExtenso(dDataBase)+ de + // StrZero(Year(dDataBase),4)+. // Ao imprimir esta linha em um programa, por exemplo, @ 00,00 Say Formula(F01) // o resultado impresso sera algo como: // Sao Paulo, 17 de dezembro de 1997. // Formula cadastrada no SM4: // Codigo: F02 // Regra : (GETMV(MV_JUROS)/100)+1 // Ao usar esta formula, pode-se dar um acrescimo em um // valor de acordo com a taxa de juros cadastrada no parametro MV_JUROS: nValor := nValor * Formula(F02)

@...

GET

Tipo: Tela DOS/Windows Executa um Get, diferenciado pela clusula <F3>. Sintaxe @ nLinha,nColuna GET cVar <PICTURE> cMscara <VALID> cFuno <F3> cConsulta Parmetros

Anotaes:

144 - SIGAADVPL Protheus - APL8110401061027

nLinha Nmero da Linha em que o Get ser posicionado nColuna Nmero da Coluna em que o Get ser posicionado cVar Varivel a ser editada cMscara Define a mscara de edio (opcional) cFuno Funo que retorna valor lgico para validao da edio (opcional) cConsulta Definio (SXB) da consulta <F3> associada ao contedo de cVar Comentrios Os cdigos utilizados na clusula <F3> devem ser obtidos por meio do arquivo (SXB). No necessrio utilizar o comando READ aps a definio dos Gets.

GetAdvFval
Tipo: Processamento Esta funo permite executar uma pesquisa em um arquivo pela chave e ordem especificadas, retornando o contedo de um ou mais campos. Sintaxe GetAdvFVal(cAlias,uCpo,uChave,nOrder,uDef) Parmetros cAlias Alias do arquivo. uCpo Nome de um campo ou array contendo os nomes dos campos desejados. uChave Chave para a pesquisa. nOrder Ordem do indice para a pesquisa. uDef Valor ou array default para ser retornado caso a chave no seja encontrada. Retorna uRet Retorna o contedo de um campo ou array com o contedo de vrios campos. Exemplo // Exemplo de uso da funcao GetAdvFVal: // Obtendo apenas de um campo: cChave := SD2->D2_COD+SD2->D2_LOCAL cDesc := GetAdvFVal(SB1,B1_DESC,cChave,1,SC6->C6_DESCRI) // Obtendo o conteudo de mais de um campo: cChave := SD2->D2_COD+SD2->D2_LOCAL aCpos := {B1_DESC,B1_PRV1,B1_UM} aDados := GetAdvFVal(SB1,aCpos,cChave,1,{SC6->C6_DESCRI,SC6->C6_PRCVEN,SC6>C6_UM}) refere-se aos Itens do Pedido de Venda) e, aps pesquisar no SB1 (Cadastro de Produtos), sugerir a quantidade vendida a partir de um campo especfico:

Anotaes:

APL8110401061027 - SIGAADVPL Protheus - 145

// Colunas... nPosCod := aScan(aHeader,{ |x| Upper(AllTrim(x[2])) == C6_PRODUTO }) nPosQtd := aScan(aHeader,{ |x| Upper(AllTrim(x[2])) == C6_QTDVEN }) // Obtm o cdigo do produto cCodigo := aCols[n,nPosCod] // Pesquisa dbSelectArea(SB1) dbSetOrder(1) dbSeek(xFilial(SB1)+cCod) // Altera a quantidade no grid aCols[n,nPosQtd] := SB1->B1_QTSUGER // Campo especfico com a quantidade padro __Return(SB1->B1_QTSUGER) Para uma melhor compreenso, voc pode analisar os programas RDMOD2.PRX e/ou RDMOD3.PRX que acompanham o SIGA MP8. Eles esto no diretrio principal do sistema (geralmente \SIGAADV\) e demonstram rotinas usadas para cadastros semelhantes ao Pedido de Vendas e que trabalham com os arrays mencionados.

GetMV
Tipo: Processamento Recupera o contedo de parmetros originados em SX6. Sintaxe GetMV(cParam) Parmetros cParam Nome do parmetro a ser pesquisado no SX6 Retorna ExpX1 Contedo do parmetro devolvido pela funo Exemplos cTabVista := GETMV(MV_TABVIST) cColICMS := GETMV(MV_COLICMS)

Anotaes:

146 - SIGAADVPL Protheus - APL8110401061027

GetSX8Num
Tipo: Processamento Fornece um nmero seqencial do arquivo de semforo (SX8??0.DBF). Esta funo retorna o prximo nmero, na seqncia e disponvel, para o cadastro no SIGA MP8 e mantm esta numerao para o usurio at o momento em que ele confirme ou abandone a operao. O arquivo de semforo usado para evitar a duplicidade de chaves em ambientes multiusurio. Esta funo trabalha juntamente com outras duas chamadas CONFIRMSX8 e ROLLBACKSX8. Verifique os exemplos para maiores detalhes. Sintaxe GetSx8Num(cAlias,cCpoSx8) Parmetros cAlias Alias do Arquivo cCpoSx8 Nome do campo para aplicao do semforo Exemplo Para que o cadastro de clientes, por exemplo, carregue na incluso o prximo nmero disponvel automaticamente, pode-se utilizar a seguinte sintaxe no inicializador padro do campo A1_COD: GetSx8Num(SA1) Caso seja um arquivo especfico, utilize a sintaxe a seguir: GetSx8Num(SZ1,Z1_COD) Para uso em programas AdvPL, as sintaxes descritas acima tambm so vlidas, no devendo esquecer de que a funo GETSX8NUM trabalha junto com as funes CONFIRMSX8 e ROLLBACKSX8, que devem ser chamadas ao final do processamento (procedimento que feito automaticamente em um inicializador padro conforme a sintaxe explicada acima). Exemplo em AdvPL: cCodNew := GetSx8Num(SZ1,Z1_COD) // Processamento... // Confirmacao ConfirmSx8() // ou Cancelamento RollBackSx8() Return

Anotaes:

APL8110401061027 - SIGAADVPL Protheus - 147

GetArea()
Descrio Grava Caracteres da rea atual (GetArea) em um array. Sintaxe ExpA1 := GetArea() Parmetros ExpA1 = Expresso Array 1 Veja Tambm: RestArea() Tpicos Relacionados: Exemplo de uso da Funo GetArea ExpA1 = GetArea() RestArea(ExpA1)

Help
Tipo: Tela DOS/Windows Esta funo exibe a ajuda especificada para o campo e permite sua edio. Se for um help novo, escreve-se o texto em tempo de execuo. Sintaxe Help(cHelp,nLinha,cTtulo,cNil,cMensagem,nLinMen,nColMen) Parmetros cHelp Nome da Rotina chamadora do help (sempre branco) nLinha Nmero da linha da rotina chamadora (sempre 1) cTtulo Ttulo do help cNil Sempre NIL cMensagem Mensagem adicional ao help nLinMen Nmero de linhas da Mensagem (relativa janela) nColMen Nmero de colunas da Mensagem (relativa janela) Retorna Nada Exemplos If Empty(cArqs) dbSelectArea(cAlias) RecLock(cAlias,.F.) dbDelete()

Anotaes:

148 - SIGAADVPL Protheus - APL8110401061027

Else Help( Endif

,1,NaoExclui,,cArqs,4,1)

ImpCadast
Tipo: Impresso Imprime relatrio de cadastros padres do SIGA MP8. Esta funo monta uma interface padro de relatrio com parametrizaes de/at e permite imprimir qualquer arquivo de cadastro definido no sistema. Sintaxe ImpCadast(cCab1,cCab2,cCab3,cNomePrg,cTam,nLim,cAlias) Parmetros cCab1 Primeira linha de cabealho cCab2 Segunda linha de cabealho cCab3 Terceira linha de cabealho cNomePrg Nome do programa cTam Tamanho do relatrio (P,M ou G) nLim Limite do relatrio. Mxima coluna a ser impressa cAlias Alias do arquivo de cadastro a ser impresso Exemplo // Exemplo de uso da funcao Impcadast: // Imprime relatorio de cadastro de produtos: ImpCadast(Cabec1,Cabec2,Cabec3,PRG01,P,80,SB1) Return

IncRegua
Tipo: Impresso Incrementa rgua padro de processamento em relatrios. Sintaxe IncRegua() Parmetros Nil Retorno

Anotaes:

APL8110401061027 - SIGAADVPL Protheus - 149

Nil Exemplo DbSelectArea(SA1) SetRegua(LastRec()) While ( ! Eof() ) @ Li, 001 PSAY SA1->A1_NOME DbSkip() IncRegua() End Comentrio Ver tambm SetRegua()

IncProc
Tipo: Tela DOS/Windows Incrementa rgua padro de processamento. Sintaxe IncProc() Parmetros Nil Retorno Nil Exemplo ProcRegua(1000) For i:= 1 to 1000 IncProc() Next Return

INDEXORD()
Retorna a posio de ordem do ndice controlador Sintaxe INDEXORD() --> nOrdem Retorno INDEXORD() retorna um valor numrico inteiro. O valor retornado igual posio do ndice controlador na lista de ndices abertos na area de trabalho corrente. Um valor de zero indica que nao h ndice
Anotaes:

150 - SIGAADVPL Protheus - APL8110401061027

controlador e que os registros estao sendo acessados em ordem natural. Descrio INDEXORD() uma funao de tratamento de banco de dados, que pode ser utilizada para determinar a posiao do ndice controlador na lista de arquivos de ndices abertos pelo ltimo comando USE...INDEX ou SET INDEX TO na rea de trabalho corrente. Geralmente til para gravar o ltimo ndice controlador para que ele possa ser recuperado depois.

IndRegua
Tipo: Processamento Cria ndice de trabalho, podendo ser condicional. Sintaxe IndRegua(cAlias,cArqtrab,cChave,cPar,cFiltro,cTexto) Parmetros cAlias Alias do arquivo. cArqtrab Nome do arquivo de trabalho retornado pela funo CriaTrab (.F.). cChave Expresso utilizada na chave do novo ndice. cPar Se for igual a D, cria um indice com a chave inversa, do maior valor para o menor. cFiltro Expresso utilizada para filtro. cTexto Texto da rgua de processamento ( Selecionando registros ...). RetornoNil Exemplo DbSelectArea(SC5) cFiltro := C5_OK<>X cChave := Dtos(C5_EMISSAO)+C5_VEND1 cIndSC51 := CriaTrab(Nil,.F.) IndRegua(SC5, cIndSC51, cChave, , cFiltro, Selecionando Pedidos...)

LEN()
Retorna o tamanho Sintaxe LEN(<cString> Argumentos <cString> a <aDestino> de um string ou a quantidade de elementos em um vetor | <aDestino>) --> nCont cadeia de caracteres cujo tamanho ser medido. o vetor cujos elementos serao contados.

Anotaes:

APL8110401061027 - SIGAADVPL Protheus - 151

Retorno LEN() retorna o tamanho de uma cadeia de caracteres ou a quantidade de elementos em um vetor na forma de um valor numrico inteiro. Caso a cadeia de caracteres seja nula ("") ou o vetor esteja vazio, LEN() retorna zero.

LetterOrNum
Tipo: Processamento Verifica se determinado caractere uma letra ou um nmero. Sintaxe LetterOrNum(cChar) Parmetros cChar Caracter para verificao. Retorna lAlfa Retorna Verdadeiro (.V.) se o caracter informado for uma letra ou um nmero. Exemplo // Exemplo de uso da funcao LetterOrNum: cCh := Inkey(0) If LetterOrNum(cCh) ... Processamento Endif Return

MarkBrowse
Tipo: Processamento Monta um browse padro do sistema, permitindo marcar e desmacar linhas. Sintaxe MarkBrowse(cAlias,cCampo,cCpo,aCampos,lMarc,cMarca,cCtrlM,lBotoes,cTopFun,cBotFun,aCoord) Parmetros cAlias Alias do arquivo cCampo Campo que estabelece relao com a culuna de marca cCpo Campo que se estiver vazio muda a cor da linha aCampos Array com os campos para montar o browse lMarc Flag para inicializar marcado ou no cMarca Marca obtida com a funo Getmark

Anotaes:

152 - SIGAADVPL Protheus - APL8110401061027

cCtrlM Funo para ser executada no Alt_M lBotoes Parmetro obsoleto cTopFun Funo filtro para estabelecer o primeiro registro cTopFun Funo filtro para estabelecer o ltimo registro aCoord Array com as coordenadas da MarkBrowse. Exemplo cMarca := GetMark() cCadastro := Escolher Clientes aRotina := { { Pesquisar,AxPesqui,0,1}, ; {Visualizar,AxVisual,0,2}} MarkBrow(SA1,A1_OK,SA1->A1_OK,,,cMarca)

MBrowse
Tipo: Processamento Monta um browse padro do sistema, conforme os parmetros. Sintaxe mBrowse(nLinha1, nColuna1, nLinha2, nColuna2, cAlias, aFixe, cCpo, nPar, cCor, n Opc) Parmetros nLinha1 Nmero da linha inicial nColuna1 Nmero da coluna inicial nLinha2 Nmero da linha final nColuna2 Nmero da coluna final cAlias Alias do arquivo aFixe Array contendo os campos fixos (a serem mostrados em primeiro lugar no browse) cCpo Campo a ser tratado. Quando vazio, muda a cor da linha nPar Parmetro obsoleto cCor Funo que retorna um valor lgico, muda a cor da linha nOpc Define qual opo do aRotina que ser utilizada no double click MBrowse(6, 1, 22, 75, SA1)

MesExtenso
Tipo: Processamento Retorna o nome do ms por extenso. Sintaxe
Anotaes:

APL8110401061027 - SIGAADVPL Protheus - 153

MesExtenso(nMes) Parmetros nMes Nmero do ms (1 a 12). Se nMes no for informado, assumido o ms da data base do sistema. Esta varivel tambm pode ser caracter (1 ou 2) ou do tipo data. Retorna cNome Nome do ms retornado por extenso. Exemplo // Exemplo do uso da funcao MesExtenso: ? Sao Paulo, +STRZERO(Day(dDataBase),2)+ de +; MesExtenso(dDataBase)+ de +StrZero(Year(dDataBase),4)

Modelo2
Tipo: Processamento Exibe formulrio para cadastro segundo o modelo 2 (como a rotina de Nota Fiscal). Sintaxe M o d e l o 2 (c T t u l o ,a C a b e c ,a R o d a p ,a G d ,n O p ,c L O k ,c T O k , [aGetsGD,bF4,cIniCpos,nMax,aCordw,lDelget]) Parmetros cTtulo Ttulo da janela aCabec Array com os campos do cabealho aRodap Array com os campos do rodap aGd Array com as posies para edio dos itens (GETDADOS) nOp Modo de operao (3 ou 4 altera e inclui itens, 6 altera mas no inclui itens, qualquer outro nmero s visualiza os itens) cLOk Funo para validao da linha cTOk Funo para validao de todos os dados (na confirmao) aGetsGD Array Gets editveis (GetDados) Default = Todos. bF4 Codeblock a ser atribudo a tecla F4. Default = Nenhum. cIniCpos String com o nome dos campos que devem ser inicializados ao teclar seta para baixo (GetDados). nMAx Limita o nmero de linhas (GetDados). Default = 99. aCordw Array com quatro elementos numricos, correspondendo s coor-denadas linha superior, coluna esquerda, linha interior e coluna

Anotaes:

154 - SIGAADVPL Protheus - APL8110401061027

direita, definindo a rea de tela a ser usada. Default = rea de Dados Livre. lDelget Determina se as linhas podem ser deletadas ou no (GetDados) Default = .T. Retorna lRet Retorna .T. se for confirmado lRet:=Modelo2(cTitulo,aC,aR,aCGD,nOpcx,cLinhaOk,cTudoOk)

Modelo3
Sintaxe Modelo3(cTitulo,cAliasEnchoice,cAliasGetD,aCpoEnchoice,cLinOk,cTudOk,nOpcE,nOpcG,cFieldOk, [lVirtual,nLinhas,aAltEnchoice]) Parmetros cTitulo Ttulo da janela cAliasEnchoice lias do cabealho cAliasGetd lias dos itens aCpoEnchoice Array com os campos que sero mostrados cLinOk Funo para validar a mudana de linha nos itens. cTudOk Funo para validar todos os itens. nOpce Nmero da opo do menu para o cabealho (Enchoice) nOpcG Nmero da opo do menu para o itens (GetDados) cFieldOk Funo para validar os campos dos itens (GetDados) lVirtual Permite visualizar campos virtuais na enchoice. Default = .F. nLinhas Limita o nmero mximo de linhas (GetDados) Default = 99. aAltEnchoice Array com campos alterveis (Enchoice) Default = Todos. Retorna lRet Retorno da funo modelo3. Se True a operao foi confirmada. _lRet:=Modelo3(cTitulo,cAliasEnchoice,cAliasGetD,aCpoEnchoice,cLinOk,cTudOk,nOpcE,nOpcG,cFieldOk)

MontaF3
Tipo: Processamento Permite o acesso janela de consultas padronizadas (criadas no SXB) por meio de um GET usando a tecla F3.
Anotaes:

APL8110401061027 - SIGAADVPL Protheus - 155

Sintaxe MontaF3(cAlias) Parmetros cAlias Alias do arquivo ou cdigo de tabela para consulta. Se no informado, desabilita a tecla F3. Exemplo // Exemplo de uso da funcao MontaF3: // Versao DOS cCod := Space(15) @02,50 Say Digite o codigo: Get cCod Picture @! ; When MontaF3(SB1) Valid(MontaF3()) Read Return // *************************** // Versao WINDOWS // Use a propria clausula do comando get: @ 250,250 To 360,450 Dialog oDlg Title Teste @ 02,50 Get cCod Picture @! F3 SB1 Activate Dialog oDlg Centered Return

MsgBox
Tipo: Tela Windows Abre uma caixa de dilogo padronizada para informar ao usurio de um erro, deciso a ser tomada ou apenas uma informao (Registro Gravado com sucesso). Sintaxe MSGBOX(cMensagem,cTtulo,cTpCaixa) Parmetros cMensagem Define a mensagem apresentada no interior da janela cTtulo Titulo da janela cTpCaixa Tipo da caixa padronizada Retorno Retorna Nil ou um valor lgico (.T. ou .F.) conforme o tipo de caixa. Comentrios As caixas assumem o tamanho de <cMensagem>. Tipos de caixas:

Anotaes:

156 - SIGAADVPL Protheus - APL8110401061027

STOP, utiliza um bitmap para advertncia e tem um boto Ok. Retorna Nil. INFO, utiliza um bitmap para advertncia e tem um boto Ok. Retorna Nil. ALERT, utiliza um bitmap para advertncia e tem um boto Ok. Retorna Nil. YESNO, utiliza um bitmap para advertncia e tem dois botes Sim e No, retorna .T. ou .F. RETRYCANCEL, utiliza um bitmap para advertncia e tem dois botes Repetir e Cancelar, retorna .T. ou .F.

MsUnLock()
Libera lock de registro. Sintaxe MsUnLock() Descrio A funo MsUnlock() libera os registros bloqueados pela funo RecLock(). No retorna valores. Exemplo RecLock( XXX ,.F. ) Replace Campo With 000001 MsUnLock()

@..To...MultiLine
Tipo: Tela Windows Ativa Browse para edio de mltiplos itens padro SigaAdv Win (GetDados Itens SC6). Sintaxe @ nLinha1,nColuna1 TO nLinha2,nColuna2 MULTILINE <<MODIFY>> <<DELETE>> <<VALID>> cFuno <<FREEZE>> nColuna Parmetros nLinha1 Nmero da linha superior nColuna1 Nmero da coluna superior nLinha2 Nmero da linha inferior nColuna2 Nmero da coluna inferior cFuno Funo a ser executada para validar mudana de linha <opcional> nColuna Nmero de colunas Congeladas esquerda <opcional> Comentrios As clusulas opcionais permitidas controlam as alteraes, excluses e validaes

Anotaes:

APL8110401061027 - SIGAADVPL Protheus - 157

nas mudanas de linha e congelamento de colunas, respectivamente. Devem ser criadas obrigatoriamente as matrizes aHeader [n][n] e aCols[n][n] antes da definio da MULTILINE, sendo que aHeader [n][n] contm informaes sobre os campos que sero editados (SX3) e aCols [n][n] contm os dados referentes aos campos que sero editados.

NaoVazio
Tipo: Processamento Verifica se o campo no est vazio. Sintaxe NaoVazio(cCpo) Parmetros cCpo Campo a verificar Retorna ExpL1 Valor Lgico de Retorno (.T. ou .F.) Exemplos @ 5,10 Get cCodigo Valid NaoVazio(cCodigo)

Ms_Flush()
Descarrega spool de impresso. Sintaxe Ms_Flush() Descrio Aps os comandos de impresso as informaes ficam armazenadas no spool e so descarrega em seus destinos atravs da funo Ms_Flush().

Negativo
Tipo: Processamento Verifica se negativo. Sintaxe Negativo(nCpo) Parmetros nCpo Campo a verificar Retorna ExpL1 Se o valor de nCpo for menor que 0, retornado .T., caso contrrio ser

Anotaes:

158 - SIGAADVPL Protheus - APL8110401061027

retornado .F.. Exemplos If Negativo (nValTitulo) @ 5,10 Say Valor invalido Loop EndIf

OpenFile
Tipo: Processamento a funo que exibe o diagnstico de arquivos, verificando a existncia dos arquivos de dados e dos ndices do sistema, criando-os caso no existam, etc. Abre os arquivos de acordo com o ambiente onde executada ou de acordo com a parametrizao. Sintaxe OpenFile(cEmp) Parmetros cEmp Cdigo da empresa que deve ser aberta. Exemplo // Exemplo de uso da funcao openfile: cEmp := SM0->M0_CODIGO // Elimina os indices de todos os arquivos abertos no // SX2 para reindexacao dbSelectArea(SX2) dbGoTop() While !EOF() If Select(SX2->X2_CHAVE) > 0 dbSelectArea(SX2->X2_CHAVE) dbCloseArea() cEsp := AllTrim(SX2->X2_PATH) cEsp := cEsp + AllTrim(SX2->X2_ARQUIVO) + * + RetIndExt() fErase(cEsp) Endif dbSelectArea(SX2)

Anotaes:

APL8110401061027 - SIGAADVPL Protheus - 159

dbSkip() EndDo dbCloseAll() // Fecha todos os arquivos OpenFile(cEmp) // Abre os arquivos (reindexa) Return Parmetro cEmp apenas no Windows.

OurSpool
Tipo: Impresso Abre a tela do gerenciador de impresso do sistema. O gerenciador mostra os relatrios impressos em disco gravados no diretrio definido por meio do parmetro MV_RELATO. Sintaxe OurSpool(cArq) Parmetros cArq Nome do arquivo. Este parmetro opcional, se informado, o gerenciador de impresso j aberto neste arquivo. Exemplo // Exemplo de uso da funcao ourspool: // Ativa o gerenciador de impressao: OurSpool() // Para verificar o uso desta funcao em relatorios, // verifique o exemplo da funcao AVALIMP. Return

Obrigatorio
Descrio Verifica se todos os campos obrigatrios foram digitados. Sintaxe ExpL1 := Obrigatorio(aGets,aTela,tObg) Parmetros aGets = Retorna .F. se algum campo obrigatrio est vazio aTela = Array com os campos a serem verificados tObg = Array com os ttulos da tela Tpicos Relacionados: Exemplo de uso da Funo Obrigatorio

Anotaes:

160 - SIGAADVPL Protheus - APL8110401061027

Pergunte
Tipo: Impresso Esta funo permite acessar e editar um grupo de perguntas do arquivo SX1. Mostra uma tela contendo as perguntas gravadas em SX1 a serem respondidas ou confirmadas pelo usurio. Sintaxe Pergunte(cGrupo, lVar) Parmetros cGrupo Nome do Grupo de perguntas. lVar .F. - devolve o contedo das variveis, no apresentando a janela de perguntas; .T. - permite a alterao das variveis, apresentando a janela. Retorna ExpL1 .T. se o grupo de perguntas existe. Exemplos pergunte(AFR090,.T.) // Variveis utilizadas na pergunta // mv_par01 a partir da data // mv_par02 at a data // mv_par03 da conta // mv_par04 at a conta // mv_par05 do centro de custo // mv_par06 at o centro de custo // mv_par07 do cdigo // mv_par08 at o cdigo // mv_par09 do projeto // mv_par10 at o projeto // mv_par11 moeda

Pertence
Tipo: Processamento Verifica se o campo est contido em outro. Sintaxe Pertence(cString,cCampo) Parmetros cString String que deve estar contida no cCampo

Anotaes:

APL8110401061027 - SIGAADVPL Protheus - 161

cCampo Campo a verificar Retorna ExpL1 Valor Lgico de Retorno (.T. ou .F.) Exemplo SetCursor(1) @ 09,19 Get cTipo Picture @! Valid Pertence(CL\VD\PD,cTipo)

PesqPict
Tipo: Processamento Pesquisa, no dicionrio de dados, qual a picture usada em um determinado campo, seja para a edio em tela ou para a impresso de relatrios. Sintaxe PesqPict(cAlias,cCampo,nTam) Parmetros cAlias Alias do arquivo cCampo Nome do campo nTam Opcional, para campos numricos, ser usado como o tamanho do campo para definio da picture. Se no informado, e usado o tamanho padro no dicionrio de dados. Retorna cPic Picture do campo Exemplo // Exemplo de uso da funcao PesqPict // Em um relatorio pode-se usar a sintaxe abaixo para // formatacao automatica de acordo com o dicionario de // dados: @ nLin,20 Say Total: @ nLin,27 Say SF2->F2_VALBRUT Picture PesqPict(SF2,F2_VALBRUT) // ... Return

PesqPictQt
Tipo: Processamento Devolve a picture de um campo de quantidade, de acordo com o dicionrio de dados. Esta funo geralmente utilizada quando h pouco espao disponvel para impresso de valores em relatrios, quando o valor nEdio no informado.

Anotaes:

162 - SIGAADVPL Protheus - APL8110401061027

Ela tem o comportamento semelhante ao da funo X3Picture, pois busca o tamanho do campo no dicionrio de dados. Sintaxe PesqPictQt(cCampo,nEdio) Parmetros cCampo Nome do campo a verificar a picture nEdio Espao disponvel para edio Retorna ExpC Picture ideal para o espao definido por nEdio, sem a separao dos milhares por vrgula Exemplo @ 8,10 Say SB2->B2_QATU Picture PesqPictQt (B2_QATU,8)

Posicione
Tipo: Processamento Posiciona o arquivo em um determinado registro. Sintaxe Posicione(cAlias, nOrdem, cChave, cCampo) Parmetros cAlias Alias do arquivo nOrdem Ordem utilizada cChave Chave pesquisa cCampo Campo a ser retornado Retorna Retorna o contedo do campo passado com o permetro. Exemplo Posicione(SA1,1,xFilial(SA1)+001,A1_NOME)

Positivo
Tipo: Processamento Verifica se positivo. Sintaxe Positivo(nCampo) Parmetros nCampo Campo a verificar

Anotaes:

APL8110401061027 - SIGAADVPL Protheus - 163

Retorna ExpL1 Valor Lgico de Retorno (.T. ou .F.) Comentrios Se cCampo for maior ou igual ( >= ) a zero a funo retorna .T. Caso contrrio retorna .F. Exemplo @ 09,07 Get nValor Picture 999999 Valid Positivo ( nValor )

PswAdmin( )
Verifica se um usurio Administrador. Sintaxe PswAdmin( cUsuario, cSenha ) Argumento O b r i g a t . Tipo Descrio cUsuario Sim C Nome do usurio. cSenha Sim C Senha do usurio. Descrio Esta funo retorna um valor lgico, se for usurio administrador verdadeiro (.T.), caso contrrio falso (.F.). Exemplo User Function <nome-da-funo>( cUsuario, cSenha ) Local lAdminst := .F. If PswAdmin( cUsuario, cSenha ) lAdminst := .T. Else APMsgInfo( Usurio no Administrador ! ) EndIf Return lAdminst

ProcRegua
Tipo: Tela DOS/Windows Inicializa rgua padro de processamento. Sintaxe ProcRegua(nRegs,nLinha,nColuna) Parmetros nRegs Nmero de registros que sero processados.

Anotaes:

164 - SIGAADVPL Protheus - APL8110401061027

nLinha Nmero da Linha da rgua nColuna Nmero da Coluna da rgua Retorna Nil Exemplo ProcRegua(1000) For i:= 1 to 1000 IncProc() Next Return No programa para Windows a ProcRegua s utiliza o primeiro parmetro. No programa para DOS so utilizados os trs parmetros. = Ver tambm IncProc()

ProxReg
Tipo: Processamento Retorna o ltimo registro incrementado. Esta funo retorna um valor, numrico ou caracter, contendo o prximo nmero a partir do ltimo registro encontrado. O campo que levado em considerao aquele que se encontra posicionado no SX3 (dicionrio de dados). Pode ser usada para obter os prximos valores para campos dos tipos: Caracter, Numrico e Data. Sintaxe ProxReg(nInc,nPos,nIndice) Parmetros nInc Valor a incrementar nPos Tamanho nndice Nmero do ndice a ser utilizado Retorna uRet Prximo nmero (ltimo registro incrementado) Exemplo // Exemplo de uso da funo ProxReg: dbSelectArea(SX3) dbSetOrder(2) dbSeek(A1_COD) dbSelectArea(SA1) cProx := ProxReg(1,6,1) // Retorna o possvel prximo

Anotaes:

APL8110401061027 - SIGAADVPL Protheus - 165

// cdigo para o cadastro de // cliente dbSelectArea(SX3) dbSeek(D2_NUMSEQ) dbSelectArea(SD2) nProx := ProxReg(1,,4) // Retorna o proximo nmero // seqencial Return

Processa()
Cria dilogo com uma rgua de progresso. Sintaxe Processa( bAcao, [cTitulo] , [cMsg], [lAborta] ) Argumento O b r i g a t . Tipo Descrio cAcao Sim Cdigo de bloco Funo a ser executada. cMsg No C Mensagem a ser exibida a baixo da rgua de progresso l A b o r t a No L Habilita boto cancelar. c T i t u l o No C Ttulo de janela Descrio A funo Processa() cria um dilogo onde a execuo de um determinada funo pode ser acompanhada atrves de uma rgua de progresso. Para atribuir o valor total da rgua utilizamos a funo ProcRegua() e para incrementar a rgua utilizamos a funo IncProc(). Exemplo User Function <nome-da-funo>( ) Local bAcao := {|lFim| Exemplo(@lFim) } Local cTitulo := Local cMsg := Processando Local lAborta := .T. Processa( bAcao, cTitulo, cMsg, lAborta ) Return Static Function Exemplo(lFim) Local nI ProcRegua(10000) For nI := 1 To 10000 If lFim Exit

Anotaes:

166 - SIGAADVPL Protheus - APL8110401061027

EndIf IncProc() Next nI Return

@...Radio
Tipo: Tela Windows Cria uma caixa de seleo semelhante a CHECKBOX. Todos os itens so Apresentados, mas apenas um pode ser selecionado. Sintaxe @ nLinha,nColuna RADIO aArray VAR nPos Object oRdx Parmetros nLinha Nmero da linha superior nColuna Nmero da coluna superior aArray Matriz [1] com os Itens nPos Contm a posio na Matriz[1] do item selecionado oRdx Objeto associado Radiobox() Retorno O item selecionado pode ser obtido por - Matriz [n3] Comentrios Os itens da Matriz [1] devem ser do tipo C caracter. Pode ser utilizada para definir uma caracterstica em um conjunto. Ex.Tipo da Condio de pagamento Tipo 1 Tipo 2 Tipo 3

RecLock
Tipo: Processamento Tenta efetuar um lock no registro do banco de dados informado. Sintaxe RecLock(cAlias,lAdiciona) Parmetros cAlias Alias do Banco de Dados lAdiciona .T. adiciona registro ao Banco de Dados Retorna ExpL1 Valor Lgico de Retorno (.T. ou .F.)
Anotaes:

APL8110401061027 - SIGAADVPL Protheus - 167

Comentrios Esta funo tenta colocar o registro corrente do arquivo cAlias em lock. necessrio colocar um registro em lock sempre que for efetuar uma atualizao, como um comando Replace ou um Delete. Caso lAdiciona = .T., a funo RecLock inclui (com um Append Blank) um registro no arquivo cAlias. Se a operao for bem sucedida, retorna .T. Exemplo // Excluso de Registro // Com lAdiciona = .F. If ! RecLock(SF1,.F.) @ 1,1 Say Registro em uso por outra estao Loop EndIf dbDelete() dbUnLock() Com ExpL2 = .T. // Incluso de Registro RecLock(SF1,.T.) Replace F1_TIPO With cTipo, F1_DOC With cNFiscal,; F1_SERIE With cSerie ,F1_EMISSAO With dDEmissao,; F1_LOJA With cLoja ,F1_FORNECE With Subs(cA100For,1,6) dbUnLock() Aps a atualizao do registro, deve-se executar a funo MsUnlock().

RollBackSX8
Descrio Retorna o nmero obtido pela funo GetSX8Num no semforo como pendente. Verifique a funo GetSX8Num para maiores detalhes. Sintaxe RollBackSx8() Parmetros Veja Tambm: GetSX8Num Tpicos Relacionados: Exemplo de uso da Funo RollBackSX8

Anotaes:

168 - SIGAADVPL Protheus - APL8110401061027

RestArea
Tipo: Processamento Restaura a rea RestArea a partir do array. Sintaxe RestArea(aArray) Parmetros aArray Expresso Array para restaurao Exemplo aArray:=GetArea() RestArea(aArray) Ver tambm Funo GetArea( )

RetASC
Tipo: Processamento Retorna um cdigo de letras quando ultrapassar o nmero mximo de dgitos. Sintaxe RetAsc(cOri,nTam,lAlfa) Parmetros cOri String original a ser convertida. nTam Tamanho mximo para a converso. lAlfa Indica se o retorno deve conter letras (.T.) ou somente nmeros (.F.) Retorna cStr Retorna a String formada com letras ou nmeros. Exemplo

Anotaes:

APL8110401061027 - SIGAADVPL Protheus - 169

// Exemplo de uso da funcao RetAsc: // Suponha a existencia de um campo caracter de tamanho // 2. Usando a funcao RetAsc com o parametro lAlfa ver// dadeiro (.T.) se o numero ultrapassar 99 retornara A0 cCod := StrZero(ProxReg(1,2,1),2) // Se ultrapassar 99 retorna A0 cCod := RetAsc(cCod,2,.T.) __Return(cCod)

RetIndex
Tipo: Processamento Devolve os ndices padres do SIGA. Sintaxe RetIndex(cAlias) Parmetros cAlias Alias do Arquivo Retorna Nmero ndices existentes no SINDEX Comentrios Baseado no SINDEX, abre todos os ndices padres para o arquivo em pauta. Exemplo Select SA1 Index on A1_ACUM to TRAB SINDEX := RetIndex (SA1) RollBackSX8 Tipo: Processamento Retorna o nmero obtido pela funo GETSX8NUM no semforo como pendente. Verifique a funo GETSX8NUM para maiores detalhes. Sintaxe RollBackSx8() Exemplo Verifique os exemplos na funo GETSX8NUM.

RECNO()
Retorna o nmero do registro corrente de uma rea de trabalho

Anotaes:

170 - SIGAADVPL Protheus - APL8110401061027

Sintaxe RECNO() --> nRegistro Retorno RECNO() retorna o nmero do registro corrente na forma de um valor numrico inteiro. Se a rea de trabalho contm um arquivo de banco de dados com zero registros, RECNO() retorna um, BOF() e EOF() retornam verdadeiro (.T.), e LASTREC() retorna zero. Se o ponteiro de registros for movido para alm do ltimo registro, RECNO() retorna LASTREC() + 1 e EOF() retorna verdadeiro (.T.). Caso seja feita uma tentativa para mover o ponteiro alm do primeiro registro, RECNO() retorna o nmero do primeiro registro lgico no arquivo de banco de dados, e BOF() retorna verdadeiro (.T.).

RptStatus
Tipo: Processamento (Apenas Windows) Executa funo de detalhe do relatrio. Sintaxe RptStatus(bBlock) => RptStatus(bBlock, cTtulo, cMsg) Parmetros bBlock Bloco de cdigo que define a funo a ser executada. cTtulo Ttulo do dilogo de processamento. cMsg Mensagem do dilogo de processamento. Comentrios Pode ser utilizada com os parmetros: RptStatus( { | | Execute(Nome da Funo) } )

RegToMemory
Descrio Cria variaveis M-> para uso na Modelo3() Sintaxe RegToMemory(cAlias,lInc) Parmetros cAlias = lInc = Veja Tambm:

Anotaes:

APL8110401061027 - SIGAADVPL Protheus - 171

Modelo3 Tpicos Relacionados: Exemplo de uso da Funo RegToMemory

SetDefault
Tipo: Processamento Habilita os padres definidos pela funo SetPrint. Sintaxe SetDefault (aArray, cAlias) Parmetros aArray Array aReturn, preenchido pelo SetPrint [1] Reservado para Formulrio [2] Reservado para N de Vias [3] Destinatrio [4] Formato => 1-Comprimido 2-Normal [5] Mdia => 1-Disco 2-Impressora [6] Porta ou Arquivo 1-LPT1... 4-COM1... [7] Expresso do Filtro [8] Ordem a ser selecionada [9]..[10]..[n] Campos a Processar (se houver) cAlias Alias do arquivo a ser impresso. Retorna Nil Comentrios Esta funo habilita os padres de relatrio alterados pela funo SetPrint. Exemplo // Define Variveis cString:= SB1 NomeRel:= MATR290 cPerg := MTR290 titulo := RELAO PARA ANLISE DOS ESTOQUES cDesc1 := Este relatrio demonstra a situao de cada item em cDesc2 := relao ao seu saldo , seu empenho , suas entradas previstas cDesc3 := e sua classe ABC. aOrd := { Por Codigo , Por Tipo } Tamanho := G

Anotaes:

172 - SIGAADVPL Protheus - APL8110401061027

// Envia controle para a funo SETPRINT NomeRel:= SetPrint( cString, NomeRel, cPerg, @titulo, cDesc1, ; cDesc2, cDesc3, .F., aOrd, .F., Tamanho) If LastKey() = 27 .or. nLastKey = 27 RestScreen(3,0,24,79,cSavScr1) Return Endif SetDefault(aReturn,cAlias) If LastKey() = 27 .OR. nLastKey = 27 RestScreen(3,0,24,79,cSavScr1) Return Endif

SetDlg
Tipo: Tela Windows Colocar um ttulo em uma Dialog. Sintaxe SetDlg(oWnd, cText) Parmetros oWnd Objeto da janela cText Novo Texto Exemplo If ( INCLUI ) cCaption := Inclusao de Pedidos ElseIf ( ALTERA ) cCaption := Alteracao de Pedidos EndIf SetDlg( oDlg, cCaption )

SUBSTR()
Extrai um substring de uma cadeia de caracteres Sintaxe SUBSTR(<cString>, <nIncio>, [<nCont>]) --> cSubstring Argumentos <cString> a cadeia de caracteres da qual ser extraido um substring, podendo ter at 65.535 (64K) bytes, que o tamanho mximo
Anotaes:

APL8110401061027 - SIGAADVPL Protheus - 173

de uma cadeia de caracteres em Clipper. <nInicio> a posio inicial em <cString>. Se <nIncio> for positivo, ele relativo ao caractere mais esquerda em <cString>. Se <nIncio> for negativo, ele relativo ao caractere mais direita em <cString>. <nCont> a quantidade de caracteres a serem extraidos. Se omitido, o substring comea em <nIncio> e continua at o fim da cadeia de caracteres. Se <nCont> for maior do que a quantidade de caracteres existentes a partir de <nIncio> at o final de <cString>, o excedente ignorado. Retorno SUBSTR() retorna uma cadeia de caracteres. Descrio SUBSTR() uma funao de tratamento de caracteres que extrai um substring de qualquer outra cadeia ou campo memo. SUBSTR() esta relacionada s funes LEFT() e RIGHT(), que extraem substrings que comeam com os caracteres mais esquerda e mais direita em <cString>, respectivamente. As funoes SUBSTR(), RIGHT(), e LEFT() sao utilizadas juntamente com as funes AT() e RAT() para localizar a primeira e/ou ltima posiao de um substring antes de extrai-lo. Elas tambm sao utilizadas para exibir ou imprimir apenas uma parte de uma cadeia de caracteres. Exemplos Os exemplos a seguir extraem o primeiro e o ltimo nome de uma vari vel: cName := "Biff Styvesent" ? SUBSTR(cNome, 1, 4) // Resulta: Biff ? SUBSTR(cNome, 6) // Resulta: Styvesent ? SUBSTR(cNome, LEN(cNome) + 2) // Resulta: null string ? SUBSTR(cNome, -9) // Resulta: Styvesent ? SUBSTR(cNome, -9, 3) // Resulta: Sty

SetPrint
Tipo: Impresso Altera os padres de impresso. Sintaxe SetPrint(cAlias, cNomeRel, cPerg, cDesc1, cDesc2, cDesc3, cDesc4, lDic, aOrdem, lComp, cClass) Parmetros cAlias Alias do Arquivo Principal (se existir) cNomeRel Nome padro do relatrio cPerg Nome do grupo de perguntas

Anotaes:

174 - SIGAADVPL Protheus - APL8110401061027

cDesc1 ..cDesc4 Descrio do Relatrio lDic Habilita o Dicionrio de Dados .T. Habilita (s utilizar em conjunto com a funo ImpCadast) .F. Desabilita aOrdem Array contendo as ordens de indexao do arquivo principal. lComp Habilita a alterao da compresso do relatrio .T. Habilita .F. Desabilita cClass Classificao do Relatrio por Tamanho ( G, M ou P ) P 80 colunas M 132 colunas G 220 colunas Retorna ExpC Nome do arquivo com o relatrio impresso em disco opcionalmente alterado pelo usurio Comentrios Esta funo possibilita a alterao de determinados padres dos relatrios. Ela funciona em conjunto com a funo SetDefault. Exemplo // Define Variveis cString:= SB1 NomeRel:= MATR290 cPerg := MTR290 titulo := RELAO PARA ANLISE DOS ESTOQUES cDesc1 := Este relatrio demonstra a situao de cada item em cDesc2 := relao ao seu saldo , seu empenho , suas entradas previstas cDesc3 := e sua classe ABC. aOrd := { Por Codigo , Por Tipo } Tamanho:= G // Envia controle para a funo SETPRINT NomeRel := SetPrint( cString, NomeRel, cPerg, @titulo, cDesc1,; cDesc2, cDesc3, .F., aOrd, .F., Tamanho ) If LastKey() = 27 .or. nLastKey = 27 RestScreen(3,0,24,79,cSavScr1) Return Endif SetDefault(aReturn,cAlias) If LastKey() = 27 .OR. nLastKey = 27
Anotaes:

APL8110401061027 - SIGAADVPL Protheus - 175

RestScreen(3,0,24,79,cSavScr1) Return Endif

SET FILTER
Esconde registros que nao atendam uma condio Sintaxe SET FILTER TO [<lcondio>] Argumentos <lcondio> uma expressao lgica que define um conjunto especfico de registros das rea de trabalho corrente que sejam acessveis para processamento. SET FILTER TO sem um argumento desativa a condiao filtro. Descriao Quando uma condio FILTER est ativa, a rea de trabalho corrente age como se contivesse somente os registros que atendem a condio especificada. Uma condiao FILTER uma das propriedades de uma area de trabalho. Uma vez ativada, a condio pode ser retornada na forma de uma cadeia de caracteres usando-se a funao DBFILTER(). Exemplos Este exemplo filtra somente aqueles registros onde a idade seja maior do que 50 no arquivo Employee.dbf: USE Employee INDEX Name NEW SET FILTER TO Age > 50 LIST Lastname, Firstname, Age, Phone SET FILTER TO

SetRegua
Tipo: Impresso (DOS/ Windows) Inicializa rgua padro em relatrios. Sintaxe SetRegua(nRegs) Parmetros nRegs Nmero de registros que sero processados. Retorno Nil

Anotaes:

176 - SIGAADVPL Protheus - APL8110401061027

Exemplo DbSelectArea(SA1) SetRegua(LastRec()) While ( ! Eof() ) @ Li, 001 PSAY SA1->A1_NOME DbSkip() IncRegua() End Do Comentrio Ver tambm incRegra.

Somar
Tipo: Processamento Faz o somatrio de um arquivo, retornando o valor acumulado de um campo determinado. Sintaxe Somar(cAlias, cCond, cCampo) Parmetros cAlias Alias do arquivo cCond Condio para soma cCampo Campo a ser somado Exemplo Somar(SI1,I1_CLASSE=S ,I1_SALANT) Caso o usurio no deseje definir nenhuma condio, a ExpC2 deve ser .T..

Tabela
Tipo: Processamento Devolve o contedo da tabela de acordo com a chave. Esta funo usada para a obteno do contedo de uma determinada tabela, na chave especificada. Retorna o contedo, possibilitando inclusive a exibio de um help caso a tabela no exista. Sintaxe Tabela(cTab,cChav,lPrint) Parmetros cTab Nmero da tabela a pesquisar (deve ser informado como caracter). cChav Chave a pesquisar na tabela informada.

Anotaes:

APL8110401061027 - SIGAADVPL Protheus - 177

lPrint Indica se deve (.T.) ou no (.F.) exibir o help ou a chave NOTAB se a tabela no existir. Retorna cRet Contedo da tabela na chave especificada. Retorna nulo caso a tabela no exista ou a chave no seja encontrada. Exemplo // Exemplo de uso da funcao tabela: // Suponha a existencia da tabela 99 (tabela de // vendedor x Comissao): // Chave Conteudo // // V0 10 // V1 2.20 // V3 5 // Pode-se fazer um gatilho que, quando da informacao do // codigo do vendedor no cadastro, sugira o percentual // da tabela acima, de acordo com as duas primeiras po// sicoes do codigo digitado: //Gatilho-Dominio : A3_COD // Cta. Dominio: A3_COMIS // Regra : Val(Tabela(99,Left(M->A3_COD,2)))

TamSX3
Tipo: Processamento Retorna o tamanho de um campo no SX3 (dicionrio de dados). Sintaxe TamSx3(cCampo) Parmetros cCampo Nome do campo. Retorna aTam Array com o tamanho e decimais do campo. Exemplo // Exemplo de uso da funcao TAMSX3 // Array auxiliar: aCampos := { {B1_COD ,C},; {B1_DESC,C},; {B1_QE ,N},;
Anotaes:

178 - SIGAADVPL Protheus - APL8110401061027

{B1_PRV1,N} } // Cria arquivo de trabalho com o tamanho dos campos // exatamente como na base de dados, evitando erros de ] // Data Width Error: i := 0 aStru := {} For i:=1 To Len(aCampos) cCpo := aCampos[i,1] cTp := aCampos[i,2] aTam := TamSx3(cCpo) aAdd(aStru,{cCpo,cTp,aTam[1],aTam[2]) Next i cArq := CriaTrab(aStru,.T.) // O programa continua. . . Return

Texto
Tipo: Processamento No permite a digitao seguida de mais de um espao em branco, em campo do tipo Caracter. Sintaxe Texto(ExpC) Parmetros ExpC1 Expresso a ser verificada Exemplo Texto()

@
Tipo: Tela Desenha um box 3d. Sintaxe @ nLInha1,nColuna1 TO nLinha2,nColuna2 <TITLE> cTtulo Parmetros nLinha1 Nmero da linha superior nColuna1 Nmero da coluna superior nLinha2 Nmero da linha inferior
Anotaes:

...TO

APL8110401061027 - SIGAADVPL Protheus - 179

nColuna2 Nmero da coluna inferior cTtulo Titulo apresentado na linha superior (opcional) Comentrios A clusula TITLE opcional. Se for omitida, o box no ter ttulo. Exemplo @ 000, 000 TO 430, 500 DIALOG oDlg TITLE Interpretador xBase for Windows @ 060, 005 TO 185, 245 TITLE Exemplos @ 070, 010 BUTTON _Objetos B sicos SIZE 70,20 ACTION Execute(BasicObj) @ 070, 090 BUTTON _Browses SIZE 70,20 ACTION Execute(Browse) @ 130, 170 BUTTON Dlg c/Refresh SIZE 70,20 ACTION Execute(DlgDinam) @ 160, 090 BUTTON SQL SIZE 70,20 ACTION Execute(SqlDemo) @ 192,218 BMPBUTTON TYPE 1 ACTION Close(oDlg) ACTIVATE DIALOG oDlg CENTERED

T M
Tipo: Processamento Devolve a picture de impresso de campos numricos dependendo do espao disponvel. Sintaxe TM(nValor, nEdio, nDec) Parmetros nValor Valor a ser editado nEdio Espao disponvel para edio nDec Nmero de casas decimais Retorna ExpC1 Picture ideal para edio do valor nValor. Comentrios Esta rotina leva em considerao duas variveis: MV_MILHAR Determina se deve haver separao de milhar; MV_CENT Nmero de casas decimais padro da moeda corrente. Para ajustar o valor passado (ExpN1) ao espao disponvel (ExpN2) o programa verifica se pode haver separao de milhar, neste caso, a rotina eliminar tantos pontos decimais quantos sejam necessrios ao ajuste do tamanho. Caso no seja possvel ajustar o valor ao espao dado, ser colocado na picture o caracter de estouro de campo . O programa tambm ajusta um valor ao nmero de decimais (ExpN3), sempre imprimindo a quantidade de decimais passados no parmetro. Exemplo Cabec(Ttulo,Cabec1,Cabec2,NomeProg,Tamanho,nTipo) Endif
Anotaes:

180 - SIGAADVPL Protheus - APL8110401061027

li:=li+1 nSalAnt := nSaldoAtu-nCompras-nRecProd-nRecCons @li,00 Say cTipAnt @li,05 Say nSalAnt Picture TM(nSalAnt, 14) @li,23 Say nCompras Picture TM(nCompras, 17, 3) Se o contedo do campo nSalAnt for: 3.423.659.234,48 o valor ser impresso como: 3423659.234,48

UPPER()
Converte caracteres minsculos para maisculos Sintaxe UPPER(<cString>) --> cStringMaiusc Argumentos <cString> a cadeia de caracteres a ser convertida. Descrio UPPER() uma funao de tratamento de caracteres utilizada para converter todos os caracteres em um string para maisculos. Ela esta relacionada a LOWER(), que converte todos os caracteres em um string para minsculos. UPPER() est relacionada s funoes ISUPPER() e ISLOWER(), as quais determinam se um string comea com uma letra maiscula ou minscula. UPPER() geralmente utilizada para formatar cadeias de caracteres para fins de exibio. Ela pode, porm, ser usada para normalizar strings para fins de comparaces onde nao se diferencia maisculas de minsculas, ou para fins de INDEXao. Exemplos Os exemplos a seguir ilustram os efeitos de UPPER(): ? UPPER("a string") // Resulta: A STRING ? UPPER("123 char = <>") // Resulta: 123 CHAR = <>

Vazio
Tipo: Processamento Verifica se o campo est vazio. Sintaxe Vazio(cCampo) Parmetros

Anotaes:

APL8110401061027 - SIGAADVPL Protheus - 181

cCampo Campo a verificar Retorna ExpL1 Valor Lgico de Retorno (.T. ou .F.) Comentrios Retorna .T. se ExpC1 estiver vazio. Exemplo @ 9,10 Get cCodigo Valid !Vazio(cCodigo)

X3Picture
Tipo: Processamento Devolve a picture do campo de acordo com o dicionrio de dados. Sintaxe X3Picture(cCampo) Parmetros cCampo Nome do campo a verificar a picture. Retorna ExpC1 Picture do campo no dicionrio de dados. Comentrios Funo geralmente usada para atribuir aos relatrios a efetiva picture de campos numricos em relatrios. Exemplo cRel:=SetPrint(cAlias, cPrograma , , @cTitulo, cDesc1, cDesc2, cDesc3 , .T., aOrd ) SetDefault(aReturn, cString) While !EOF() nLinha:=nLinha+1 @nLinha, 1 Say SB2->B2_QATU Picture X3Picture(B2_QATU)

XFilial
Tipo: Processamento Retorna a filial utilizada por determinado arquivo. Esta funo utilizada para permitir que pesquisas e consultas em arquivos trabalhem somente com os dados da filial corrente, dependendo de se o arquivo est compartilhado ou no (definio que feita por meio do ambiente Configurador). importante verificar que esta funo no tem por objetivo retornar apenas a filial corrente, mas retorn-la caso o arquivo seja exclusivo. Se o arquivo estiver compartilhado, a funo xFilial retornar dois espaos em branco.
Anotaes:

182 - SIGAADVPL Protheus - APL8110401061027

Sintaxe xFilial(cAlias) Parmetros cAlias Alias do arquivo desejado. Se no for especificado, o arquivo tratado ser o da rea corrente. Retorna cFilArq Retorna a Filial para o arquivo desejado. Exemplo // Exemplo de uso da funcao xFilial: // Supondo que a filial corrente seja a 01: @ 10,10 Say xFilial(SB1) // A linha acima ira imprimir 01 se o arquivo de // produtos estiver exclusivo. Se estiver compartilhado // imprimira . // Usando em processamentos (Pesquisa e processa // enquanto for a mesma filial): dbSeek(xFilial()+mv_par01) While !EOF() .And. xFilial() == SB1->B1_FILIAL ... Processamento Enddo Return

X3USO
Verifica se o campo est disponvel para uso. Sintaxe X3Uso( cUsado, [nModulo] ) Argumento O b r i g a t . Tipo Descrio cUsado Sim C Contedo do campo X3_USADO a ser pesquisado nModulo No N Numero do mdulo, caso no seja informado ser assumido como padro o nmero do mdulo corrente. Descrio Esta funo retornar um valor lgico, se for uma campo usado verdadeiro (.T.), caso contrrio falso (.F.). Exemplo User Function <nome-da-funo>() Local lUsado := .F.

Anotaes:

APL8110401061027 - SIGAADVPL Protheus - 183

DbSelectArea(SX3) DbSetOrder(2) DbSeek(A1_COD) If X3Uso( SX3->X3_USADO ) lUsado := .T. EndIf Return lUsado

X3Picture
Retorna a mascara de um campo do dicionrio de dados SX3. Sintaxe X3Picture( cCampo ) Argumento O b r i g a t . Tipo Descrio cCampo Sim C Nome de um campo cadastrado no SX3 Exemplo User Function <nome-da-funo>( cCampo ) Local cPicture cPicture := X3Picture( cCampo ) Return cPicture

X3Cbox()
Retorna o contedo de um campo tipo combo contido no dicionrio de dados SX3 Sintaxe X3CBox() Descrio Esta funo retorna contedo do campo combo de acordo com o registro posicionado no SX3 e o idioma corrente. Exemplo User Function <nome-da-funo>( ) Local cTitulo Local cDescri Local cCombo dbSelectArea(SX3) dbSetOrder(2) If dbSeek( cCampo ) cTitulo := X3Titulo()
Anotaes:

184 - SIGAADVPL Protheus - APL8110401061027

cDescri := X3Descri() cCombo := X3Cbox() EndIf Return

X3Descri()
Retorna o descrio de um campo contido no dicionrio de dados SX3 Sintaxe X3Titulo() Descrio Esta funo retorna a descrio do campo de acordo com o registro posicionando no SX3 e o idioma corrente. Exemplo User Function <nome-da-funo>( ) Local cTitulo Local cDescri Local cCombo dbSelectArea(SX3) dbSetOrder(2) If dbSeek( cCampo ) cTitulo := X3Titulo() cDescri := X3Descri() cCombo := X3Cbox() EndIf Return

X3Titulo()
Retorna o ttulo de um campo contido no dicionrio de dados SX3 Sintaxe X3Titulo() Descrio Esta funo retorna o ttulo do campo de acordo com o registro posicionado no SX3 e o idioma corrente. Exemplo User Function <nome-da-funo>( ) Local cTitulo

Anotaes:

APL8110401061027 - SIGAADVPL Protheus - 185

dbSelectArea(SX3) dbSetOrder(2) If dbSeek( A1_COD ) cTitulo := X3Titulo() EndIf Return

Prximo Passo
Esperamos que voc tenha conhecido e aprendido melhor sobre os principais recursos da Linguagem de Programao ADVPL. Mantenha esta apostila como roteiro para seu trabalho dirio. Se tiver alguma sugesto para melhoria do nosso material, utilize o nosso e-mail: microsigaeducacao@microsiga.com.br. Teremos satisfao em receb-la e analisaremos a viabilidade de aplic-la ao nosso material. Agora, o prximo passo : Aplicar o contedo apresentado rotina de trabalho de sua empresa!

Nmero do Registro: APL8110401061027

Anotaes:

186 - SIGAADVPL Protheus - APL8110401061027