ADVPL Completo

Educao Corporativa
Programao em ADVPL
Completo
Matriz Av. Braz Leme, 1.717 02511-000 So Paulo SP Brasil.

Tel.: 55 (11) 3981-7001 www.microsiga.com.br
ESTRUTURA DO TREINAMENTO
MDULO 01: Introduo programao...................................................................................................................... 11
1.
Lgica de Programao e Algoritmos .................................................................................................................... 11
1.1.
Lgica de Programao ................................................................................................................ 11
1.2.
Desenvolvendo algoritmos ............................................................................................................ 12
1.2.1.
1.2.2.
2.
Estudando algoritmos ................................................................................................................................ 13

Teste de mesa ............................................................................................................................................ 15
Estruturas de programao .................................................................................................................................... 16
2.1.
Diagrama de bloco ........................................................................................................................ 16
2.2.
Estruturas de deciso e repetio ................................................................................................ 19
2.2.1.
2.2.2.
Estruturas de deciso ................................................................................................................................. 19

Estruturas de repetio .............................................................................................................................. 22
MDULO 02: A linguagem ADVPL ............................................................................................................................... 24

3.
Estrutura de um Programa ADVPL ...................................................................................................................... 26
3.1.
4.
Declarao e Atribuio de Variveis .................................................................................................................... 31
4.1.
Tipo de Dados ................................................................................................................................ 31
4.2.
Declarao de variveis ................................................................................................................ 32
4.3.
Escopo de variveis ....................................................................................................................... 33
4.4.
Entendendo a influncia do escopo das variveis ...................................................................... 37
4.5.
Operaes com Variveis ............................................................................................................. 38
4.5.1.
4.5.2.
4.5.3.
4.5.4.
5.
5.1.1.
5.2.
Estruturas de repetio ................................................................................................................ 51

Influenciando o fluxo de repetio ............................................................................................................ 54
Estruturas de deciso .................................................................................................................... 56
Arrays e Blocos de Cdigo...................................................................................................................................... 60
6.1.
6.1.1.
6.1.2.
6.1.3.
6.2.
6.2.1.
6.2.2.
6.2.3.
6.2.4.
7.
Atribuio de variveis.............................................................................................................................. 38
Operadores da linguagem ADVPL............................................................................................................ 39
Operao de Macro Substituio ............................................................................................................... 44
Funes de manipulao de variveis ....................................................................................................... 45
Estruturas bsicas de programao ....................................................................................................................... 51
5.1.
6.
reas de um Programa ADVPL .................................................................................................. 28
Arrays ............................................................................................................................................ 60
Inicializando arrays ................................................................................................................................... 62
Funes de manipulao de arrays ............................................................................................................ 63
Cpia de arrays .......................................................................................................................................... 65
Listas de Expresses e Blocos de Cdigo .................................................................................... 67

Premissas para utilizao de Blocos de Cdigo ........................................................................................ 67
Lista de expresses .................................................................................................................................... 68
Blocos de Cdigo ...................................................................................................................................... 70
Funes para manipulao de blocos de cdigo........................................................................................ 72
Funes ................................................................................................................................................................... 73
7.1.
Tipos e escopos de funes ........................................................................................................... 74
7.2.
Passagem de parmetros entre funes ...................................................................................... 77

-2ADVPL Completo
8.
Diretivas de compilao.......................................................................................................................................... 83
MDULO 03: Desenvolvendo pequenas customizaes ................................................................................................ 88

9.
ADVPL e o ERP Microsiga Protheus .................................................................................................................... 88
9.1.
O Ambiente Protheus ................................................................................................................... 88
9.2.
Organizao e configurao inicial do ambiente Protheus ....................................................... 92
9.3.
O Configurador do Protheus ....................................................................................................... 98
9.3.1.
9.3.2.
9.3.3.
9.4.
Funcionalidades Abordadas ...................................................................................................................... 98

Estruturas bsicas da aplicao ERP Protheus .......................................................................................... 98
Acessando o mdulo Configurador ......................................................................................................... 101
Funcionalidades do Configurador ............................................................................................. 104
9.4.1.
9.4.2.
9.4.3.
9.4.4.
9.4.5.
9.4.6.
9.4.7.
10.
Dicionrio de Dados da aplicao ERP ................................................................................................... 105

Adio de tabelas ao Dicionrio de Dados .............................................................................................. 105
Adio de campos as tabelas do Dicionrio de Dados ............................................................................ 108
Adio de ndices para as tabelas do Dicionrio de Dados ..................................................................... 113
Adio de gatilhos para os campos das tabelas do sistema ..................................................................... 116
Criao de Tabelas Genricas ................................................................................................................. 118
Criao de Parmetros ............................................................................................................................. 119
TOTVS Development Studio ................................................................................................................................ 121
Desenvolvimento de pequenas customizaes ....................................................................................... 124

11.
Acesso e manipulao de bases de dados em ADVPL ......................................................................................... 124
11.1.
Diferenas e compatibilizaes entre bases de dados............................................................... 125
11.2.
Funes de acesso e manipulao de dados .............................................................................. 126
11.3.
Diferenciao entre variveis e nomes de campos ................................................................... 131
11.4.
Controle de numerao seqencial............................................................................................ 132
12.
Customizaes para a aplicao ERP .................................................................................................................. 133
12.1.
Customizao de campos Dicionrio de Dados ..................................................................... 134
12.1.1.
12.1.2.
Validaes de campos e perguntas ..................................................................................................... 134

Pictures de formao disponveis ....................................................................................................... 136
12.2.
Customizao de gatilhos Configurador ................................................................................ 138
12.3.
Customizao de parmetros Configurador ......................................................................... 139
12.3.1.
12.3.2.
12.4.
13.
Funes para manipulao de parmetros .......................................................................................... 139

Cuidados na utilizao de um parmetro ............................................................................................ 140
Pontos de Entrada Conceitos, Premissas e Regras ............................................................... 141
Interfaces visuais .................................................................................................................................................. 142
13.1.
Sintaxe e componentes das interfaces visuais ........................................................................... 142
13.2.
Interfaces padres para atualizaes de dados ........................................................................ 145
13.2.1.
13.2.2.
13.2.3.
AxCadastro() ...................................................................................................................................... 145

MBrowse().......................................................................................................................................... 146
AxFunctions() ..................................................................................................................................... 150
APNDICES .................................................................................................................................................................. 152

BOAS PRTICAS DE PROGRAMAO .................................................................................................................... 152
14.
Utilizao de Identao ........................................................................................................................................ 152
15.
Capitulao de Palavras-Chave ........................................................................................................................... 153
15.1.
Palavras em maisculo ............................................................................................................... 154

-3ADVPL Completo
16.
Utilizao da Notao Hngara ........................................................................................................................... 154
17.
Palavras reservadas .............................................................................................................................................. 155
LISTAS DE EXERCCIOS ........................................................................................................................................... 156
Mdulo 01: Introduo programao ................................................................................................. 156

Mdulo 02: A linguagem ADVPL........................................................................................................... 157
Mdulo 03: Desenvolvendo pequenas customizaes ........................................................................... 160
MDULO 04: Desenvolvendo aplicaes em ADVPL ................................................................................................. 162
18.
A linguagem ADVPL ............................................................................................................................................ 162
19.
Estrutura de um Programa ADVPL .................................................................................................................... 164
19.1.
20.
reas de um Programa ADVPL ................................................................................................ 166
Declarao e Atribuio de Variveis .................................................................................................................. 169
20.1.
Tipo de Dados .............................................................................................................................. 169
20.2.
Declarao de variveis .............................................................................................................. 170
20.3.
Escopo de variveis ..................................................................................................................... 171
20.4.
Entendendo a influncia do escopo das variveis .................................................................... 175
21.
Regras adicionais da linguagem ADVPL ............................................................................................................ 176
21.1.
Palavras reservadas .................................................................................................................... 176
21.2.
Pictures de formatao disponveis ........................................................................................... 177
22.
Programas de Atualizao.................................................................................................................................... 178
22.1.
Modelo1() ou AxCadastro() ....................................................................................................... 179
22.2.
Modelo2() ..................................................................................................................................... 181
22.2.1.
22.2.2.
22.2.3.
22.3.
Modelo3() ..................................................................................................................................... 201
22.3.1.
22.3.2.
22.4.
23.
Estrutura de um programa utilizando a Modelo3() ............................................................................. 204

Funo Modelo3() .............................................................................................................................. 213
Mbrowse() .................................................................................................................................... 217
22.4.1.
22.4.2.
22.4.3.
22.4.4.
22.4.5.
22.5.
Componentes de uma tela no formato Modelo 2 ................................................................................ 181

Estrutura de um programa utilizando a Modelo2() ............................................................................. 189
Funo Modelo2() .............................................................................................................................. 197
AxFunctions() ..................................................................................................................................... 222

FilBrowse() ......................................................................................................................................... 224
EndFilBrw()........................................................................................................................................ 224
PesqBrw() ........................................................................................................................................... 225
BrwLegenda () .................................................................................................................................... 225
MarkBrowse() ............................................................................................................................. 229
Arquivos e ndices Temporrios........................................................................................................................... 233
23.1.
Utilizao de arquivos e ndices temporrios ........................................................................... 233
23.2.
Funes para manipulao de arquivos e ndices temporrios .............................................. 233
23.2.1.
23.2.2.
23.2.3.
CriaTrab() ........................................................................................................................................... 233

dbUseArea() ....................................................................................................................................... 234
IndRegua() .......................................................................................................................................... 234
24.
Relatrios no grficos ......................................................................................................................................... 238

Estrutura de relatrios baseados na SetPrint() .................................................................................... 238
24.1.1.
25.
Manipulao de arquivos I ................................................................................................................................... 248

-4ADVPL Completo
25.1.
Gerao e leitura de arquivos em formato texto ...................................................................... 248

1. Famlia de funes de gravao e leitura de arquivos texto .................................................................... 249
2. Famlia de funes de gravao e leitura de arquivos texto .................................................................... 254
26.
Oficina de programao I .................................................................................................................................... 256
26.1.
Interfaces com sintaxe clssica................................................................................................... 256
26.2.
Rguas de processamento ........................................................................................................... 259
26.2.1.
RptStatus() .......................................................................................................................................... 259
SETREGUA() .............................................................................................................................................. 261
INCREGUA() .............................................................................................................................................. 262
Processa() ........................................................................................................................................... 263
26.2.2.
SETPROC() ................................................................................................................................................. 265
INCPROC() ................................................................................................................................................. 265
MsNewProcess(). ............................................................................................................................... 266
26.2.3.
MsAguarde(). ..................................................................................................................................... 268
26.2.4.
MsgRun()............................................................................................................................................ 270
26.2.5.
26.3.
ListBox() ...................................................................................................................................... 271
26.3.1.
26.3.2.
ListBox simples .................................................................................................................................. 271

ListBox mltiplas colunas .................................................................................................................. 274
26.4.
ScrollBox() ................................................................................................................................... 276
26.5.
ParamBox().................................................................................................................................. 280
MDULO 05: Introduo a orientao objetos......................................................................................................... 285

27.
Conceitos de orientao objetos ........................................................................................................................ 285
27.1.
Definies ..................................................................................................................................... 285
27.2.
Conceitos Bsicos ........................................................................................................................ 288
27.3.
O Modelo de Objetos (OMT) ..................................................................................................... 289
27.3.1.
27.3.2.
27.3.3.
27.3.4.
28.
Objetos e Classes ................................................................................................................................ 289

Atributos ............................................................................................................................................. 290
Operaes e Mtodos ......................................................................................................................... 291
Sugestes de desenvolvimento ........................................................................................................... 292
Orientao a objetos em ADVPL ......................................................................................................................... 293
28.1.
Sintaxe e operadores para orientao a objetos ....................................................................... 293
28.2.
Estrutura de uma classe de objetos em ADVPL ...................................................................... 295
28.3.
Implementao dos mtodos de uma classe em ADVPL ......................................................... 296
MDULO 06: ADVPL Orientado objetos I ............................................................................................................... 300

29.
Componentes da interface visual do ADVPL ...................................................................................................... 300
29.1.
Particularidades dos componentes visuais ................................................................................ 307
29.1.1.
30.
Configurando as cores para os componentes ...................................................................................... 307
Aplicaes com a interface visual do ADVPL ..................................................................................................... 309
30.1.
Captura de informaes simples (Multi-Gets) ......................................................................... 309
30.1.1.
30.1.2.
30.2.
Enchoice() .......................................................................................................................................... 310

MsMGet() ........................................................................................................................................... 312
Captura de mltiplas informaes (Multi-Lines)..................................................................... 314
30.2.1.
MsGetDB() ......................................................................................................................................... 315
MsGetDados() .................................................................................................................................... 319
30.2.2.
MsNewGetDados() ............................................................................................................................. 323
30.2.3.
30.2.3.1. Definindo cores personalizadas para o objeto MsNewGetDados() ............................................... 328
-5ADVPL Completo
30.3.
Barras de botes .......................................................................................................................... 333
30.3.1.
30.3.2.
30.3.3.
30.3.4.
EnchoiceBar() ..................................................................................................................................... 333

TBar() ................................................................................................................................................. 335
ButtonBar ........................................................................................................................................... 336
Imagens pr-definidas para as barras de botes.................................................................................. 339
APNDICES .................................................................................................................................................................. 340

BOAS PRTICAS DE PROGRAMAO .................................................................................................................... 340
31.
Arredondamento ................................................................................................................................................... 340
32.
Utilizao de Identao ........................................................................................................................................ 340
33.
Capitulao de Palavras-Chave ........................................................................................................................... 342
33.1.
Palavras em maisculo ............................................................................................................... 342
34.
Utilizao da Notao Hngara ........................................................................................................................... 343
35.
Tcnicas de programao eficiente ...................................................................................................................... 343
Mdulo 04.1.: Desenvolvendo aplicaes em ADVPL ......................................................................... 353

Mdulo 04.2.: Oficina de Programao I .............................................................................................. 358
Mdulo 05: Introduo a orientao objetos ..................................................................................... 360
Mdulo 06: ADVPL orientado objetos I ............................................................................................ 361
Projeto: Avaliao prtica do treinamento de ADVPL Intermedirio ............................................... 363
MDULO 07: ADVPL Orientado objetos II.............................................................................................................. 364
36.
Componentes da interface visual do ADVPL ...................................................................................................... 364

TSRVOBJECT() .......................................................................................................................................... 366
TFONT() ...................................................................................................................................................... 369
MSDIALOG() .............................................................................................................................................. 370
TDIALOG() ................................................................................................................................................. 371
TWINDOW() ............................................................................................................................................... 374
TCONTROL().............................................................................................................................................. 377
BRGETDDB() ............................................................................................................................................. 378
MSCALEND() ............................................................................................................................................. 381
MSCALENDGRID() ................................................................................................................................... 383
MSSELBR()................................................................................................................................................. 385
MSWORKTIME() ....................................................................................................................................... 388
SBUTTON() ................................................................................................................................................ 391
TBAR() ........................................................................................................................................................ 393
TBITMAP() ................................................................................................................................................. 395
TBROWSEBUTTON()................................................................................................................................ 397
TBTNBMP() ................................................................................................................................................ 399
TBTNBMP2() .............................................................................................................................................. 401
TBUTTON() ................................................................................................................................................ 403
TCBROWSE() ............................................................................................................................................. 405
TCHECKBOX() .......................................................................................................................................... 409
TCOLORTRIANGLE() ............................................................................................................................... 411
TCOMBOBOX() ......................................................................................................................................... 413
TFOLDER() ................................................................................................................................................. 416
TGET()......................................................................................................................................................... 418
TGROUP() ................................................................................................................................................... 420
THBUTTON() ............................................................................................................................................. 422
TIBROWSER() ............................................................................................................................................ 423
TLISTBOX()................................................................................................................................................ 425
TMENU()..................................................................................................................................................... 429
-6ADVPL Completo
TMENUBAR() ............................................................................................................................................ 430

TMETER() ................................................................................................................................................... 431
TMSGRAPHIC() ......................................................................................................................................... 434
TMSGBAR()................................................................................................................................................ 440
TMSGITEM() .............................................................................................................................................. 442
TMULTIBTN() ............................................................................................................................................ 443
TMULTIGET() ............................................................................................................................................ 446
TOLECONTAINER() .................................................................................................................................. 448
TPAGEVIEW()............................................................................................................................................ 450
TPANEL() ................................................................................................................................................... 452
TRADMENU() ............................................................................................................................................ 453
TSBROWSE().............................................................................................................................................. 457
TSAY() ........................................................................................................................................................ 461
TSCROLLBOX() ......................................................................................................................................... 463
TSIMPLEEDITOR().................................................................................................................................... 464
TSLIDER() .................................................................................................................................................. 469
TSPLITTER() .............................................................................................................................................. 472
TTABS() ...................................................................................................................................................... 476
TTOOLBOX() ............................................................................................................................................. 478
TWBROWSE() ............................................................................................................................................ 481
VCBROWSE() ............................................................................................................................................. 485
36.1.
Particularidades dos componentes visuais ................................................................................ 491
36.1.1.
37.
Configurando as cores para os componentes ...................................................................................... 491
Aplicaes com a interface visual do ADVPL ..................................................................................................... 493
37.1.
Captura de informaes simples (Multi-Gets) ......................................................................... 493
37.1.1.
37.1.2.
37.2.
Enchoice() .......................................................................................................................................... 494

MsMGet() ........................................................................................................................................... 496
Captura de mltiplas informaes (Multi-Lines)..................................................................... 498
37.2.1.
MsGetDB() ......................................................................................................................................... 499
MsGetDados() .................................................................................................................................... 503
37.2.2.
MsNewGetDados() ............................................................................................................................. 507
37.2.3.
37.2.3.1. Definindo cores personalizadas para o objeto MsNewGetDados() ............................................... 512
37.3.
Barras de botes .......................................................................................................................... 517
37.3.1.
37.3.2.
37.3.3.
37.3.4.
38.
EnchoiceBar() ..................................................................................................................................... 517

TBar() ................................................................................................................................................. 519
ButtonBar ........................................................................................................................................... 520
Imagens pr-definidas para as barras de botes.................................................................................. 523
Outras aplicaes da interface visual do ADVPL ............................................................................................... 524
38.1.
MaWndBrowse() ......................................................................................................................... 524
38.1.1.
Enchoice para Arquivos Temporrios ................................................................................................ 527
38.2.
DbTree() ....................................................................................................................................... 537
38.3.
MsSelect()..................................................................................................................................... 542
39.
Introduo relatrios grficos ........................................................................................................................... 545
39.1.
TReport() ..................................................................................................................................... 545
39.1.1.
Introduo ........................................................................................................................................... 545
Finalidade..................................................................................................................................................... 545
Descrio ..................................................................................................................................................... 546
Pr-Requisitos .............................................................................................................................................. 546
Impresso do relatrio personalizvel ................................................................................................ 547
39.1.2.
39.1.2.1. Parmetros de impresso ............................................................................................................... 547
Impresso ..................................................................................................................................................... 547
Arquivo ........................................................................................................................................................ 547
Spool ............................................................................................................................................................ 548
-7ADVPL Completo
E-mail........................................................................................................................................................... 548
Papel............................................................................................................................................................. 549
Tamanho do papel ........................................................................................................................................ 549
Formato da impresso .................................................................................................................................. 549
Configuraes .............................................................................................................................................. 549
Ttulo ............................................................................................................................................................ 549
Ordem .......................................................................................................................................................... 549
Layout .......................................................................................................................................................... 549
Preview ........................................................................................................................................................ 549
Executar em segundo plano ......................................................................................................................... 550
Personalizao .................................................................................................................................... 550
39.1.3.
39.1.3.1. Editando o layout do relatrio ....................................................................................................... 550
Nova estrutura do relatrio TReport: ........................................................................................................... 551
Definindo a Funo ReportDef() ........................................................................................................ 551
39.1.4.
DEFINE REPORT ....................................................................................................................................... 552
DEFINE SECTION ..................................................................................................................................... 552
DEFINE CELL ............................................................................................................................................ 552
MDULO 08: Aplicaes ADVPL para o ERP ............................................................................................................ 553
40.
Protheus e o TOPCONNECT / TOTVS DbAccess .............................................................................................. 553
40.1.
Caractersticas tcnicas com o uso do TOTVS DbAccess ...................................................... 554

Comportamento de Queries Colunas Calculadas ...................................................................................... 554
Comportamento diferenciado com Bandos de Dados PostGres ................................................................... 556
Conceito de ndices Permanentes e Diferenas das RDDs .......................................................................... 557
Funcionamento Interno ................................................................................................................................ 557
Quebra de Compatibilidade com CodeBase/DBF ........................................................................................ 558
Lista dos cdigos de erro do TOPConnect / DbAccess................................................................................ 559
40.2.
Funes ADVPL para TOPCONNECT / TOTVS DbAccess.................................................. 560

Lista das funes de interao com a aplicao TopConnect / DbAccess: .................................................. 560
Lista das funes acessrias utilizadas nos fontes como facilitadoras: ........................................................ 560
Funes de interao com o TopConnect / DbAccess ................................................................................. 561
TCCANOPEN () .......................................................................................................................................... 561
TCCONTYPE() ........................................................................................................................................... 561
TCDELFILE().............................................................................................................................................. 562
TCGENQRY() ............................................................................................................................................. 563
TCGETDB() ................................................................................................................................................ 563
TCLINK() .................................................................................................................................................... 564
TCQUERY() ................................................................................................................................................ 566
TCQUIT() .................................................................................................................................................... 567
TCSETCONN() ........................................................................................................................................... 567
TCSETFIELD() ........................................................................................................................................... 568
TCSPEXEC() ............................................................................................................................................... 570
TCSPEXIST() .............................................................................................................................................. 572
TCSQLERROR() ......................................................................................................................................... 572
TCSQLEXEC() ............................................................................................................................................ 573
TCSRVTYPE() ............................................................................................................................................ 573
TCUNLINK() .............................................................................................................................................. 574
TCCHKOBJ() .............................................................................................................................................. 575
TCEXEERROR() ......................................................................................................................................... 575
TCPGMEXE() ............................................................................................................................................. 576
TCSYSEXE()............................................................................................................................................... 576
Funes acessrias para uso em fontes com interao com o TOTVS DbAccess ....................................... 577
CHANGEQUERY() .................................................................................................................................... 577
RETFULLNAME()...................................................................................................................................... 578
RETSQLCOND() ........................................................................................................................................ 579
RETSQLNAME() ........................................................................................................................................ 579
RETSQLTABLE() ....................................................................................................................................... 580
SQLCOPY()................................................................................................................................................. 580
-8ADVPL Completo
SQLORDER() .............................................................................................................................................. 581

SQLTOTRB() .............................................................................................................................................. 582
40.3.
Aplicaes com controle de comunio com o Banco de Dados.............................................. 583
40.3.1.
MaWndBrowse com Alias Temporrio gerado por Query ................................................................. 583
Exemplo: MaWndBrowse com Alias Temporrio gerado por Query .......................................................... 584
Banco de dados de interface ............................................................................................................... 595
40.3.2.
Consideraes relevantes sobre as funes TCLink() e TCSetConn()......................................................... 595
Consideraes complementares sobre o conceito de Banco de Dados de Interface..................................... 596
40.4.
Embedded SQL Facilitador de Querys................................................................................. 598

Disponibilidade do Recurso ......................................................................................................................... 598
Caractersticas operacionais - Sintaxe .......................................................................................................... 599
Limitao: .................................................................................................................................................... 599
Erros de Compilao .................................................................................................................................... 600
Erros de Execuo........................................................................................................................................ 600
Caractersticas operacionais - depurao ..................................................................................................... 601
Funo auxiliar - GETLastQuery() .............................................................................................................. 601
41.
Funcionalidade MsExecAuto ............................................................................................................................... 603

Sobre a MsExecAuto e Rotinas Automticas .............................................................................................. 603
Quando utilizar a funcionalidade MsExecAuto ?......................................................................................... 604
Processos da aplicao ERP com tratamentos para execuo por MsExecAuto.......................................... 604
Quando no utilizar a funcionalidade MsExecAuto..................................................................................... 605
41.1.
Desenvolvendo aplicaes com MsExecAuto ............................................................................ 606

Estrutura de uma rotina com execuo de MsExecAuto .............................................................................. 606
Variveis de controle ................................................................................................................................... 606
Montagem dos arrays de parmetros............................................................................................................ 606
Definio dos parmetros especficos da rotina que ser executada ............................................................ 610
Controle de transao ................................................................................................................................... 611
Tratamento de mensagens de erro ................................................................................................................ 613
Aplicao completa de importao utilizando MsExecAuto: Carga de imobilizado ................................... 616
42.
Recursos de envio de e-mail ................................................................................................................................. 629

Funes para manipulao de e-mails .......................................................................................................... 629
Detalhamento das funes de manipulao de e-mails ................................................................................ 629
CALLPROC() .............................................................................................................................................. 629
MAILSMTPON() ........................................................................................................................................ 630
MAILPOPON()............................................................................................................................................ 630
MAILSMTPOFF() ....................................................................................................................................... 631
MAILPOPOFF() .......................................................................................................................................... 631
MAILRECEIVE() ........................................................................................................................................ 632
MAILAUTH().............................................................................................................................................. 633
POPMSGCOUNT() ..................................................................................................................................... 634
MAILSEND() .............................................................................................................................................. 634
MAILGETERR() ......................................................................................................................................... 635
Exemplos de utilizao das funcionalidades de envio e recebimento de e-mail .......................................... 635
Envio de mensagens utilizando sintaxe clssica .......................................................................................... 635
Envio de mensagens utilizando funes ...................................................................................................... 638
Recebimento de mensagens utilizando funes ........................................................................................... 641
43.
Integrao bsica com MsOffice.......................................................................................................................... 643
43.1.
Exportao para EXCEL ........................................................................................................... 643

DLGTOEXCEL() ........................................................................................................................................ 643
Exemplo de exportao para o Microsoft Excel utilizando a funo DlgToExcel() .................................... 644
APNDICES .................................................................................................................................................................. 646
Relao de imagens para aplicaes visuais .......................................................................................... 646

-9ADVPL Completo
Projeto: Avaliao prtica do treinamento de ADVPL Avanado ...................................................... 659

REFERNCIAS BIBLIOGRFICAS .......................................................................................................................... 660
- 10 ADVPL Completo
MDULO 01: Introduo programao

1. Lgica de Programao e Algoritmos
No aprendizado de qualquer linguagem de programao essencial desenvolver os conceitos
relacionados a lgica e a tcnica da escrita de um programa.
Com foco nesta necessidade, este tpico ir descrever resumidamente os conceitos envolvidos
no processo de desenvolvimento de um programa atravs dos conceitos relacionados :
Lgica de programao
Algoritmos
Diagramas de blocos
1.1. Lgica de Programao

Lgica
A lgica de programao necessria para pessoas que desejam trabalhar com
desenvolvimento de sistemas e programas, ela permite definir a seqncia lgica para o
desenvolvimento. Ento o que lgica?
Lgica de programao
determinado objetivo.
tcnica
de
encadear
pensamentos
para
atingir
Seqncia Lgica
Estes pensamentos, podem ser descritos como uma seqncia de instrues, que devem ser
seguidas para se cumprir uma determinada tarefa.
Seqncia Lgica so passos executados at atingir um objetivo ou soluo de um

problema.
Instrues
Na linguagem comum, entende-se por instrues um conjunto de regras ou normas definidas
para a realizao ou emprego de algo.
Em informtica, porm, instruo a informao que indica a um computador uma ao
elementar a executar. Convm ressaltar que uma ordem isolada no permite realizar o
processo completo, para isso necessrio um conjunto de instrues colocadas em ordem
seqencial lgica.
Por exemplo, se quisermos fazer uma omelete de batatas, precisaremos colocar em prtica
uma srie de instrues: descascar as batatas, bater os ovos, fritar as batatas, etc. evidente
que essas instrues tm que ser executadas em uma ordem adequada no se pode
descascar as batatas depois de frit-las.
Dessa maneira, uma instruo tomada em separado no tem muito sentido; para obtermos o
resultado, precisamos colocar em prtica o conjunto de todas as instrues, na ordem correta.
- 11 ADVPL Completo
Instrues so um conjunto de regras ou normas definidas para a realizao ou

emprego de algo. Em informtica, o que indica a um computador uma ao
elementar a executar.
Algoritmo
Um algoritmo formalmente uma seqncia finita de passos que levam a execuo de uma
tarefa. Podemos pensar em algoritmo como uma receita, uma seqncia de instrues que do
cabo de uma meta especfica. Estas tarefas no podem ser redundantes nem subjetivas na sua
definio, devem ser claras e precisas.
Como exemplos de algoritmos podemos citar os algoritmos das operaes bsicas (adio,
multiplicao, diviso e subtrao) de nmeros reais decimais. Outros exemplos seriam os
manuais de aparelhos eletrnicos, como um videocassete, que explicam passo-a-passo como,
por exemplo, gravar um evento.
At mesmo as coisas mais simples, podem ser descritas por seqncias lgicas, tais como:
Chupar uma bala
1. Pegar a bala;
2. Retirar o papel;
3. Chupar a bala;
4. Jogar o papel no lixo.
Somar dois nmeros quaisquer
1. Escreva o primeiro nmero no retngulo A;
2. Escreva o segundo nmero no retngulo B;
3. Some o nmero do retngulo A com nmero do retngulo B e coloque o
resultado no retngulo C.
1.2. Desenvolvendo algoritmos

Pseudocdigo
Os algoritmos so descritos em uma linguagem chamada pseudocdigo. Este nome uma
aluso posterior implementao em uma linguagem de programao, ou seja, quando for
utilizada a linguagem a de programao propriamente dita como, por exemplo, ADVPL.
Por isso os algoritmos so independentes das linguagens de programao, sendo que ao
contrrio de uma linguagem de programao no existe um formalismo rgido de como deve
ser escrito o algoritmo.
O algoritmo deve ser fcil de interpretar e fcil de codificar. Ou seja, ele deve ser o
intermedirio entre a linguagem falada e a linguagem de programao.
- 12 ADVPL Completo
Regras para construo do Algoritmo

Para escrever um algoritmo precisamos descrever a seqncia de instrues, de maneira
simples e objetiva. Para isso utilizaremos algumas tcnicas:
1. Usar somente um verbo por frase;
2. Imaginar que voc est desenvolvendo um algoritmo para pessoas que no trabalham
com informtica;
3. Usar frases curtas e simples;
4. Ser objetivo;
5. Procurar usar palavras que no tenham sentido dbio.
Fases
Para implementar de um algoritmo de simples interpretao e codificao necessrio
inicialmente dividir o problema apresentado em trs fases fundamentais, as quais so:
ENTRADA: So os dados de entrada do algoritmo;
PROCESSAMENTO: So os procedimentos utilizados para chegar ao resultado final;
SADA: So os dados j processados.
1.2.1.
Estudando algoritmos
Neste tpico sero demonstrados alguns algoritmos do cotidiano,

implementados utilizando os princpios descritos nos tpicos anteriores.
Mascar um chiclete
Utilizar um telefone pblico carto
Fritar um ovo
Trocar lmpadas
Descascar batatas
Jogar o jogo da forca
Calcular a mdia de notas
Jogar o jogo da velha contra o algoritmo
Mascar um chiclete
1.
2.
3.
4.
Pegar o chiclete
Retirar o papel
Mastigar
Jogar o papel no lixo
Utilizar um telefone pblico - carto

1.
2.
3.
4.
5.
6.
Retirar o telefone do gancho

Esperar o sinal
Colocar o carto
Discar o nmero
Falar no telefone
Colocar o telefone no ganho
- 13 ADVPL Completo
os
quais
foram
Fritar um ovo
1. Pegar frigideira, ovo, leo e sal
2. Colocar leo na frigideira
3. Ascender o fogo
4. Colocar a frigideira no fogo
5. Esperar o leo esquentar
6. Quebrar o ovo na frigideira
7. Jogar a casca no lixo
8. Retirar a frigideira do fogo quando o ovo estiver no ponto
9. Desligar o fogo
10. Colocar sal a gosto
Trocar lmpadas
1.
2.
3.
4.
5.
Se a lmpada estiver fora do alcance, pegar uma escada

Pegar a lmpada nova
Se a lmpada queimada estiver quente, pegar um pano
Tirar lmpada queimada
Colocar lmpada nova
Descascar batatas
1. Pegar faca, bacia e batatas
2. Colocar gua na bacia
3. Enquanto houver batatas, descascar as batatas
3.1.
Colocar as batatas descascadas na bacia
Jogar o jogo da forca
1. Escolher a palavra
2. Montar o diagrama do jogo
3. Enquanto houver lacunas vazias e o corpo estiver incompleto:
3.1.
Se acertar a letra: escrever na lacuna correspondente
3.2.
Se errar a letra: desenhar uma parte do corpo na forca
Calcular a mdia de notas
1. Enquanto houver notas a serem recebidas:
1.1.
Receber a nota;
2. Some todas as notas recebidas;
3. Divida o total obtido pela quantidade de notas recebidas;
4. Exiba a mdia das notas.
Jogar o jogo da velha contra o algoritmo
1. Enquanto existir um quadrado livre e ningum ganhou ou perdeu o jogo:
1.1.
Espere a jogada do adversrio, continue depois
1.2.
Se centro estiver livre: jogue no centro
1.3.
Seno, se o adversrio possuir 2 quadrados em linha com um quadrado livre,
jogue neste quadrado
1.4.
Seno, se h algum canto livre, jogue neste canto
- 14 ADVPL Completo
1.2.2.
Teste de mesa
Aps desenvolver um algoritmo ele dever sempre ser testado. Este teste chamado de
TESTE DE MESA, que significa seguir as instrues do algoritmo de maneira precisa para
verificar se o procedimento utilizado est correto ou no.
Para avaliar a aplicao do teste de mesa, utilizaremos o algoritmo de calcular a mdia de
notas:
Algoritmo: Calcular a mdia de notas
a. Receber a nota;
Teste de mesa:
1. Para cada nota informada, receber e registrar na tabela abaixo:
ID
Nota
2. Ao trmino das notas, a tabela dever conter todas as notas informadas, como abaixo:
ID
1
2
3
4
5
6
Nota
8.0
7.0
8.0
8.0
7.0
7.0
3. Somar todas as notas: 45

4. Dividir a soma das notas, pelo total de notas informado: 45/6 7.5
5. Exibir a mdia obtida: Mensagem(Mdia: 7.5)
- 15 ADVPL Completo
2. Estruturas de programao
2.1. Diagrama de bloco
O diagrama de blocos uma forma padronizada e eficaz para representar os passos lgicos de
um determinado processamento.
Com o diagrama podemos definir uma seqncia de smbolos, com significado bem definido,
portanto, sua principal funo a de facilitar a visualizao dos passos de um processamento.
Simbologia
Existem diversos smbolos em um diagrama de bloco. No quadro abaixo esto representados
alguns dos smbolos mais utilizados:
Smbolo
Funo
Indica o incio e o fim de um processamento.
Terminador
Processamento em geral.
Processamento
Indica a entrada de dados atravs do teclado.

Entrada
Manual
Indica um ponto no qual dever ser efetuada
uma escolha entre duas situaes possveis.
Deciso
Mostra os resultados
processamento.
obtidos
com
um
Exibio
Documento
Indica
um
documento
utilizado
pelo
processamento,
seja
para
entrada
de
informaes ou para exibio dos dados
disponveis aps um processamento.
Cada smbolo ir conter uma descrio pertinente a forma com o qual o

mesmo foi utilizado no fluxo, indicando o processamento ou a informao
que o mesmo representa.
- 16 ADVPL Completo
Representao de algoritmos atravs de diagramas de bloco

Algoritmo 01: Fritar um ovo
1. Pegar frigideira, ovo, leo e sal
2. Colocar leo na frigideira
3. Ascender o fogo
4. Colocar a frigideira no fogo
5. Esperar o leo esquentar
6. Quebrar o ovo na frigideira
7. Jogar a casca no lixo
8. Retirar a frigideira do fogo quando o ovo estiver no ponto
9. Desligar o fogo
10. Colocar sal a gosto
- 17 ADVPL Completo
Algoritmo 02: Calcular a mdia de notas

a. Receber a nota;
- 18 ADVPL Completo
2.2. Estruturas de deciso e repetio

A utilizao de estruturas de deciso e repetio em um algoritmo permite a realizao de
aes relacionadas a situaes que influenciam na execuo e soluo do problema.
Como foco na utilizao da linguagem ADVPL sero ilustradas as seguintes estruturas:
Estruturas de deciso
o IF...ELSE
o DO CASE ... CASE
Estruturas de repetio
o WHILE...END
o FOR...NEXT
2.2.1.
Os comandos de deciso so utilizados em algoritmos cuja soluo no obtida atravs da

utilizao de aes meramente seqenciais, permitindo que este avalie as condies
necessrias para optar por uma ou outra maneira de continuar seu fluxo.
As estruturas de deciso que sero analisadas so:
IF...ELSE
DO CASE ... CASE
IF...ELSE
A estrutura IF...ELSE (Se/Seno) permite a anlise de uma condio e a partir da qual ser
executada uma de duas aes possveis: se a anlise da condio resultar em um valor
verdadeiro ou se a anlise da condio resultar em um valor falso.
Representao 01: IF...ELSE com aes para ambas as situaes
Aes anteriores
...
Verdadeiro
Anlise da
condio
Ao vinculada ao
resultado
verdadeiro
Falso
Ao vinculada ao
resultado falso
Continuao do
fluxo aps a
tomada da
deciso
- 19 ADVPL Completo
Esta estrutura permite ainda que seja executada apenas uma ao, na situao em que a a
anlise da condio resultar em um valor verdadeiro.
Representao 02: IF...ELSE somente com ao para situao verdadeira
Aes anteriores
...
Falso
Anlise da
condio
Verdadeiro
Ao vinculada ao
resultado
verdadeiro
Continuao do
fluxo aps a
tomada da
deciso
Apesar das linguagens de programao possurem variaes para a estrutura

IF...ELSE, conceitualmente todas as representaes podem ser descritas com
base no modelo apresentado.
A linguagem ADVPL possui uma variao para a estrutura IF...ELSE, descrita

como IF...ELSEIF...ELSE.
Com esta estrutura possvel realizar a anlise de diversas condies em
seqncia, para as quais ser avaliada somente a ao da primeira expresso
cujo anlise resultar em um valor verdadeiro.
- 20 ADVPL Completo
DO CASE...CASE
A estrutura DO CASE...ENDCASE (Caso) permite a anlise de diversas condies consecutivas,
para as quais somente a condio a primeira condio verdadeira ser sua ao vinculada
executada.
O recurso de anlise de mltiplas condies necessrio para soluo de problemas mais
complexos, nos quais as possibilidades de soluo superam a mera anlise de um nico
resultado verdadeiro ou falso.
Aes anteriores
...
Falso
Anlise da
condio 1
Verdadeiro
Ao vinculada a
condio 1
Verdadeiro
Ao vinculada a
condio 2
Verdadeiro
Ao vinculada a
condio N
Falso
Anlise da
condio 2
Falso
Anlise da
condio N
Falso
Continuao do
fluxo aps a
tomada da
deciso
Apesar das linguagens de programao possurem variaes para a estrutura

DO CASE...CASE, conceitualmente todas as representaes podem ser
descritas com base no modelo apresentado.
- 21 ADVPL Completo
2.2.2.
Os comandos de repetio so utilizados em algoritmos nas situaes em que necessrio

realizar uma determinada ao ou um conjunto de aes para um nmero definido ou
indefinido de vezes, ou ainda enquanto uma determinada condio for verdadeira.
As estruturas de deciso que sero analisadas so:
WHILE...END
FOR...TO...NEXT
WHILE...END
Nesta estrutura, o conjunto de aes ser executado enquanto a anlise de uma condio de
referncia resultar em um valor verdadeiro. importante verificar que o bloco somente ser
executado, inclusive se na primeira anlise a condio resultar em um valor verdadeiro.
Representao: WHILE...END
Aes anteriores
...
Anlise da
condio
Loop
Falso
Verdadeiro
Ao vinculada ao
resultado
verdadeiro
Continuao do
fluxo
...
Existem diversas variaes para a estrutura WHILE...END, na qual h a

possibilidade da primeira execuo ser realizada sem a anlise da condio, a
qual valer apenas a partir da segunda execuo.
A linguagem ADVPL aceita a sintaxe DO WHILE...ENDDO, que em outras
linguagens representa a situao descrita anteriormente (anlise da condio
somente a partir da segunda execuo), mas em ADVPL esta sintaxe tem o
mesmo efeito do WHILE...END.
- 22 ADVPL Completo
FOR...TO...NEXT
Nesta estrutura, o conjunto de aes ser executado uma quantidade de vezes definida,
normalmente referenciada como passo.
Para cada passo realizado pela estrutura FOR...TO...NEXT, ser avaliada uma condio que
verificar se foi atingido o nmero de execues previamente definido. Desta forma a
estrutura compreende um controle de nmero de passos executados, o qual incrementado
na anlise da expresso NEXT.
Semelhante a estrutura WHILE...END, a primeira ao somente ser realizada mediante um
resultado verdadeiro na anlise da condio.
Representao: FOR...TO...NEXT
Aes anteriores
...
Anlise da
condio
Falso
Verdadeiro
Ao vinculada ao
resultado
verdadeiro
Incrementa o
contador de
passos
Continuao do
fluxo
...
A estrutura FOR...TO...NEXT, dependendo da linguagem de programao,

permite a realizao de um incremento simples a cada execuo da instruo
NEXT, ou a adio de outro valor ao contador, o qual dever especificado de
acordo com a sintaxe da linguagem.
Em ADVPL pode ser utilizada a instruo STEPS para alterar o valor a ser
adicionado no contador de passos a cada execuo da instruo NEXT, sendo
que este valor poder ser at negativo, viabilizando uma contagem
decrescente.
- 23 ADVPL Completo
MDULO 02: A linguagem ADVPL

A Linguagem ADVPL teve seu incio em 1994, sendo na verdade uma evoluo na utilizao de
linguagens no padro xBase pela Microsiga Software S.A. (Clipper, Visual Objects e depois
FiveWin). Com a criao da tecnologia Protheus, era necessrio criar uma linguagem que
suportasse o padro xBase para a manuteno de todo o cdigo existente do sistema de ERP
Siga Advanced. Foi ento criada a linguagem chamada Advanced Protheus Language.
O ADVPL uma extenso do padro xBase de comandos e funes, operadores, estruturas de
controle de fluxo e palavras reservadas, contando tambm com funes e comandos
disponibilizados pela Microsiga que a torna uma linguagem completa para a criao de
aplicaes ERP prontas para a Internet. Tambm uma linguagem orientada a objetos e
eventos, permitindo ao programador desenvolver aplicaes visuais e criar suas prprias
classes de objetos.
Quando compilados, todos os arquivos de cdigo tornam-se unidades de inteligncia bsicas,
chamados APOs (de Advanced Protheus Objects). Tais APOs so mantidos em um
repositrio e carregados dinamicamente pelo PROTHEUS Server para a execuo. Como no
existe a linkedio, ou unio fsica do cdigo compilado a um determinado mdulo ou
aplicao, funes criadas em ADVPL podem ser executadas em qualquer ponto do ambiente
Advanced Protheus.
O compilador e o interpretador da linguagem ADVPL o prprio servidor PROTHEUS
(PROTHEUS Server), e existe um ambiente visual para desenvolvimento integrado
(PROTHEUSIDE) onde o cdigo pode ser criado, compilado e depurado.
Os programas em ADVPL podem conter comandos ou funes de interface com o usurio. De
acordo com tal caracterstica, tais programas so subdivididos nas seguintes categorias:
Programao Com Interface Prpria com o Usurio
Nesta categoria entram os programas desenvolvidos para serem executados atravs do
terminal remoto do Protheus, o Protheus Remote. O Protheus Remote a aplicao
encarregada da interface e da interao com o usurio, sendo que todo o processamento do
cdigo em ADVPL, o acesso ao banco de dados e o gerenciamento de conexes efetuado no
Protheus Server. O Protheus Remote o principal meio de acesso a execuo de rotinas
escritas em ADVPL no Protheus Server, e por isso permite executar qualquer tipo de cdigo,
tenha ele interface com o usurio ou no. Porm nesta categoria so considerados apenas os
programas que realizem algum tipo de interface remota utilizando o protocolo de comunicao
do Protheus.
Podem-se criar rotinas para a customizao do sistema ERP Microsiga Protheus, desde
processos adicionais at mesmo relatrios. A grande vantagem aproveitar todo o ambiente
montado pelos mdulos do ERP Microsiga Protheus. Porm, com o ADVPL possvel at
mesmo criar toda uma aplicao, ou mdulo, do comeo.
Todo o cdigo do sistema ERP Microsiga Protheus escrito em ADVPL.
Programao Sem Interface Prpria com o Usurio
As rotinas criadas sem interface so consideradas nesta categoria porque geralmente tm uma
utilizao mais especfica do que um processo adicional ou um relatrio novo. Tais rotinas no
tm interface com o usurio atravs do Protheus Remote, e qualquer tentativa nesse sentido
- 24 ADVPL Completo
(como a criao de uma janela padro) ocasionar uma exceo em tempo de execuo. Estas
rotinas so apenas processos, ou Jobs, executados no Protheus Server. Algumas vezes, a
interface destas rotinas fica a cargo de aplicaes externas, desenvolvidas em outras
linguagens, que so responsveis por iniciar os processos no servidor Protheus atravs dos
meios disponveis de integrao e conectividade no Protheus.
De acordo com a utilizao e com o meio de conectividade utilizado, estas rotinas so
subcategorizadas assim:
Programao por Processos
Rotinas escritas em ADVPL podem ser iniciadas como processos individuais (sem interface) no
Protheus Server atravs de duas maneiras: Iniciadas por outra rotina ADVPL atravs da
chamada de funes como StartJob() ou CallProc() ou iniciadas automaticamente na
inicializao do Protheus Server (quando propriamente configurado).
Programao de RPC
Atravs de uma biblioteca de funes disponvel no Protheus (uma API de comunicao),

podem-se executar rotinas escritas em ADVPL diretamente no Protheus Server, atravs de
aplicaes externas escritas em outras linguagens. Isto o que se chama de RPC (de Remote
Procedure Call, ou Chamada de Procedimentos Remota).
O servidor Protheus tambm pode executar rotinas em ADVPL em outros servidores Protheus
atravs de conexo TCP/IP direta utilizando o conceito de RPC. Do mesmo modo, aplicaes
externas podem requisitar a execuo de rotinas escritas em ADVPL atravs de conexo
TCP/IP direta.
Programao Web
O Protheus Server pode tambm ser executado como um servidor Web, respondendo a
requisies HTTP. No momento destas requisies, pode executar rotinas escritas em ADVPL
como processos individuais, enviando o resultado das funes como retorno das requisies
para o cliente HTTP (como por exemplo, um Browser de Internet). Qualquer rotina escrita em
ADVPL que no contenha comandos de interface pode ser executada atravs de requisies
HTTP. O Protheus permite a compilao de arquivos HTML contendo cdigo ADVPL embutido.
So os chamados arquivos ADVPL ASP, para a criao de pginas dinmicas.
Programao TelNet
TelNet parte da gama de protocolos TCP/IP que permite a conexo a um computador remoto
atravs de uma aplicao cliente deste protocolo. O PROTHEUS Server pode emular um
terminal TelNet, atravs da execuo de rotinas escritas em ADVPL. Ou seja, pode-se escrever
rotinas ADVPL cuja interface final ser um terminal TelNet ou um coletor de dados mvel.
- 25 ADVPL Completo
3. Estrutura de um Programa ADVPL

Um programa de computador nada mais do que um grupo de comandos logicamente
dispostos com o objetivo de executar determinada tarefa. Esses comandos so gravados em
um arquivo texto que transformado em uma linguagem executvel por um computador
atravs de um processo chamado compilao. A compilao substitui os comandos de alto
nvel (que os humanos compreendem) por instrues de baixo nvel (compreendida pelo
sistema operacional em execuo no computador). No caso do ADVPL, no o sistema
operacional de um computador que ir executar o cdigo compilado, mas sim o Protheus
Server.
Dentro de um programa, os comandos e funes utilizados devem seguir regras de sintaxe da
linguagem utilizada, pois caso contrrio o programa ser interrompido por erros. Os erros
podem ser de compilao ou de execuo.
Erros de compilao so aqueles encontrados na sintaxe que no permitem que o arquivo de
cdigo do programa seja compilado. Podem ser comandos especificados de forma errnea,
utilizao invlida de operadores, etc.
Erros de execuo so aqueles que acontecem depois da compilao, quando o programa est
sendo executado. Podem ocorrer por inmeras razes, mas geralmente se referem as funes
no existentes, ou variveis no criadas ou inicializadas, etc.
Linhas de Programa
As linhas existentes dentro de um arquivo texto de cdigo de programa podem ser linhas de
comando, linhas de comentrio ou linhas mistas.
Linhas de Comando
Linhas de comando possuem os comandos ou instrues que sero executadas. Por exemplo:
Local nCnt
Local nSoma := 0
For nCnt := 1 To 10
nSoma += nCnt
Next nCnt
Linhas de Comentrio
Linhas de comentrio possuem um texto qualquer, mas no so executadas. Servem apenas

para documentao e para tornar mais fcil o entendimento do programa. Existem trs formas
de se comentar linhas de texto. A primeira delas utilizar o sinal de * (asterisco) no comeo
da linha:
* Programa para clculo do total
* Autor: Microsiga Software S.A.
* Data: 2 de outubro de 2001
- 26 ADVPL Completo
Todas as linhas iniciadas com um sinal de asterisco so consideradas como comentrio. Podese utilizar a palavra NOTE ou dois smbolos da letra "e" comercial (&&) para realizar a funo
do sinal de asterisco. Porm todas estas formas de comentrio de linhas so obsoletas e
existem apenas para compatibilizao com o padro xBase. A melhor maneira de comentar
linhas em ADVPL utilizar duas barras transversais:
// Programa para clculo do total
// Autor: Microsiga Software S.A.
// Data: 2 de outubro de 2001
Outra forma de documentar textos utilizar as barras transversais juntamente com o
asterisco, podendo-se comentar todo um bloco de texto sem precisar comentar linha a linha:
/*
Programa para clculo do total
Autor: Microsiga Software S.A.
Data: 2 de outubro de 2001
*/
Todo o texto encontrado entre a abertura (indicada pelos caracteres /*) e o fechamento
(indicada pelos caracteres */) considerado como comentrio.
Linhas Mistas
O ADVPL tambm permite que existam linhas de comando com comentrio. Isto possvel
adicionando-se as duas barras transversais (//) ao final da linha de comando e adicionando-se
o texto do comentrio:
Local nCnt
Local nSoma := 0 // Inicializa a varivel com zero para a soma
For nCnt := 1 To 10
nSoma += nCnt
Next nCnt
Tamanho da Linha
Assim como a linha fsica, delimitada pela quantidade de caracteres que pode ser digitado no
editor de textos utilizado, existe uma linha considerada linha lgica. A linha lgica, aquela
considerada para a compilao como uma nica linha de comando.
A princpio, cada linha digitada no arquivo texto diferenciada aps o pressionamento da tecla
<Enter>. Ou seja, a linha lgica, a linha fsica no arquivo. Porm algumas vezes, por
limitao fsica do editor de texto ou por esttica, pode-se "quebrar" a linha lgica em mais de
uma linha fsica no arquivo texto. Isto efetuado utilizando-se o sinal de ponto-e-vrgula (;).
If !Empty(cNome) .And. !Empty(cEnd) .And. ; <enter>
!Empty(cTel) .And. !Empty(cFax) .And. ; <enter>
!Empty(cEmail)
GravaDados(cNome,cEnd,cTel,cFax,cEmail)
Endif
- 27 ADVPL Completo
Neste exemplo existe uma linha de comando para a checagem das variveis utilizadas. Como a
linha torna-se muito grande, pode-se dividi-la em mais de uma linha fsica utilizando o sinal de
ponto-e-vrgula. Se um sinal de ponto-e-vrgula for esquecido nas duas primeiras linhas,
durante a execuo do programa ocorrer um erro, pois a segunda linha fsica ser
considerada como uma segunda linha de comando na compilao. E durante a execuo esta
linha no ter sentido.
3.1. reas de um Programa ADVPL

Apesar de no ser uma linguagem de padres rgidos com relao estrutura do programa,
importante identificar algumas de suas partes. Considere o programa de exemplo abaixo:
#include protheus.ch
/*
+===========================================+
| Programa: Clculo do Fatorial
|
| Autor : Microsiga Software S.A.
|
| Data : 02 de outubro de 2001
|
+===========================================+
*/
User Function CalcFator()
Local nCnt
Local nResultado := 1 // Resultado do fatorial
Local nFator
:= 5 // Nmero para o clculo
// Clculo do fatorial
For nCnt := nFator To 1 Step -1
nResultado *= nCnt
Next nCnt
// Exibe o resultado na tela, atravs da funo alert
Alert("O fatorial de " + cValToChar(nFator) + ;
" " + cValToChar(nResultado))
// Termina o programa
Return
A estrutura de um programa ADVPL composta pelas seguintes reas:
rea de Identificao
Declarao dos includes
Declarao da funo
Identificao do programa
rea de Ajustes Iniciais
Declarao das variveis
Corpo do Programa
Preparao para o processamento
Processamento
rea de Encerramento
- 28 ADVPL Completo
rea de Identificao
Esta uma rea que no obrigatria e dedicada a documentao do programa. Quando
existente, contm apenas comentrios explicando a sua finalidade, data de criao, autor, etc.,
e aparece no comeo do programa, antes de qualquer linha de comando.
O formato para esta rea no definido. Pode-se colocar qualquer tipo de informao
desejada e escolher a formatao apropriada.
/*
+==========================================+
|
| Autor : Microsiga Software S.A.
|
| Data : 02 de outubro de 2001
|
+==========================================+
*/
Opcionalmente podem-se incluir definies de constantes utilizadas no programa ou incluso

de arquivos de cabealho nesta rea.
Nesta rea geralmente se fazem os ajustes iniciais, importantes para o correto funcionamento
do programa. Entre os ajustes se encontram declaraes de variveis, inicializaes, abertura
de arquivos, etc. Apesar do ADVPL no ser uma linguagem rgida e as variveis poderem ser
declaradas em qualquer lugar do programa, aconselhvel faz-lo nesta rea visando tornar o
cdigo mais legvel e facilitar a identificao de variveis no utilizadas.
Local nCnt
Local nFator
Corpo do Programa
nesta rea que se encontram as linhas de cdigo do programa. onde se realiza a tarefa
necessria atravs da organizao lgica destas linhas de comando. Espera-se que as linhas de
comando estejam organizadas de tal modo que no final desta rea o resultado esperado seja
obtido, seja ele armazenado em um arquivo ou em variveis de memria, pronto para ser
exibido ao usurio atravs de um relatrio ou na tela.
nResultado *= nCnt
Next nCnt
- 29 ADVPL Completo
A preparao para o processamento formada pelo conjunto de validaes e processamentos

necessrios antes da realizao do processamento em si.
Avaliando o processamento do clculo do fatorial descrito anteriormente, pode-se definir que a
validao inicial a ser realizada o contedo da varivel nFator, pois a mesma determinar a
correta execuo do cdigo.
nFator := GetFator()
// GetFator funo ilustrativa na qual a varivel recebe a informao do usurio.
If nFator <= 0
Alert(Informao invlida)
Return
Endif
nResultado *= nCnt
Next nCnt
rea de Encerramento
nesta rea onde as finalizaes so efetuadas. onde os arquivos abertos so fechados, e o
resultado da execuo do programa utilizado. Pode-se exibir o resultado armazenado em
uma varivel ou em um arquivo ou simplesmente finalizar, caso a tarefa j tenha sido toda
completada no corpo do programa. nesta rea que se encontra o encerramento do
programa. Todo programa em ADVPL deve sempre terminar com a palavra chave return.
Return
- 30 ADVPL Completo
4. Declarao e Atribuio de Variveis

4.1. Tipo de Dados
O ADVPL no uma linguagem de tipos rgidos (strongly typed), o que significa que variveis
de memria podem receber diferentes tipos de dados durante a execuo do programa.
As variveis podem tambm conter objetos, mas os tipos primrios da linguagem so:
Numrico
O ADVPL no diferencia valores inteiros de valores com ponto flutuante, portanto podem-se
criar variveis numricas com qualquer valor dentro do intervalo permitido. Os seguintes
elementos so do tipo de dado numrico:
2
43.53
0.5
0.00001
1000000
Uma varivel do tipo de dado numrico pode conter um nmero de dezoito dgitos incluindo o
ponto flutuante, no intervalo de 2.2250738585072014 E308 at 1.7976931348623158
E+308.
Lgico
Valores lgicos em ADVPL so identificados atravs de .T. ou .Y. para verdadeiro e .F. ou .N.
para falso (independentemente se os caracteres estiverem em maisculo ou minsculo).
Caractere
Strings ou cadeias de caracteres so identificadas em ADVPL por blocos de texto entre aspas
duplas (") ou aspas simples ('):
"Ol mundo!"
'Esta uma string'
"Esta 'outra' string"
Uma varivel do tipo caractere pode conter strings com no mximo 1 MB, ou seja, 1048576
caracteres.
Data
O ADVPL tem um tipo de dados especfico para datas. Internamente as variveis deste tipo de
dado so armazenadas como um nmero correspondente a data Juliana.
Variveis do tipo de dados Data no podem ser declaradas diretamente, e sim atravs da
utilizao de funes especficas como por exemplo CTOD() que converte uma string para
data.
- 31 ADVPL Completo
Array
O Array um tipo de dado especial. a disposio de outros elementos em colunas e linhas. O
ADVPL suporta arrays unidimensionais (vetores) ou multidimensionais (matrizes). Os
elementos de um array so acessados atravs de ndices numricos iniciados em 1,
identificando a linha e coluna para quantas dimenses existirem.
Arrays devem ser utilizadas com cautela, pois se forem muito grandes podem exaurir a
memria do servidor.
Bloco de Cdigo
O bloco de cdigo um tipo de dado especial. utilizado para armazenar instrues escritas
em ADVPL que podero ser executadas posteriormente.
4.2. Declarao de variveis

Variveis de memria so um dos recursos mais importantes de uma linguagem. So reas de
memria criadas para armazenar informaes utilizadas por um programa para a execuo de
tarefas. Por exemplo, quando o usurio digita uma informao qualquer, como o nome de um
produto, em uma tela de um programa esta informao armazenada em uma varivel de
memria para posteriormente ser gravada ou impressa.
A partir do momento que uma varivel criada, no necessrio mais se referenciar ao seu
contedo, e sim ao seu nome.
O nome de uma varivel um identificador nico o qual deve respeitar um mximo de 10
caracteres. O ADVPL no impede a criao de uma varivel de memria cujo nome contenha
mais de 10 caracteres, porm apenas os 10 primeiros sero considerados para a
localizao do contedo armazenado.
Portanto se forem criadas duas variveis cujos 10 primeiros caracteres forem iguais, como
nTotalGeralAnual e nTotalGeralMensal, as referncias a qualquer uma delas no programa
resultaro o mesmo, ou seja, sero a mesma varivel:
nTotalGeralMensal := 100
nTotalGeralAnual := 300
Alert("Valor mensal: " + cValToChar(nTotalGeralMensal))
Quando o contedo da varivel nTotalGeralMensal exibido, o seu valor ser de 300. Isso
acontece porque no momento que esse valor foi atribudo varivel nTotalGeralAnual, o
ADVPL considerou apenas os 10 primeiros caracteres (assim como o faz quando deve exibir o
valor da varivel nTotalGeralMensal), ou seja, considerou-as como a mesma varivel. Assim o
valor original de 100 foi substitudo pelo de 300.
- 32 ADVPL Completo
4.3. Escopo de variveis

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. 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), pblico (visualizadas por qualquer outro programa), entre outros.
O Contexto de Variveis dentro de um Programa
As variveis declaradas em um programa ou funo, so visveis de acordo com o escopo onde
so definidas. Como tambm do escopo depende o tempo de existncia das variveis. A
definio do escopo de uma varivel efetuada no momento de sua declarao.
Local nNumero := 10
Esta linha de cdigo declara uma varivel chamada nNumero indicando que pertence seu
escopo local.
Os identificadores de escopo so:
Local
Static
Private
Public
O ADVPL no rgido em relao declarao de variveis no comeo do programa. A incluso

de um identificador de escopo no necessrio para a declarao de uma varivel, contanto
que um valor lhe seja atribudo.
nNumero2 := 15
Quando um valor atribudo uma varivel em um programa ou funo, o ADVPL criar a
varivel caso ela no tenha sido declarada anteriormente. A varivel ento criada como se
tivesse sido declarada como Private.
Devido a essa caracterstica, quando se pretende fazer uma atribuio a uma varivel
declarada previamente mas escreve-se o nome da varivel de forma incorreta, o ADVPL no
gerar nenhum erro de compilao ou de execuo. Pois compreender o nome da varivel
escrito de forma incorreta como se fosse a criao de uma nova varivel. Isto alterar a lgica
do programa, e um erro muitas vezes difcil de identificar.
- 33 ADVPL Completo
Variveis de escopo local

Variveis de escopo local so pertencentes apenas ao escopo da funo onde foram declaradas
e devem ser explicitamente declaradas com o identificador LOCAL, como no exemplo:
Function Pai()
Local nVar := 10, aMatriz := {0,1,2,3}
.
<comandos>
.
Filha()
.
<mais comandos>
.
Return(.T.)
Neste exemplo, a varivel nVar foi declarada como local e atribuda com o valor 10. Quando a
funo Filha executada, nVar ainda existe mas no pode ser acessada. Quando a execuo
da funo Pai terminar, a varivel nVar destruda. Qualquer varivel com o mesmo nome no
programa que chamou a funo Pai no afetada.
Variveis de escopo local so criadas automaticamente cada vez que a funo onde forem
declaradas for ativada. Elas continuam a existir e mantm seu valor at o fim da ativao da
funo (ou seja, at que a funo retorne o controle para o cdigo que a executou). Se uma
funo chamada recursivamente (por exemplo, chama a si mesma), cada chamada em
recurso cria um novo conjunto de variveis locais.
A visibilidade de variveis de escopo locais idntica ao escopo de sua declarao, ou seja, a
varivel visvel em qualquer lugar do cdigo fonte em que foi declarada. Se uma funo
chamada recursivamente, apenas as variveis de escopo local criadas na mais recente ativao
so visveis.
Variveis de escopo static
Variveis de escopo static funcionam basicamente como as variveis de escopo local, mas
mantm seu valor atravs da execuo e devem ser declaradas explicitamente no cdigo com
o identificador STATIC.
O escopo das variveis static depende de onde so declaradas. Se forem declaradas dentro do
corpo de uma funo ou procedimento, seu escopo ser limitado quela rotina. Se forem
declaradas fora do corpo de qualquer rotina, seu escopo afeta a todas as funes declaradas
no fonte.
- 34 ADVPL Completo
Neste exemplo, a varivel nVar declarada como static e inicializada com o valor 10:
Function Pai()
Static nVar := 10
.
<comandos>
.
Filha()
.
<mais comandos>
.
Return(.T.)
Quando a funo Filha executada, nVar ainda existe mas no pode ser acessada. Diferente
de variveis declaradas como LOCAL ou PRIVATE, nVar continua a existir e mantm seu valor
atual quando a execuo da funo Pai termina. Entretanto, somente pode ser acessada por
execues subseqentes da funo Pai.
Variveis de escopo private
A declarao opcional para variveis privadas. Mas podem ser declaradas explicitamente com
o identificador PRIVATE.
Adicionalmente, a atribuio de valor a uma varivel no criada anteriormente
automaticamente cria a varivel como privada. Uma vez criada, uma varivel privada continua
a existir e mantm seu valor at que o programa ou funo onde foi criada termine (ou seja,
at que a funo onde foi criada retorne para o cdigo que a executou). Neste momento,
automaticamente destruda.
possvel criar uma nova varivel privada com o mesmo nome de uma varivel j existente.
Entretanto, a nova (duplicada) varivel pode apenas ser criada em um nvel de ativao
inferior ao nvel onde a varivel foi declarada pela primeira vez (ou seja, apenas em uma
funo chamada pela funo onde a varivel j havia sido criada). A nova varivel privada ir
esconder qualquer outra varivel privada ou pblica (veja a documentao sobre variveis
pblicas) com o mesmo nome enquanto existir.
Uma vez criada, uma varivel privada visvel em todo o programa enquanto no for
destruda automaticamente quando a rotina que a criou terminar ou uma outra varivel
privada com o mesmo nome for criada em uma subfuno chamada (neste caso, a varivel
existente torna-se inacessvel at que a nova varivel privada seja destruda).
Em termos mais simples, uma varivel privada visvel dentro da funo de criao e todas as
funes chamadas por esta, a menos que uma funo chamada crie sua prpria varivel
privada com o mesmo nome.
- 35 ADVPL Completo
Por exemplo:
Function Pai()
Private nVar := 10
<comandos>
.
Filha()
<mais comandos>
.
Return(.T.)
Neste exemplo, a varivel nVar criada com escopo private e inicializada com o valor 10.
Quando a funo Filha executada, nVar ainda existe e, diferente de uma varivel de escopo
local, pode ser acessada pela funo Filha. Quando a funo Pai terminar, nVar ser destruda
e qualquer declarao de nVar anterior se tornar acessvel novamente.
No ambiente ERP Protheus, existe uma conveno adicional a qual deve ser
respeitada que variveis em uso pela aplicao no sejam incorretamente
manipuladas. Por esta conveno deve ser adicionado o caracter _ antes
do nome de variveis PRIVATE e PUBLIC. Maiores informaes avaliar o
tpico: Boas Prticas de Programao.
Exemplo: Private _dData
Variveis de escopo public
Podem-se criar variveis de escopo public dinamicamente no cdigo com o identificador
PUBLIC. As variveis deste escopo continuam a existir e mantm seu valor at o fim da
execuo da thread (conexo).
possvel criar uma varivel de escopo private com o mesmo nome de uma varivel de escopo
public existente, entretanto, no permitido criar uma varivel de escopo public com o mesmo
nome de uma varivel de escopo private existente.
Uma vez criada, uma varivel de escopo public visvel em todo o programa onde foi
declarada at que seja escondida por uma varivel de escopo private criada com o mesmo
nome. A nova varivel de escopo private criada esconde a varivel de escopo public existente,
e esta se tornar inacessvel at que a nova varivel private seja destruda. Por exemplo:
Function Pai()
Public nVar := 10
<comandos>
.
Filha()
<mais comandos>
.
Return(.T.)
- 36 ADVPL Completo
Neste exemplo, nVar criada como public e inicializada com o valor 10. Quando a funo Filha
executada, nVar ainda existe e pode ser acessada. Diferente de variveis locais ou privates,
nVar ainda existe aps o trmino da a execuo da funo Pai.
Diferentemente dos outros identificadores de escopo, quando uma varivel declarada como
pblica sem ser inicializada, o valor assumido falso (.F.) e no nulo (nil).
Exemplo: Public _cRotina
4.4. Entendendo a influncia do escopo das variveis

Considere as linhas de cdigo de exemplo:
nResultado := 250 * (1 + (nPercentual / 100))
Se esta linha for executada em um programa ADVPL, 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

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 mais
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
atravs de uma das formas:

nPercentual := 10
ou
Local nPercentual := 10, nResultado
A diferena entre o ltimo exemplo e os dois anteriores que a varivel inicializada no
momento da declarao. Em ambos os exemplos, a varivel primeiro declarada e ento
inicializada em uma outra linha de cdigo.
- 37 ADVPL Completo
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.
4.5. Operaes com Variveis

4.5.1.
Atribuio de variveis
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 caractere 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:
01
02
03
04
05
06
07
08
09
10
11
12
13
14
15
16
17
18
19
20
21
22
Local xVariavel // Declara a varivel inicialmente com valor nulo

xVariavel := "Agora a varivel caractere..."
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 varivel tem valor falso...")
Endif
xVariavel := Date() // Agora a varivel data
Alert("Hoje : " + DtoC(xVariavel))
xVariavel := nil // Nulo novamente
Alert("Valor nulo: " + xVariavel)
Return
No programa de exemplo anterior, a varivel xVariavel utilizada para armazenar diversos

tipos de dados. A letra "x" em minsculo no comeo do nome utilizada para indicar uma
varivel que pode conter diversos tipos de dados, segundo a Notao Hngara (consulte
documentao especfica para detalhes). Este programa troca os valores da varivel e exibe
seu contedo para o usurio atravs da funo ALERT(). Essa funo recebe um parmetro
que deve ser do tipo string de caractere, por isso dependendo do tipo de dado da varivel
xVariavel necessrio fazer uma converso antes.
Apesar dessa flexibilidade de utilizao de variveis, devem-se tomar cuidados na passagem
de parmetros para funes ou comandos, e na concatenao (ou soma) de valores. Note a
linha 20 do programa de exemplo. Quando esta linha executada, a varivel xVariavel contm
o valor nulo. A tentativa de soma de tipos de dados diferentes gera erro de execuo do
programa. Nesta linha do exemplo, ocorrer um erro com a mensagem "type mismatch on +".
Excetuando-se o caso do valor nulo, para os demais devem ser utilizadas funes de
converso quando necessrio concatenar tipos de dados diferentes (por exemplo, nas linhas
07 e 17.
- 38 ADVPL Completo
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.
4.5.2.
Operadores da linguagem ADVPL
Operadores comuns
Na documentao sobre variveis h uma breve demonstrao de como atribuir valores a uma
varivel da forma mais simples. O ADVPL amplia significativamente a utilizao de variveis
atravs do uso de expresses e funes.
Uma expresso um conjunto de operadores e operandos cujo resultado pode ser atribudo a
uma varivel ou ento analisado para a tomada de decises. Por exemplo:
Local nSalario := 1000, nDesconto := 0.10
Local nAumento, nSalLiquido
nAumento := nSalario * 1.20
nSalLiquido := nAumento * (1-nDesconto)
Neste exemplo so utilizadas algumas expresses para calcular o salrio lquido aps um
aumento. Os operandos de uma expresso podem ser uma varivel, uma constante, um
campo de arquivo ou uma funo.
Operadores Matemticos
Os operadores utilizados em ADVPL para clculos matemticos so:
+
*
/
** ou ^
%
Adio
Subtrao
Multiplicao
Diviso
Exponenciao
Mdulo (Resto da Diviso)
Operadores de String
Os operadores utilizados em ADVPL para tratamento de caracteres so:
+
$
Concatenao de strings (unio)

Concatenao de strings com eliminao dos brancos finais das strings
intermedirias
Comparao de Substrings (contido em)
- 39 ADVPL Completo
Operadores Relacionais
Os operadores utilizados em ADVPL para operaes e avaliaes relacionais so:
<
>
=
==
<=
>=
<> ou #
ou !=
Comparao
Comparao
Comparao
Comparao
Comparao
Comparao
Comparao
Menor
Maior
Igual
Exatamente Igual (para caracteres)
Menor ou Igual
Maior ou Igual
Diferente
Operadores Lgicos
Os operadores utilizados em ADVPL para operaes e avaliaes lgicas so:
.And.
.Or.
.Not. ou !
E lgico
OU lgico
NO lgico
Operadores de Atribuio
Os operadores utilizados em ADVPL para atribuio de valores a variveis de memria so:
:=
+=
-=
*=
/=
**=
^=
%=
ou
Atribuio Simples
Adio e Atribuio em Linha
Subtrao e Atribuio em Linha
Multiplicao e Atribuio em Linha
Diviso e Atribuio em Linha
Exponenciao e Atribuio em Linha
Mdulo (resto da diviso) e Atribuio em Linha
Atribuio Simples
O sinal de igualdade utilizado para atribuir valor a uma varivel de memria.

nVariavel := 10
Atribuio em Linha
O operador de atribuio em linha caracterizado por dois pontos e o sinal de igualdade. Tem
a mesma funo do sinal de igualdade sozinho, porm aplica a atribuio s variveis. Com ele
pode-se atribuir mais de uma varivel ao mesmo tempo.
nVar1 := nVar2 := nVar3 := 0
- 40 ADVPL Completo
Quando diversas variveis so inicializadas em uma mesma linha, a atribuio comea da

direita para a esquerda, ou seja, nVar3 recebe o valor zero inicialmente, nVar2 recebe o
contedo de nVar3 e nVar1 recebe o contedo de nVar2 por final.
Com o operador de atribuio em linha, pode-se substituir as inicializaes individuais de cada
varivel por uma inicializao apenas:
Local nVar1 := 0, nVar2 := 0, nVar3 := 0
por
Local nVar1 := nVar2 := nVar3 := 0
O operador de atribuio em linha tambm pode ser utilizado para substituir valores de
campos em um banco de dados.
Atribuio Composta
Os operadores de atribuio composta so uma facilidade da linguagem ADVPL para

expresses de clculo e atribuio. Com eles pode-se economizar digitao:
Operador
+=
-=
*=
/=
**= ou ^=
%=
Exemplo
X += Y
X -= Y
X *= Y
X /= Y
X **= Y
X %= Y
Equivalente a
X=X+Y
X=X-Y
X=X*Y
X=X/Y
X = X ** Y
X=X%Y
Operadores de Incremento/Decremento
A linguagem ADVPL possui operadores para realizar incremento ou decremento de variveis.
Entende-se por incremento aumentar o valor de uma varivel numrica em 1 e entende-se por
decremento diminuir o valor da varivel em 1. Os operadores so:
++
--
Incremento Ps ou Pr-fixado
Decremento Ps ou Pr-fixado
Os operadores de decremento/incremento podem ser colocados tanto antes (pr-fixado) como

depois (ps-fixado) do nome da varivel. Dentro de uma expresso, a ordem do operador
muito importante, podendo alterar o resultado da expresso. Os operadores incrementais so
executados da esquerda para a direita dentro de uma expresso.
Local nA := 10
Local nB := nA++ + nA
O valor da varivel nB resulta em 21, pois a primeira referncia a nA (antes do ++) continha o
valor 10 que foi considerado e imediatamente aumentado em 1. Na segunda referncia a nA,
este j possua o valor 11. O que foi efetuado foi a soma de 10 mais 11, igual a 21. O
resultado final aps a execuo destas duas linhas a varivel nB contendo 21 e a varivel nA
contendo 11.
No entanto:
Local nA := 10
Local nB := ++nA + nA
- 41 ADVPL Completo
Resulta em 22, pois o operador incremental aumentou o valor da primeira nA antes que seu
valor fosse considerado.
Operadores Especiais
Alm dos operadores comuns, o ADVPL possui alguns outros operadores ou identificadores.
Estas so suas finalidades:
()
[]
{}
->
&
@
||
Agrupamento ou Funo
Elemento de Matriz
Definio de Matriz, Constante ou Bloco de Cdigo
Identificador de Apelido
Macro substituio
Passagem de parmetro por referncia
Passagem de parmetro por valor
Os parnteses so utilizados para agrupar elementos em uma expresso mudando a

ordem de precedncia da avaliao da expresso (segundo as regras matemticas por
exemplo). Tambm servem para envolver os argumentos de uma funo.
Os colchetes so utilizados para especificar um elemento especfico de uma matriz. Por

exemplo, A[3,2], refere-se ao elemento da matriz A na linha 3, coluna 2.
As chaves so utilizadas para a especificao de matrizes literais ou blocos de cdigo.

Por exemplo, A:={10,20,30} cria uma matriz chamada A com trs elementos.
O smbolo -> identifica um campo de um arquivo diferenciando-o de uma varivel. Por

exemplo, FUNC->nome refere-se ao campo nome do arquivo FUNC. Mesmo que exista uma
varivel chamada nome, o campo nome que ser acessado.
O smbolo & identifica uma avaliao de expresso atravs de macro e visto em

detalhes na documentao sobre macro substituio.
O smbolo @ utilizado para indicar que durante a passagem de uma varivel para uma
funo ou procedimento ela seja tomada como uma referncia e no como valor.
O smbolo || utilizado para indicar que durante a passagem de uma varivel para
uma funo ou procedimento ela seja tomada como um e valor no como referncia.
- 42 ADVPL Completo
Ordem de Precedncia dos Operadores

Dependendo do tipo de operador, existe uma ordem de precedncia para a avaliao dos
operandos. Em princpio, todas as operaes com os operadores, so realizadas da esquerda
para a direita se eles tiverem o mesmo nvel de prioridade.
A ordem de precedncia, ou nvel de prioridade de execuo, dos operadores em ADVPL :
1.
2.
3.
4.
5.
6.
7.
Operadores
Operadores
Operadores
Operadores
Operadores
Operadores
Operadores
de Incremento/Decremento pr-fixado
de String
Matemticos
Relacionais
Lgicos
de Atribuio
de Incremento/Decremento ps-fixado
Em expresses complexas com diferentes tipos de operadores, a avaliao seguir essa

seqncia. Caso exista mais de um operador do mesmo tipo (ou seja, de mesmo nvel), a
avaliao se d da esquerda para direita. Para os operadores matemticos entretanto, h uma
precedncia a seguir:
1.
2.
3.
Exponenciao
Multiplicao e Diviso
Adio e Subtrao
Considere o exemplo:
Local nResultado := 2+10/2+5*3+2^3
O resultado desta expresso 30, pois primeiramente calculada a exponenciao 2^3(=8),
ento so calculadas as multiplicaes e divises 10/2(=5) e 5*3(=15), e finalmente as
adies resultando em 2+5+15+8(=30).
Alterao da Precedncia
A utilizao de parnteses dentro de uma expresso altera a ordem de precedncia dos

operadores. Operandos entre parnteses so analisados antes dos que se encontram fora dos
parnteses. Se existirem mais de um conjunto de parnteses no-aninhados, o grupo mais a
esquerda ser avaliado primeiro e assim sucessivamente.
Local nResultado := (2+10)/(2+5)*3+2^3
No exemplo acima primeiro ser calculada a exponenciao 2^3(=8). Em seguida 2+10(=12)
ser calculado, 2+5(=7) calculado, e finalmente a diviso e a multiplicao sero efetuadas, o
que resulta em 12/7*3+8(=13.14).
Se existirem vrios parnteses aninhados, ou seja, colocados um dentro do outro, a avaliao
ocorrer do parnteses mais intero em direo ao mais externo.
- 43 ADVPL Completo
4.5.3.
Operao de Macro Substituio
O operador de macro substituio, simbolizado pelo "e" comercial (&), utilizado para a
avaliao de expresses em tempo de execuo. Funciona como se uma expresso
armazenada fosse compilada em tempo de execuo, antes de ser de fato executada.
01 X := 10
02 Y := "X + 1"
03 B := &Y // O contedo de B ser 11
A varivel X atribuda com o valor 10, enquanto a varivel Y atribuda com a string de
caracteres contendo "X + 1".
A terceira linha utiliza o operador de macro. Esta linha faz com que o nmero 11 seja atribudo
varivel B. Pode-se perceber que esse o valor resultante da expresso em formato de
caractere contida na varivel Y.
Utilizando-se uma tcnica matemtica elementar, a substituio, temos que na segunda linha,
Y definido como "X + 1", ento pode-se substituir Y na terceira linha:
03 B := &"X + 1"
O operador de macro cancela as aspas:
03 B := X + 1
Pode-se perceber que o operador de macro remove as aspas, o que deixa um pedao de
cdigo para ser executado. Deve-se ter em mente que tudo isso acontece em tempo de
execuo, o que torna tudo muito dinmico. Uma utilizao interessante criar um tipo de
calculadora, ou avaliador de frmulas, que determina o resultado de algo que o usurio digita.
O operador de macro tem uma limitao: variveis referenciadas dentro da string de
caracteres (X nos exemplos anteriores) no podem ser locais.
- 44 ADVPL Completo
4.5.4.
Funes de manipulao de variveis
Alm de atribuir, controlar o escopo e macro executar o contedo das variveis necessrio
manipular seu contedo atravs de funes especficas da linguagem para cada situao.
As operaes de manipulao de contedo mais comuns em programao so:
Converses entre tipos de variveis

Manipulao de strings
Manipulao de variveis numricas
Verificao de tipos de variveis
Manipulao de arrays
Execuo de blocos de cdigo
Neste tpico sero abordadas as converses entre tipos de variveis e as funes de

manipulao de strings e variveis numricas.
Converses entre tipos de variveis
As funes mais utilizadas nas operaes entre converso entre tipos de variveis so:
CTOD()
CVALTOCHAR()
DTOC()
DTOS()
STOD()
STR()
STRZERO()
VAL()
CTOD()
Sintaxe
CTOD(cData)
Descrio
Realiza a converso de uma informao do tipo caracter no formato

DD/MM/AAAA para uma varivel do tipo data.
CVALTOCHAR()
Sintaxe
CVALTOCHAR(nValor)
Descrio
Realiza a converso de uma informao do tipo numrico em uma string,

sem a adio de espaos a informao.
- 45 ADVPL Completo
DTOC()
Sintaxe
DTOC(dData)
Descrio
Realiza a converso de uma informao do tipo data para em caracter, sendo

o resultado no formato DD/MM/AAAA.
DTOS()
Sintaxe
DTOS(dData)
Descrio
Realiza a converso de uma informao do tipo data em um caracter, sendo

o resultado no formato AAAAMMDD.
STOD()
Sintaxe
STOD(sData)
Descrio
Realiza a converso de uma informao do tipo caracter com contedo no

formato AAAAMMDD em data.
STR()
Sintaxe
STR(nValor)
Descrio

adicionando espaos direita.
STRZERO()
Sintaxe
STRZERO(nValor, nTamanho)
Descrio

adicionando zeros esquerda do nmero convertido, de forma que a string
gerada tenha o tamanho especificado no parmetro.
VAL()
Sintaxe
VAL(cValor)
Descrio
Realiza a converso de uma informao do tipo caracter em numrica.

- 46 ADVPL Completo
Manipulao de strings
As funes mais utilizadas nas operaes de manipulao do contedo de strings so:
ALLTRIM()
ASC()
AT()
CHR()
CSTUFF()
LEN()
RAT()
SUBSTR()
ALLTRIM()
Sintaxe
ALLTRIM(cString)
Retorna uma string sem os espaos direita e esquerda, referente ao
contedo informado como parmetro.
Descrio
A funo ALLTRIM() implementa as aes das funes RTRIM (right trim) e

LTRIM (left trim).
ASC()
Sintaxe
ASC(cCaractere)
Descrio
Converte uma informao caractere em seu valor de acordo com a tabela

ASCII.
AT()
Sintaxe
AT(cCaractere, cString )
Descrio
Retorna a primeira posio de um caracter ou string dentro de outra string

especificada.
- 47 ADVPL Completo
CHR()
Sintaxe
CHR(nASCII)
Descrio
Converte um valor nmero referente a uma informao da tabela ASCII no

caractere que esta informao representa.
LEN()
Sintaxe
LEN(cString)
Descrio
Retorna o tamanho da string especificada no parmetro.
LOWER()
Sintaxe
LOWER(cString)
Descrio
Retorna uma string com todos os caracteres minsculos, tendo como base a
string passada como parmetro.
RAT()
Sintaxe
RAT(cCaractere, cString)
Descrio
Retorna a ltima posio de um caracter ou string dentro de outra string

especificada.
STUFF()
Sintaxe
Descrio
STUFF(cString, nPosInicial, nExcluir, cAdicao)

Permite substituir um contedo caractere em uma string j existente,
especificando a posio inicial para esta adio e o nmero de caracteres que
sero substitudos.
SUBSTR()
Sintaxe
Descrio
SUBSTR(cString, nPosInicial, nCaracteres)

Retorna parte do contedo de uma string especificada, de acordo com a
posio inicial deste contedo na string e a quantidade de caracteres que
dever ser retornada a partir daquele ponto (inclusive).
- 48 ADVPL Completo
UPPER()
Sintaxe
UPPER(cString)
Descrio
Retorna uma string com todos os caracteres maisculos, tendo como base a
string passada como parmetro.
Manipulao de variveis numricas

As funes mais utilizadas nas operaes de manipulao do contedo de strings so:
ABS()
INT()
NOROUND()
ROUND()
ABS()
Sintaxe
ABS(nValor)
Descrio
Retorna um valor absoluto (independente do sinal) com base no valor

especificado no parmetro.
INT()
Sintaxe
INT(nValor)
Descrio
Retorna a parte inteira de um valor especificado no parmetro.
NOROUND()
Sintaxe
NOROUND(nValor, nCasas)
Descrio
Retorna um valor, truncando a parte decimal do valor especificado no

parmetro de acordo com a quantidade de casas decimais solicitadas.
ROUND()
Sintaxe
Descrio
ROUND(nValor, nCasas)
Retorna um valor, arredondando a parte decimal do valor especificado no
parmetro de acordo com a quantidades de casas decimais solicitadas,
utilizando o critrio matemtico.
- 49 ADVPL Completo
Verificao de tipos de variveis

As funes de verificao permitem a consulta ao tipo do contedo da varivel durante a
execuo do programa.
TYPE()
VALTYPE()
TYPE()
Sintaxe
TYPE(cVariavel)
Descrio
Determina o tipo do contedo de uma varivel, a qual no foi definida na

funo em execuo.
VALTYPE()
Sintaxe
VALTYPE(cVarivel)
Descrio
Determina o tipo do contedo de uma varivel, a qual foi definida na funo

em execuo.
- 50 ADVPL Completo
5. Estruturas bsicas de programao

O ADVPL suporta vrias estruturas de controle que permitem mudar a seqncia de fluxo de
execuo de um programa. Estas estruturas permitem a execuo de cdigo baseado em
condies lgica e a repetio da execuo de pedaos de cdigo qualquer nmero de vezes.
Em ADVPL, todas as estruturas de controle podem ser "aninhadas" dentro de todas as demais
estruturas contanto que estejam aninhadas propriamente. Estruturas de controle tm um
identificador de incio e um de fim, e qualquer estrutura aninhada deve se encontrar entre
estes identificadores.
Tambm existem estruturas de controle para determinar que elementos, comandos, etc. em
um programa sero compilados. Estas so as diretivas do pr-processador #ifdef...#endif e
#ifndef...#endif. Consulte a documentao sobre o pr-processador para maiores detalhes.
As estruturas de controle em ADVPL esto divididas em:
5.1. Estruturas de repetio

Estruturas de repetio so designadas para executar uma seo de cdigo mais de uma vez.
Por exemplo, imaginando-se a existncia de uma funo para imprimir um relatrio, pode-se
desejar imprimi-lo quatro vezes. Claro, pode-se simplesmente chamar a funo de impresso
quatro vezes em seqncia, mas isto se tornaria pouco profissional e no resolveria o
problema se o nmero de relatrios fosse varivel.
Em ADVPL existem dois comandos para a repetio de sees de cdigo, que so os comandos
FOR...NEXT e o comando WHILE...ENDDO.
O Comando FOR...NEXT
A estrutura de controle FOR...NEXT, ou simplesmente o loop FOR, repete uma seo de cdigo
em um nmero determinado de vezes.
Sintaxe
FOR Variavel := nValorInicial TO nValorFinal [STEP nIncremento]

Comandos...
[EXIT]
[LOOP]
NEXT
- 51 ADVPL Completo
Parmetros
Varivel
nValorInicial
TO nValorFinal
STEP
nIncremento
Comandos
EXIT
LOOP
Especifica uma varivel ou um elemento de uma matriz para

atuar como um contador. A varivel ou o elemento da matriz
no precisa ter sido declarado antes da execuo do comando
FOR...NEXT. Se a varivel no existir, ser criada como uma
varivel privada.
nValorInicial o valor inicial para o contador; nValorFinal o
valor final para o contador. Pode-se utilizar valores numricos
literais, variveis ou expresses, contanto que o resultado seja
do tipo de dado numrico.
nIncremento a quantidade que ser incrementada ou
decrementada no contador aps cada execuo da seo de
comandos. Se o valor de nIncremento for negativo, o contador
ser decrementado. Se a clusula STEP for omitida, o contador
ser incrementado em 1. Pode-se utilizar valores numricos
literais, variveis ou expresses, contanto que o resultado seja
do tipo de dado numrico.
Especifica um ou mais instrues de comando ADVPL que sero
executadas.
Transfere o controle de dentro do comando FOR...NEXT para o
comando imediatamente seguinte ao NEXT, ou seja, finaliza a
repetio da seo de comandos imediatamente. Pode-se
colocar o comando EXIT em qualquer lugar entre o FOR e o
NEXT.
Retorna o controle diretamente para a clusula FOR sem
executar o restante dos comandos entre o LOOP e o NEXT. O
contador incrementado ou decrementado normalmente, como
se o NEXT tivesse sido alcanado. Pode-se colocar o comando
LOOP em qualquer lugar entre o FOR e o NEXT.
Uma varivel ou um elemento de uma matriz utilizado como um

contador para especificar quantas vezes os comandos ADVPL dentro da
estrutura FOR...NEXT so executados.
Os comandos ADVPL depois do FOR so executados at que o NEXT
seja alcanado. O contador (Variavel) ento incrementado ou
decrementado com o valor em nIncremento (se a clusula STEP for
omitida, o contador incrementado em 1). Ento, o contador
comparado com o valor em nValorFinal. Se for menor ou igual ao valor
em nValorFinal, os comandos seguintes ao FOR so executados
novamente.
Se o valor for maior que o contido em nValorFinal, a estrutura
FOR...NEXT terminada e o programa continua a execuo no
primeiro comando aps o NEXT.
Os valores de nValorInicial, nValorFinal e nIncremento so apenas
considerados inicialmente. Entretanto, mudar o valor da varivel
utilizada como contador dentro da estrutura afetar o nmero de
vezes que a repetio ser executada. Se o valor de nIncremento
negativo e o valor de nValorInicial maior que o de nValorFinal, o
contador ser decrementado a cada repetio.
- 52 ADVPL Completo
Exemplo:
Local nCnt
Local nSomaPar := 0
For nCnt := 0 To 100 Step 2
nSomaPar += nCnt
Next
Alert( "A soma dos 100 primeiros nmeros pares : " + ;
cValToChar(nSomaPar) )
Return
Este exemplo imprime a soma dos 100 primeiros nmeros pares. A soma obtida atravs da
repetio do clculo utilizando a prpria varivel de contador. Como a clusula STEP est
sendo utilizada, a varivel nCnt ser sempre incrementada em 2. E como o contador comea
com 0, seu valor sempre ser um nmero par.
O Comando WHILE...ENDDO
A estrutura de controle WHILE...ENDDO, ou simplesmente o loop WHILE, repete uma seo de
cdigo enquanto uma determinada expresso resultar em verdadeiro (.T.).
Sintaxe
WHILE lExpressao
Comandos...
[EXIT]
[LOOP]
ENDDO
Parmetros
lExpressao
Comandos
EXIT
LOOP
Especifica uma expresso lgica cujo valor determina quando os

comandos entre o WHILE e o ENDDO so executados. Enquanto o
resultado de lExpressao for avaliado como verdadeiro (.T.), o
conjunto de comandos so executados.
Especifica um ou mais instrues de comando ADVPL que sero
executadas enquanto lExpressao for avaliado como verdadeiro (.T.).
Transfere o controle de dentro do comando WHILE...ENDDO para o
comando imediatamente seguinte ao ENDDO, ou seja, finaliza a
repetio da seo de comandos imediatamente. Pode-se colocar o
comando EXIT em qualquer lugar entre o WHILE e o ENDO.
Retorna o controle diretamente para a clusula WHILE sem executar
o restante dos comandos entre o LOOP e o ENDDO. A expresso em
lExpressao reavaliada para a deciso se os comandos continuaro
sendo executados.
Os comandos entre o WHILE e o ENDDO so executados enquanto o
resultado da avaliao da expresso em lExpressao permanecer
verdadeiro (.T.). Cada palavra chave WHILE deve ter uma palavra
chave ENDDO correspondente.
- 53 ADVPL Completo
Exemplo :
Local nNumber := nAux := 350
nAux := Int(nAux / 2)
While nAux > 0
nSomaPar += nCnt
Next
Alert( "A soma dos 100 primeiros nmeros pares : " + ;
cValToChar(nSomaPar) )
Return
5.1.1.
Influenciando o fluxo de repetio
A linguagem ADVPL permite a utilizao de comandos que influem diretamente em um

processo de repetio, sendo eles:
LOOP
EXIT
LOOP
A instruo LOOP utilizada para forar um desvio no fluxo do programa de volta a anlise da
condio de repetio. Desta forma, todas as operaes que seriam realizadas dentro da
estrutura de repetio aps o LOOP sero desconsideradas.
Exemplo:
aItens:= ListaProdutos() // funo ilustrativa que retorna um array com dados dos produtos
nQuantidade := Len(aItens)
nItens := 0
While nItens < nQuantidade
nItens++
IF BLOQUEADO(aItens [nItens]) // funo ilustrativa que verifica se o produto est
LOOP
// bloqueado.
ENDIF
IMPRIME() // funo ilustrativa que realiza a impresso de um item liberado para uso
End
// Caso o produto esteja bloqueado, o mesmo no ser impresso, pois a execuo da
// instruo LOOP far o fluxo do programa retornar a partir da anlise da condio.
- 54 ADVPL Completo
EXIT
A instruo EXIT utilizada para forar o trmino de uma estrutura de repetio. Desta forma,
todas as operaes que seriam realizadas dentro da estrutura de repetio aps o EXIT sero
desconsideradas, e o programa ir continuar a execuo a partir da prxima instruo
posterior ao trmino da estrutura (END ou NEXT).
Exemplo:
While .T.
End
IF MSGYESNO(Deseja jogar o jogo da forca?)

JFORCA() // Funo ilustrativa que implementa o algoritmo do jogo da forca.
ELSE
EXIT
ENDIF
MSGINFO(Final de Jogo)
// Enquanto no for respondido No para a pergunta: Deseja jogar o jogo da
// forca, ser executada a funo do jogo da forca.
// Caso seja selecionada a opo No, ser executada a instruo EXIT que
provocar o trmino do LOOP, permitindo a execuo da mensagem de Final de
Jogo.
- 55 ADVPL Completo
5.2. Estruturas de deciso

Estruturas de desvio so designadas para executar uma seo de cdigo se determinada
condio lgica resultar em verdadeiro (.T.).
Em ADVPL existem dois comandos para execuo de sees de cdigo de acordo com
avaliaes lgicas, que so os comandos IF...ELSE...ENDIF e o comando DO
CASE...ENDCASE.
O Comando IF...ELSE...ENDIF
Executa um conjunto de comandos baseado no valor de uma expresso lgica.
Sintaxe
IF lExpressao
Comandos
[ELSE
Comandos...]
ENDIF
Parmetros
LExpressao
Comandos
Especifica uma expresso lgica que avaliada. Se lExpressao

resultar em verdadeiro (.T.), qualquer comando seguinte ao IF e
antecedente ao ELSE ou ENDIF (o que ocorrer primeiro) ser
executado.
Se lExpressao resultar em falso (.F.) e a clusula ELSE for definida,
qualquer comando aps essa clusula e anterior ao ENDIF ser
executada. Se a clusula ELSE no for definida, todos os comandos
entre o IF e o ENDIF so ignorados. Neste caso, a execuo do
programa continua com o primeiro comando seguinte ao ENDIF.
Conjunto de comandos ADVPL que sero executados dependendo da
avaliao da expresso lgica em lExpressao.
Pode-se aninhar um bloco de comando IF...ELSE...ENDIF dentro de

outro bloco de comando IF...ELSE...ENDIF. Porm, para a avaliao de
mais de uma expresso lgica, deve-se utilizar o comando DO
ou
a
verso
estendida
da
expresso
CASE...ENDCASE
IF...ELSE...ENDIF denominada IF...ELSEIF...ELSE...ENDIF.
Exemplo:
Local dVencto := CTOD("31/12/01")
If Date() > dVencto
Alert("Vencimento ultrapassado!")
Endif
Return
- 56 ADVPL Completo
O Comando IF...ELSEIF...ELSE...ENDIF
Executa o primeiro conjunto de comandos cuja expresso condicional resulta em verdadeiro
(.T.).
Sintaxe
IF lExpressao1
Comandos
[ELSEIF lExpressaoX
Comandos]
[ELSE
Comandos...]
ENDIF
Parmetros
lExpressao1
lExpressaoX
Comandos
Especifica uma expresso lgica que avaliada. Se lExpressao

executar
os
comandos
resultar
em
verdadeiro
(.T.),
compreendidos entre o IF e a prxima expresso da estrutura
(ELSEIF ou IF)
Se lExpressao resultar em falso (.F.), ser avaliada a prxima
expresso lgica vinculada ao comando ELSEIF, ou se o mesmo
no existir ser executada a ao definida no comando ELSE.
Especifica uma expresso lgica que ser avaliada para cada
comando ELSEIF. Esta expresso somente ser avaliada se a
expresso lgica especificada no comando IF resultar em falso
(.F.).
Caso a lExpressaoX avaliada resulte em falso (.F.) ser avaliada a
prxima expresso lExpressaoX vinculada ao prximo comando
ELSEIF, ou caso o mesmo no exista ser executada a ao
definida parao comando ELSE.
Conjunto de comandos ADVPL que sero executados dependendo
da avaliao da expresso lgica em lExpressao.
O campo IF...ELSE...ELSEIF...ENDIF possui a mesma estruturao de

deciso que pode ser obtida com a utilizao do comando DO
CASE...ENDCASE.
- 57 ADVPL Completo
Exemplo:
Local dVencto := CTOD("31/12/01")
If Date() > dVencto
Alert("Vencimento ultrapassado!")
ElseIf Date() == dVencto
Alert("Vencimento na data!")
Else
Alert("Vencimento dentro do prazo!")
Endif
Return
O Comando DO CASE...ENDCASE
Executa o primeiro conjunto de comandos cuja expresso condicional resulta em verdadeiro
(.T.).
Sintaxe
DO CASE
CASE lExpressao1
Comandos
[CASE lExpressao2
Comandos
...
CASE lExpressaoN
Comandos]
[OTHERWISE
Comandos]
ENDCASE
Parmetros
CASE
lExpressao1
Comandos...
OTHERWISE
Comandos
Quando a primeira expresso CASE resultante em verdadeiro (.T.)

for encontrada, o conjunto de comandos seguinte executado. A
execuo do conjunto de comandos continua at que a prxima
clusula CASE, OTHERWISE ou ENDCASE seja encontrada. Ao
terminar de executar esse conjunto de comandos, a execuo
continua com o primeiro comando seguinte ao ENDCASE.
Se uma expresso CASE resultar em falso (.F.), o conjunto de
comandos seguinte a esta at a prxima clusula ignorado.
Apenas um conjunto de comandos executado. Estes so os
primeiros comandos cuja expresso CASE avaliada como
verdadeiro (.T.). Aps a execuo, qualquer outra expresso CASE
posterior ignorada (mesmo que sua avaliao resultasse em
verdadeiro).
Se todas as expresses CASE forem avaliadas como falso (.F.), a
clusula OTHERWISE determina se um conjunto adicional de
comandos deve ser executado. Se essa clusula for includa, os
comandos seguintes sero executados e ento o programa
continuar com o primeiro comando seguinte ao ENDCASE. Se a
clusula OTHERWISE for omitida, a execuo continuar
normalmente aps a clusula ENDCASE.
- 58 ADVPL Completo
O Comando DO CASE...ENDCASE utilizado no lugar do comando

IF...ENDIF quando um nmero maior do que uma expresso deve ser
avaliada, substituindo a necessidade de mais de um comando
IF...ENDIF aninhados.
Exemplo:
Local nMes
:= Month(Date())
Local cPeriodo := ""
DO CASE
CASE nMes <= 3
cPeriodo := "Primeiro Trimestre"
CASE nMes >= 4 .And. nMes <= 6
cPeriodo := "Segundo Trimestre"
CASE nMes >= 7 .And. nMes <= 9
cPeriodo := "Terceiro Trimestre"
OTHERWISE
cPeriodo := "Quarto Trimestre"
ENDCASE
Return
- 59 ADVPL Completo
6. Arrays e Blocos de Cdigo

6.1. Arrays
Arrays ou matrizes, so colees de valores, semelhantes a uma lista. Uma matriz pode ser
criada atravs de diferentes maneiras.
Cada item em um array referenciado pela indicao de sua posio numrica na lista,
iniciando pelo nmero 1.
O exemplo a seguir declara uma varivel, atribui um array de trs elementos a ela, e ento
exibe um dos elementos e o tamanho do array:
Local aLetras
// Declarao da varivel
aLetras := {"A", "B", "C"} // Atribuio do array a varivel
Alert(aLetras[2])
// Exibe o segundo elemento do array
Alert(cValToChar(Len(aLetras))) // Exibe o tamanho do array
O ADVPL permite a manipulao de arrays facilmente. Enquanto que em outras linguagens
como C ou Pascal necessrio alocar memria para cada elemento de um array (o que
tornaria a utilizao de "ponteiros" necessria), o ADVPL se encarrega de gerenciar a memria
e torna simples adicionar elementos a um array, utilizando a funo AADD():
AADD(aLetras,"D") // Adiciona o quarto elemento ao final do array
Alert(aLetras[4]) // Exibe o quarto elemento
Alert(aLetras[5]) // Erro! No h um quinto elemento no array
Arrays como Estruturas

Uma caracterstica interessante do ADVPL que um array pode conter qualquer tipo de dado:
nmeros, datas, lgicos, caracteres, objetos, etc., e ao mesmo tempo. Em outras palavras, os
elementos de um array no precisam ser necessariamente do mesmo tipo de dado, em
contraste com outras linguagens como C e Pascal.
aFunct1 := {"Pedro",32,.T.}
Este array 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 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 de um array:
#define FUNCT_NOME 1
#define FUNCT_IDADE 2
#define FUNCT_CASADO 3
- 60 ADVPL Completo
E considere mais alguns arrays para representar mais pessoas:

aFunct2 := {"Maria" , 22, .T.}
aFunct3 := {"Antnio", 42, .F.}
Os nomes podem ser impressos assim:
Alert(aFunct1[FUNCT_NOME])
Agora, ao invs de trabalhar com variveis individuais, pode-se agrup-las em um outro array,
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 um array com 3 linhas por 3 colunas. Uma vez que as variveis separadas foram
combinadas em um array, os nomes podem ser exibidos assim:
Local nCount
For nCount := 1 To Len(aFuncts)
Alert(aFuncts[nCount, FUNCT_NOME])
// O acesso a elementos de um array 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.
Cuidados com Arrays
Arrays so listas de elementos, portanto memria necessria para armazenar estas
informaes. Como estes arrays podem ser multidimensionais, a memria necessria ser a
multiplicao do nmero de itens em cada dimenso do array, considerando-se o tamanho do
contedo de cada elemento contido nesta. Portanto o tamanho de um array pode variar muito.
A facilidade da utilizao de arrays, mesmo que para armazenar informaes em pacotes como
descrito anteriormente, no compensada pela utilizao em memria quando o nmero de
itens em um array for muito grande. Quando o nmero de elementos for muito grande deve-se
procurar outras solues, como a utilizao de um arquivo de banco de dados temporrio.
- 61 ADVPL Completo
6.1.1.
Inicializando arrays
Algumas vezes o tamanho da matriz conhecido previamente. Outras vezes o tamanho do

array somente ser conhecido em tempo de execuo.
Se o tamanho do array conhecido
Se o tamanho do array conhecido no momento que o programa escrito, h diversas
maneiras de implementar o cdigo:
01
02
03
04
05
06
07
08
Local
Local
Local
Local
nCnt
aX[10]
aY := Array(10)
aZ := {0,0,0,0,0,0,0,0,0,0}
For nCnt := 1 To 10
aX[nCnt] := nCnt * nCnt
Next nCnt
Este cdigo preenche o array com uma tabela de quadrados. Os valores sero 1, 4, 9, 16 ...
81, 100. Note que a linha 07 se refere varivel aX, mas poderia tambm trabalhar com aY ou
aZ.
O objetivo deste exemplo demonstrar trs modos de criar um array de tamanho conhecido
no momento da criao do cdigo.
1.
Na linha 02 o array criada usando aX[10]. Isto indica ao ADVPL para alocar espao
para 10 elementos no array. Os colchetes [ e ] so utilizados para indicar o tamanho
necessrio.
2.
Na linha 03 utilizada a funo array com o parmetro 10 para criar o array, e o
retorno desta funo atribudo varivel aY. Na linha 03 efetuado o que se chama
"desenhar a imagen do array". Como se pode notar, existem dez 0s na lista encerrada entre
chaves ({}). Claramente, este mtodo no o utilizado para criar uma matriz de 1000
elementos.
3.
O terceiro mtodo difere dos anteriores porque inicializa a matriz com os valores
definitivos. Nos dois primeiros mtodos, cada posio da matriz contm um valor nulo (Nil) e
deve ser inicializado posteriormente.
4.
A linha 07 demonstra como um valor pode ser atribudo para uma posio existente em
uma matriz especificando o ndice entre colchetes.
- 62 ADVPL Completo
Se o tamanho do array no conhecido

Se o tamanho do array no conhecido at o momento da execuo do programa, h algumas
maneiras de criar um array e adicionar elementos a ele. O exemplo a seguir ilustra a idia de
criao de um array vazio (sem nenhum elemento) e adio de elementos dinamicamente.
01
02
03
04
05
06
07
08
Local
Local
Local
Local
nCnt
aX[0]
aY := Array(0)
aZ := {}
For nCnt := 1 To nSize

AADD(aX, nCnt*nCnt)
Next nCnt
1.
A linha 02 utiliza os colchetes para criar um array vazio. Apesar de no ter nenhum
elemento, seu tipo de dado array.
2.
Na linha 03 a chamada da funo array cria uma matriz sem nenhum elemento.
3.
Na linha 04 est declarada a representao de um array vazio em ADVPL. Mais uma
vez, esto sendo utilizadas as chaves para indicar que o tipo de dados da varivel array.
Note que {} um array vazio (tem o tamanho 0), enquanto {Nil} um array com um nico
elemento nulo (tem tamanho 1).
Porque cada uma destes arrays no contm elementos, a linha 07 utiliza a funo AADD() para
adicionar elementos sucessivamente at o tamanho necessrio (especificado por exemplo na
varivel nSize).
6.1.2.
Funes de manipulao de arrays
A linguagem ADVPL possui diversas funes que auxiliam na manipulao de arrays, dentre as
quais podemos citar as mais utilizadas:
ARRAY()
AADD()
ACLONE()
ADEL()
ASIZE()
AINS()
ASORT()
ASCAN()
- 63 ADVPL Completo
ARRAY()
Sintaxe
ARRAY(nLinhas, nColunas)
Descrio
A funo Array() utilizada na definio de variveis de tipo array, como

uma opo a sintaxe utilizando chaves ({}).
AADD()
Sintaxe
AADD(aArray, xItem)
Descrio
A funo AADD() permite a insero de um item em um array j existente,

sendo que este item podem ser um elemento simples, um objeto ou outro
array.
ACLONE()
Sintaxe
AADD(aArray)
Descrio
A funo ACLONE() realiza a cpia dos elementos de um array para outro

array integralmente.
ADEL()
Sintaxe
ADEL(aArray, nPosio)
Descrio
A funo ADEL() permite a excluso de um elemento do array. Ao efetuar a

excluso de um elemento, todos os demais so reorganizados de forma que
a ultima posio do array passar a ser nula.
ASIZE()
Sintaxe
ASIZE(aArray, nTamanho)
Descrio
A funo ASIZE permite a redefinio da estrutura de um array prexistente, adicionando ou removendo itens do mesmo.
ASORT()
Sintaxe
ASORT(aArray, nInicio, nItens, bOrdem)
Descrio
A funo ASORT() permite que os itens de um array sejam ordenados a

partir de um critrio pr-estabelecido.
- 64 ADVPL Completo
ASCAN()
Sintaxe
ASCAN(aArray, bSeek)
Descrio
A funo ASCAN() permite que seja identificada a posio do array que

contm uma determinada informao, atravs da anlise de uma expresso
descrita em um bloco de cdigo.
AINS()
Sintaxe
AINS(aArray, nPosicao)
Descrio
6.1.3.
A funo AINS() permite a insero de um elemento no array especificado

em qualquer ponto da estrutura do mesmo, diferindo desta forma da funo
AADD() a qual sempre insere um novo elemento ao final da estrutura j
existente.
Cpia de arrays
Conforme comentado anteriormente, um array uma rea na memria, o qual possui uma
estrutura permite que as informaes sejam armazenadas e organizadas das mais diversas
formas.
Com base nesse conceito, o array pode ser considerado apenas como um mapa ou um guia
de como as informaes esto organizadas e de como elas podem ser armazenadas ou
consultadas. Para se copiar um array deve-se levar este conceito em considerao, pois caso
contrrio o resultado esperado no ser o obtido na execuo da cpia.
Para copiar o contedo de uma varivel, utiliza-se o operador de atribuio :=, conforme
abaixo:
nPessoas := 10
nAlunos := nPessoas
Ao executar a atribuio de nAlunos com o contedo de nPessoas, o contedo de nPessoas

atribudo a varivel nAlunos, causando o efeito de cpia do contedo de uma varivel para
outra.
Isto porque o comando de atribuio copia o contedo da rea de memria representada pelo
nome nPessoas para a rea de memria representada pelo nome nAlunos. Mas ao utilizar o
operador de atribuio := da mesma forma que utilizado em variveis simples para se copiar
um array o efeito diferente:
aPessoas := {Ricardo, Cristiane, Andr, Camila}

aAlunos := aPessoas
- 65 ADVPL Completo
A varivel aPessoas represente uma rea de memria que contm a estrutura de um array
(mapa), no as informaes do array, pois cada informao est em sua prpria rea de
memria.
Desta forma ao atribuir o contedo representado pela varivel aPessoas a varivel aAlunos no
est se copiando as informaes e sim o mapa das reas de memria onde as informaes
esto realmente armazenadas.
Como foi copiado o mapa e no as informaes, qualquer ao utilizando o rtulo aAlunos ir

afetar as informaes do rtulo aPessoas. Com isso ao invs de se obter dois arrays distintos,
tem-se o mesmo array com duas formas de acesso (rtulos) diferentes.
Por esta razo deve ser utilizado o comando ACLONE() quando deseja-se obter um array com
a mesma estrutura e informaes que compe outro array j existente.
- 66 ADVPL Completo
6.2. Listas de Expresses e Blocos de Cdigo

Blocos de cdigo so um conceito existente h muito tempo em linguagens xBase. No como
algo que apareceu da noite para o dia, e sim uma evoluo progressiva utilizando a
combinao de muitos conceitos da linguagem para a sua implementao.
6.2.1.
Premissas para utilizao de Blocos de Cdigo
Primeira premissa
O ADVPL uma linguagem baseada em funes. Funes tm um valor de retorno. Assim
como o operador de atribuio :=.
Assim, ao invs de escrever:
x := 10 // Atribui o valor 10 varivel chamada X
Alert("Valor de x: " + cValToChar(x))
Pode-se escrever:
// Atribui e ento exibe o valor da varivel X
Alert("Valor de x: " + cValtoChar(X := 10))
A expresso x:=10 avaliada primeiro, e ento seu resultado (o valor de X, que agora 10)
passada para a funo cvaltochar para a converso para caractere, e em seguida para a
funo alert para a exibio. Por causa desta regra de precedncia possvel atribuir um valor
a mais de uma varivel ao mesmo tempo:
Z := Y := X := 0
Por causa dessa regra, essa expresso avaliada como se fosse escrita assim:
Z := ( Y := (X := 0) )
Apesar de o ADVPL avaliar expresses da esquerda para a direita, no caso de atribuies isso
acontece ao contrrio, da direita para a esquerda. O valor atribudo varivel X, que retorna
- 67 ADVPL Completo
o valor para ser atribudo varivel Y e assim sucessivamente. Pode-se dizer que o zero foi
"propagado atravs da expresso".
Segunda premissa
Em ADVPL pode-se juntar diversas linhas de cdigo em uma nica linha fsica de comando. Por
exemplo, o cdigo:
If lAchou
Alert("Cliente encontrado!")
Endif
pode ser escrito assim:
If lAchou ; Alert("Cliente encontrado!") ;
Endif
O ponto-e-vrgula indica ao ADVPL que a nova linha de cdigo est para comear. Pode-se
ento colocar diversas linhas lgicas de cdigo na mesma linha fsica atravs do editor de texto
utilizado.
Apesar da possibilidade de se escrever todo o programa assim, em uma nica linha fsica, isto
no recomendado pois dificulta a legibilidade do programa e, conseqentemente, a
manuteno.
6.2.2.
Lista de expresses
A evoluo dos blocos de cdigo comea com as listas de expresses. Nos exemplos a seguir,
o smbolo ==> indicar o retorno da expresso aps sua avaliao (seja para atribuir em uma
varivel, exibir para o usurio ou imprimir em um relatrio), que ser impresso em um
relatrio por exemplo.
Duas Linhas de Cdigo
@00,00 PSAY x := 10
@00,00 PSAY y := 20
==>
==>
10
20
Cada uma das linhas ter a expresso avaliada, e o valor da varivel ser ento impresso.
Duas linha de cdigo em uma , utilizando ponto-e-vrgula
Este o mesmo cdigo que o anterior, apenas escrito em uma nica linha:
Alert( cValToChar( x := 10 ; y := 20 ) )
==>
10
Apesar desse cdigo se encontrar em uma nica linha fsica, existem duas linhas lgicas
separadas pelo ponto e vrgula. Ou seja, esse cdigo equivalente a:
Alert( cValToChar( x := 10 ) )
y := 20
Portanto apenas o valor 10 da varivel x ser passado para as funes cvaltochar e alert para
ser exibido. E o valor 20 apenas ser atribudo varivel y.
- 68 ADVPL Completo
Convertendo para uma lista de expresses

Quando parnteses so colocados ao redor do cdigo e o sinal de ponto-e-vrgula substitudo
por uma vrgula apenas, o cdigo torna-se uma lista de expresses:
Alert( cValToChar ( ( X := 10 , Y := 20 ) ) )
==>
20
O valor de retorno resultante de uma lista de expresses o valor resultante da ltima

expresso ou elemento da lista. Funciona como se fosse um pequeno programa ou funo, que
retorna o resultado de sua ltima avaliao (efetuadas da esquerda para a direita).
Neste exemplo, a expresso x := 10 avaliada, e ento a expresso y := 20, cujo valor
resultante passado para a funo alert e cvaltochar, e ento exibido. Depois que essa linha
de cdigo executada, o valor de X igual a 10 e o de y igual a 20, e 20 ser exibido.
Teoricamente, no h limitao para o nmero de expresses que podem ser combinadas em
uma lista de expresses. Na prtica, o nmero mximo por volta de 500 smbolos.
Debugar listas de expresses difcil porque as expresses no esto divididas em linhas de
cdigo fonte, o que torna todas as expresses associadas a uma mesma linha de cdigo. Isto
pode tornar muito difcil determinar onde um erro ocorreu.
Onde pode-se utilizar uma lista de expresses?
O propsito principal de uma lista de expresses agrup-las em uma nica unidade. Em
qualquer lugar do cdigo ADVPL que uma expresso simples pode ser utilizada, pode-se
utilizar uma lista de expresses. E ainda, pode-se fazer com que vrias coisas aconteam onde
normalmente apenas uma aconteceria.
X := 10 ; Y := 20
If X > Y
Alert("X")
Z := 1
Else
Alert("Y")
Z := -1
Endif
Aqui temos o mesmo conceito, escrito utilizando listas de expresses na funo IIF():
X := 10 ; Y := 20
iif( X > Y , ;
( Alert("X"), Z := 1 ) , ;
( Alert("Y"), Z := -1 ) )
De listas de expresses para blocos de cdigo
Considere a seguinte lista de expresses:
Alert( cValToChar( ( x := 10, y := 20 ) ) ) ==> 20
O ADVPL permite criar funes, que so pequenos pedaos de cdigo, como se fosse um
pequeno programa, utilizados para diminuir partes de tarefas mais complexas e reaproveitar
cdigo em mais de um lugar num programa. Para maiores detalhes consulte a documentao
sobre a criao de funes em ADVPL. Porm, a idia neste momento que a lista de
expresses utilizada na linha anterior pode ser criada como uma funo:
- 69 ADVPL Completo
Function Lista()
X := 10
Y := 20
Return Y
E a linha de exemplo com a lista de expresses pode ser substituda, tendo o mesmo
resultado, por:
Alert( cValToChar( Lista() ) ) ==> 20
Como mencionado anteriormente, uma lista de expresses como um pequeno programa ou
funo. Com poucas mudanas, uma lista de expresses pode se tornar um bloco de cdigo:
( X := 10 , Y := 20 ) // Lista de Expresses
{|| X := 10 , Y := 20 } // Bloco de Cdigo
Note as chaves {} utilizadas no bloco de cdigo. Ou seja, um bloco de cdigo uma matriz.
Porm na verdade, no uma lista de dados, e sim uma lista de comandos, uma lista de
cdigo.
// Isto uma matriz de dados
A := {10, 20, 30}
// Isto um bloco de cdigo, porm funciona como
// se fosse uma matriz de comandos
B := {|| x := 10, y := 20}
6.2.3.
Blocos de Cdigo
Diferentemente de uma matriz, no se pode acessar elementos de um bloco de cdigo atravs

de um ndice numrico. Porm blocos de cdigo so semelhantes a uma lista de expresses, e
a uma pequena funo.
Ou seja, podem ser executados. Para a execuo, ou avaliao, de um bloco de cdigo, devese utilizar a funo Eval():
nRes := Eval(B) ==> 20
Essa funo recebe como parmetro um bloco de cdigo e avalias todas as expresses
contidas neste bloco de cdigo, retornando o resultado da ltima expresso avaliada.
Passando Parmetros
J que blocos de cdigo so como pequenas funes, tambm possvel a passagem de
parmetros para um bloco de cdigo. Os parmetros devem ser informados entre as barras
verticais (||) separados por vrgulas, assim como em uma funo.
B := {| N | X := 10, Y := 20 + N}
Porm deve-se notar que j que o bloco de cdigo recebe um parmetro, um valor deve ser
passado quando o bloco de cdigo for avaliado.
C := Eval(B, 1) ==> 21
- 70 ADVPL Completo
Utilizando Blocos de Cdigo

Blocos de cdigo podem ser utilizados em diversas situaes. Geralmente so utilizados para
executar tarefas quando eventos de objetos so acionados ou para modificar o comportamento
padro de algumas funes.
Por exemplo, considere a matriz abaixo:
A := {"GARY HALL", "FRED SMITH", "TIM JONES"}
Esta matriz pode ser ordenada pelo primeiro nome, utilizando-se a chamada da funo
asort(A), resultado na matriz com os elementos ordenados dessa forma:
{"FRED SMITH", "GARY HALL", "TIM JONES"}
A ordem padro para a funo asort ascendente. Este comportamento pode ser modificado
atravs da informao de um bloco de cdigo que ordena a matriz de forma descendente:
B := { |X, Y| X > Y }
aSort(A, B)
O bloco de cdigo (de acordo com a documentao da funo asort) deve ser escrito para
aceitar dois parmetros que so os dois elementos da matriz para comparao. Note que o
bloco de cdigo no conhece que elementos est comparando - a funo asort seleciona os
elementos (talvez utilizando o algoritmo QuickSort) e passa-os para o bloco de cdigo. O bloco
de cdigo compara-os e retorna verdadeiro (.T.) se encontram na ordem correta, ou falso (.F.)
se no. Se o valor de retorno for falso, a funo asort ir ento trocar os valores de lugar e
seguir comparando o prximo par de valores.
Ento, no bloco de cdigo anterior, a comparao X > Y verdadeira se os elementos esto
em ordem descendente, o que significa que o primeiro valor maior que o segundo.
Para ordenar a mesma matriz pelo ltimo nome, tambm em ordem descendente, pode-se
utilizar o seguinte bloco de cdigo:
B := { |X, Y| SUBSTR(X, At(" ",X)+1) > SUBSTR(Y, At(" ",Y)+1) }
Note que este bloco de cdigo procura e compara as partes dos caracteres imediatamente
seguinte a um espao em branco. Depois de utilizar esse bloco de cdigo para a funo asort,
a matriz conter:
{"GARY HALL", "TIM JONES", "FRED SMITH"}
Finalmente, para ordenar um sub-elemento (coluna) de uma matriz por exemplo, pode-se
utilizar o seguinte bloco de cdigo:
B := { |X, Y| X[1] > Y[1] }
- 71 ADVPL Completo
6.2.4.
Funes para manipulao de blocos de cdigo
A linguagem ADVPL possui diversas funes que auxiliam na manipulao de blocos de cdigo,
dentre as quais podemos citar as mais utilizadas:
EVAL()
DBEVAL()
AEVAL()
EVAL()
Sintaxe
EVAL(bBloco, xParam1, xParam2, xParamZ)
Descrio
A funo EVAL() utilizada para avaliao direta de um bloco de cdigo,

utilizando as informaes disponveis no mesmo de sua execuo. Esta
funo permite a definio e passagem de diversos parmetros que sero
considerados na interpretao do bloco de cdigo.
DBEVAL()
Sintaxe
Array(bBloco, bFor, bWhile)
Descrio
A funo DBEval() permite que todos os registro de uma determinada tabela

sejam analisados e para cada registro ser executado o bloco de cdigo
definido.
AEVAL()
Sintaxe
AEVAL(aArray, bBloco, nInicio, nFim)
Descrio
A funo AEVAL() permite que todos os elementos de um determinada array

sejam analisados e para cada elemento ser executado o bloco de cdigo
definido.
- 72 ADVPL Completo
7. Funes
A maior parte das rotinas que queremos escrever em programas so compostas 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 que para ser
utilizada basta cham-la pelo seu nome.
Para tornar uma funo mais flexvel, ao cham-la pode-se passar parmetros, o quais contm
os dados e informaes que definem o processamento da funo.
Os parmetros das funes descritas utilizando a linguagem ADVPL so posicionais, ou seja, na
sua passagem no importa o nome da varivel e sim a sua posio dentro da lista de
parmetros, o que permite executar uma funo escrevendo:
Calcula(parA, parB, parC) // Chamada da funo em uma rotina
E a funo estar escrita:
User Function Calcula(x, y, z)
... Comandos da Funo
Return ...
Neste caso, x assume o valor de parA, y de parB e z de parC.

A funo tambm tem a faculdade de retornar uma varivel, podendo inclusive ser um Array.
Para tal encerra-se a funo com:
Return(campo)
Assim A := Calcula(parA,parB,parC) atribui
Calcula.
A o contedo do retorno da funo
No ADVPL existem milhares de funes escritas pela equipe de Tecnologia Microsiga,

20
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, mesmo sendo gnio, reinventa a roda a
cada novo programa.
No DEM (Documentao Eletrnica Microsiga) mais de 500 esto documentadas, e este
nmero tende a aumentar exponencialmente com os novos processos de documentao que
esto em implantao na Tecnologia e Inteligncia Protheus.
O objetivo do curso apresentar, demonstrar e fixar a utilizao das principais funes,
sintaxes e estruturas utilizadas em ADVPL.
No ADVPL, at os programas chamados do menu so funes, sendo que em um repositrio
no podem haver funes com o mesmo nome, e para permitir que os usurios e analistas
- 73 ADVPL Completo
possam desenvolver suas prprias funes sem que as mesmas conflitem com as j
disponveis no ambiente ERP, foi implementada pela Tecnologia Microsiga um tipo especial de
funo denominado User Function.
Nos tpicos a seguir sero detalhados os tipos de funes disponveis na linguagem ADVPL,
suas formas de utilizao e respectivas diferenas.
7.1. Tipos e escopos de funes

Em ADVPL podem ser utilizados os seguintes tipos de funes:
Function()
User Function()
Static Function()
Main Function()
Function()
Funes ADVPL convencionais, restritas ao desenvolvimento da rea de Inteligncia Protheus
da Microsiga.
O interpretador ADVPL distingue nomes de funes do tipo Function() com at dez caracteres.
A partir do dcimo caracter, apesar do compilador no indicar quaisquer tipos de erros, o
interpretador ignorar os demais caracteres.
Exemplo:
// Fonte MATA100INCL.PRW
#INCLUDE "protheus.ch"
Function MATA100INCL01()
ALERT("01")
Return
Function MATA100INCL02()
ALERT("02")
Return
Ao executar a funo MATA100INCL01() ser exibida a mensagem 01, mas ao executar a
funo MATA100INCL02() tambm ser exibida a mensagem 01, pois o interpretador
considera o nome da funo como MATA100INC.
1. Funes do tipo Function() somente podem ser executadas atravs
dos mdulos do ERP.
2. Somente podero ser compiladas funes do tipo Function() se o MPIDE possuir uma autorizao especial fornecida pela Microsiga.
3. Funes do tipo Function() so acessveis por quaisquer outras
funes em uso pela aplicao.
- 74 ADVPL Completo
User Function()
As User Defined Functions ou funes definidas pelos usurios, so tipos especiais de funes
implementados pelo ADVPL para garantir que desenvolvimentos especficos no realizados pela
Inteligncia Protheus da Microsiga sobreponham as funes padres desenvolvidas para o ERP.
O interpretador ADVPL considera que o nome de uma User Function composto pelo nome
definido para a funo precedido dos caracteres U_. Desta forma a User Function XMAT100I
ser tratada pelo interpretador como U_XMAT100I.
1. Como ocorre o acrscimo dos caracteres U_ no nome da funo e o
interpretador considera apenas os dez primeiros caracteres da funo
para sua diferenciao, recomendado que os nomes das User
Functions tenham apenas oito caracteres para evitar resultados
indesejados durante a execuo da aplicao.
2. Funes do tipo User Function so acessveis por quaisquer outras
funes em uso pela aplicao, desde que em sua chamada sejam
utilizados os caracteres U_ em conjunto com o nome da funo.
As User Functions podem ser executadas a partir da tela inicial do client do
ERP (Microsiga Protheus Remote), mas as aplicaes que pretendem
disponibilizar esta opo devem possuir um preparo adicional de ambiente.
Para maiores informaes consulte no DEM o tpico sobre preparao de
ambiente e a documentao sobre a funo RpcSetEnv().
Static Function()
Funes ADVPL tradicionais, cuja visibilidade est restrita as funes descritas no mesmo
arquivo de cdigo fonte no qual esto definidas.
Exemplo:
//Fonte FINA010.PRW
Function FINA010()
CriaSx1(FIN010)
Return
Static Function CRIASX1()
//Fonte FINA020.PRW
Function FINA020()
CriaSx1(FIN020)
Return
Static Function CRIASX1()
- 75 ADVPL Completo
No exemplo acima, existem duas funes denominadas CRIASX1() definidas em arquivos de

cdigo fonte distintos: FINA010.PRW e FINA020.PRW.
A funo FINA010() ter visibilidade apenas da funo CRIASX1() definida no arquivo de
cdigo fonte FINA010.PRW, sendo que o mesmo ocorre com a funo FINA020().
Este recurso permite isolar funes de uso exclusivo de um arquivo de cdigo fonte, evitando a
sobreposio ou duplicao de funes na aplicao.
Neste contexto as Static Functions() so utilizadas para:
1. Padronizar o nome de uma determinada funo, que possui a mesma finalidade, mas
que sua implementao pode variar de acordo com a necessidade de funo principal /
aplicao.
2. Redefinir uma funo padro da aplicao, adequando-a as necessidades especficas de
uma funo principal / aplicao.
3. Proteger funes de uso especfico de um arquivo de cdigo fonte / funo principal.
O ambiente de desenvolvimento utilizado na aplicao ERP (MP-IDE) valida
se existem Functions(), Main Functions() ou User Functions() com o mesmo
nome mas em arquivos de cdigo fontes distintos, evitando a duplicidade ou
sobreposio de funes.
Main Function()
Main Function() outro tipo de funo especial do ADVPL incorporado para permitir
tratamentos diferenciados na aplicao ERP.
Uma Main Function() tem a caracterstica de poder ser executada atravs da tela inicial de
parmetros do client do ERP (Microsiga Protheus Remote), da mesma forma que uma User
Function, com a diferena que as Main Functions somente podem ser desenvolvidas com o uso
da autorizao de compilao, tornando sua utilizao restrita a Inteligncia Protheus da
Microsiga.
Na aplicao ERP comum o uso das Main Functions() nas seguintes situaes:
1. Definio dos mdulos da aplicao ERP: Main Function Sigaadv()
2. Definio de atualizaes e updates: AP710TOMP811()
3. Atualizaes especficas de mdulos da aplicao ERP: UpdateATF()
- 76 ADVPL Completo
7.2. Passagem de parmetros entre funes

Como mencionado anteriormente os parmetros das funes descritas utilizando a linguagem
ADVPL so posicionais, ou seja, na sua passagem no importa o nome da varivel e sim a
sua posio dentro da lista de parmetros.
Complementando esta definio, podem ser utilizadas duas formas distintas de passagens de
parmetros para funes descritas na linguagem ADVPL:
Passagem de parmetros por contedo
Passagem de parmetros por referncia
Passagem de parmetros por contedo
A passagem de parmetros por contedo a forma convencional de definio dos parmetros
recebidos pela funo chamada, na qual a funo recebe os contedos passados pela funo
chamadora, na ordem com os quais so informados.
User Function CalcFator(nFator)

Local nCnt
Local nResultado := 0
nResultado *= nCnt
Next nCnt
Return
Avaliando a funo CalcFator() descrita anteriormente podemos verificar que a mesma recebe
como parmetro para sua execuo a varivel nFator.
Com base nesta funo podemos descrever duas forma de passagem de parmetros por
contedo:
Passagem de contedos diretos
Passagem de variveis como contedos
Exemplo 01 Passagem de contedos diretos
User Function DirFator()
nResultado := CalcFator(5)
- 77 ADVPL Completo
A passagem de contedos diretos implica na definio explcita do valor do parmetro na

execuo da chamada da funo. Neste caso foi informado o contedo 5 (numrico) como
contedo para o primeiro parmetro da funo CalcFator.
Como a linguagem ADVPL trata os parmetros de forma posicional, o contedo 5 ser atribudo
diretamente a varivel definida como primeiro parmetro da funo chamado, no nosso caso
nFator.
Por ser uma atribuio de parmetros por contedo, o interpretador da linguagem basicamente
executa uma operao de atribuio normal, ou seja, nFator := 5.
Duas caractersticas da linguagem ADVPL tornam necessria uma ateno
especial na chamada de funes:
1. A linguagem ADVPL no uma linguagem tipada, de forma que as
variveis no tem um tipo previamente definido, aceitando o contedo
que lhes for imposto atravs de uma atribuio.
2. Os parmetros de uma funo so atribudos de acordo com a ordem
com os quais so definidos na chamada da mesma. No realizada
nenhum tipo de consistncia em relao aos tipos dos contedos e
obrigatoriedade de parmetros nesta ao.
Os parmetros de uma funo so caracterizados como variveis de escopo

LOCAL para efeito de execuo.
Desta forma os mesmos no devem ser definidos novamente como LOCAL na
rea de definio e inicializao de variveis, pois caso isto ocorra haver a
perda dos valores recebidos pela redefinio das variveis na funo.
Caso seja necessrio garantir um contedo padro para um determinado
parmetro dever ser utilizado o identificador DEFAULT conforme detalhado
no tpico Tratamento de valores padres para parmetros de funes.
Exemplo 02 Passagem de variveis como contedos

Local nFatorUser := 0
nFatorUser := GetFator() // Funo ilustrativa na qual o usurio informa o fator a ser utilizado.
nResultado := CalcFator(nFatorUser)
A passagem de contedos como variveis implica na utilizao de variveis de apoio para

executar a chamada de uma funo. Neste caso foi informada a varivel nFatorUser, a qual
ser definida pelo usurio atravs da funo ilustrativa GetFator(). O uso de variveis de apoio
flexibiliza a chamada de outras funes, pois elas sero parametrizadas de acordo com as
necessidades daquele processamento especfico no qual se encontra a funo chamadora.
- 78 ADVPL Completo
Como a linguagem ADVPL trata os parmetros de forma posicional, o contedo da varivel

nFatorUser ser atribudo diretamente a varivel definida como primeiro parmetro da funo
chamado, no nosso caso nFator.
Por ser uma atribuio de parmetros por contedo, o interpretador da linguagem basicamente
executa uma operao de atribuio normal, ou seja, nFator := nFatorUser.
A passagem de parmetros no necessita que as variveis informadas na
funo chamadora tenham os mesmos nomes das variveis utilizadas na
definio de parmetros da funo chamada.
Desta forma podemos ter:
Local nFatorUser := GetFator()
nResultado := CalcFator(nFatorUser)
...
Function CalcFator(nFator)
...
As variveis nFatorUser e nFator podem ter nomes diferentes pois o

interpretador far a atribuio de contedo com base na ordem dos
parmetros e no pelo nome das variveis.
Passagem de parmetros por referncia
A passagem de parmetros por referncia uma tcnica muito comum nas linguagens de
programao a qual permite que variveis de escopo LOCAL tenham seu contedo manipulado
por funes especficas, mantendo o controle destas variveis restrito a funo que as definiu e
as funes desejadas pela aplicao.
A passagem de parmetros por referncia utiliza o conceito de que uma varivel uma rea
de memria e portanto passar um parmetro por referncia nada mais do que ao invs de
passar o contedo para a funo chamada, passar qual a rea de memria utilizada pela
varivel passada.
- 79 ADVPL Completo
Passagem de parmetros tradicional Duas variveis x Duas reas de memria
Passagem de parmetros por referncia Duas variveis x uma nica rea de memria
- 80 ADVPL Completo
Desta forma a funo chamada tem acesso no apenas ao contedo, mas a varivel em si,
pois a rea de memria a varivel, e qualquer alterao nesta ser visvel a funo
chamadora quando tiver o retorno da funo chamadora.
Tratamento de contedos padres para parmetros de funes

O tratamento de contedos padres para parmetros de funes muito utilizado nas funes
padres da aplicao ERP, de forma a garantir a correta execuo destas funes por qualquer
funo chamadora, evitando situaes de ocorrncias de erros pela falta da definio de
parmetros necessrios a correta utilizao da funo.
A linguagem ADVPL no obriga a passagem de todos os parmetros descritos
na definio da funo, sendo que os parmetros no informados sero
considerados com contedo nulo.
Desta forma o uso do identificador DEFAULT permite ao desenvolvedor garantir que na
utilizao da funo determinados parmetros tero o valor com um tipo adequado a funo.
Exemplo:
Local nCnt
Default nFator := 1
nResultado *= nCnt
Next nCnt
Return nResultado
No exemplo descrito, caso o parmetro nFator no seja informado na funo chamadora, o

mesmo ter seu contedo definido como 1.
- 81 ADVPL Completo
Se este tratamento no fosse realizado e com isso o parmetro nFator no fosse informado,
ocorreria o seguinte evento de erro:
Exemplo:
Local nCnt
For nCnt := nFator To 1 Step -1 // nFator est como Nulo, portando nCnt nulo
nResultado *= nCnt
Next nCnt // Ao efetuar o Next, o interpretador realiza a ao nCnt += 1.
Return nResultado
Como o interpretador realizar a ao nCnt += 1, e o contedo da varivel nCnt nulo

ocorrer o erro de type mismath on +=, expected N U pois os tipos das variveis
envolvidos na operao so diferentes: nCnt nulo (U) e 1 numrico (N).
Caso o parmetro que possui a opo DEFAULT descrita no fonte seja
informado, a linha de DEFAULT no ser executada, mantendo desta forma o
contedo passado pela funo chamadora.
- 82 ADVPL Completo
8. Diretivas de compilao
O compilador ADVPL possui uma funcionalidade denominada pr-processador, o qual nada
mais do que um programa que examina o programa fonte escrito em ADVPL e executa certas
modificaes nele, baseadas nas Diretivas de Compilao.
As diretivas de compilao so comandos que no so compilados, sendo dirigidos ao prprocessador, o qual executado pelo compilador antes da execuo do processo de
compilao propriamente dito.
Portanto, o pr-processador modifica o programa fonte, entregando para o compilador um
programa modificado de acordo com as diretivas de compilao, as so iniciadas pelo caractere
#.
As diretivas podem ser colocadas em qualquer parte do programa, sendo que as
implementadas pela linguagem ADVPL so:
#INCLUDE
#DEFINE
#IFDEF
#IFNDEF
#ELSE
#ENDIF
#COMMAND
Lembre-se
As diretivas de compilao tambm so conhecidas como UDC User Defined

Commands.
Diretiva: #INCLUDE
A diretiva #INCLUDE indica em que arquivo de extenso CH (padro ADVPL) esto os UDCs
a serem utilizados pelo pr-processador.
A aplicao ERP possui diversos includes, os quais devem ser utilizados segundo a aplicao
que ser desenvolvida, o que permitir a utilizao de recursos adicionais definidos para a
linguagem, implementados pela rea de Tecnologia da Microsiga.
Os includes mais utilizados nas aplicaes ADVPL desenvolvidas para o ERP so:
PROTHEUS.CH: diretivas de compilao padres para a linguagem. Contm a
especificao da maioria das sintaxes utilizadas nos fontes, inclusive permitindo a
compatibilidade da sintaxe tradicional do Clipper para os novos recursos implementados
no ADVPL.
- 83 ADVPL Completo
O include PROTHEUS.CH ainda contm a referncia a outros includes utilizadas pela

linguagem ADVPL que complementam esta funcionalidade de compatibilidade com a
sintaxe Clipper, tais como:
o
o
o
o
o
DIALOG.CH
FONT.CH
INI.CH
PTMENU.CH
PRINT.CH
Fique atento
A utilizao do include protheus.ch nos fontes desenvolvidos para a

aplicao ERP Protheus obrigatria e necessria ao correto
funcionamento das aplicaes.
AP5MAIL.CH: Permite a utilizao da sintaxe tradicional na definio das seguintes

funes de envio e recebimento de e-mail:
o
o
o
o
o
o
o
o
CONNECT SMTP SERVER

CONNECT POP SERVER
DISCONNECT SMTP SERVER
DISCONNECT POP SERVER
POP MESSAGE COUNT
SEND MAIL FROM
GET MAIL ERROR
RECEIVE MAIL MESSAGE
TOPCONN.CH: Permite a utilizao da sintaxe tradicional na definio das seguintes

funes de integrao com a ferramenta TOPCONNECT (MP10 DbAcess):
o
TCQUERY
TBICONN.CH: Permite a utilizao da sintaxe tradicional na definio de conexes com

a aplicao Server do ambiente ERP, atravs da seguintes sintaxes:
o
o
o
o
o
o
o
o
CREATE RPCCONN
CLOSE RPCCONN
PREPARE ENVIRONMENT
RESET ENVIRONMENT
OPEN REMOTE TRANSACTION
CLOSE REMOTE TRANSACTION
CALLPROC IN
OPEN REMOTE TABLES
XMLXFUN.CH: Permite a utilizao da sintaxe tradicional na manipulao de arquivos e

strings no padro XML, atravs das seguintes sintaxes:
o
o
o
o
CREATE XMLSTRING
CREATE XMLFILE
SAVE XMLSTRING
SAVE XMLFILE
- 84 ADVPL Completo
o
o
o
ADDITEM TAG
ADDNODE NODE
DELETENODE
Os recursos de tratamentos de e-mails, integrao com a ferramenta
TOPCONNECT (DbAcess), preparao de ambientes e manipulao de
arquivos e strings do padro XML sero abordados no curso de ADVPL
Avanado.
O diretrio de includes deve ser especificado no ambiente de

desenvolvimento do ERP Protheus (MP-IDE) para cada configurao de
compilao disponvel.
Caso o diretrio de includes no esteja informado, ou esteja informado
incorretamente ser exibida uma mensagem de erro informando:
No foi possvel criar o arquivo <caminho\nome> .ERX
As funes desenvolvidas para a aplicao ERP costumam utilizar includes

para definir o contedo de strings e variveis diversas utilizadas pela
aplicao em diferentes idiomas. Desta forma normal verificar que um
fonte possui um arquivo .CH com o mesmo nome, o que caracteriza este
tipo de include.
Diretiva: #DEFINE
A diretiva #DEFINE permite que o desenvolvedor crie novos termos para serem utilizadas no
cdigo fonte. Este termo tem o efeito de uma varivel de escopo PUBLIC, mas que afeta
somente o fonte na qual o #DEFINE est definido, com a caracterstica de no permitir a
alterao de seu contedo.
Desta forma um termo definido atravs da diretiva #DEFINE pode ser considerado como uma
constante.
Os arquivos de include definidos para os fontes da aplicao ERP contm
diretivas #DEFINE para as strings de textos de mensagens exibidas para os
usurios nos trs idiomas com os quais a aplicao distribuda: Portugus,
Ingls e Espanhol.
Por esta razo a aplicao ERP possui trs repositrios distintos para cada
uma das bases de dados homologadas pela Microsiga, pois cada compilao
utiliza uma diretiva referente ao seu idioma.
- 85 ADVPL Completo
Diretivas: #IFDEF, IFNDEF, #ELSE e #ENDIF

As diretivas #IFDEF, #IFNDEF, #ELSE e #ENDIF permitem ao desenvolvedor criar fontes
flexveis e sensveis a determinadas configuraes da aplicao ERP.
Atravs destas diretivas, podem ser verificados parmetros do sistema, tais como o idioma
com o qual est parametrizado e a base de dados utilizada para armazenar e gerenciar as
informaes do ERP.
Desta forma, ao invs de escrever dois ou mais cdigos fontes que realizam a mesma funo,
mas utilizando recursos distintos para cada base de dados ou exibindo mensagem para cada
um dos idiomas tratados pela aplicao, o desenvolvedor pode preparar seu cdigo fonte para
ser avaliado pelo pr-processador, o qual ir gerar um cdigo compilado de acordo com a
anlise dos parmetros de ambiente.
Estas diretivas de compilao esto normalmente associadas as seguintes verificaes de
ambiente:
Idioma: verifica as variveis SPANISH e ENGLISH, disponibilizadas pela aplicao. O
idioma portugus determinado pela exceo:
#IFDEF SPANISH
#DEFINE STR0001 Hola !!!
#ELSE
#IFDEF ENGLISH
#DEFINE STR0001 Hello !!!
#ELSE
#DEFINE STR0001 Ol !!!
#ENDIF
#ENDIF
Apesar da estrutura semelhante ao IF-ELSE-ELSEIF-ENDIF, no existe

a diretiva de compilao #ELSEIF, o que torna necessrio o uso de
diversos #IFDEFs para a montagem de uma estrutura que seria
facilmente solucionada com IF-ELSE-ELSEIF-ENDIF.
A aplicao ERP disponibiliza a varivel de escopo PUBLIC __LANGUAGE, a qual contm uma string que identifica o idioma em
uso pelo sistema, cujo os contedos possveis so:
PORTUGUESE
SPANISH
ENGLISH
- 86 ADVPL Completo
Banco de Dados: verifica as variveis AXS e TOP para determinar se o banco de dados
em uso pela aplicao est no formado ISAM (DBF, ADS, CTREE, etc.) ou se est
utilizando a ferramenta TOPCONNECT (DbAcess).
#IFDEF TOP
cQuery := SELECT * FROM +RETSQLNAME(SA1)
dbUseArea(.T., "TOPCONN", TcGenQry(,,cQuery), SA1QRY,.T.,.T.)
#ELSE
DbSelectArea(SA1)
#ENDIF
Os bancos de dados padro AS400 no permitem a execuo de queries

no formato SQLANSI atravs da ferramenta TOPCONNECT (DbAcess).
Desta forma necessrio realizar uma verificao adicional ao #IFDEF
TOP antes de executar uma query, que no caso realizada atravs do
uso da funo TcSrvType(), a qual retorna a string AS/400 quando este
for o banco em uso.
Para estes bancos deve ser utilizada a sintaxe ADVPL tradicional.
Diretiva: #COMMAND
A diretiva #COMMAND utilizada principalmente nos includes da linguagem ADVPL para
efetuar a traduo de comandos em sintaxe CLIPPER para as funes implementadas pela
Tecnologia Microsiga.
Esta diretiva permite que o desenvolvedor defina para o compilador como uma expresso
dever ser interpretada.
Trecho do arquivo PROTHEUS.CH
#xcommand @ <nRow>, <nCol> SAY [ <oSay> <label: PROMPT,VAR > ] <cText> ;
[ PICTURE <cPict> ] ; [ <dlg: OF,WINDOW,DIALOG > <oWnd> ] ;
[ FONT <oFont> ] ; [ <lCenter: CENTERED, CENTER > ] ;
[ <lRight: RIGHT > ] ; [ <lBorder: BORDER > ] ;
[ <lPixel: PIXEL, PIXELS > ] ; [ <color: COLOR,COLORS > <nClrText> [,<nClrBack> ] ] ;
[ SIZE <nWidth>, <nHeight> ] ; [ <design: DESIGN > ] ;
[ <update: UPDATE > ] ; [ <lShaded: SHADED, SHADOW > ] ;
[ <lBox: BOX > ] ; [ <lRaised: RAISED > ] ;
=> ;
[ <oSay> := ] TSay():New( <nRow>, <nCol>, <{cText}>,;
[<oWnd>], [<cPict>], <oFont>, <.lCenter.>, <.lRight.>, <.lBorder.>,;
<.lPixel.>, <nClrText>, <nClrBack>, <nWidth>, <nHeight>,;
<.design.>, <.update.>, <.lShaded.>, <.lBox.>, <.lRaised.> )
Atravs da diretiva #COMMAND, o desenvolvedor determinou as regras para que a sintaxe

tradicional da linguagem CLIPPER para o comando SAY fosse convertida na especificao de
um objeto TSAY() do ADVPL.
- 87 ADVPL Completo
MDULO 03: Desenvolvendo pequenas customizaes

9. ADVPL e o ERP Microsiga Protheus
O ADVPL (Advanced Protheus Language) uma linguagem de programao desenvolvida pela
Microsiga e que contm todas as instrues e funes necessrias ao desenvolvimento de
um sistema, independente de sua complexidade.
O PROTHEUS, por outro lado, uma plataforma tecnolgica que engloba um Servidor de
Aplicao, um Dicionrio de Dados e as Interfaces para conexo com o usurio. o Protheus
que executa o cdigo ADVPL e o devido acesso base da dados.
O Protheus composto pelo ERP (que engloba, alm das funcionalidades descritas nos
captulos anteriores, mais de trinta verticais aplicadas a reas especficas de negcios) e
pelo Configurador (programa que permite customizar o sistema s necessidades do usurio
de forma fcil).
9.1. O Ambiente Protheus

O Protheus constitudo de um conjunto de Softwares que compem as camadas de
funcionalidades bsicas aos servios de aplicao, interface, banco de dados e repositrio,
conforme o diagrama da figura abaixo:
Figura: Camadas bsicas do ambiente Protheus

Para executar um programa desenvolvido em ADVPL, preciso antes de mais nada escrev-lo
e compil-lo. Este procedimento feito atravs da ferramenta TOTVS DevStudio do
Protheus (Totvs Development Studio).
O objetivo do TOTVS DevStudio 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 e administra o repositrio de objetos; aponta erros de
- 88 ADVPL Completo
sintaxe; permite o debug (execuo passo a passo do programa, verificando o contedo das
variveis) e fornece assistentes (modelos) de programas.
Figura: Manuteno no repositrio de objetos

Aps compilar o programa, o resultado um objeto, o qual carregado na memria ficando
disponvel para sua execuo atravs da aplicao PROTHEUS.
O objeto no um executvel, ou seja, no est convertido para a linguagem nativa do
equipamento. Quem faz esse trabalho o Protheus Server em tempo de execuo. Por isso, o
Protheus Server est sempre presente na memria em tempo de execuo, permitindo:
Proteger o programa fonte, evitando que seja alterado indevidamente, pois somente os
objetos so distribudos com uma execuo mais rpida em funo da compilao no
DEV-Studio;
Flexibilizao plataforma de trabalho. Assim, um mesmo programa pode rodar em
ambientes Windows, Linux ou mesmo em um Hand Held, ficando a tarefa de adequao
para o Servidor Protheus;
Que o sistema cresa de forma ilimitada, pois os objetos ficam fora do executvel;
O uso de macro substituies, ou seja, o uso de rotinas exteriores ao sistema
armazenadas em arquivos e que podem facilmente alteradas pelo usurio, pois o Server
tambm interpreta o cdigo fonte em tempo de execuo.
- 89 ADVPL Completo
Figura: Diagrama esquemtico de objetos Protheus

O Repositrio de Objetos a biblioteca de objetos de todo o ambiente Protheus, incluindo
tanto os objetos implementados para as funcionalidades bsicas do ERP como aqueles gerados
pelos usurios. A figura abaixo demonstra a estrutura e a interconexo entre as vrias
camadas.
Figura: Estrutura de interconexo do Protheus
- 90 ADVPL Completo
Ela demonstra tambm que os dados a serem processados podem estar armazenados em
bases ISAM ou em Bancos de Dados padro SQL. No primeiro caso o server comunica- se
diretamente com os dados. Em Bancos SQL a interface TOPCONNECT / DBACCESS que
converte os comandos de entrada e sada, adequando-os ao SQL utilizado (SQl Server
Microsoft, Oracle, DB2, etc.).
Uma vez terminado o processamento do objeto chamado, o ele descartado da memria, ou
seja, o Protheus um sistema que pode crescer de forma ilimitada pois os objetos,
armazenados em um repositrio praticamente no ocupam espao no HD (Hard Disk).
O Protheus uma plataforma multicamada. Entre as diversas camadas, temos a interface de
apresentao ao usurio (Remote), o tratamento dado para as regras de negcio
implementadas (Server), o acesso aos objetos do repositrio (Server), o acesso aos
dados disponveis no Banco de Dados (Server ou TOPCONNECT / DBACCESS ) e ao
gerenciamento de servios WEB (Server). Neste processo, o Protheus possui, basicamente,
quatro aplicativos utilizados com diferentes finalidades:
Protheus Server / TOTVS AppServer: Responsvel pela comunicao entre o cliente,
o banco de dados e o RPO. O nome do executvel depende da verso do sistema
(TOTVSAPPSERVER.EXE) sendo que as plataformas ISAM suportadas pelo Protheus
Server so DBF e CTREE.
Protheus Remote / TOTVS SmartClient: Instalado no Server ou na estao.
nome tambm depende da verso do sistema (TOTVSSMARTCLIENT.EXE).
TopConnect / DbAccess: Responsvel pela converso dos comandos de banco de

dados, adequando-os ao SQL utilizado.
Protheus Monitor / TOTVS Monitor: Programa de anlise que verifica quem est
usando o sistema e possibilita o envio de mensagens ou mesmo derrubar conexes
(TOTVSMONITOR.EXE).
Alguns nomes referem-se a um conjunto de programas para facilitar a sua identificao:
RPO: o arquivo binrio do APO (Advanced Protheus Objects), ou seja, os objetos.
Build: Executveis, DLLs e o RPO completo.
Patch: Atualizaes pontuais do RPO, aplicadas por meio do IDE.
Update: Pacote de atualizao para o repositrio (RPO) liberado periodicamente
contendo todas as adequaes e melhorias disponibilizadas para o sistema em um
determinado perodo, sendo no cumulativo, aplicadas por meio do DEV-Studio.
A interface de apresentao realizada pelo SmartClient que processa a parte da estao,
basicamente, tela e teclado. Pode estar gravado no Server 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 prprio browser com o
SmartClient ActiveX e permitindo o acesso ao Protheus Server pela Internet, com as mesmas
funcionalidades do SmartClient, sendo que o browser precisa suportar o uso da tecnologia
ActiveX.
Caso exista algum Firewall ou Proxy entre o WEB Server e o Browser que vai acessar o
SmartClient ActiveX, eles devero ser configurados para permitir o seu download.
- 91 ADVPL Completo
9.2. Organizao e configurao inicial do ambiente Protheus

O Protheus ocupa uma pasta que tem a seguinte estrutura:
Figura: Estrutura bsica das pastas do Protheus

APO: Contm o arquivo RPO, repositrio de objetos do Protheus.
SMARTCLIENT: Rene um conjunto de arquivos executveis, dlls e arquivos de
configurao do sistema, para possibilitar o acesso ao servidor.
APPSERVER: Rene um conjunto de executveis, dlls e arquivos de configurao do
sistema que compem o servidor.
INCLUDE: Contm as bibliotecas necessrias para a compilao de programas
Protheus.
DATA: Contm a base de dados no caso de verso ISAM.
SAMPLES: Oferece um conjunto de programas exemplo e arquivos ADVPL padres da
Microsiga.
SPOOL: Nesta pasta so gravados os relatrios gerados em disco pelo sistema
Protheus.
SYSTEM: Contm os arquivos de menus, os arquivos de configuraes e os arquivos
de customizaes (SXs) do sistema Protheus.
- 92 ADVPL Completo
SYSTEMLOAD: Contm o dicionrio de dados em formato TXT. neste arquivo que

esto todos os padres e formatos para a gerao dos arquivos de configuraes e de
customizaes (SXs), conforme a localizao de pas definida pelo usurio na entrada
do sistema.
MY PROJECTS: Sugere-se a criao desta pasta para armazenar projetos e fontes das
customizaes realizadas pelo usurio.
UPDATES: Sugere-se esta pasta para o armazenamento das atualizaes a serem
aplicadas no sistema Protheus.
Apesar da estrutura ilustrada anteriormente indicar que as pastas esto subordinadas pasta
PROTHEUS, possvel que algumas delas possam estar em mquinas diferentes ou at mesmo
em ambientes computacionais diferentes.
Figura: Formas de instalao e uso do Protheus
- 93 ADVPL Completo
Para isso, necessrio configurar, ou seja, informar ao Protheus onde est cada uma delas.
Esse tipo de informao consta nos arquivos de parmetros de configurao do sistema
(TOTVSAPPSERVER.INI e TOTVSSMARTCLIENT.INI) existentes nas respectivas pastas
APPSERVER e SMARTCLIENT.
Os parmetros do TOTVSAPPSERVER.INI so lidos pelo programa TOTVSAPPSERVER.EXE logo
no incio de sua execuo. O mesmo procedimento ocorre em relao aos parmetros do
TOTVSSMARTCLIENT.INI pelo programa TOTVSSMARTCLIENT.EXE. A execuo desses dois
programas feita por meio de ao do usurio, facilitada pelos atalhos TOTVS APPSERVER e
TOTVS SMARTCLIENT.
Figura: Links dos parmetros de configurao

Para que o TOTVS AppServer e o TOTVS SmartClient sejam executados, os arquivos
TOTVSAPPSERVER.INI e TOTVSSMARTCLIENT.INI devem estar disponveis nas respectivas
pastas APPSERVER e SMARTCLIENT pois so eles que indicam o endereo das demais pastas
conforme a ilustrao da figura anterior.
O detalhe de preenchimento das propriedades dos respectivos atalhos TOTVS AppServer e o
TOTVS SmartClient demonstrado a seguir. No atalho do TOTV SAppServer, necessrio que
seja informado o parmetro -debug ou -console.
- 94 ADVPL Completo
Propriedades dos atalhos
Destino:
c:\protheus\bin\appserver\totvsappserver.exe
- console
Iniciar em:
c:\protheus\bin\appserver
-Console ou -Debug
Executado como uma JanelaConsole, as informaes recebidas das conexes com o TOTVS
Application Server conectados so exibidas diretamente na tela do console do TOTVS
Application Server, bem como informaes de No Conformidades.
-Install
Se o TOTVS Application Server, no for instalado como um Servio do NT, durante a
Instalao, isto pode ser realizado, executando-o com a opo de Linha de Comando.
-Remove
Para remov-lo da Lista de Servios do NT, pode-se execut-lo com a opo de Linha de
Comando.
Destino:
c:\protheus\bin\smartclient\totvssmartcliente.exe
M
Iniciar em:
c:\protheus\bin\smartclient
-Q (Quiet)
Indica que o TOTVS Smart Client, no dever mostrar o Splash (Imagem de Apresentao) e a
tela de identificao de Parmetros Iniciais, necessita ser acompanhada da (Clusula P).
-P (Main Program)
Identifica o Programa (APO) Inicial.
-E (Environment)
Nome da Seo de Environment, no (Ini do Server), que ser utilizada, para definies gerais.
-C (Connection)
Nome da Seo de Conexo, que ser utilizada, para a conexo ao TOTVS Application Server.
-M (AllowMultiSession)
Permite mltiplas instncias (Cpias) do TOTVS Smart Client, na mesma mquina, o que por
Default no permitido.
- 95 ADVPL Completo
Os parmetros que configuram o local do RPO, o Banco de Dados (ISAM ou SQL), os arquivos
de menus, configuraes e customizaes do sistema no arquivo INI so:
SourcePath: Indica o local de origem dos objetos. o endereo do Repositrio
Objetos (Exemplo: SourcePath=C:\PROTHEUS\APO)
de
RootPath: Aponta para a pasta raiz (inicial), a partir da qual sero localizados os dados
(no caso de ISAM), bem como o prprio Dicionrio de Dados
(Exemplo:
RootPath=C:\PROTHEUS\PROTHEUS_DATA)
StartPath: Indica qual a pasta dentro da pasta raiz (informada no parmetro
RootPath) que contm os arquivos de menus, os arquivos de configuraes e os
arquivos de customizaes
(SXs)
do
sistema
Protheus
(Exemplo:
StartPath=\SYSTEM\).
No h necessidade de que os parmetros estejam em ordem nos arquivos de configurao
(.ini). Alm dos parmetros j detalhados, existem outros que podem indicar a verso do
sistema, o tipo de banco de dados, linguagem do pas em que est sendo utilizado e as
mscaras de edio e formatao.
[ENVIRONMENT]
SOURCEPATHC:\PROTHEUS\APO
ROOTPATH= C:\MP811\PROTHEUS_DATA
STARTPATH=\ PROTHEUS\
RPODB=TOP
RPOLANGUAGE=PORTUGUESE
RPOVERSION=101
LOCALFILES=ADS
TRACE=0
LOCALDBEXTENSION=.DBF
PICTFORMAT=DEFAULT
DATEFORMAT=DEFAULT
[DRIVERS]
ACTIVE=TCP
[TCP]
TYPE=TCPIP
PORT=1234
Figura: Exemplo de um ambiente em um arquivo de parmetros
No exemplo da figura anterior, o rtulo [environment] descreve um conjunto de parmetros
que sero inicializados no sistema. Os rtulos [Drivers] e [TCP] identificam a comunicao que
pode ser estabelecida entre o Protheus Server e o Protheus Remote. Outros ambientes podem
ser configurados no mesmo arquivo (TOTVSAPPSERVER.INI).
J o arquivo de parmetros do Protheus Remote (TOTVSSMARTCLIENT.INI) contm apenas as
configuraes locais, basicamente as informaes necessrias para a inicializao e a
comunicao com o Protheus Server, conforme o exemplo da figura a seguir.
- 96 ADVPL Completo
[CONFIG]
LASTMAINPROG=SIGACFG
LANGUAGE=1
[DRIVERS]
ACTIVE=TCP
[TCP]
SERVER=172.16.72.41
PORT=1234
Figura: Exemplo de um arquivo de configurao do remote

Active: Indica qual a forma de comunicao.
Port: Indica o nmero da porta a ser utilizada para a comunicao entre o Protheus
Server e o Protheus Remote. necessrio que a porta utilizada na comunicao seja a
mesma em ambos (no TOTVSAPPSERVER.INI e no TOTVSSMARTCLIENT.INI). Vale
ressaltar que a porta 80 reservada para a Internet e pode causar conflitos caso seja
utilizada na comunicao do Protheus.
Server: Aponta para o endereo do servidor que pode ser a prpria mquina
(localhost) ou o nome da mquina (Server= Servidor_01) ou mesmo um endereo IP
(exemplo Server=172.16.72.41).
Exemplo:
O parmetro Server=172.16.72.41 no arquivo TOTVSSMARTCLIENT.INI indica ao Protheus
Remote o endereo da mquina na qual est funcionando o Protheus Server.
- 97 ADVPL Completo
9.3. O Configurador do Protheus

9.3.1.
Funcionalidades Abordadas
O objetivo deste tpico no abranger todo a estrutura e recursos do mdulo Configurador da

aplicao ERP, mas permitir a realizao de tarefas de configurao simples que sero
necessrias no desenvolvimento de pequenas customizaes.
Com foco neste objetivo sero detalhadas as seguintes operaes
Configurao e criao de novas tabelas no Dicionrio de Dados
Atualizao das estruturas do Dicionrio de Dados
o Tabelas do sistema
o Validaes de campos
o ndices de tabelas
o Gatilhos de campos
Para contextualizar a estrutura da aplicao ERP, no tpico a seguir detalhada a forma como
as tabelas de dados do sistema esto divididas entre os diversos mdulos que compe o
PROTHEUS.
9.3.2.
Estruturas bsicas da aplicao ERP Protheus
Arquivos de configurao do sistema

Arquivo
SIGAMAT
SIGAPSS
SIX
SX1
SX2
SX3
SX4
SX5
SX6
SX7
SX8
SX9
SXA
SXB
SXD
SXE
SXF
SXG
SXK
SXO
SXP
SXQ
SXR
Descrio
Cadastro de empresas e filiais do sistema
Arquivo de usurios, grupos e senhas do sistema
ndices dos arquivos
Perguntas e respostas
Mapeamento de tabelas
Dicionrio de Dados
Agenda do Schedule de processos
Tabelas
Parmetros
Gatilhos de Interface
Fora de uso
Relacionamentos entre tabelas
Pastas cadastrais apontadas no SX3
Consulta por meio da tecla F3 (Consulta Padro)
Controle do Schedule de processos
Seqncia de documentos (+1)
Seqncia de documentos (Prximo)
Tamanho padro para campos apontado pelo SX3
Resposta de Perguntas (SX1) por usurios
Controle de LOGs por tabela
Histrico de Logs cadastrados no SXO
Cadastro de filtros inteligentes da mbrowse (contm as
informaes necessrias para a criao do filtro).
Cadastro de relacionamento entre programa x filtro
(utilizada internamente pelo Protheus para verificar em
quais programas os filtros podero ser utilizados).
- 98 ADVPL Completo
Cadastro de programas (utilizado na validao para

mostrar/inibir os filtros na execuo da mbrowse).
Tabela de usurios (contm as informaes dos
usurios que podero utilizar os filtros da mbrowse).
SXS
SXT
Cadastro de relacionamento entre as entidades

SXOffice (tabelas) e as consultas TOII.
Ambientes e tabelas
Na aplicao PROTHEUS as tabelas de dados podem ter uma estrutura mais simples e
econmica, com tabelas em DBF/ADS, do fabricante Extended System ou CTREE do fabricante
FAIRCOM ou uma estrutura mais robusta e complexa, em bases SQL (SQLSERVER da
Microsoft, ORACLE, DB II da IBM, SYBASE, MYSQL, POSTGREE, etc.).
No caso do SQL, o acesso feito atravs do TOPCONNECT / DBACESS, que converte os
comandos do ADVPL para este ambiente.
Para permitir uma utilizao adequada das tabelas de dados do sistema por cada um dos
ambientes da aplicao ERP, as tabelas foram divididas em grupos denominados famlias.
Cada mdulo pode utilizar uma ou mais famlias de tabelas especificas para suas atividades, e
ainda compartilhar informaes com outros mdulos atravs de famlias comuns a todas as
operaes realizadas no sistema.
A tabela a seguir demonstra alguns dos mdulos que compe a aplicao ERP PROTHEUS
atualmente:
Ambiente
SIGAATF
SIGACOM
SIGACON
SIGAEST
SIGAFAT
SIGAFIN
SIGAFIS
SIGAPCP
SIGAGPE
SIGAFAS
SIGAVEI
SIGALOJ
SIGATMK
SIGAOFI
SIGAPON
SIGAEIC
SIGATCF
SIGAMNT
SIGARSP
SIGAQIE
SIGAQMT
Identificao
ATIVO FIXO
COMPRAS
CONTABILIDADE
ESTOQUE E CUSTOS
FATURAMENTO
FINANCEIRO
LIVROS FISCAIS
PLANEJAMENTO E CONTROLE DA PRODUO
GESTO DE PESSOAL
FATURAMENTO DE SERVIOS
VECULOS
CONTROLE DE LOJAS/AUTOMAO COMERCIAL
CALL CENTER
OFICINAS
PONTO ELETRNICO
EASY IMPORT CONTROL
TERMINAL
MANUTENO DE ATIVOS
RECRUTAMENTO E SELEO DE PESSOAL
INSPEO DE ENTRADA QUALIDADE
METODOLOGIA QUALIDADE
O nome de cada tabela no Protheus constitudo de seis dgitos, os quais so utilizados para
formar a seguinte representao:
F
- 99 ADVPL Completo
Onde:
F
SF
Primeiro dgito representa a famlia, o segundo dgito

pode ser utilizado para detalhar ainda mais a famlia
especificada no primeiro nvel (subfamlia), e o terceiro
dgito a numerao seqencial das tabelas da famlia
iniciando em 0 e finalizando em Z.
Os dois primeiros dgitos identificam a que empresa as
tabelas esto vinculadas, lembrando que a informao
de filial est contida nos dados da tabela.
O ltimo dgito fixo em 0.
A tabela a seguir demonstra algumas das principais famlias de tabelas utilizadas pela
aplicao ERP Protheus:
Famlia
S
S
S
S
S
S
S
S
S
A
C
C
C
C
D
E
G
J
N
P
Q
R
T
W
Z
G
H
I
N
R
X
Z
T
V
W
-
Descrio
Tabelas pertencentes ao sistema bsico, tambm chamado Classic
Cadastros de entidades compartilhadas entre os ambientes
(Clientes, Fornecedores, Bancos entre outros).
Cadastros dos ambientes de Materiais (Produtos, Saldos entre
outros).
Arquivos de movimentaes diversas utilizados pelos ambientes de
Materiais (Solicitao ao Almoxarifado, Solicitao de Compras,
Pedido de Compras, Pedido de Vendas, Ordens de Produo entre
outros).
Arquivos de movimentaes de estoque (Itens de notas fiscais de
entrada e sada, movimentos internos de estoque entre outros).
Cadastros e movimentaes do ambiente Financeiro.
Cadastros e movimentaes Fiscais (Cabealhos das notas fiscais
de entrada e sada, cadastro de tipos de entrada e sada, livros
fiscais, entre outros).
Cadastros do ambiente de Planejamento e Controle de Produo
Movimentos do ambiente de Planejamento e Controle de Produo
Cadastros e movimentos do ambiente Contbil (descontinuado)
Cadastros e movimentos do ambiente Ativo Fixo
Cadastros e movimentos do ambiente Gesto de Pessoal
Tabelas de configurao do sistema
Tabelas livres para utilizao e projetos especficos em clientes.
Gesto de Projetos
Contabilidade Gerencial
Transportadoras e derivados
Comrcio exterior e derivados
Gesto Hospitalar
Gesto Educacional
Servios Pblicos
Reservado para projetos da fbrica de software
Qualidade e derivados
Recursos Humanos e derivados
Plano de Sade
Workflow
Tabelas livres para utilizao e projetos especficos em clientes em
adio a famlia SZ.
- 100 ADVPL Completo
ndices
Cada tabela do sistema possui seus ndices definidos no arquivo de configurao SIX, o qual
pode ser atualizado atravs do mdulo Configurador.
Os arquivos de ndices das tabelas de sistema sero criados de acordo com o banco de dados
utilizado (ISAM ou conexo via TOPCONNECT).
Para bancos de dados ISAM, ser gerados arquivos com a mesma nomenclatura da tabela de
dados, mas com uma extenso diferenciada (atualmente .CDX). No caso da utilizao de um
banco de dados, cada ndice ser uma numerao seqencial em funo do nome da tabela
original.
As especificaes das chaves de ndices de cada um das tabelas est disponvel no arquivo de
sistema SIX, e a chave nica da tabela utilizada para banco de dados est descrita na tabela
SX2.
Menus
Cada mdulo da aplicao ERP possui um menu padro com todas as funcionalidades
disponveis para o ambiente, menu este definido atravs de sintaxe XML (arquivos .XNU).
Os menus possuem uma estrutura padro que permite ao usurio localizar e identificar
facilmente cada uma das funcionalidades oferecidas pelo ambiente.
9.3.3.
Acessando o mdulo Configurador
Para executar o mdulo Configurador necessrio que a aplicao Protheus Server esteja em
execuo e atravs da aplicao Protheus Remote dever ser informada como programa inicial
a opo SIGACFG.
Figura: Parmetros de inicializao do sistema
Aps a confirmao, a validao do acesso feita conforme tela ilustrada a seguir:
Figura: Validao de acesso
Figura: Confirmao do acesso ao mdulo Configurador
Logo aps a sua confirmao do usurio e senha com direito de administrador, ser
apresentada a tela inicial do configurador, conforme mostra a figura a seguir:
Figura: Interface principal do mdulo Configurador
9.4. Funcionalidades do Configurador

A customizao de um sistema como o Protheus consiste em adaptar o sistema de forma a
melhor atender as necessidades do cliente.
A flexibilidade de um sistema, ou seja, sua capacidade de adaptar-se (polimorfismo, aquele
que assume vrias formas) uma das mais importantes caractersticas de uma soluo ERP.
As funcionalidades tratadas pelo Configurador definem a flexibilidade do ERP Protheus.
Flexibilizar sem despadronizar, ou seja, tudo que foi customizado permanece vlido, mesmo
com o desenvolvimento de novas verses.
Figura: Principais funcionalidades do mdulo Configurador

O Configurador o programa bsico para o processo de customizao do Protheus atravs da
alterao das tabelas da famlia SX. Neles, o usurio ou o analista de suporte responsvel pela
implantao configura as informaes que sero utilizadas pelos demais ambientes do sistema.
Essas informaes vo de simples parmetros at complexas expresses e comandos que so
interpretadas em tempo de execuo.
Nos prximos tpicos sero abordadas as funcionalidades de customizao disponveis no
ambiente Configurador, relevantes ao objetivo de desenvolvimento de pequenas
customizaes para a aplicao ERP.
9.4.1.
Dicionrio de Dados da aplicao ERP
A idia do Dicionrio de Dados permitir que o usurio possa incluir ou inibir campos, ou
mesmo alterar as propriedades dos campos existentes. Pode, ainda, criar novas tabelas. Ou
seja, os programas ao invs de terem os campos definidos em seu cdigo original, lem o
Dicionrio em tempo de execuo, montando arrays com as propriedades de cada um. A partir
da, sua utilizao normal, atravs do uso de funes do ADVPL que tornam o trabalho do
desenvolvedor transparente a esta arquitetura.
O objetivo do Dicionrio de Dados permitir que o prprio usurio crie novas tabelas ou altere
os campos nas tabelas existentes quanto ao seu uso, sua ordem de apresentao, legenda
(nos trs idiomas), validao, help, obrigatoriedade de preenchimento, inicializao etc.
Figura: Conjunto de pacotes que compe o Dicionrio de Dados
9.4.2.
Adio de tabelas ao Dicionrio de Dados
Procedimento
1. Para adicionar uma tabela ao dicionrio de dados de uma empresa, selecione a opo
Dicionrio de Dados abaixo da empresa que ser atualizada. (rvore de opes da parte
esquerda da interface visual do Gerenciador de Bases de Dados).
2. Aps a seleo da opo Dicionrio de Dados sero exibidas as tabelas j cadastradas
no arquivo de sistema SX2.
Figura: Conjunto de tabelas j cadastradas no SX2

3. Aps a visualizao das tabelas j cadastradas no SX2 da empresa selecionada, utilize o
). Ao utilizar esta opo ser exibida a tela para definio dos dados
boto Incluir (
referentes nova tabela que ser criada:
Figura: Cadastro de uma nova tabela

4. Realize o preenchimento das informaes solicitadas de acordo com as orientaes a
seguir, e ao trmino confirme o cadastramento da nova tabela com o boto Confirmar
).
Orientaes para o cadastramento de uma nova tabela

O domnio SZ1 at SZZ (considerando todos os nmero e todas as letras no ltimo
byte) reservado para dados exclusivos do usurio pois esse intervalo no ser
utilizado pelo sistema. Caso seja necessrio o domnio Z00 a ZZZ tambm pode ser
empregado para desenvolvimentos especficos do cliente.
No devem ser criadas tabelas especficas de clientes com
quaisquer outras nomenclaturas, o que pode afetar diretamente
um processo de atualizao futuro.
O nome da tabela preenchido automaticamente, adicionando 990. Esse dado referese empresa 99 (Teste Matriz) a qual est sendo adicionado tabela.
O Path refere-se pasta que conter efetivamente os dados das tabelas, quando ISAM,
nas verses com banco de dados relacional no so utilizadas. Essa pasta ser criada
dentro da pasta indicada na configurao do sistema como ROOTTPATH.
O modo de acesso compartilhado indica que o sistema possibilitar o uso simultneo da
tabela por duas ou mais filiais. Se for compartilhado o campo Filial fica em branco. Se
for exclusivo, grava-se o cdigo da filial ativa e somente ela tem acesso ao registro.
Aps a confirmao, a tabela criada passa a fazer parte do cadastro do Dicionrio de
Dados, contendo somente o campo FILIAL, o qual criado como padro pela
funcionalidade do mdulo.
9.4.3.
Adio de campos as tabelas do Dicionrio de Dados
Procedimento
1. Para adicionar um campo a uma tabela do dicionrio de dados de uma empresa,
selecione a opo Dicionrio de Dados abaixo da empresa que ser atualizada. (rvore
de opes da parte esquerda da interface visual do Gerenciador de Bases de Dados).

3. Aps a visualizao das tabelas j cadastradas no SX2 da empresa selecionada, localize
). Ao utilizar esta
e selecione a tabela que ser atualizada, e utilize o boto Editar (
opo ser exibida a tela de manuteno de campos da tabela selecionada:
Figura: Estrutura de uma tabela j cadastrada no sistema

4. Selecione a opo Campos (
), para que sejam exibidos os campos
disponveis para a tabela no arquivo de sistema SX3.
Figura: Estrutura de campos de uma tabela j cadastrada no sistema

5. Aps a visualizao dos campos j cadastrados no SX3 da tabela selecionada, utilize a
). Ao utilizar esta opo ser exibida a tela para definio dos dados
opo Incluir (
referentes ao novo campo que ser criado:
Figura: Dados para parametrizao de um novo campo no sistema

seguir, e ao trmino confirme o cadastramento do novo campo para a tabela com o
boto Confirmar (
).
6. Confirme as atualizaes para a tabela selecionada com o boto Confirmar (
7. Atualize as configuraes do sistema com o boto Atualizar (
Figura: Atualizao dos dados do sistema

).
).
Orientaes para o cadastramento de um novo campo

1. As propriedades definidas no Dicionrio de Dados (SX3) so as seguintes:
Nome do campo: Todos os campos tm como prefixo o prprio nome da tabela, sendo
que para tabelas da famlia S, o prefixo do campo composto apenas pelos prximos
dois dgitos. No caso das demais tabelas, o prefixo do campo sero os trs dgitos
identificadores da tabela.
Tipo do campo: Indica se caractere, numrico, lgico, data ou memo. claro que a
mudana do tipo de campo deve ser feita com muito cuidado, pois, se tivermos um
campo numrico usado em clculos e ele for alterado para caractere, certamente
teremos um erro.
Tamanho do campo: Tambm aqui necessrio certo cuidado ao alter-lo, pois
poderemos ter truncamentos em relatrios e consultas em que h espao para
contedos maiores que o original.
Formato de edio: Define como o campo aparece nas telas e nos relatrios.
Contexto: Pode ser real ou virtual. O contexto virtual cria o campo somente na
memria e no na tabela
armazenada no disco.
Isso necessrio porque os
programas de cadastramento e de consulta genrica apresentam somente uma tabela
de cada vez. Assim, se quisermos apresentar um campo de uma outra tabela, ou
mesmo o resultado de um clculo, sem que tal informao ocupe espao fsico no HD,
utilizamos o contexto virtual. Campos virtuais normalmente so alimentados por
gatilhos.
Propriedade: Indica se um campo pode ou no ser alterado pelo usurio. Exemplo:
saldos normalmente no podem, pois quem cuida dessa tarefa so os programas.
2. Demais caractersticas que devem ser observadas na configurao do campo:
Guia: Campo
O campo Decimal ser solicitado somente para os campos de tipo numrico.
O formato ! indica que o caractere ser sempre maisculo, independente da ao
do usurio. O formato @! indica que essa caracterstica estende-se por todo 20
o
campo.
O contexto real indica que o campo existir efetivamente no banco de dados e o
contexto virtual significa que o campo existir apenas no dicionrio de dados e no
fisicamente.
A propriedade alterar indica que o campo pode ser alterado.
Nesta janela, os dados esto classificados em seis pastas com objetivos de
preenchimento bem especficos:
Guia: Informaes
Contm as informaes a respeito dos ttulos.
Ttulo: a legenda que aparece nas telas/relatrios. H inclusive trs campos para
esta finalidade: em portugus, espanhol e ingls. Esta propriedade pode ser alterada
vontade, pois no interfere em nenhum processamento.
Descrio e Help: So propriedades que objetivam documentar o campo.
Guia: Opes
Contm os dados que facilitam a digitao.
Guia: Validaes
Representam as regras de validao do campo.
Validaes: Nesta propriedade, escreve-se uma funo de validao do campo que
est sendo digitado. Existe um conjunto de funes disponveis no ADVPL apropriadas
para esse caso.
Todas as validaes informadas sero executadas no momento do preenchimento do
prprio campo. Uma validao pode ser uma expresso lgica ou uma funo de
usurio que retorna um valor lgico Verdadeiro ou Falso. O sistema s permitir o
avano para o prximo campo quando o respectivo preenchimento resultar Verdadeiro
seja na expresso ou no retorno da funo.
Guia: Uso
Descreve a forma de utilizao do campo.
Guia: Mdulos
Relaciona todos os mdulos em que o campo ser utilizado.
9.4.4.
Adio de ndices para as tabelas do Dicionrio de Dados
Conforme mencionado anteriormente, no ambiente Protheus uma tabela pode ter vrios
ndices, os quais sero gerados de acordo com o banco de dados configurado para o sistema.
Os ndices do sistema auxiliam na seleo e obteno de informaes da base de dados alm
de determinar a ordem de apresentao dos registros de uma tabela em consultas e relatrios.
Procedimento
1. Para adicionar um ndice a uma tabela do dicionrio de dados de uma empresa,
selecione a opo Dicionrio de Dados abaixo da empresa que ser atualizada. (rvore
de opes da parte esquerda da interface visual do Gerenciador de Bases de Dados).

3. Aps a visualizao das tabelas j cadastradas no SX2 da empresa selecionada, localize
). Ao utilizar esta
e selecione a tabela que ser atualizada, e utilize o boto Editar (
opo ser exibida a tela de manuteno de campos da tabela selecionada:
Figura: Estrutura de uma tabela j cadastrada no sistema
4. Selecione a opo ndices (

), para que sejam exibidos os ndices
disponveis para a tabela no arquivo de sistema SIX.
Figura: ndices disponveis para a tabela no arquivo de sistema SIX

5. Aps a visualizao dos ndices j cadastrados no SIX para a tabela selecionada, utilize
). Ao utilizar esta opo ser exibida a tela para definio dos

a opo Incluir (
dados referentes ao novo ndice que ser criado:
Figura: Adio de um ndice para uma tabela

seguir, e ao trmino confirme o cadastramento do novo ndice para a tabela com o boto
Confirmar (
).
7. Confirme as atualizaes para a tabela selecionada com o boto Confirmar (
8. Atualize as configuraes do sistema com o boto Atualizar (
Figura: Atualizao dos dados do sistema
).
).
Orientaes para o cadastramento de um novo ndice

O Nickname uma identificao complementar do ndice o qual pode ser utilizada para
auxiliar o desenvolvedor na utilizao desta ordem em uma aplicao, a qual pode ser
padro do sistema ou especfica de um cliente.
Para selecionar os campos j cadastrados na tabela, pode ser utilizado o boto Campos
). Esta facilidade preenche, automaticamente, os campos de descrio.
O campo relativo filial sempre faz parte dos ndices, com exceo do SM2, para que
os registros nas tabelas estejam agrupados por filiais, independente desta tabela ser
compartilhada entre as filiais.
Uma tabela poder ter vrios ndices cadastrados no Dicionrio de Dados. Em
determinado momento, porm, apenas um deles oferecer acesso ao registro. Essa
ordem pode ser alterada em tempo de execuo pelos programas da aplicao, atravs
do comando DBSetOrder(), ou atravs da definio de uma ordem especfica na
utilizao de queries para acesso as dados diretamente em bancos de dados de
ambientes TOPCONNECT (DbAcess).
9.4.5.
Adio de gatilhos para os campos das tabelas do sistema
Procedimento
1. Para adicionar um gatilho a um campo de uma tabela do dicionrio de dados de uma
empresa, selecione a opo Gatilho abaixo da empresa que ser atualizada. (rvore de
opes da parte esquerda da interface visual do Gerenciador de Bases de Dados).
2. Aps a seleo da opo Gatilhos sero exibidos os itens j cadastradas no arquivo de
sistema SX7.
Figura: Conjunto de gatilhos j cadastros no SX7
3. Aps a visualizao dos gatilhos j cadastrados no SX7 da empresa selecionada, utilize
) para realizar o cadastro de um novo gatilho no sistema:
o boto Incluir (
Figura: Dados para o cadastro de um novo gatilho no sistema

seguir, e ao trmino confirme o cadastramento do novo gatilho de sitema com o boto
Confirmar (
).
Orientaes para o cadastramento de um novo gatilho
Pode haver vrios gatilhos para o mesmo campo. A ordem de execuo determinada
pelo campo Seqncia.
Os tipos do Gatilho Primrio, Estrangeiro e de Posicionamento definem se o Contra
Domnio um campo da mesma tabela, de outra tabela ou se o gatilho deve realizar
um posicionamento, respectivamente.
A regra pode ser uma expresso que resulta em um valor a ser preenchido no Contra
Domnio.
O posicionamento igual a Sim indica que ser executado um comando de busca do
registro de acordo com a chave indicada.
O Alias, a Ordem e a Chave descrevem a tabela envolvida no gatilho, seu ndice e a
chave para que a funcionalidade se posicione no registro adequado.
9.4.6.
Criao de Tabelas Genricas
Procedimento
1. Para adicionar uma tabela genrica, selecione os menus Ambiente, Cadastros, Tabelas.
2. Aps a seleo da opo Tabelas sero exibidos os itens j cadastradas no arquivo de
sistema SX5.
Figura: Conjunto de Tabelas j cadastras no SX5

3. Aps a visualizao das tabelas j cadastrados no SX5 da empresa selecionada, utilize o
boto Incluir (
) para realizar o cadastro de uma nova tabela no sistema:
Figura: Dados para o cadastro de uma nova tabela no sistema


seguir, e ao trmino confirme o cadastramento da nova tabela do sistema com o boto
Confirmar (
9.4.7.
).
Criao de Parmetros
Procedimento
1. Para adicionar um Parmetro, selecione os menus Ambiente, Cadastros, Parmetros.
2. Aps a seleo da opo Tabelas sero exibidos os itens j cadastradas no arquivo de
sistema SX6.
Figura: Conjunto de Parmetros j cadastras no SX6

3. Aps a visualizao dos Parmetros j cadastrados no SX6 da empresa selecionada,
utilize o boto Incluir (
) para realizar o cadastro de uma nova tabela no sistema:
Figura: Dados para o cadastro de um novo parmetro no sistema

seguir, e ao trmino confirme o cadastramento do novo Parmetro do sistema com o
boto Confirmar (
).
10.
TOTVS Development Studio
A ferramenta TOTVS Development Studio um programa que faz parte do Protheus e permite
o trabalho de edio, compilao e depurao de programas escritos em ADVPL.
Projeto
Um programa para ser compilado deve ser vinculado a um projeto. Normalmente, programas
que fazem parte de um determinado mdulo ou ambiente esto em um mesmo projeto.
A vinculao dos programas a um projeto feita por meio dos arquivos do tipo PRW. Na
verdade, um projeto pode ser constitudo de um ou mais arquivos deste tipo, que por sua vez,
podem ter uma ou mais funes, conforme ilustra o diagrama a seguir:
Figura: Representao da estrutura de um projeto no DEV-Studio
Compilao
Uma vez adicionado a um projeto e compilado sem incidncias de erros de cdigo, o objeto
resultante ser cadastrado no RPO (Repositrio de Objetos) e poder ser utilizado pela
aplicao ERP.
A compilao dos itens de um projeto pode ser realizada individualmente, por grupo de fontes
(pastas) ou ainda selecionando-o inteiramente. Cada uma dos fontes ser processado e
compilado separadamente, permitindo a visualizao do progresso da operao e das
mensagens de aviso (warnings) ou erros (critical errors) na guia Mensagens.
Execuo
Para que os objetos compilados e disponveis n RPO sejam utilizados, devem ser observadas as
seguintes regras:
Se o programa no manipula arquivos, pode-se cham-lo diretamente do DEV-Studio
(nome no lado direito da barra de ferramentas);
Se o programa manipula tabelas existem duas opes:
Adicionar o programa no menu de um dos ambientes e executa-lo atravs do
Remote.
Realizar a preparao do ambiente na prpria rotina, permitindo sua execuo
diretamente pelo DEV-Studio.
No se pode compilar um programa com o Remote e o Monitor abertos, tenha este
finalizado ou no por erro.
Anlise e depurao de erros
Para identificar as causas de erros, a ferramenta DEV-Studio possui diversos recursos que
auxiliam o DEBUG.
A ao de DEBUG necessita que o programa seja executado a partir do DEV-Studio, sendo
necessrio observar as seguintes regras:
Definir e marcar os pontos de parada mais adequados a anlise do fonte;
Executar a rotina atravs do DEV-Studio, selecionando seu nome diretamente, ou o
mdulo que contm a opo ou a ao que ir execut-la;
A partir do momento em que o DEV-Studio pausar o processamento em um dos pontos
de parada especificados previamente podem ser utilizadas as janelas de visualizao
disponveis no DEV-Studio, que so:
Variveis Locais
Variveis Privates
Variveis Publics
Variveis Statics
Janela da Watchs
Janela de Tabelas e Campos
Pilha de Chamadas
Atravs da Janela de Watchs possvel determinar quais variveis devem ser exibidas;
Na pilha de chamadas, verifica-se a seqncia de chamadas das funes;

Na pasta de Comandos, pode-se, enquanto o programa estiver pausado, escrever
qualquer comando e ao dar Enter, ele executado, permitindo pesquisar palavras e
expresses no prprio fonte ou em qualquer fonte armazenado no HD;
Ao parar pode-se ou continuar o programa at o prximo ponto de parada, caso haja
um outro definido, ou executar linha a linha da rotina.
Interface da aplicao
Por ser um ambiente integrado de desenvolvimento, o DEV-Studio proporciona todas essas
facilidades, por meio de interface nica como ilustra a figura a seguir:
Figura: Interface principal do TOTVS Development Studio

O DEV-Studio apresenta, no topo da tela, um conjunto de opes de menu e uma srie
de botes que facilitam a sua manipulao.
Na tela central, apresentado o cdigo das funes em ADVPL. Na parte inferior so
exibidas algumas pastas que facilitam a execuo de comandos, exibio de contedos
de variveis e mensagens, bem como dados sobre o projeto.
Desenvolvimento de pequenas customizaes

11.
Acesso e manipulao de bases de dados em ADVPL
Como a linguagem ADVPL utilizada no desenvolvimento de aplicao para o sistema ERP

Protheus, ela deve possuir recursos que permitam o acesso e a manipulao de informaes
independentemente da base de dados para o qual o sistema foi configurado.
Desta forma a linguagem possui dois grupos de funes distintos para atuar com os bancos de
dados:
Funes de manipulao de dados genricas
Funes de manipulao de dados especficas para ambientes TOPCONNECT /
DBACCESS
Funes de manipulao de dados genricas
As funes de manipulao de dados ditas como genricas permitem que uma aplicao ADVPL
seja escrita da mesma forma, independente se a base de dados configurada para o sistema
ERP for do tipo ISAM ou padro SQL.
Muitas destas funes foram inicialmente herdadas da linguagem CLIPPER, e mediante novas
implementaes da rea de Tecnologia da Microsiga foram melhoradas e adequadas s
necessidades do ERP. Por esta razo possvel encontrar em documentaes da linguagem
CLIPPER informaes sobre funes de manipulao de dados utilizadas na ferramenta ERP.
Dentre as melhorias implementadas pela rea de Tecnologia da Microsiga, podemos mencionar
o desenvolvimento de novas funes como por exemplo a funo MsSeek() - verso da
Microsiga para a funo DbSeek(), e a integrao entre a sintaxe ADVPL convencional e a
ferramenta de acesso a bancos de dados no padro SQL TOPCONNECT (DbAcess).
A integrao entre a aplicao ERP e a ferramenta TOPCONNECT permite que as funes de
acesso e manipulao de dados escritas em ADVPL sejam interpretadas e convertidas para
uma sintaxe compatvel com o padro SQL ANSI e desta forma aplicadas aos SGDBs (Sistemas
Gerenciadores de Bancos de Dados) com sua sintaxe nativa.
Funes de manipulao de dados para ambientes TOPCONNECT / DBACCESS
Para implementar um acesso mais otimizado e disponibilizar no ambiente ERP funcionalidades
que utilizem de forma mais adequada os recursos dos SGDBs homologados para o sistema,
foram implementadas funes de acesso e manipulao de dados especficas para ambientes
TOPCONNECT/DBACCESS.
Estas funes permitem que o desenvolvedor ADVPL execute comandos em sintaxe SQL
diretamente de um cdigo fonte da aplicao, disponibilizando recursos como execuo de
queries de consulta, chamadas de procedures e comunicao com outros bancos de dados
atravs de ODBCs.
As funes especficas para ambientes TOPCONNECT sero abordas no

material de ADVPL Avanado.
11.1.
Diferenas e compatibilizaes entre bases de dados
Como a aplicao ERP pode ser configurada para utilizar diferentes tipos de bases de dados
importante mencionar as principais diferenas entre estes recursos, o que pode determinar a
forma como o desenvolvedor ir optar por escrever sua aplicao.
Acesso a dados e ndices
No acesso a informaes em bases de dados do padro ISAM so sempre lidos os registros
inteiros, enquanto no SQL pode-se ler apenas os campos necessrios naquele processamento.
O acesso direto feito atravs de ndices que so tabelas paralelas s tabelas de dados e que
contm a chave e o endereo do registro, de forma anloga ao ndice de um livro. Para cada
chave, criado um ndice prprio.
Nas bases de dados padro ISAM os ndices so armazenados em um nico arquivo do tipo
CDX, j nos bancos de dados padro SQL cada ndice criado com uma numerao seqencial
tendo como base o nome da tabela ao qual ele est relacionado.
A cada incluso ou alterao de um registro todos os ndices so atualizados, tornando
necessrio planejar adequadamente quais e quantos ndices sero definidos para uma tabela,
pois uma quantidade excessiva pode comprometer o desempenho destas operaes.
Deve ser considerada a possibilidade de utilizao de ndices temporrios para processos
especficos, os quais sero criados em tempo de execuo da rotina. Este fator deve levar em
considerao o esforo do ambiente a cada execuo da rotina e a periodicidade com a qual
executada.
Estrutura dos registros (informaes)
Nas bases de dados padro ISAM, cada registro possui um identificador nativo ou ID
seqencial e ascendente que funciona como o endereo base daquela informao.
Este ID, mas conhecido como RECNO ou RECNUMBER gerado no momento de incluso do
registro na tabela e somente ser alterado caso a estrutura dos dados desta tabela sofra
alguma manuteno. Dentre as manutenes que uma tabela de dados ISAM pode sofrer
pode-se citar a utilizao do comando PACK, o qual ir apagar fisicamente os registros
deletados da tabela forando uma renumerao dos identificadores de todos os registros. Esta
situao tambm torna necessria a recriao de todos os ndices vinculados quela tabela.
Isto ocorre nas bases de dados ISAM devido ao conceito de excluso lgica de registros que as
mesmas possuem. J os bancos de dados padro SQL nativamente utilizam apenas o conceito
de excluso fsica de registros, o que para outras aplicaes seria transparente, mas no o
caso do ERP Protheus.
Para manter a compatibilidade das aplicaes desenvolvidas para bases de dados padro
ISAM, a rea de Tecnologia e Banco de Dados da Microsiga implementou nos bancos de dados
padro SQL o conceito de excluso lgica de registros existente nas bases de dados ISAM
atravs da criao de campos de controle especficos: R_E_C_N_O_, D_E_L_E_T_ e
R_E_C_D_E_L.
Estes campos permitem que a aplicao ERP gerencie as informaes do banco de dados da
mesma forma que as informaes em bases de dados ISAM.
Com isso o campo R_E_C_N_O_ ser um identificador nico do registro dentro da tabela,
funcionando como o ID ou RECNUMBER de uma tabela ISAM, mas utilizando um recurso
adicional disponvel nos bancos de dados relacionais conhecido com Chave Primria.
Para a aplicao ERP Protheus o campo de controle R_E_C_N_O_ definido em todas as
tabelas como sendo sua chave primria, o que transfere o controle de sua numerao
seqencial ao banco de dados.
O campo D_E_L_E_T_ tratado internamente pela aplicao ERP como um flag ou marca de
excluso. Desta forma os registros que estiverem com este campo marcado sero
considerados como excludos logicamente. A execuo do comando PACK em uma tabela de
um banco de dados padro SQL visa excluir fisicamente os registros com o campo D_E_L_E_T_
marcado, mas no causar o efeito de renumerao de RECNO (no caso R_E_C_N_O_) que
ocorre nas tabela de bases de dados ISAM.
11.2.
Funes de acesso e manipulao de dados
As funes de acesso e manipulao de dados descritas neste tpico so as classificadas

anteriormente como funes genricas da linguagem ADVPL, permitindo que as mesmas sejam
utilizadas independentemente da base de dados para a qual a aplicao ERP est configurada.
As funes de acesso e manipulao de dados definem basicamente:
Tabela que est sendo tratada;
Campos que devero ser lidos ou atualizados;
Mtodo de acesso direto as informaes (registros e campos).
Dentre as funes ADVPL disponveis para acesso e manipulao de informaes, este material
ir detalhar as seguintes opes:
SELECT()
DBSELECTAREA()
DBSETORDER()
DBSEEK() E MSSEEK()
DBSKIP()
DBGOTO()
DBGOTOP()
DBGOBOTTON()
DBSETFILTER()
RECLOCK()
SOFTLOCK()
MSUNLOCK()
DBDELETE()
DBUSEAREA()
DBCLOSEAREA()
DBRLOCK()
Sintaxe
Descrio
DBRLOCK(xIdentificador)
Funo de base de dados, que efetua o lock (travamento) do registro
identificado pelo parmetro xIdentificador. Este parmetro pode ser o
Recno() para tabelas em formado ISAM, ou a chave primria para bancos de
dados relacionais.
Se o parmetro xIdentificador no for especificado, todos os locks da rea de
trabalho sero liberados, e o registro posicionado ser travado e adicionado
em uma lista de registros bloqueados.
DBCLOSEAREA()
Sintaxe
DbCloseArea()
Descrio
Permite que um alias presente na conexo seja fechado, o que viabiliza seu
reuso em outro operao. Este comando tem efeito apenas no alias ativo na
conexo, sendo necessria sua utilizao em conjunto com o comando
DbSelectArea().
DBCOMMIT()
Sintaxe
DBCOMMIT()
Descrio
Efetua todas as atualizaes pendentes na rea de trabalho ativa.
DBCOMMITALL()
Sintaxe
DBCOMMITALL()
Descrio
Efetua todas as atualizaes pendentes em todas as rea de trabalho em uso

pela thread (conexo) ativa.
DBDELETE()
Sintaxe
DbDelete()
Descrio
Efetua a excluso lgica do registro posicionado na rea de trabalho ativa,

sendo necessria sua utilizao em conjunto com as funes RecLock() e
MsUnLock().
DBGOTO()
Sintaxe
DbGoto(nRecno)
Descrio
Move o cursor da rea de trabalho ativa para o record number (recno)

especificado, realizando um posicionamento direto, sem a necessidade uma
busca (seek) prvio.
DBGOTOP()
Sintaxe
DbGoTop()
Descrio
Move o cursor da rea de trabalho ativa para o primeiro registro lgico.
DBGOBOTTON()
Sintaxe
DbGoBotton()
Descrio
Move o cursor da rea de trabalho ativa para o ltimo registro lgico.
DBRLOCKLIST()
Sintaxe
DBRLOCKLIST()
Descrio
Retorna um array contendo o record number (recno) de todos os registros

travados da rea de trabalho ativa.
DBSEEK() E MSSEEK()
Sintaxe
Descrio
DbSeek(cChave, lSoftSeek, lLast)

DbSeek: Permite posicionar o cursor da rea de trabalho ativo no registro
com as informaes especificadas na chave de busca, fornecendo um retorno
lgico indicando se o posicionamento foi efetuado com sucesso, ou seja, se a
informao especificada na chave de busca foi localizada na rea de
trabalho.
MsSeek(): Funo desenvolvida pela rea de Tecnologia da Microsiga, a
qual possui as mesmas funcionalidades bsicas da funo DbSeek(), com a
vantagem de no necessitar acessar novamente a base de dados para
localizar uma informao j utilizada pela thread (conexo) ativa.
DBSKIP()
Sintaxe
DbSkip(nRegistros)
Descrio
Move o cursor do registro posicionado para o prximo (ou anterior

dependendo do parmetro), em funo da ordem ativa para a rea de
trabalho.
DBSELECTAREA()
Sintaxe
DbSelectArea(nArea | cArea)
Descrio
Define a rea de trabalho especificada com sendo a rea ativa. Todas as

operaes subseqentes que fizerem referncia a uma rea de trabalho a
utilizao, a menos que a rea desejada seja informada explicitamente.
DBSETFILTER()
Sintaxe
DbSetFilter(bCondicao, cCondicao)
Descrio
Define um filtro para a rea de trabalho ativa, o qual pode ser descrito na
forma de um bloco de cdigo ou atravs de uma expresso simples.
DBSETORDER()
Sintaxe
DbSetOrder(nOrdem)
Descrio
Define qual ndice ser utilizada pela rea de trabalho ativa, ou seja, pela
rea previamente selecionada atravs do comando DbSelectArea(). As
ordens disponveis no ambiente Protheus so aquelas definidas no SINDEX
/SIX, ou as ordens disponibilizadas por meio de ndices temporrios.
DBORDERNICKNAME()
Sintaxe
DbOrderNickName(NickName)
Descrio
Define qual ndice criado pelo usurio seja utilizado. O usurio pode incluir os
seus prprios ndices e no momento da incluso deve criar o NICKNAME para
o mesmo.
DBUNLOCK()
Sintaxe
Descrio
DBUNLOCK()
Mesma funcionalidade da funo UNLOCK(), s que recomendada para
ambientes de rede nos quais os arquivos so compartilhados.
Libera o travamento do registro posicionado na rea de trabalho ativa e
confirma as atualizaes efetuadas naquele registro.
DBUNLOCKALL()
Sintaxe
DBUNLOCKALL()
Descrio
Libera o travamento de todos os registros de todas as reas de trabalho

disponveis na thread (conexo) ativa.
DBUSEAREA()
Sintaxe
Descrio
DbUseArea(lNovo,
cDriver,
cArquivo,
cAlias,
lComparilhado,;
lSoLeitura)
Define um arquivo de base de dados como uma rea de trabalho disponvel
na aplicao.
MSUNLOCK()
Sintaxe
MsUnLock()
Descrio
Libera o travamento (lock) do registro

atualizaes efetuadas neste registro.
posicionado
confirmando
as
RECLOCK()
Sintaxe
RecLock(cAlias,lInclui)
Descrio
Efetua o travamento do registro posicionado na rea de trabalho ativa,

permitindo a incluso ou alterao das informaes do mesmo.
RLOCK()
Sintaxe
RLOCK() lSucesso
Descrio
Efetua o travamento do registro posicionado na rea de trabalho ativa.
SELECT()
Sintaxe
Descrio
Select(cArea)
Determina o nmero de referncia de um determinado alias em um
ambiente de trabalho. Caso o alias especificado no esteja em uso no
ambiente, ser retornado o valor 0 (zero).
SOFTLOCK()
Sintaxe
SoftLock(cAlias)
Permite a reserva do registro posicionado na rea de trabalho ativa de forma
que outras operaes, com exceo da atual, no possam atualizar este
registro. Difere da funo RecLock() pois no gera uma obrigao de
atualizao, e pode ser sucedido por ele.
Descrio
Na aplicao ERP Protheus, o SoftLock() utilizado nos browses, antes da

confirmao da operao de alterao e excluso, pois neste momento a
mesma ainda no foi efetivada, mas outras conexes no podem acessar
aquele registro pois o mesmo est em manuteno, o que implementa da
integridade da informao.
UNLOCK()
Sintaxe
UNLOCK()
Descrio
Libera o travamento do registro posicionado na rea de trabalho ativa e

confirma as atualizaes efetuadas naquele registro.
11.3.
Diferenciao entre variveis e nomes de campos
Muitas vezes uma varivel pode ter o mesmo nome que um campo de um arquivo ou de uma
tabela aberta no momento. Neste caso, o ADVPL privilegiar o campo, de forma que uma
referncia a um nome que identifique tanto uma varivel como um campo, resultar no
contedo do campo.
Para especificar qual deve ser o elemento referenciado, deve-se utilizar o operador de
identificao de apelido (->) e um dos dois identificadores de referncia, MEMVAR ou FIELD.
cRes := MEMVAR->NOME
Esta linha de comando identifica que o valor atribudo varivel cRes deve ser o valor da
varivel de memria chamada NOME.
cRes := FIELD->NOME
Neste caso, o valor atribudo varivel cRes ser o valor do campo NOME existente no arquivo
ou tabela aberto na rea atual.
O identificador FIELD pode ser substitudo pelo apelido de um arquivo ou tabela aberto, para
evitar a necessidade de selecionar a rea antes de acessar o contedo de terminado campo.
cRes := CLIENTES->NOME
As tabelas de dados utilizadas pela aplicao ERP recebem automaticamente do sistema o
apelido ou ALIAS especificado para as mesmas no arquivo de sistema SX2. Assim se o campo
NOME pertence a uma tabela da aplicao PROTHEUS, o mesmo poder ser referenciado com a
indicao do ALIAS pr-definido desta tabela.
cRes := SA1->NOME // SA1 Cadastro de Clientes
Para maiores detalhes sobre abertura de arquivos com atribuio de apelidos,

consulte a documentao sobre acesso a banco de dados ou a documentao
da funo dbUseArea().
Os alias das tabelas da aplicao ERP so padronizados em trs letras, que
correspondem as iniciais da tabela. As configuraes de cada ALIAS utilizado
pelo sistema podem ser visualizadas atravs do mdulo Configurador ->
Bases de Dados -> Dicionrios -> Bases de Dados.
11.4.
Controle de numerao seqencial
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 identificador
das informaes das tabelas. preciso ter um controle do fornecimento desses nmeros, em
especial quando vrios usurios esto trabalhando simultaneamente.
Os campos que recebem o tratamento de numerao seqencial pela
aplicao ERP no devem ser considerados como chave primria das tabelas
aos quais esto vinculados.
No caso especfico da aplicao ERP Protheus a chave primria em ambientes
TOPCONNECT ser o campo R_E_C_N_O_, e para bases de dados padro
ISAM o conceito de chave primria implementado pela regra de negcio do
sistema, pois este padro de dados no possui o conceito de unicidade de
dados.
Semforos
Para definir o conceito do que um semforo de numerao deve-se avaliar a seguinte
seqncia de eventos no sistema:
Ao ser fornecido um nmero, ele permanece reservado at a concluso da operao
que o solicitou;
Se esta operao for confirmada, o nmero indisponibilizado, mas se a operao for
cancelada, o nmero voltar a ser disponvel mesmo que naquele momento nmeros
maiores j tenham sido oferecidos e utilizados.
Com isso, mesmo que tenhamos vrios processos solicitando numeraes seqenciais para
uma mesma tabela, como por exemplo incluses simultneas de pedidos de vendas, teremos
para cada pedido um nmero exclusivos e sem o intervalos e numeraes no utilizadas.
Funes de controle de semforos e numerao seqencial
A linguagem ADVPL permite a utilizao das seguintes funes para o controle das numeraes
seqenciais utilizadas nas tabelas da aplicao ERP:
GETSXENUM()
CONFIRMSXE()
ROLLBACKSXE()
GETSXENUM()
Sintaxe
GETSXENUM(cAlias, cCampo, cAliasSXE, nOrdem)
Descrio
Obtm o nmero seqncia do alias especificado no parmetro, atravs da

referncia aos arquivos de sistema SXE/SXF ou ao servidor de numerao,
quando esta configurao est habilitada no ambiente Protheus.
CONFIRMSXE()
Sintaxe
CONFIRMSXE(lVerifica)
Descrio
Confirma o nmero alocado atravs do ltimo comando GETSXENUM().
ROLLBACKSXE()
Sintaxe
ROLLBACKSXE()
Descrio
Descarta o nmero fornecido pelo ltimo comando GETSXENUM(),

retornando a numerao disponvel para outras conexes.
12.
Customizaes para a aplicao ERP
Neste tpico sero abordas as formas pelas quais a aplicao ERP Protheus pode ser
customizada com a utilizao da linguagem ADVPL.
Pelos recursos de configurao da aplicao ERP disponveis no mdulo Configurador possvel
implementar as seguintes customizaes:
Validaes de campos e perguntas do sistema e de usurios

Incluso de gatilhos em campos de sistemas e de usurios
Incluso de regras em parmetros de sistemas e de usurios
Desenvolvimento de pontos de entrada para interagir com funes padres do sistema
12.1.
Customizao de campos Dicionrio de Dados
12.1.1.
Validaes de campos e perguntas
As funes de validao tm como caracterstica fundamental um retorno do tipo lgico, ou

seja, um contedo .T. Verdadeiro ou .F. Falso.
Com base nesta premissa, a utilizao de validaes no Dicionrio de Dados (SX3) ou nas
Perguntas de Processos e Relatrios (SX1) dever focar sempre na utilizao de funes ou
expresses que resultem em um retorno lgico.
Atravs do mdulo Configurador possvel alterar as propriedades de um campo ou de uma
pergunta de forma a incluir regras de validao para as seguintes situaes:
SX3 Validao de usurio (X3_VLDUSER)
SX1 Validao da pergunta (X1_VALID)
Dentre as funes que a linguagem ADVPL em conjunto com os recursos desenvolvidos pela
aplicao ERP para validao de campos e perguntas sero detalhadas:
VAZIO()
NAOVAZIO()
EXISTCPO()
EXISTCHAV()
PERTENCE()
POSITIVO()
NEGATIVO()
TEXTO()
EXISTCHAV()
Sintaxe
Descrio
ExistChav(cAlias, cConteudo, nIndice)

Retorna .T. ou .F. se o contedo especificado existe no alias especificado.
Caso exista ser exibido um help de sistema com um aviso informando da
ocorrncia.
Funo utilizada normalmente para verificar se um determinado cdigo de
cadastro j existe na tabela na qual a informao ser inserida, como por
exemplo o CNPJ no cadastro de clientes ou fornecedores.
EXISTCPO()
Sintaxe
Descrio
ExistCpo(cAlias, cConteudo, nIndice)

Retorna .T. ou .F. se o contedo especificado no existe no alias
especificado. Caso no exista ser exibido um help de sistema com um aviso
informando da ocorrncia.
Funo utilizada normalmente para verificar se a informao digitada em um
campo, a qual depende de outra tabela, realmente existe nesta outra tabela,
como por exemplo o cdigo de um cliente em um pedido de venda.
NAOVAZIO()
Sintaxe
NaoVazio()
Descrio
Retorna .T. ou .F. se o contedo do campo posicionado no momento no

est vazio.
NEGATIVO()
Sintaxe
Negativo()
Descrio
Retorna .T. ou .F. se o contedo digitado para o campo negativo.
PERTENCE()
Sintaxe
Pertence(cString)
Descrio
Retorna .T. ou .F. se o contedo digitado para o campo est contido na

string definida como parmetro da funo. Normalmente utilizada em
campos com a opo de combo, pois caso contrrio seria utilizada a funo
ExistCpo().
POSITIVO()
Sintaxe
Positivo()
Descrio
Retorna .T. ou .F. se o contedo digitado para o campo positivo.
TEXTO()
Sintaxe
Texto()
Descrio
Retorna .T. ou .F. se o contedo digitado para o campo contm apenas

nmeros ou alfanumricos.
VAZIO()
Sintaxe
Vazio()
Descrio
Retorna .T. ou .F. se o contedo do campo posicionado no momento est

vazio.
12.1.2.
Pictures de formao disponveis
Com base na documentao disponvel no DEM Documentao Eletrnica Microsiga, a

linguagem ADVPL e a aplicao ERP Protheus admitem as seguintes pictures:
Dicionrio de Dados (SX3) e GET
Funes
Contedo
A
C
E
R
S<n>
X
Z
(
)
!
Funcionalidade
Permite apenas caracteres alfabticos.
Exibe CR depois de nmeros positivos.
Exibe numrico com o ponto e vrgula invertidos (formato Europeu).
Insere caracteres diferentes dos caracteres de template na exibio, mas no os
insere na varivel do GET.
Permite rolamento horizontal do texto dentro do GET, <n> um nmero inteiro
que identifica o tamanho da regio.
Exibe DB depois de nmeros negativos.
Exibe zeros como brancos.
Exibe nmeros negativos entre parnteses com os espaos em branco iniciais.
Exibe nmeros negativos entre parnteses sem os espaos em branco iniciais.
Converte caracteres alfabticos para maisculo.
Templates
Contedo Funcionalidade
X
Permite qualquer caractere.
9
Permite apenas dgitos para qualquer tipo de dado, incluindo o sinal para
numricos.
#
Permite dgitos, sinais e espaos em branco para qualquer tipo de dado.
!
*
Exibe um asterisco no lugar dos espaos em branco iniciais em nmeros.
.
Exibe o ponto decimal.
,
Exibe a posio do milhar.
Exemplo 01 Picture campo numrico
CT2_VALOR Numrico 17,2
Picture: @E 99,999,999,999,999.99
Exemplo 02 Picture campo texto, com digitao apenas em caixa alta

A1_NOME Caracter - 40
Picture: @!
SAY e PSAY
Funes
Contedo
C
E
R
X
Z
(
!
Funcionalidade
Exibe CR depois de nmeros positivos
Exibe numrico com o ponto e a vrgula invertidos (formato Europeu)
Insere caracteres diferentes dos caracteres de template
Exibe DB depois de nmeros negativos
Exibe zeros como brancos
Envolve nmeros negativos entre parnteses
Converte todos os caracteres alfabticos para maisculo
Templates
Contedo
X
9
#
!
*
.
,
Funcionalidade
Exibe dgitos para qualquer tipo de dado
Converte caracteres alfabticos para maisculo
Exibe asterisco no lugar de espaos em branco inicias em nmeros
Exibe a posio do ponto decimal
Exibe a posio do milhar

Picture: @E 99,999,999,999,999.99
12.2.
Customizao de gatilhos Configurador
A aplicao ERP utiliza o recurso de gatilhos em campo com a finalidade de auxiliar o usurio
no preenchimento de informaes durante a digitao de informaes. As funes que podem
ser utilizadas no gatilho esto diretamente relacionadas a definio da expresso de retorno
que ser executada na avaliao do gatilho do campo.
As regras que devem ser observadas na montagem de um gatilho e configurao de seu
retorno so:
Na definio da chave de busca do gatilho deve ser avaliada qual filial dever ser
utilizada como parte da chave: a filial da tabela de origem do gatilho ou a filial da
tabela que ser consultada. O que normalmente determina a filial que ser utilizada
como parte da chave justamente a informao que ser consultada, aonde:
o
Consultas de informaes entre tabelas com estrutura de cabealho e itens

devem utilizar a filial da tabela de origem, pois ambas as tabelas devem possuir
o mesmo tratamento de filial (compartilhado ou exclusivo).
Exemplos:
Pedido de vendas -> SC5 x SC6
Nota fiscal de entrada -> SF1 x SD1
Ficha de imobilizado -> SN1 x SN3
Oramento contbil -> CV1 x CV2
Consulta de informaes de tabelas de cadastros devem utilizar a filial da tabela

a ser consultada, pois o compartilhamento dos cadastros normalmente
independente em relao s movimentaes e outros cadastros do sistema.
Exemplos:
Cadastro
Cadastro
Cadastro
Cadastro
de
de
de
de
clientes -> SA1 (compartilhado)

fornecedores -> SA2 (compartilhado)
vendedores -> SA3 (exclusivo)
transportadoras -> SA4 (exclusivo)
Consulta a informaes de tabelas de movimentos devem utilizar a filial da

tabela a ser consultada, pois apesar das movimentaes de um mdulo
seguirem um determinado padro, a consulta pode ser realizada entre tabelas
de mdulos distintos, o que poderia gerar um retorno incorreto baseado nas
diferentes parametrizaes destes ambientes.
Exemplos:
Contas a pagar -> SE2 (compartilhado)
Movimentos contbeis -> CT2 (exclusivo)
Pedidos de compras -> SC7 (compartilhado)
Itens da nota fiscal de entrada -> SD1 (exclusivo)
Na definio da regra de retorno deve ser considerado o tipo do campo que ser
atualizado, pois este campo que determina qual tipo do retorno ser considerado
vlido para o gatilho.
12.3.
Customizao de parmetros Configurador
Os parmetros de sistema utilizados pela aplicao ERP e definidos atravs do mdulo

configurador possuem as seguintes caractersticas fundamentais:
Tipo do parmetro: de forma similar a uma varivel, um parmetro ter um tipo de
contedo pr-definido em seu cadastro.
Esta informao utilizada pelas funes da aplicao ERP na interpretao do
contedo do parmetro e retorno desta informao a rotina que o consultou.
Interpretao do contedo do parmetro: diversos parmetros do sistema tm seu
contedo macro executado durante a execuo de uma rotina do ERP. Estes
parmetros macro executveis tem como nica caracterstica em comum seu tipo:
caractere, mas no existe nenhum identificador explicito que permite a fcil
visualizao de quais parmetros possuem um retorno simples e de quais parmetros
tero seu contedo macro executado para determinar o retorno real.
A nica forma eficaz de avaliar como um parmetro tratado (simples retorno ou
macro execuo) atravs do cdigo fonte da rotina, no qual dever ser avaliado como
tratado o retorno de uma destas funes:
GETMV()
SUPERGETMV()
GETNEWPAR()
o
o
o
Um retorno macro executado determinado atravs do uso do operador & ou de uma

das funes de execuo de blocos de cdigo em conjunto com uma das funes citadas
anteriormente.
12.3.1.
Funes para manipulao de parmetros
A aplicao ERP disponibiliza as seguintes funes para consulta e atualizao de parmetros:
GETMV()
SUPERGETMV()
GETNEWPAR()
PUTMV()
GETMV()
Sintaxe
GETMV(cParametro)
Descrio
Retorna o contedo do parmetro especificado no arquivo SX6, considerando

a filial parametrizada na conexo. Caso o parmetro no exista ser exibido
um help do sistema informando a ocorrncia.
GETNEWPAR()
Sintaxe
GETNEWPAR(cParametro, cPadrao, cFilial)
Descrio

Difere do SuperGetMV() pois considera que o parmetro pode no existir na
verso atual do sistema, e por conseqncia no ser exibida a mensagem
de help.
PUTMV()
Sintaxe
PUTMV(cParametro, cConteudo)
Descrio
Atualiza o contedo do parmetro especificado no arquivo SX6, de acordo

com as parametrizaes informadas.
SUPERGETMV()
Sintaxe
SUPERGETMV(cParametro , lHelp , cPadrao , cFilial)
Descrio
12.3.2.

Difere do GetMv() pois os parmetros consultados so adicionados em uma
rea de memria, que permite que em uma nova consulta no seja
necessrio acessar e pesquisar o parmetro na base de dados.
Cuidados na utilizao de um parmetro
Um parmetro de sistema tem a finalidade de propiciar um retorno vlido a um contedo

previamente definido na configurao do mdulo para uma rotina, processo ou quaisquer
outros tipos de funcionalidades disponveis na aplicao.
Apesar de haver parmetros que permitam a configurao de expresses, e por conseqncia
a utilizao de funes para definir o retorno que ser obtido com a consulta deste parmetro,
expressamente proibido o uso de funes em parmetros para manipular
informaes da base de dados do sistema.
Caso haja a necessidade de ser implementado um tratamento adicional a um processo padro
do sistema, o mesmo dever utilizar o recurso de ponto de entrada.
A razo desta restrio simples:
As rotinas da aplicao ERP no protegem a consulta de contedos de parmetros
quanto a gravaes realizadas dentro ou fora de uma transao.
Desta forma, quaisquer alterao na base realizada por uma rotina configurada em um
parmetro pode ocasionar a perda da integridade das informaes do sistema.
12.4.
Pontos de Entrada Conceitos, Premissas e Regras
Conceitos
Um ponto de entrada uma User Function desenvolvida com a finalidade de interagir com uma
rotina padro da aplicao ERP.
A User Function dever ter um nome pr-estabelecido no desenvolvimento da rotina padro do
ERP, e de acordo esta pr-disposio e o momento no qual o ponto de entrada executado
durante um processamento, ele poder:
Complementar uma validao realizada pela aplicao;
Complementar as atualizaes realizadas pelo processamento em tabelas padres do
ERP;
Implementar a atualizao de tabelas especificas durante o processamento de uma
rotina padro do ERP;
Executar uma ao sem processos de atualizaes, mas que necessite utilizar as
informaes atuais do ambiente durante o processamento da rotina padro para
determinar as caractersticas do processo;
Substituir um processamento padro do sistema por uma regra especfica do cliente no
qual o mesmo ser implementado.
Premissas e Regras
Um ponto de entrada no deve ser utilizado para outras finalidades seno para as quais
o mesmo foi pr-definido, sob pena de causar a perda da integridade das informaes
da base de dados ou provocar eventos de erro durante a execuo da rotina padro.
Um ponto de entrada deve ser transparente para o processo padro, de forma que
todas as tabelas acessadas pelo ponto de entrada e que sejam utilizadas pela rotina
padro, devero ter sua situao imediatamente anterior execuo do ponto
restaurada ao trmino do mesmo, e para isto recomenda-se o uso das funes
GETAREA() e RESTAREA().
Como um ponto de entrada no executado da forma tradicional, ou seja, ele no
chamado como uma funo, ele no recebe parmetros. A aplicao ERP disponibiliza
uma varivel de sistema denominada PARAMIXB, a qual recebe os parmetros da
funo chamadora e os disponibiliza para serem utilizados pela rotina customizada.
A varivel PARAMIXB no possui um padro de definio nos cdigos fontes da
aplicao ERP, desta forma seu tipo pode variar deste um contedo simples (caractere,
numrico, lgico e etc.) a um tipo complexo como um array ou um objeto. Desta forma
necessrio sempre avaliar a documentao sobre o ponto bem como proteger a
funo customizada de tipos de PARAMIXB no tratados por ela.
13.
Interfaces visuais
A linguagem ADVPL possui duas formas distintas para definio de interfaces visuais no
ambiente ERP: sintaxe convencional, nos padres da linguagem CLIPPER e a sintaxe orientada
a objetos.
Alm das diferentes sintaxes disponveis para definio das interfaces visuais o ERP Protheus
possui funcionalidades pr-definidas, as quais j contm todos os tratamentos necessrios a
atender as necessidades bsicas de acesso e manuteno das informaes do sistema.
Neste tpico sero abordadas as sintaxes convencionais para definio das interfaces visuais
da linguagem ADVPL e as interfaces de manuteno disponveis no ambiente ERP Protheus.
13.1.
Sintaxe e componentes das interfaces visuais
A sintaxe convencional para definio de componentes visuais da linguagem ADVPL depende

diretamente no include especificado no cabealho do fonte. Os dois includes disponveis para o
ambiente ADVPL Protheus so:
RWMAKE.CH: permite a utilizao da sintaxe CLIPPER na definio dos componentes
visuais.
PROTHEUS.CH: permite a utilizao da sintaxe ADVPL convencional, a qual um
aprimoramento da sintaxe CLIPPER, com a incluso de novos atributos para os
componentes visuais disponibilizados no ERP Protheus.
Para ilustrar a diferena na utilizao destes dois includes, segue abaixo as diferentes
definies para o componentes Dialog e MsDialog:
Exemplo 01 Include Rwmake.ch
#include rwmake.ch
@ 0,0 TO 400,600 DIALOG oDlg TITLE "Janela em sintaxe Clipper"
ACTIVATE DIALOG oDlg CENTERED
Exemplo 02 Include Protheus.ch

DEFINE MSDIALOG oDlg TITLE "Janela em sintaxe ADVPL "FROM 000,000 TO 400,600 PIXEL
ACTIVATE MSDIALOG oDlg CENTERED
Ambas as sintaxes produziro o mesmo efeito quando compiladas e

executadas no ambiente Protheus, mas deve ser utilizada sempre a sintaxe
ADVPL atravs do uso do include PROTHEUS.CH
Os componentes da interface visual que sero tratados neste tpico, utilizando a sintaxe
ADVPL so:
MSDIALOG()
MSGET()
SAY()
BUTTON()
SBUTTON()
BUTTON()
Sintaxe
Descrio
@ nLinha,nColuna BUTTON cTexto SIZE nLargura,nAltura UNIDADE

OF oObjetoRef ACTION AO
Define o componente visual Button, o qual permite a incluso de botes de
operao na tela da interface, os quais sero visualizados somente com um
texto simples para sua identificao.
MSDIALOG()
Sintaxe
Descrio
DEFINE MSDIALOG oObjetoDLG TITLE cTitulo FROM nLinIni,nColIni

TO nLiFim,nColFim OF oObjetoRef UNIDADE
Define o componente MSDIALOG(), o qual utilizado como base para os
demais componentes da interface visual, pois um componente MSDIALOG()
uma janela da aplicao.
MSGET()
Sintaxe
Descrio
@ nLinha, nColuna MSGET VARIAVEL SIZE nLargura,nAltura

UNIDADE OF oObjetoRef F3 cF3 VALID VALID WHEN WHEN PICTURE
cPicture
Define o componente visual MSGET, o qual utilizado para captura de
informaes digitveis na tela da interface.
SAY()
Sintaxe
Descrio
@ nLinha, nColuna SAY cTexto SIZE nLargura,nAltura UNIDADE OF

oObjetoRef
Define o componente visual SAY, o qual utilizado para exibio de textos
em uma tela de interface.
SBUTTON()
Sintaxe
Descrio
DEFINE SBUTTON FROM nLinha, nColuna TYPE N ACTION AO

STATUS OF oObjetoRet
Define o componente visual SButton, o qual permite a incluso de botes de
operao na tela da interface, os quais sero visualizados dependendo da
interface do sistema ERP utilizada somente com um texto simples para sua
identificao, ou com uma imagem (BitMap) pr-definido.
Interface visual completa

Abaixo segue um cdigo completo de interface, utilizado todos os elementos da interface visual
descritos anteriormente:
DEFINE MSDIALOG oDlg TITLE cTitulo FROM 000,000 TO 080,300 PIXEL

@ 001,001 TO 040, 150 OF oDlg PIXEL
@ 010,010 SAY
cTexto SIZE 55, 07 OF oDlg PIXEL
@ 010,050 MSGET cCGC

VALID !Vazio()
SIZE 55, 11 OF oDlg PIXEL PICTURE "@R 99.999.999/9999-99";
DEFINE SBUTTON FROM 010, 120 TYPE 1 ACTION (nOpca := 1,oDlg:End());

ENABLE OF oDlg
DEFINE SBUTTON FROM 020, 120 TYPE 2 ACTION (nOpca := 2,oDlg:End());
ENABLE OF oDlg
O cdigo demonstrado anteriormente utilizados nos exerccios de fixao

deste material e dever produzir a seguinte interface:
13.2.
Interfaces padres para atualizaes de dados
Os programas de atualizao de cadastros e digitao de movimentos seguem um padro que

se apia no Dicionrio de Dados.
Basicamente so duas as interfaces quer permitem a visualizao das informaes e a
manipulao dos dados do sistema.
AxCadastro
Mbrowse
Ambos os modelos utilizam como premissa que a estrutura da tabela a ser utilizada esteja
definida no dicionrio de dados do sistema (SX3).
13.2.1.
AxCadastro()
O AxCadastro() uma funcionalidade de cadastro simples, com poucas opes de

customizao, a qual composta de:
Browse padro para visualizao das informaes da base de dados, de acordo com as
configuraes do SX3 Dicionrio de Dados (campo browse).
Funes de pesquisa, visualizao, incluso, alterao e excluso padres para

visualizao de registros simples, sem a opo de cabealho e itens.
Sintaxe: AxCadastro(cAlias, cTitulo, cVldExc, cVldAlt)
Parmetros
cAlias
Alias padro do sistema para utilizao, o qual deve estar definido no

dicionrio de dados SX3.
cTitulo
Ttulo da Janela
cVldExc
Validao para Excluso
cVldAlt
Validao para Alterao
Exemplo:
#include "protheus.ch"
User Function XCadSA2()
Local
Local
Local
Local
cAlias := "SA2"
cTitulo := "Cadastro de Fornecedores"
cVldExc := ".T."
cVldAlt := ".T."
dbSelectArea(cAlias)
dbSetOrder(1)
AxCadastro(cAlias,cTitulo,cVldExc,cVldAlt)
Return
13.2.2.
MBrowse()
A Mbrowse() uma funcionalidade de cadastro que permite a utilizao de recursos mais

aprimorados na visualizao e manipulao das informaes do sistema, possuindo os
seguintes componentes:
Parametrizao para funes especficas para as aes de visualizao, incluso,

alterao e excluso de informaes, o que viabiliza a manuteno de informaes com
estrutura de cabealhos e itens.
Recursos adicionais como identificadores de status de registros, legendas e filtros para

as informaes.
Sintaxe simplificada: MBrowse(nLin1, nCol1, nLin2, nCol2, cAlias)
Parmetros
nLin1, nCol1,
nLin2, nCol2
cAlias
Coordenadas dos cantos aonde o browse ser exibido. Para seguir o

padro da AXCADASTRO() use 6,1,22,75 .
Variveis private adicionais

Array contendo as funes que sero executadas pela Mbrowse.
Este array pode ser parametrizados com as funes bsicas da
AxCadastro conforme abaixo:
aRotina
cCadastro
AADD(aRotina,{"Pesquisar" ,"AxPesqui",0,1})
AADD(aRotina,{"Visualizar" ,"AxVisual",0,2})
AADD(aRotina,{"Incluir"
,"AxInclui" ,0,3})
AADD(aRotina,{"Alterar"
,"AxAltera",0,4})
AADD(aRotina,{"Excluir"
,"AxDeleta",0,5})
Ttulo do browse que ser exibido.
Exemplo:
User Function MBrwSA2()
Local cAlias := "SA2"
Private cCadastro := "Cadastro de Fornecedores"
Private aRotina
:= {}
,"AxInclui",0,3})
,"AxAltera",0,4})
,"AxDeleta",0,5})
dbSetOrder(1)
mBrowse(6,1,22,75,cAlias)
Return
1. Utilizando a parametrizao exemplificada, o efeito obtido com o uso

da Mbrowse() ser o mesmo obtido com o uso da AxCadastro().
2. A posio das funes no array aRotina define o contedo de uma
varivel de controle que ser repassada para as funes chamadas a
partir da Mbrowse, convencionada como nOpc. Desta forma, para
manter o padro da aplicao ERP a ordem a ser seguida na definio
do aRotina ;
1
2
3
4
5
6
Pesquisar
Visualizar
Incluir
Alterar
Excluir
Livre
Ao definir as funes no array aRotina, se o nome da funo no for

especificado com (), a Mbrowse passar como parmetros as seguintes
variveis de controle:
cAlias: Alias ativo definido para a Mbrowse

nRecno: Record number (recno) do registro posicionado no alias
ativo.
nOpc: Posio da opo utilizada na Mbrowse de acordo com a ordem
da funo no array a Rotina.
Exemplo: Funo BInclui() substituindo a funo AxInclui()

Private cCadastro := "Cadastro de Fornecedores"
Private aRotina
:= {}
AADD(aRotina,{"Pesquisar" ,"AxPesqui"
,0,1})
AADD(aRotina,{"Visualizar" ,"AxVisual"
,0,2})
,"U_BInclui" ,0,3})
,"AxAltera"
,0,4})
,"AxDeleta"
,0,5})
dbSetOrder(1)
Return
USER FUNCTION BInclui(cAlias, nReg, nOpc)
Local cTudoOk := "(Alert('OK'),.T.)"
AxInclui(cAlias,nReg,nOpc,,,,cTudoOk)
RETURN
13.2.3.
AxFunctions()
Conforme mencionado nos tpicos sobre as interfaces padres AxCadastro() e Mbrowse(),

existem funes padres da aplicao ERP que permitem a visualizao, incluso, alterao e
excluso de dados em formato simples.
Estas funes so padres na definio da interface AxCadastro() e podem ser utilizadas
tambm da construo no array aRotina utilizado pela Mbrowse(), as quais esto listadas a
seguir:
AXPESQUI()
AXVISUAL()
AXINCLUI()
AXALTERA()
AXDELETA()
AXALTERA()
Sintaxe
Descrio
AxAltera(cAlias, nReg, nOpc, aAcho, cFunc, aCpos, cTudoOk, lF3,;

cTransact, aButtons, aParam, aAuto, lVirtual, lMaximized)
Funo de alterao padro das informaes de um registro, no formato
Enchoice, conforme demonstrado no tpico sobre a interface AxCadastro().
AXDELETA()
Sintaxe
Descrio
AXDELETA(cAlias, nReg, nOpc, cTransact, aCpos, aButtons, aParam,;

aAuto, lMaximized)
Funo de excluso padro das informaes de um registro, no formato
AXINCLUI()
Sintaxe
Descrio
AxInclui(cAlias, nReg, nOpc, aAcho, cFunc, aCpos, cTudoOk, lF3,;

Funo de incluso padro das informaes de um registro, no formato
AXPESQUI()
Sintaxe
AXPESQUI()
Descrio
Funo de pesquisa padro em registros exibidos pelos browses do sistema,

a qual posiciona o browse no registro pesquisado. Exibe uma tela que
permite a seleo do ndice a ser utilizado na pesquisa e a digitao das
informaes que compe a chave de busca.
AXVISUAL()
Sintaxe
Descrio
AXVISUAL(cAlias, nReg, nOpc, aAcho, nColMens, cMensagem, cFunc,;

aButtons, lMaximized )
Funo de visualizao padro das informaes de um registro, no formato
APNDICES
BOAS PRTICAS DE PROGRAMAO
14.
Utilizao de Identao
obrigatria a utilizao da identao, pois torna o cdigo muito mais legvel. Veja os
exemplos abaixo:
A utilizao da identao seguindo as estruturas de controle de fluxo (while, if, caso etc) torna
a compreenso do cdigo muito mais fcil:
Para identar o cdigo utilize a tecla <TAB> e na ferramenta DEV-Studio, a qual pode ser
configurada atravs da opo Preferncias:
15.
Capitulao de Palavras-Chave
Uma conveno amplamente utilizada a de capitular as palavras chaves, funes, variveis e

campos utilizando uma combinao de caracteres em maisculo e minsculo, visando facilitar
a leitura do cdigo fonte. O cdigo a seguir:
local ncnt while ( ncnt++ < 10 ) ntotal += ncnt * 2 enddo
Ficaria melhor com as palavras chaves e variveis capituladas:
Local nCnt While ( nCnt++ < 10 ) nTotal += nCnt * 2 EndDo
Para funes de manipulao de dados que comecem por db, a capitulao

s ser efetuada aps o db:
dbSeek()
dbSelectArea()
15.1.
Palavras em maisculo
A regra utilizar caracteres em maisculo para:

Constantes:
#define NUMLINES 60 #define NUMPAGES 1000
Variveis de memria:
M-> CT2_CRCONV M->CT2_MCONVER := CriaVar("CT2_CONVER")
Campos:
SC6->C6_NUMPED
Querys:
SELECT * FROM...
16.
Utilizao da Notao Hngara
A notao hngara consiste em adicionar os prefixos aos nomes de variveis, de modo a

facilmente se identificar seu tipo. Isto facilita na criao de cdigos-fonte extensos, pois
usando a Notao Hngara, voc no precisa ficar o tempo todo voltando definio de uma
varivel para se lembrar qual o tipo de dados que deve ser colocado nela. Variveis devem
ter um prefixo de Notao Hngara em minsculas, seguido de um nome que identifique a
funo da varivel, sendo que a inicial de cada palavra deve ser maiscula.
obrigatria a utilizao desta notao para nomear variveis.
Notao
a
b
c
d
l
n
o
x
Tipo de dado
Array
Bloco de cdigo
Caracter
Data
Lgico
Numrico
Objeto
Indefinido
Exemplo
aValores
bSeek
cNome
dDataBase
lContinua
nValor
oMainWindow
xConteudo
17.
Palavras reservadas
AADD
ABS
ASC
AT
BOF
BREAK
ENDIF
LTRIM
SPACE
CTOD
FILE
PCOUNT
TRANSFORM
DOW
IIF
CATCH
DTOS
ELSE
ELSEIF
EMPTY
ENDCASE
ENDDO
LOWER
SETPOS
COL
FIELDNAME
PCOL
TIME
DEVPOS
IF
RECNO
THROW
INKEY
INT
LASTREC
LEN
LOCK
LOG
SELECT
CMONTH
FCOUNT
MONTH
SUBSTR
DELETED
FUNCTION
RECCOUNT
UPPER
Palavras reservadas no
procedimentos ou funes;
REPLICATE
RLOCK
ROUND
ROW
RTRIM
SECONDS
CHR
EXP
MIN
STR
DAY
FOUND
PROW
TYPE
TRY
podem
ser
VAL
VALTYPE
WHILE
WORD
YEAR
CDOW
EOF
MAX
SQRT
DATE
FLOCK
PROCEDURE
TRIM
DTOC
AS
utilizadas
para
variveis,
Funes reservadas so pertencentes ao compilador e no podem ser

redefinidas por uma aplicao;
Todos os identificadores que comearem com dois ou mais caracteres
_ so utilizados como identificadores internos e so reservados.
Identificadores de escopo PRIVATE ou PUBLIC utilizados em aplicaes
especficas desenvolvida por ou para clientes devem ter sua
identificao iniciada por um caractere _.
LISTAS DE EXERCCIOS
Mdulo 01: Introduo programao
Aprimorar os seguintes algoritmos descritos na apostila:
01
Usar telefone pblico carto

Fritar um ovo
Mascar um chiclete
Trocar lmpadas
Descascar batatas
Jogar o Jogo da Forca
Montar os diagramas de blocos para os algoritmos desenvolvidos no exerccio

anterior:
02
Usar telefone pblico carto

Fritar um ovo
Mascar um chiclete
Trocar lmpadas
Descascar batatas
Jogar o Jogo da Forca
Mdulo 02: A linguagem ADVPL
01
02
03
Desenvolver um programa que implemente o algoritmo de descascar batatas,

utilizando a estrutura de repetio While, demonstrando quantas batatas
foram descascadas:

utilizando a estrutura de repetio FOR, demonstrando quantas batatas foram
descascadas:

utilizando a estrutura de repetio FOR, demonstrando quantas batatas faltam
para serem descascadas:
04
Desenvolver um programa que implemente o algoritmo do Jogo da Forca:
05
Desenvolver um programa que implemente o algoritmo do Jogo da Velha:
06
Desenvolver um programa que permita ao usurio pesquisar um cliente

informando seu CNPJ e caso o mesmo exista na base, exibir suas principais
informaes.
07
Utilizando a interface visual desenvolvida para o exerccio anterior,

desenvolver a funo genrica GetTexto(), para ser utilizada nas aplicaes do
Jogo da Velha e Jogo da Forca.
08
Utilizando a funo AVISO() desenvolver um programa que permita ao usurio

selecionar a opo de busca de CNPJ por cliente ou fornecedor, e caso
encontre exiba seus dados principais.
09
Desenvolver uma rotina que capture vrios CNPJs de clientes informados pelo
usurio, e verifique para cada um deles se o mesmo existe ou no na base de
dados. Ao final informar quais CNPJs foram informados, e de acordo com a
seleo do usurio, exibir os dados principais de um destes clientes.
10
Utilizando a funo FORMBATCH() desenvolver uma rotina que verifique se

para cada item de um nota fiscal de entrada existe o respectivo cabealho, e
caso seja encontrado algum item inconsistente, comunique esta ocorrncia ao
usurio que est realizando o processamento.
11
Desenvolver uma rotina que, atravs do uso de um bloco de cdigo, converta

a estrutura da tabela SA1 obtida com a funo DBSTRUCT() em uma string
denominada cCampo.
Mdulo 03: Desenvolvendo pequenas customizaes
01
Desenvolver uma validao para um campo especfico do tipo caractere, cujo

contedo esteja relacionado a outra tabela, e que exiba uma mensagem de
aviso caso o cdigo informado no exista nesta tabela relacionada.
02
Desenvolver uma validao para um campo caractere existente na base, para

que seja avaliado se aquele cdigo j existe cadastrado, e caso positivo exiba
uma mensagem de aviso alertando desta ocorrncia.
03
Desenvolver um gatilho que retorne uma descrio complementar para um

campo vinculado ao campo cdigo utilizado nos exerccios anteriores.
04
05
06
Customizar o parmetro que define o prefixo do ttulo de contas a pagar

gerado pela integrao COMPRAS -> FINANCEIRO atravs da incluso de uma
nota fiscal de entrada, de forma que o prefixo do ttulo seja gerado com o
cdigo da filial corrente.
Proteger a rotina desenvolvida no exerccio anterior, de forma a garantir que

na utilizao da filial como prefixo do ttulo no ir ocorrer duplicidade de
dados no contas a pagar do financeiro.
Implementar uma validao adicional no cadastro de clientes, atravs do

ponto de entrada adequado, de forma que o campo CNPJ (A1_CGC) seja
obrigatrio para todos os tipos de cliente, exceto os definidos como Exterior.
MDULO 04: Desenvolvendo aplicaes em ADVPL

18.
A linguagem ADVPL
A Linguagem ADVPL teve seu incio em 1994, sendo na verdade uma evoluo na utilizao de
linguagens no padro xBase pela Microsiga Software S.A. (Clipper, Visual Objects e depois
FiveWin). Com a criao da tecnologia Protheus, era necessrio criar uma linguagem que
suportasse o padro xBase para a manuteno de todo o cdigo existente do sistema de ERP
Siga Advanced. Foi ento criada a linguagem chamada Advanced Protheus Language.
O ADVPL uma extenso do padro xBase de comandos e funes, operadores, estruturas de
controle de fluxo e palavras reservadas, contando tambm com funes e comandos
disponibilizados pela Microsiga que a torna uma linguagem completa para a criao de
aplicaes ERP prontas para a Internet. Tambm uma linguagem orientada a objetos e
eventos, permitindo ao programador desenvolver aplicaes visuais e criar suas prprias
classes de objetos.
Quando compilados, todos os arquivos de cdigo tornam-se unidades de inteligncia bsicas,
chamados APOs (de Advanced Protheus Objects). Tais APOs so mantidos em um
repositrio e carregados dinamicamente pelo PROTHEUS Server para a execuo. Como no
existe a linkedio, ou unio fsica do cdigo compilado a um determinado mdulo ou
aplicao, funes criadas em ADVPL podem ser executadas em qualquer ponto do ambiente
Advanced Protheus.
O compilador e o interpretador da linguagem ADVPL o prprio servidor PROTHEUS
(PROTHEUS Server), e existe um ambiente visual para desenvolvimento integrado
(PROTHEUSIDE) onde o cdigo pode ser criado, compilado e depurado.
Os programas em ADVPL podem conter comandos ou funes de interface com o usurio. De
acordo com tal caracterstica, tais programas so subdivididos nas seguintes categorias:
Programao Com Interface Prpria com o Usurio
Nesta categoria entram os programas desenvolvidos para serem executados atravs do
terminal remoto do Protheus, o Protheus Remote. O Protheus Remote a aplicao
encarregada da interface e da interao com o usurio, sendo que todo o processamento do
cdigo em ADVPL, o acesso ao banco de dados e o gerenciamento de conexes efetuado no
Protheus Server. O Protheus Remote o principal meio de acesso a execuo de rotinas
escritas em ADVPL no Protheus Server, e por isso permite executar qualquer tipo de cdigo,
tenha ele interface com o usurio ou no. Porm nesta categoria so considerados apenas os
programas que realizem algum tipo de interface remota utilizando o protocolo de comunicao
do Protheus.
Podem-se criar rotinas para a customizao do sistema ERP Microsiga Protheus, desde
processos adicionais at mesmo relatrios. A grande vantagem aproveitar todo o ambiente
montado pelos mdulos do ERP Microsiga Protheus. Porm, com o ADVPL possvel at
mesmo criar toda uma aplicao, ou mdulo, do comeo.
Todo o cdigo do sistema ERP Microsiga Protheus escrito em ADVPL.
Programao Sem Interface Prpria com o Usurio

As rotinas criadas sem interface so consideradas nesta categoria porque geralmente tm uma
utilizao mais especfica do que um processo adicional ou um relatrio novo. Tais rotinas no
tm interface com o usurio atravs do Protheus Remote, e qualquer tentativa nesse sentido
(como a criao de uma janela padro) ocasionar uma exceo em tempo de execuo. Estas
rotinas so apenas processos, ou Jobs, executados no Protheus Server. Algumas vezes, a
interface destas rotinas fica a cargo de aplicaes externas, desenvolvidas em outras
linguagens, que so responsveis por iniciar os processos no servidor Protheus atravs dos
meios disponveis de integrao e conectividade no Protheus.
De acordo com a utilizao e com o meio de conectividade utilizado, estas rotinas so
subcategorizadas assim:
Programao por Processos
Rotinas escritas em ADVPL podem ser iniciadas como processos individuais (sem interface) no
Protheus Server atravs de duas maneiras: Iniciadas por outra rotina ADVPL atravs da
chamada de funes como StartJob() ou CallProc() ou iniciadas automaticamente na
inicializao do Protheus Server (quando propriamente configurado).
Programao de RPC
Atravs de uma biblioteca de funes disponvel no Protheus (uma API de comunicao),

podem-se executar rotinas escritas em ADVPL diretamente no Protheus Server, atravs de
aplicaes externas escritas em outras linguagens. Isto o que se chama de RPC (de Remote
Procedure Call, ou Chamada de Procedimentos Remota).
O servidor Protheus tambm pode executar rotinas em ADVPL em outros servidores Protheus
atravs de conexo TCP/IP direta utilizando o conceito de RPC. Do mesmo modo, aplicaes
externas podem requisitar a execuo de rotinas escritas em ADVPL atravs de conexo
TCP/IP direta.
Programao Web
Programao TelNet
19.
Estrutura de um Programa ADVPL
Um programa de computador nada mais do que um grupo de comandos logicamente

dispostos com o objetivo de executar determinada tarefa. Esses comandos so gravados em
um arquivo texto que transformado em uma linguagem executvel por um computador
atravs de um processo chamado compilao. A compilao substitui os comandos de alto
nvel (que os humanos compreendem) por instrues de baixo nvel (compreendida pelo
sistema operacional em execuo no computador). No caso do ADVPL, no o sistema
operacional de um computador que ir executar o cdigo compilado, mas sim o Protheus
Server.
Dentro de um programa, os comandos e funes utilizados devem seguir regras de sintaxe da
linguagem utilizada, pois caso contrrio o programa ser interrompido por erros. Os erros
podem ser de compilao ou de execuo.
Erros de compilao so aqueles encontrados na sintaxe que no permitem que o arquivo de
cdigo do programa seja compilado. Podem ser comandos especificados de forma errnea,
utilizao invlida de operadores, etc.
Erros de execuo so aqueles que acontecem depois da compilao, quando o programa est
sendo executado. Podem ocorrer por inmeras razes, mas geralmente se referem as funes
no existentes, ou variveis no criadas ou inicializadas, etc.
Linhas de Programa
As linhas existentes dentro de um arquivo texto de cdigo de programa podem ser linhas de
comando, linhas de comentrio ou linhas mistas.
Linhas de Comando
Linhas de comando possuem os comandos ou instrues que sero executadas. Por exemplo:
Local nCnt
Local nSoma := 0
For nCnt := 1 To 10
nSoma += nCnt
Next nCnt
Linhas de Comentrio
Linhas de comentrio possuem um texto qualquer, mas no so executadas. Servem apenas

para documentao e para tornar mais fcil o entendimento do programa. Existem trs formas
de se comentar linhas de texto. A primeira delas utilizar o sinal de * (asterisco) no comeo
da linha:
* Programa para clculo do total
* Autor: Microsiga Software S.A.
* Data: 2 de outubro de 2001
Todas as linhas iniciadas com um sinal de asterisco so consideradas como comentrio. Podese utilizar a palavra NOTE ou dois smbolos da letra "e" comercial (&&) para realizar a funo
do sinal de asterisco. Porm todas estas formas de comentrio de linhas so obsoletas e
existem apenas para compatibilizao com o padro xBase. A melhor maneira de comentar
linhas em ADVPL utilizar duas barras transversais:
// Programa para clculo do total
// Autor: Microsiga Software S.A.
// Data: 2 de outubro de 2001
Outra forma de documentar textos utilizar as barras transversais juntamente com o
asterisco, podendo-se comentar todo um bloco de texto sem precisar comentar linha a linha:
/*
Programa para clculo do total
Autor: Microsiga Software S.A.
Data: 2 de outubro de 2001
*/
Todo o texto encontrado entre a abertura (indicada pelos caracteres /*) e o fechamento
(indicada pelos caracteres */) considerado como comentrio.
Linhas Mistas
O ADVPL tambm permite que existam linhas de comando com comentrio. Isto possvel
adicionando-se as duas barras transversais (//) ao final da linha de comando e adicionando-se
o texto do comentrio:
Local nCnt
Local nSoma := 0 // Inicializa a varivel com zero para a soma
For nCnt := 1 To 10
nSoma += nCnt
Next nCnt
Tamanho da Linha
Assim como a linha fsica, delimitada pela quantidade de caracteres que pode ser digitado no
editor de textos utilizado, existe uma linha considerada linha lgica. A linha lgica, aquela
considerada para a compilao como uma nica linha de comando.
A princpio, cada linha digitada no arquivo texto diferenciada aps o pressionamento da tecla
<Enter>. Ou seja, a linha lgica, a linha fsica no arquivo. Porm algumas vezes, por
limitao fsica do editor de texto ou por esttica, pode-se "quebrar" a linha lgica em mais de
uma linha fsica no arquivo texto. Isto efetuado utilizando-se o sinal de ponto-e-vrgula (;).
If !Empty(cNome) .And. !Empty(cEnd) .And. ; <enter>
!Empty(cTel) .And. !Empty(cFax) .And. ; <enter>
!Empty(cEmail)
GravaDados(cNome,cEnd,cTel,cFax,cEmail)
Endif
Neste exemplo existe uma linha de comando para a checagem das variveis utilizadas. Como a
linha torna-se muito grande, pode-se dividi-la em mais de uma linha fsica utilizando o sinal de
ponto-e-vrgula. Se um sinal de ponto-e-vrgula for esquecido nas duas primeiras linhas,

durante a execuo do programa ocorrer um erro, pois a segunda linha fsica ser
considerada como uma segunda linha de comando na compilao. E durante a execuo esta
linha no ter sentido.
19.1. reas de um Programa ADVPL

Apesar de no ser uma linguagem de padres rgidos com relao estrutura do programa,
importante identificar algumas de suas partes. Considere o programa de exemplo abaixo:
/*
+===========================================+
|
| Autor
: Microsiga Software S.A.
|
| Data
: 02 de outubro de 2001
|
+===========================================+
*/
Local nCnt
Local nFator
nResultado *= nCnt
Next nCnt
Return
A estrutura de um programa ADVPL composta pelas seguintes reas:
rea de Identificao
Declarao dos includes
Declarao da funo
Identificao do programa
Declarao das variveis
Corpo do Programa
Preparao para o processamento
Processamento
rea de Encerramento
rea de Identificao
Esta uma rea que no obrigatria e dedicada a documentao do programa. Quando
existente, contm apenas comentrios explicando a sua finalidade, data de criao, autor, etc.,
e aparece no comeo do programa, antes de qualquer linha de comando.
O formato para esta rea no definido. Pode-se colocar qualquer tipo de informao
desejada e escolher a formatao apropriada.
/*
+==========================================+
|
| Autor
: Microsiga Software S.A.
|
| Data
: 02 de outubro de 2001
|
+==========================================+
*/
Opcionalmente podem-se incluir definies de constantes utilizadas no programa ou incluso

de arquivos de cabealho nesta rea.
Nesta rea geralmente se fazem os ajustes iniciais, importantes para o correto funcionamento
do programa. Entre os ajustes se encontram declaraes de variveis, inicializaes, abertura
de arquivos, etc. Apesar do ADVPL no ser uma linguagem rgida e as variveis poderem ser
declaradas em qualquer lugar do programa, aconselhvel faz-lo nesta rea visando tornar o
cdigo mais legvel e facilitar a identificao de variveis no utilizadas.
Local nCnt
Local nFator
Corpo do Programa
nesta rea que se encontram as linhas de cdigo do programa. onde se realiza a tarefa
necessria atravs da organizao lgica destas linhas de comando. Espera-se que as linhas de
comando estejam organizadas de tal modo que no final desta rea o resultado esperado seja
obtido, seja ele armazenado em um arquivo ou em variveis de memria, pronto para ser
exibido ao usurio atravs de um relatrio ou na tela.
nResultado *= nCnt
Next nCnt
A preparao para o processamento formada pelo conjunto de validaes e processamentos

necessrios antes da realizao do processamento em si.
Avaliando o processamento do clculo do fatorial descrito anteriormente, pode-se definir que a
validao inicial a ser realizada o contedo da varivel nFator, pois a mesma determinar a
correta execuo do cdigo.
nFator := GetFator()
// GetFator funo ilustrativa na qual a varivel recebe a informao do
usurio.
If nFator <= 0
Alert(Informao invlida)
Return
Endif
nResultado *= nCnt
Next nCnt
rea de Encerramento
nesta rea onde as finalizaes so efetuadas. onde os arquivos abertos so fechados, e o
resultado da execuo do programa utilizado. Pode-se exibir o resultado armazenado em
uma varivel ou em um arquivo ou simplesmente finalizar, caso a tarefa j tenha sido toda
completada no corpo do programa. nesta rea que se encontra o encerramento do
programa. Todo programa em ADVPL deve sempre terminar com a palavra chave return.
Return
20.
Declarao e Atribuio de Variveis
20.1. Tipo de Dados

O ADVPL no uma linguagem de tipos rgidos (strongly typed), o que significa que variveis
de memria podem receber diferentes tipos de dados durante a execuo do programa.
As variveis podem tambm conter objetos, mas os tipos primrios da linguagem so:
Numrico
O ADVPL no diferencia valores inteiros de valores com ponto flutuante, portanto podem-se
criar variveis numricas com qualquer valor dentro do intervalo permitido. Os seguintes
elementos so do tipo de dado numrico:
2
43.53
0.5
0.00001
1000000
Uma varivel do tipo de dado numrico pode conter um nmero de dezoito dgitos incluindo o
ponto flutuante, no intervalo de 2.2250738585072014 E308 at 1.7976931348623158
E+308.
Lgico
Valores lgicos em ADVPL so identificados atravs de .T. ou .Y. para verdadeiro e .F. ou .N.
para falso (independentemente se os caracteres estiverem em maisculo ou minsculo).
Caractere
Strings ou cadeias de caracteres so identificadas em ADVPL por blocos de texto entre aspas
duplas (") ou aspas simples ('):
"Ol mundo!"
'Esta uma string'
"Esta 'outra' string"
Uma varivel do tipo caractere pode conter strings com no mximo 1 MB, ou seja, 1048576
caracteres.
Data
O ADVPL tem um tipo de dados especfico para datas. Internamente as variveis deste tipo de
dado so armazenadas como um nmero correspondente a data Juliana.
Variveis do tipo de dados Data no podem ser declaradas diretamente, e sim atravs da
utilizao de funes especficas como por exemplo CTOD() que converte uma string para
data.
Array
O Array um tipo de dado especial. a disposio de outros elementos em colunas e linhas. O
ADVPL suporta arrays unidimensionais (vetores) ou multidimensionais (matrizes). Os
elementos de um array so acessados atravs de ndices numricos iniciados em 1,
identificando a linha e coluna para quantas dimenses existirem.
Arrays devem ser utilizadas com cautela, pois se forem muito grandes podem exaurir a
memria do servidor.
Bloco de Cdigo
O bloco de cdigo um tipo de dado especial. utilizado para armazenar instrues escritas
em ADVPL que podero ser executadas posteriormente.
20.2. Declarao de variveis

Variveis de memria so um dos recursos mais importantes de uma linguagem. So reas de
memria criadas para armazenar informaes utilizadas por um programa para a execuo de
tarefas. Por exemplo, quando o usurio digita uma informao qualquer, como o nome de um
produto, em uma tela de um programa esta informao armazenada em uma varivel de
memria para posteriormente ser gravada ou impressa.
A partir do momento que uma varivel criada, no necessrio mais se referenciar ao seu
contedo, e sim ao seu nome.
O nome de uma varivel um identificador nico o qual deve respeitar um mximo de 10
caracteres. O ADVPL no impede a criao de uma varivel de memria cujo nome contenha
mais de 10 caracteres, porm apenas os 10 primeiros sero considerados para a
localizao do contedo armazenado.
Portanto se forem criadas duas variveis cujos 10 primeiros caracteres forem iguais, como
nTotalGeralAnual e nTotalGeralMensal, as referncias a qualquer uma delas no programa
resultaro o mesmo, ou seja, sero a mesma varivel:
nTotalGeralMensal := 100
nTotalGeralAnual := 300
Alert("Valor mensal: " + cValToChar(nTotalGeralMensal))
Quando o contedo da varivel nTotalGeralMensal exibido, o seu valor ser de 300. Isso
acontece porque no momento que esse valor foi atribudo varivel nTotalGeralAnual, o
ADVPL considerou apenas os 10 primeiros caracteres (assim como o faz quando deve exibir o
valor da varivel nTotalGeralMensal), ou seja, considerou-as como a mesma varivel. Assim o
valor original de 100 foi substitudo pelo de 300.
20.3. Escopo de variveis

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. 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), pblico (visualizadas por qualquer outro programa), entre outros.
O Contexto de Variveis dentro de um Programa
As variveis declaradas em um programa ou funo, so visveis de acordo com o escopo onde
so definidas. Como tambm do escopo depende o tempo de existncia das variveis. A
definio do escopo de uma varivel efetuada no momento de sua declarao.
Local nNumero := 10
Esta linha de cdigo declara uma varivel chamada nNumero indicando que pertence seu
escopo local.
Os identificadores de escopo so:
Local
Static
Private
Public
O ADVPL no rgido em relao declarao de variveis no comeo do programa. A incluso

de um identificador de escopo no necessrio para a declarao de uma varivel, contanto
que um valor lhe seja atribudo.
nNumero2 := 15
Quando um valor atribudo uma varivel em um programa ou funo, o ADVPL criar a
varivel caso ela no tenha sido declarada anteriormente. A varivel ento criada como se
tivesse sido declarada como Private.
Devido a essa caracterstica, quando se pretende fazer uma atribuio a uma varivel
declarada previamente mas escreve-se o nome da varivel de forma incorreta, o ADVPL no
gerar nenhum erro de compilao ou de execuo. Pois compreender o nome da varivel
escrito de forma incorreta como se fosse a criao de uma nova varivel. Isto alterar a lgica
do programa, e um erro muitas vezes difcil de identificar.
Variveis de escopo local

Variveis de escopo local so pertencentes apenas ao escopo da funo onde foram declaradas
e devem ser explicitamente declaradas com o identificador LOCAL, como no exemplo:
Function Pai()
Local nVar := 10, aMatriz := {0,1,2,3}
.
<comandos>
.
Filha()
.
<mais comandos>
.
Return(.T.)
Neste exemplo, a varivel nVar foi declarada como local e atribuda com o valor 10. Quando a
funo Filha executada, nVar ainda existe mas no pode ser acessada. Quando a execuo
da funo Pai terminar, a varivel nVar destruda. Qualquer varivel com o mesmo nome no
programa que chamou a funo Pai no afetada.
Variveis de escopo local so criadas automaticamente cada vez que a funo onde forem
declaradas for ativada. Elas continuam a existir e mantm seu valor at o fim da ativao da
funo (ou seja, at que a funo retorne o controle para o cdigo que a executou). Se uma
funo chamada recursivamente (por exemplo, chama a si mesma), cada chamada em
recurso cria um novo conjunto de variveis locais.
A visibilidade de variveis de escopo locais idntica ao escopo de sua declarao, ou seja, a
varivel visvel em qualquer lugar do cdigo fonte em que foi declarada. Se uma funo
chamada recursivamente, apenas as variveis de escopo local criadas na mais recente ativao
so visveis.
Variveis de escopo static
Variveis de escopo static funcionam basicamente como as variveis de escopo local, mas
mantm seu valor atravs da execuo e devem ser declaradas explicitamente no cdigo com
o identificador STATIC.
O escopo das variveis static depende de onde so declaradas. Se forem declaradas dentro do
corpo de uma funo ou procedimento, seu escopo ser limitado quela rotina. Se forem
declaradas fora do corpo de qualquer rotina, seu escopo afeta a todas as funes declaradas
no fonte. Neste exemplo, a varivel nVar declarada como static e inicializada com o valor 10:
Function Pai()
Static nVar := 10
.
<comandos>
.
Filha()
.
<mais comandos>
.
Return(.T.)
Quando a funo Filha executada, nVar ainda existe mas no pode ser acessada. Diferente
de variveis declaradas como LOCAL ou PRIVATE, nVar continua a existir e mantm seu valor
atual quando a execuo da funo Pai termina. Entretanto, somente pode ser acessada por
execues subseqentes da funo Pai.
Variveis de escopo private
A declarao opcional para variveis privadas. Mas podem ser declaradas explicitamente com
o identificador PRIVATE.
Adicionalmente, a atribuio de valor a uma varivel no criada anteriormente
automaticamente cria a varivel como privada. Uma vez criada, uma varivel privada continua
a existir e mantm seu valor at que o programa ou funo onde foi criada termine (ou seja,
at que a funo onde foi criada retorne para o cdigo que a executou). Neste momento,
automaticamente destruda.
possvel criar uma nova varivel privada com o mesmo nome de uma varivel j existente.
Entretanto, a nova (duplicada) varivel pode apenas ser criada em um nvel de ativao
inferior ao nvel onde a varivel foi declarada pela primeira vez (ou seja, apenas em uma
funo chamada pela funo onde a varivel j havia sido criada). A nova varivel privada ir
esconder qualquer outra varivel privada ou pblica (veja a documentao sobre variveis
pblicas) com o mesmo nome enquanto existir.
Uma vez criada, uma varivel privada visvel em todo o programa enquanto no for
destruda automaticamente quando a rotina que a criou terminar ou uma outra varivel
privada com o mesmo nome for criada em uma subfuno chamada (neste caso, a varivel
existente torna-se inacessvel at que a nova varivel privada seja destruda).
Em termos mais simples, uma varivel privada visvel dentro da funo de criao e todas as
funes chamadas por esta, a menos que uma funo chamada crie sua prpria varivel
privada com o mesmo nome.
Por exemplo:
Function Pai()
Private nVar := 10
<comandos>
.
Filha()
<mais comandos>
.
Return(.T.)
Neste exemplo, a varivel nVar criada com escopo private e inicializada com o valor 10.
Quando a funo Filha executada, nVar ainda existe e, diferente de uma varivel de escopo
local, pode ser acessada pela funo Filha. Quando a funo Pai terminar, nVar ser destruda
e qualquer declarao de nVar anterior se tornar acessvel novamente.
Exemplo: Private _dData
Variveis de escopo public

Podem-se criar variveis de escopo public dinamicamente no cdigo com o identificador
PUBLIC. As variveis deste escopo continuam a existir e mantm seu valor at o fim da
execuo da thread (conexo).
possvel criar uma varivel de escopo private com o mesmo nome de uma varivel de escopo
public existente, entretanto, no permitido criar uma varivel de escopo public com o mesmo
nome de uma varivel de escopo private existente.
Uma vez criada, uma varivel de escopo public visvel em todo o programa onde foi
declarada at que seja escondida por uma varivel de escopo private criada com o mesmo
nome. A nova varivel de escopo private criada esconde a varivel de escopo public existente,
e esta se tornar inacessvel at que a nova varivel private seja destruda. Por exemplo:
Function Pai()
Public nVar := 10
<comandos>
.
Filha()
<mais comandos>
.
Return(.T.)
Neste exemplo, nVar criada como public e inicializada com o valor 10. Quando a funo Filha
executada, nVar ainda existe e pode ser acessada. Diferente de variveis locais ou privates,
nVar ainda existe aps o trmino da a execuo da funo Pai.
Diferentemente dos outros identificadores de escopo, quando uma varivel declarada como
pblica sem ser inicializada, o valor assumido falso (.F.) e no nulo (nil).
Exemplo: Public _cRotina
20.4. Entendendo a influncia do escopo das variveis

Considere as linhas de cdigo de exemplo:
Se esta linha for executada em um programa ADVPL, 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:

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 mais
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
atravs de uma das formas:

nPercentual := 10
ou
Local nPercentual := 10, nResultado
A diferena entre o ltimo exemplo e os dois anteriores que a varivel inicializada no

momento da declarao. Em ambos os exemplos, a varivel primeiro declarada e ento
inicializada em uma outra linha de cdigo.
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.
21.
Regras adicionais da linguagem ADVPL
21.1. Palavras reservadas

AADD
ABS
ASC
AT
BOF
BREAK
ENDIF
LTRIM
SPACE
CTOD
FILE
PCOUNT
TRANSFORM
DOW
IIF
CATCH
DTOS
ELSE
ELSEIF
EMPTY
ENDCASE
ENDDO
LOWER
SETPOS
COL
FIELDNAME
PCOL
TIME
DEVPOS
IF
RECNO
THROW
INKEY
INT
LASTREC
LEN
LOCK
LOG
SELECT
CMONTH
FCOUNT
MONTH
SUBSTR
DELETED
FUNCTION
RECCOUNT
UPPER
Palavras reservadas no
procedimentos ou funes;
REPLICATE
RLOCK
ROUND
ROW
RTRIM
SECONDS
CHR
EXP
MIN
STR
DAY
FOUND
PROW
TYPE
TRY
podem
ser
VAL
VALTYPE
WHILE
WORD
YEAR
CDOW
EOF
MAX
SQRT
DATE
FLOCK
PROCEDURE
TRIM
DTOC
AS
utilizadas
para
variveis,
Funes reservadas so pertencentes ao compilador e no podem ser

redefinidas por uma aplicao;
Todos os identificadores que comearem com dois ou mais caracteres
_ so utilizados como identificadores internos e so reservados.
Identificadores de escopo PRIVATE ou PUBLIC utilizados em aplicaes
especficas desenvolvida por ou para clientes devem ter sua
identificao iniciada por um caractere _.
21.2. Pictures de formatao disponveis

Com base na documentao disponvel no DEM Documentao Eletrnica Microsiga, a
linguagem ADVPL e a aplicao ERP Protheus admitem as seguintes pictures:
Dicionrio de Dados (SX3) e GET
Funes
Contedo
A
C
E
R
S<n>
X
Z
(
)
!
Funcionalidade
Permite apenas caracteres alfabticos.
Exibe CR depois de nmeros positivos.
Exibe numrico com o ponto e vrgula invertidos (formato Europeu).
Insere caracteres diferentes dos caracteres de template na exibio, mas no os
insere na varivel do GET.
Permite rolamento horizontal do texto dentro do GET, <n> um nmero inteiro
que identifica o tamanho da regio.
Exibe DB depois de nmeros negativos.
Exibe zeros como brancos.
Exibe nmeros negativos entre parnteses com os espaos em branco iniciais.
Exibe nmeros negativos entre parnteses sem os espaos em branco iniciais.
Templates
Contedo Funcionalidade
X
Permite qualquer caractere.
9
Permite apenas dgitos para qualquer tipo de dado, incluindo o sinal para
numricos.
#
Permite dgitos, sinais e espaos em branco para qualquer tipo de dado.
!
*
Exibe um asterisco no lugar dos espaos em branco iniciais em nmeros.
.
Exibe o ponto decimal.
,
Exibe a posio do milhar.
Picture: @E 99,999,999,999,999.99
Exemplo 02 Picture campo texto, com digitao apenas em caixa alta

A1_NOME Caracter - 40
Picture: @!
22.
Programas de Atualizao
Os programas de atualizao de cadastros e digitao de movimentos seguem um padro que

se apia no Dicionrio de Dados.
Basicamente so trs os modelos mais utilizados:
Modelo 1 ou AxCadastro:
Para
cadastramentos
em
Exemplo: Cadastro de Cliente.
Modelo 2:
Cadastramentos
tabela,
mas
envolvendo
com
um
tela
apenas
cabealho
cheia.
uma
e,
opcionalmente, um rodap e um corpo com

quantidade ilimitada de linhas.
Ideal para
casos em que h dados que se repetem

por vrios
itens
que,
por
isso,
so
colocados no cabealho. Exemplo: Pedido de

Compra.
Modelo 3:
Cadastramentos envolvendo duas tabelas,

um com dados de cabealho e outro digitado
em linhas com os itens. Exemplo: Pedido de
Vendas, Oramento etc.
Todos os modelos so genricos, ou seja, o programa independe da tabela a ser tratada,

bastando praticamente que se informe apenas o seu Alias.
O resto obtido do
Dicionrio de Dados (SX3).
22.1. Modelo1() ou AxCadastro()

O AxCadastro() uma funcionalidade de cadastro simples, com poucas opes de
customizao, a qual composta de:
Funes de pesquisa, visualizao, incluso, alterao e excluso padres para

visualizao de registros simples, sem a opo de cabealho e itens.
Sintaxe: AxCadastro(cAlias, cTitulo, cVldExc, cVldAlt)
Parmetros:
cAlias

cTitulo
Ttulo da Janela
cVldExc
Validao para Excluso
cVldAlt
Validao para Alterao
Exemplo: Funo AxCadastro()
/*/
+----------------------------------------------------------------------------| Funo
| XCADSA2
| Autor | ARNALDO RAYMUNDO JR. | Data |
|
+----------------------------------------------------------------------------| Descrio | Exemplo de utilizao da funo AXCADASTRO()
|
|+---------------------------------------------------------------------------| Uso
| Curso ADVPL
|
|+---------------------------------------------------------------------------/*/
User Function XCadSA2()
Local
Local
Local
Local
cAlias
cTitulo
cVldExc
cVldAlt
:=
:=
:=
:=
"SA2"
"Cadastro de Fornecedores"
".T."
".T."
dbSetOrder(1)
AxCadastro(cAlias,cTitulo,cVldExc,cVldAlt)
Return Nil
Exemplo: Funo de validao da alterao
/*/
+-----------------------------------------------------------------------------| Funo
| VLDALT
|
+-----------------------------------------------------------------------------| Descrio | Funo de validao de alterao para a AXCADASTRO()
|
+-----------------------------------------------------------------------------| Uso
| Curso ADVPL
|
+-----------------------------------------------------------------------------/*/
User Function VldAlt(cAlias,nReg,nOpc)
Local lRet
Local aArea
Local nOpcao
:= .T.
:= GetArea()
:= 0
nOpcao := AxAltera(cAlias,nReg,nOpc)
If nOpcao == 1
MsgInfo(Aterao concluda com sucesso!)
Endif
RestArea(aArea)
Return lRet
Exemplo: Funo de validao da excluso
/*/
+-----------------------------------------------------------------------------| Funo
| VLDEXC
|
+-----------------------------------------------------------------------------| Descrio | Funo de validao de excluso para a AXCADASTRO()
|
+-----------------------------------------------------------------------------| Uso
| Curso ADVPL
|
+-----------------------------------------------------------------------------/*/
User Function VldExc(cAlias,nReg,nOpc)
Local lRet
Local aArea
Local nOpcao
:= .T.
:= GetArea()
:= 0
nOpcao := AxExclui(cAlias,nReg,nOpc)
If nOpcao == 1
MsgInfo(Excluso concluda com sucesso!)
Endif
RestArea(aArea)
Return lRet
22.2. Modelo2()
O nome Modelo 2 foi conceituado pela Microsiga por se tratar de um prottipo de tela para
entrada de dados. Inicialmente vamos desmistificar dois pontos:
Funo Modelo2() Trata-se de uma funo pronta que contempla o prottipo
Modelo 2, porm, este um assunto que no iremos tratar aqui, visto que
uma funcionalidade simples que quando necessrio intervir em algo na rotina
no h muito recurso para tal.
Prottipo Modelo 2 Trata-se de uma tela, como a figura abaixo, onde seu
objetivo efetuar a manuteno em vrios registros de uma s vez. Por
exemplo: efetuar o movimento interno de vrios produtos do estoque em um
nico lote.
22.2.1.
Componentes de uma tela no formato Modelo 2
Objeto MsDialog()
Deve ser utilizada como janela padro para entrada de dados, um tipo de objeto modal, ou
seja, no permite que outra janela ativa receba dados enquanto esta estiver ativa.
Toda vez que utilizar este comando o ADVPL exige que seja declarado a diretiva Include no
cabealho do programa o arquivo Protheus.ch, isto porque o compilador precisar porque
este comando trata-se de um pseudo cdigo e sua traduo ser feita na compilao. Vale
lembrar tambm que este s ser acionado depois que instanciado e ativado por outro
comando.
DEFINE MSDIALOG oDlg TITLE "Prottipo Modelo 2" FROM 0,0 TO 280,552 OF;
oMainWnd PIXEL
ACTIVATE MSDIALOG oDlg CENTER
Reparem que o comando DEFINE MSDIALOG instanciou e o comando ACTIVATE MSDIALOG

ativa todos os objetos, ou seja, todo ou qualquer outro objeto que precisar colocar nesta
janela ser preciso informar em qual objeto, para este caso sempre ser utilizada a varivel de
objeto exportvel oDlg.
Funo EnchoiceBar()
Funo que cria uma barra de botes padro de Ok e Cancelar, permitindo a implementao
de botes adicionais.
Sintaxe: ENCHOICEBAR( oDlg, bOk, bCancelar, [ lMensApag ] , [ aBotoes ] )

Parmetros:
oDlg
Objeto
Janela onde a barra ser criada.
bOk
Objeto
Bloco de cdigo executado quando clicado boto Ok.
bCancelar
Objeto
Bloco de cdigo executado quando clicado.
lMensApag
Lgico
aBotes
Vetor
Indica se ao clicar no boto Ok aparecer uma tela de

confirmao de excluso. Valor padro falso.
Vetor com informaes para criao de botes
adicionais na barra. Seu formato {bitmap, bloco de
cdigo, mensagem}.
Figura: Prottipo Modelo2 Enchoice

Objeto TPanel()
Repare que para facilitar o desenvolvimento foi utilizado o objeto TPanel para ajudar o
alinhamento dos objetos TSay e TGet, ou seja, a utilizao deste recurso permite que o
programador no se preocupe com coordenadas complexas para deixar a unio dos objetos
simtricos.
Utilize o objeto TPanel quando desejar criar um painel esttico, onde podem ser criados outros
controles com o objetivo de organizar ou agrupar componentes visuais.
Sintaxe:
TPanel():New([anRow], [anCol], [acText], [aoWnd], [aoFont],

[alCentered],
[lPar6],
[anClrText],
[anClrBack],
[anWidth],
[anHeight], [alLowered], [alRaised])
Parmetros:
nRow
Numrico vertical em pixel.
nCol
Numrico horizontal em pixel.
cText
Texto a ser exibido ao fundo.
oWnd
Objeto da janela ou controle onde ser criado o objeto.
oFont
Caractersticas da fonte do texto que aparecer ao fundo.
lCentered
Exibe o texto do ttulo centralizado.
lPar6
Reservado.
nClrText
Cor do texto de controle.
nClrBack
Cor do fundo de controle.
nWidth
Largura do controle em pixel.
nHeight
Altura do controle em pixel.
lLowered
Exibe o painel rebaixado em relao ao controle de fundo.
lRaised
Exibe a borda do controle rebaixado em relao ao controle de

fundo.
Comando SAY - Objeto: TSay()

O comando SAY ou objeto TSay exibe o contedo de texto esttico sobre uma janela.
Sintaxe SAY:
@ 4,6 SAY "Cdigo:" SIZE 70,7 PIXEL OF oTPanel1

Sintaxe
TSay():
TSay():New([anRow],
[anCol],
[abText],
[aoWnd],
[acPicture],
[aoFont],
[lPar7],
[lPar8],
[lPar9],
[alPixels],
[anClrText], [anClrBack], [anWidth], [anHeight], [lPar15], [lPar16],
[lPar17], [lPar18], [lPar19])
Parmetros:
anRow
anCol
abText
aoWnd
acPicture
aoFont
lPar7
lPar8
lPar9
alPixels
anClrText
anClrBack
anWidth
anHeight
lPar15
lPar16
lPar17
lPar18
lPar19
Numrico, opcional. Coordenada vertical em pixels ou

caracteres.
Numrico, opcional. Coordenada horizontal em pixels ou
caracteres.
Code-Block, opcional. Quando executado deve retornar uma
cadeia de caracteres a ser exibida.
Objeto, opcional. Janela ou dilogo onde o controle ser criado.
Caractere, opcional. Picture de formatao do contedo a ser
exibido.
Objeto, opcional. Objeto tipo tFont para configurao do tipo de
fonte que ser utilizado para exibir o contedo.
Reservado.
Reservado.
Reservado.
Lgico, opcional. Se .T. considera coordenadas passadas em
pixels se .F., padro, considera as coordenadas passadas em
caracteres.
Numrico, opcional. Cor do contedo do controle.
Numrico, opcional. Cor do fundo do controle.
Numrico, opcional. Largura do controle em pixels.
Numrico, opcional. Altura do controle em pixels.
Reservado.
Reservado.
Reservado.
Reservado.
Reservado.
Comando MSGET - Objeto: TGet()

O comando MsGet ou o objeto TGet utilizado para criar um controle que armazene ou altere
o contedo de uma varivel atravs de digitao. O contedo da varivel s modificado
quando o controle perde o foco de edio para outro controle.
Sintaxe MSGET:
@ 3,192 MSGET dData PICTURE "99/99/99" SIZE 40,7 PIXEL OF oTPanel1
Sintaxe
TGet():New([anRow], [anCol], [abSetGet], [aoWnd], [anWidth],

[anHeight], [acPict], [abValid], [anClrFore], [anClrBack], [aoFont],
[lPar12], [oPar13], [alPixel], [cPar15], [lPar16], [abWhen], [lPar18],
[lPar19],
[abChange],
[alReadOnly],
[alPassword],
[cPar23],
[acReadVar], [cPar25], [lPar26], [nPar27], [lPar28])
Parmetros:
anRow
anCol
abSetGet
aoWnd
anWidth
anHeight
acPict
abValid
anClrFore
anClrBack
aoFont
lPar12
oPar13
alPixel
cPar15
lPar16
abWhen
lPar18

caracteres.
caracteres.
Bloco de cdigo, opcional. Bloco de cdigo no formato {|u| IF(
Pcount( )>0, <var>:= u, <var> ) } que o controle utiliza para
atualizar a varivel <var>. <var> deve ser tipo caracter,
numrico ou data.
Objeto, opcional. Janela ou controle onde o controle ser
criado.
Caractere, opcional. Mscara de formatao do contedo a ser
exibido.
Bloco de cdigo, opcional. Executado quando o contedo do
controle deve ser validado, deve retornar .T. se o contedo for
vlido e .F. quando o contedo for invlido.
Numrico, opcional. Cor de fundo do controle.
Numrico, opcional. Cor do texto do controle.
Objeto, opcional. Objeto tipo tFont utilizado para definir as
caractersticas da fonte utilizada para exibir o contedo do
controle.
Reservado.
Reservado.
Lgico, opcional. Se .T. as coordenadas informadas so em
pixels, se .F. so em caracteres.
Reservado.
Reservado.
Bloco de cdigo, opcional. Executado quando mudana de foco
de entrada de dados est sendo efetuada na janela onde o
controle foi criado. O bloco deve retornar .T. se o controle deve
permanecer habilitado ou .F. se no.
Reservado.
lPar19
abChange
alReadOnly
alPassword
cPar23
acReadVar
cPar25
lPar26
nPar27
lPar18
Reservado.
Bloco de cdigo, opcional. Executado quando o controle
modifica o valor da varivel associada.
Lgico, opcional. Se .T. o controle no poder ser editado.
Lgico, opcional. Se .T. o controle exibir asteriscos * no
lugar dos caracteres exibidos pelo controle para simular
entrada de senha.
Reservado.
Caractere, opcional. Nome da varivel que o controle dever
manipular, dever ser a mesma varivel informada no
parmetro abSetGet, e ser o retorno da funo ReadVar( ).
Reservado.
Reservado.
Reservado.
Reservado.
Objeto MsGetDados()
Objeto tipo lista com uma ou mais colunas para cadastramento de dados baseado em um
vetor. Sua utilizao exige que seja utilizado trs variveis com seu escopo Private, so elas:
aRotina, aHeader e aCOLS.
Observaes importantes:
O vetor aHeader deve ser construdo com base no dicionrio de dados.
O vetor aCOLS deve ser construdo com base no vetor aHeader, porm devese criar uma coluna adicional para o controle de excluso do registro, ou
seja, quando o usurio teclar a tecla <DELETE> a linha ficar na cor cinza e
esta coluna estar com o seu valor igual a verdadeiro (.T.).
Quando instanciado este objeto possvel saber em que linha o usurio est
porque o objeto trabalha com uma varivel de escopo Public denominada n,
seu valor numrico e ter sempre no contedo a linha em que o usurio
encontra-se com o cursor.
Sintaxe:
MSGETDADOS():NEW( nSuperior, nEsquerda, nInferior, nDireita,

nOpc, [ cLinhaOk ], [ cTudoOk ], [ cIniCpos ], [ lApagar ], [ aAlter], ,
[ uPar1 ], [ lVazio ], [ nMax], [ cCampoOk ], [ cSuperApagar ],
[ uPar2 ], [ cApagaOk ], [ oWnd ] )
Parmetros:
nSuperior
nEsquerda
nInferior
nDireita
nOpc
cLinhaOk
cTudoOk
cIniCpos
lApagar
aAlter
uPar1
lVazio
nMax
cCampoOk
cSuperApagar
uPar2
cApagaOk
oWnd
Distancia entre a MsGetDados e o extremidade superior do

objeto que a contm.
Distancia entre a MsGetDados e o extremidade esquerda do
objeto que a contm.
Distancia entre a MsGetDados e o extremidade inferior do
objeto que a contm.
Distancia entre a MsGetDados e o extremidade direita do
objeto que a contm.
Posio do elemento do vetor aRotina que a MsGetDados
usar como referencia.
Funo executada para validar o contexto da linha atual do
aCols.
Funo executada para validar o contexto geral da
MsGetDados (todo aCols).
Nome dos campos do tipo caracter que utilizaro incremento
automtico. Este parmetro deve ser no formato +<nome
do primeiro campo>+<nome do segundo campo>+....
Habilita deletar linhas do aCols. Valor padro falso.
Vetor com os campos que podero ser alterados.
Parmetro reservado.
Habilita validao da primeira coluna do aCols para esta no
poder estar vazia. Valor padro falso.
Nmero mximo de linhas permitidas. Valor padro 99.
Funo executada na validao do campo.
Funo executada quando pressionada as teclas
<Ctrl>+<Delete>.
Parmetro reservado.
Funo executada para validar a excluso de uma linha do
aCols.
Objeto no qual a MsGetDados ser criada.
Varivel Private aRotina

Array com as rotinas que sero executadas na MBrowse e que definir o tipo de operao que
est sendo executada, por exemplo: Pesquisar, Visualizar, Incluir, Alterar, Excluir e outros.
Este vetor precisa ser construdo no formato:
Elemento
1
2
3
4
5
Contedo
Ttulo da opo.
Nome da rotina (Function).
Reservado.
Operao (1-Pesquisar;2-Visualizar;3-Incluir;4-Alterar;5-Excluso).
Acesso relacionado a rotina, se est opo no for informada nenhum
acesso ser validado.
Varivel Private aHeader

Array com informaes das colunas, ou seja, com as caractersticas dos campos que esto
contidas no dicionrio de dados (SX3), este vetor precisa estar no formato abaixo:
Elemento
1
2
3
4
5
6
7
8
9
10
Contedo
Ttulo do campo
Nome do campo
Mscara do campo
Tamanho do campo
Decimal do campo
Validao de usurio do campo
Uso do campo
Tipo do campo (caractere, numrico, data e etc.)
Prefixo da tabela
Contexto do campo (real ou virtual)
Varivel Private aCols

Vetor com as linhas a serem editadas. As colunas devem ser construdas com base no vetor
aHeader e mais uma ltima coluna com o valor lgico que determina se a linha foi excluda,
inicialmente esta dever ter o seu contedo igual a falso (.F.).
22.2.2.
Estrutura de um programa utilizando a Modelo2()
O exemplo abaixo demonstra a montagem de um programa para a utilizao do prottipo

Modelo 2. Antes de iniciarmos o exemplo vamos estruturar o programa.
Estrutura do programa
Linhas
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
Programa
Funo principal;
Declarao e atribuio de variveis;
Acesso a tabela principal e sua ordem;
Chamada da funo MBrowse;
Fim da funo principal.
Funo de visualizao, alterao e excluso;
Acesso ao primeiro registro da chave em que est posicionado na MBrowse;
Montagem das variveis estticas em tela;
Montagem do vetor aHeader por meio do dicionrio de dados;
Montagem do vetor aCOLS de todos os registros referente a chave principal em que est
posicionado na MBrowse;
Instncia da MsDialog;
Instncia dos objetos TSay e TGet;
Instncia do objeto MsGetDados;
Ativar o objeto principal que o objeto da janela;
Se for operao diferente de visualizao e clicou no boto OK;
A operao e de Alterao?
Chamar a funo para alterar os dados;
Caso contrrio
Chamar a funo para excluir os dados;
Fim da funo de visualizao, alterao e excluso.
Funo de incluso;
Montagem das variveis estticas em tela;
Montagem do vetor aCOLS com o seu contedo conforme o inicializador padro do campo ou
vazio, pois trata-se de uma incluso;
Se clicou no boto OK;
Chamar a funo para incluir os dados;
Fim da funo de incluso.
Rotina principal
//+--------------------------------------------------------------------+
//| Rotina | xModelo2 | Autor | Robson Luiz (rleg) | Data | 01.01.2007 |
//+--------------------------------------------------------------------+
//| Descr. | Funo exemplo do prottipo Modelo2.
|
//+--------------------------------------------------------------------+
//| Uso
| Para treinamento e capacitao.
|
//+--------------------------------------------------------------------+
User Function xModelo2()
Private cCadastro := "Prottipo Modelo 2"
Private aRotina := {}
AADD(
AADD(
AADD(
AADD(
AADD(
aRotina,
aRotina,
aRotina,
aRotina,
aRotina,
{"Pesquisar"
{"Visualizar"
{"Incluir"
{"Alterar"
{"Excluir"
,"AxPesqui" ,0,1})
,'U_Mod2Mnt',0,2})
,'U_Mod2Inc',0,3})
,'U_Mod2Mnt',0,4})
,'U_Mod2Mnt',0,5})
dbSelectArea("ZA3")
dbSetOrder(1)
dbGoTop()
MBrowse(,,,,"ZA3")
Return
Rotina de incluso
//+--------------------------------------------------------------------+
//| Rotina | Mod2Inc | Autor | Robson Luiz (rleg) | Data | 01.01.2007 |
//+--------------------------------------------------------------------+
//| Descr. | Rotina para incluir dados.
|
//+--------------------------------------------------------------------+
//| Uso
|
//+--------------------------------------------------------------------+
User Function Mod2Inc( cAlias, nReg, nOpc )
Local oDlg
Local oGet
Local oTPanel1
Local oTPAnel2
Local cCodigo := ZA3->ZA3_CODIGO
Local cNome
:= ZA3->ZA3_NOME
Local dData
:= dDataBase
Private aHeader := {}
Private aCOLS := {}
Private aREG := {}
dbSelectArea( cAlias )
dbSetOrder(1)
Mod2aHeader( cAlias )
Mod2aCOLS( cAlias, nReg, nOpc )
DEFINE MSDIALOG oDlg TITLE cCadastro From 8,0 To 28,80 OF oMainWnd
oTPanel1 := TPanel():New(0,0,"",oDlg,NIL,.T.,;
.F.,NIL,NIL,0,16,.T.,.F.)
oTPanel1:Align := CONTROL_ALIGN_TOP
@ 4, 006 SAY "Cdigo:" SIZE 70,7 PIXEL OF oTPanel1
@ 4, 062 SAY "Nome:"
SIZE 70,7 PIXEL OF oTPanel1
@ 4, 166 SAY "Emissao:" SIZE 70,7 PIXEL OF oTPanel1
@ 3, 026 MSGET cCodigo F3 "SA3" PICTURE "@!" VALID;
Mod2Vend(cCodigo, @cNome);
@ 3, 080 MSGET cNome When .F. SIZE 78,7 PIXEL OF oTPanel1
@ 3, 192 MSGET dData PICTURE "99/99/99" SIZE 40,7 PIXEL OF
oTPanel1
.F.,NIL,NIL,0,16,.T.,.F.)
oTPanel2:Align := CONTROL_ALIGN_BOTTOM
oGet := MSGetDados():New(0,0,0,0,nOpc,"U_Mod2LOk()",;
".T.","+ZA3_ITEM",.T.)
oGet:oBrowse:Align := CONTROL_ALIGN_ALLCLIENT
ACTIVATE MSDIALOG oDlg CENTER ON INIT ;
EnchoiceBar(oDlg,{|| IIF(U_Mod2TOk(), Mod2GrvI(),;
( oDlg:End(), NIL ) )},{|| oDlg:End() })
Return
Rotina de Visualizao, Alterao e Excluso
//+--------------------------------------------------------------------+
//| Rotina | Mod2Mnt | Autor | Robson Luiz (rleg) | Data | 01.01.2007 |
//+--------------------------------------------------------------------+
//| Descr. | Rotina para Visualizar, Alterar e Excluir dados.
|
//+--------------------------------------------------------------------+
//| Uso
|
//+--------------------------------------------------------------------+
User Function Mod2Mnt( cAlias, nReg, nOpc )
Local
Local
Local
Local
oDlg
oGet
oTPanel1
oTPAnel2
Local cCodigo := Space(Len(Space(ZA3->ZA3_CODIGO)))

Local cNome := Space(Len(Space(ZA3->ZA3_NOME)))
Local dData := Ctod(Space(8))
Private aCOLS := {}
Private aREG := {}
dbGoTo( nReg )
cCodigo := ZA3->ZA3_CODIGO
cNome
:= ZA3->ZA3_NOME
cData
:= ZA3->ZA3_DATA
Mod2aHeader( cAlias )
Mod2aCOLS( cAlias, nReg, nOpc )
DEFINE MSDIALOG oDlg TITLE cCadastro From 8,0 To 28,80 OF oMainWnd
oTPane1 := TPanel():New(0,0,"",oDlg,NIL,.T.,;
.F.,NIL,NIL,0,16,.T.,.F.)
oTPane1:Align := CONTROL_ALIGN_TOP
@ 4, 006 SAY "Cdigo:" SIZE 70,7 PIXEL OF oTPanel1
@ 4, 062 SAY "Nome:"
@ 4, 166 SAY "Emissao:" SIZE 70,7 PIXEL OF oTPanel1
@ 3, 026 MSGET cCodigo When .F. SIZE 30,7 PIXEL OF oTPanel1
@ 3, 080 MSGET cNome
When .F. SIZE 78,7 PIXEL OF oTPanel1
@ 3, 192 MSGET dData
When .F. SIZE 40,7 PIXEL OF oTPanel1
.F.,NIL,NIL,0,16,.T.,.F.)
oTPanel2:Align := CONTROL_ALIGN_BOTTOM
If nOpc == 4
oGet := MSGetDados():New(0,0,0,0,nOpc,"U_Mod2LOk()",;
".T.","+ZA3_ITEM",.T.)
Else
oGet := MSGetDados():New(0,0,0,0,nOpc)
Endif
oGet:oBrowse:Align := CONTROL_ALIGN_ALLCLIENT
ACTIVATE MSDIALOG oDlg CENTER ON INIT ;
EnchoiceBar(oDlg,{|| ( IIF( nOpc==4, Mod2GrvA(), ;
IIF( nOpc==5, Mod2GrvE(), oDlg:End() ) ), oDlg:End() ) },;
{|| oDlg:End() })
Return
Montagem do array aHeader
//+--------------------------------------------------------------------+
//| Rotina | Mod2aHeader | Autor | Robson Luiz (rleg) |Data|01.01.2007 |
//+--------------------------------------------------------------------+
//| Descr. | Rotina para montar o vetor aHeader.
|
//+--------------------------------------------------------------------+
//| Uso
|
//+--------------------------------------------------------------------+
Static Function Mod2aHeader( cAlias )
Local aArea := GetArea()
dbSelectArea("SX3")
dbSetOrder(1)
dbSeek( cAlias )
While !EOF() .And. X3_ARQUIVO == cAlias
If X3Uso(X3_USADO) .And. cNivel >= X3_NIVEL
AADD( aHeader, { Trim( X3Titulo() ),;
X3_CAMPO,;
X3_PICTURE,;
X3_TAMANHO,;
X3_DECIMAL,;
X3_VALID,;
X3_USADO,;
X3_TIPO,;
X3_ARQUIVO,;
X3_CONTEXT})
Endif
dbSkip()
End
RestArea(aArea)
Return
Montagem do array aCols
//+--------------------------------------------------------------------+
//| Rotina | Mod2aCOLS | Autor | Robson Luiz (rleg) |Data | 01.01.2007 |
//+--------------------------------------------------------------------+
//| Descr. | Rotina para montar o vetor aCOLS.
|
//+--------------------------------------------------------------------+
//| Uso
|
//+--------------------------------------------------------------------+
Static Function Mod2aCOLS( cAlias, nReg, nOpc )
Local cChave := ZA3->ZA3_CODIGO
Local nI := 0
If nOpc <> 3
dbSetOrder(1)
dbSeek( xFilial( cAlias ) + cChave )
While !EOF() .And. ;
ZA3->( ZA3_FILIAL + ZA3_CODIGO ) == xFilial( cAlias ) + cChave
AADD( aREG, ZA3->( RecNo() ) )
AADD( aCOLS, Array( Len( aHeader ) + 1 ) )

For nI := 1 To Len( aHeader )
If aHeader[nI,10] == "V"
aCOLS[Len(aCOLS),nI] := CriaVar(aHeader[nI,2],.T.)
Else
aCOLS[Len(aCOLS),nI]
:=
FieldGet(FieldPos(aHeader[nI,2]))
Endif
Next nI
aCOLS[Len(aCOLS),Len(aHeader)+1] := .F.
dbSkip()
End
Else
aCOLS[1, nI] := CriaVar( aHeader[nI, 2], .T. )
Next nI
aCOLS[1, GdFieldPos("ZA3_ITEM")] := "01"
aCOLS[1, Len( aHeader )+1 ] := .F.
Endif
Restarea( aArea )
Return
Efetivao da incluso
//+--------------------------------------------------------------------+
//| Rotina | Mod2GrvI | Autor | Robson Luiz (rleg) | Data | 01.01.2007 |
//+--------------------------------------------------------------------+
//| Descr. | Rotina para gravar os dados na incluso.
|
//+--------------------------------------------------------------------+
//| Uso
|
//+--------------------------------------------------------------------+
Static Function Mod2GrvI()
Local nI := 0
Local nX := 0
dbSelectArea("ZA3")
dbSetOrder(1)
For nI := 1 To Len( aCOLS )
If ! aCOLS[nI,Len(aHeader)+1]
RecLock("ZA3",.T.)
ZA3->ZA3_FILIAL := xFilial("ZA3")
ZA3->ZA3_CODIGO := cCodigo
ZA3->ZA3_DATA
:= dData
For nX := 1 To Len( aHeader )
FieldPut( FieldPos( aHeader[nX, 2] ), aCOLS[nI, nX] )
Next nX
MsUnLock()
Endif
Next nI
RestArea(aArea)
Return
Efetivao da alterao
//+--------------------------------------------------------------------+
//| Rotina | Mod2GrvA | Autor | Robson Luiz (rleg) | Data | 01.01.2007 |
//+--------------------------------------------------------------------+
//| Descr. | Rotina para gravar os dados na alterao.
|
//+--------------------------------------------------------------------+
//| Uso
|
//+--------------------------------------------------------------------+
Static Function Mod2GrvA()
Local nI := 0
Local nX := 0
dbSelectArea("ZA3")
For nI := 1 To Len( aREG )
If nI <= Len( aREG )
dbGoTo( aREG[nI] )
RecLock("ZA3",.F.)
If aCOLS[nI, Len(aHeader)+1]
dbDelete()
Endif
Else
RecLock("ZA3",.T.)
Endif
If !aCOLS[nI, Len(aHeader)+1]
ZA3->ZA3_CODIGO := cCodigo
ZA3->ZA3_DATA
:= dData
For nX := 1 To Len( aHeader )
FieldPut( FieldPos( aHeader[nX, 2] ), aCOLS[nI, nX] )
Next nX
Endif
MsUnLock()
Next nI
RestArea( aArea )
Return
Efetivao da excluso
//+--------------------------------------------------------------------+
//| Rotina | Mod2GrvE | Autor | Robson Luiz (rleg) | Data | 01.01.2007 |
//+--------------------------------------------------------------------+
//| Descr. | Rotina para excluir os registros.
|
//+--------------------------------------------------------------------+
//| Uso
|
//+--------------------------------------------------------------------+
Static Function Mod2GrvE()
Local nI := 0
dbSelectArea("ZA3")
dbGoTo(aREG[nI])
RecLock("ZA3",.F.)
dbDelete()
MsUnLock()
Next nI
Return
Funo auxiliar: Validao do cdigo do vendedor
//+--------------------------------------------------------------------+
//| Rotina | Mod2Vend | Autor | Robson Luiz (rleg) | Data | 01.01.2007 |
//+--------------------------------------------------------------------+
//| Descr. | Rotina para validar o cdigo do vendedor.
|
//+--------------------------------------------------------------------+
//| Uso
|
//+--------------------------------------------------------------------+
Static Function Mod2Vend( cCodigo, cNome )
If ExistCpo("SA3",cCodigo) .And. ExistChav("ZA3",cCodigo)
cNome := Posicione("SA3",1,xFilial("SA3")+cCodigo,"A3_NOME")
Endif
Return(!Empty(cNome))
Funo auxiliar: Validao do cdigo do centro de custo na mudana de linha

//+--------------------------------------------------------------------+
//| Rotina | Mod2LOk | Autor | Robson Luiz (rleg)
| Data |01.01.2007 |
//+--------------------------------------------------------------------+
//| Descr. | Rotina para validar a linha de dados.
|
//+--------------------------------------------------------------------+
//| Uso
|
//+--------------------------------------------------------------------+
User Function Mod2LOk()
Local lRet := .T.
Local cMensagem := "No ser permitido linhas sem o centro de custo."
If !aCOLS[n, Len(aHeader)+1]
If Empty(aCOLS[n,GdFieldPos("ZA3_CCUSTO")])
MsgAlert(cMensagem,cCadastro)
lRet := .F.
Endif
Endif
Return( lRet )
Funo auxiliar: Validao do cdigo do centro de custo para todas as linhas
//+--------------------------------------------------------------------+
//| Rotina | Mod2TOk | Autor | Robson Luiz (rleg)
| Data |01.01.2007 |
//+--------------------------------------------------------------------+
//| Descr. | Rotina para validar toda as linhas de dados.
|
//+--------------------------------------------------------------------+
//| Uso
|
//+--------------------------------------------------------------------+
User Function Mod2TOk()
Local lRet := .T.
Local nI := 0
Local cMensagem := "No ser permitido linhas sem o centro de custo."
Loop
Endif
If !aCOLS[nI, Len(aHeader)+1]
If Empty(aCOLS[n,GdFieldPos("ZA3_CCUSTO")])
MsgAlert(cMensagem,cCadastro)
lRet := .F.
Exit
Endif
Endif
Next nI
Return( lRet )
22.2.3.
Funo Modelo2()
A funo Modelo2() uma interface pr-definida pela Microsiga que implementa de forma
padronizada os compontes necessrios a manipulao de estruturas de dados nas quais o
cabealho e os itens da informao compartilham o mesmo registro fsico.
Seu objetivo atuar como um facilitador de codificao, permitindo a utilizao dos recursos
bsicos dos seguintes componentes visuais:
MsDialog()
TGet()
TSay()
MsNewGetDados()
EnchoiceBar()
A funo Modelo2() no implementa as regras de visualizao,
incluso, alterao e excluso, como uma AxCadastro() ou
AxFunction().
A inicializao das variveis Private utilizada nos cabealhos e rodaps,
bem como a inicializao e gravao do aCols devem ser realizadas
pela rotina que suporta a execuo da Modelo2().
Da mesma forma, o Browse deve ser tratado por esta rotina, sendo
comum a Modelo2() estar vinculada ao uso de uma MBrowse().
Sintaxe: Modelo2([cTitulo], [aCab], [aRoda], [aGrid], [nOpc], [cLinhaOk],

[cTudoOk])
Parmetros:
cTitulo
aCab
Ttulo da janela
Array contendo as informaes que sero exibidas no cabealho na forma de
Enchoice()
aCab[n][1] (Caractere) := Nome da varivel private que ser vinculada ao
campo da Enchoice().
aCab[n][2] (Array) := Array com as coordenadas do campo na tela {Linha,
Coluna}
aCab[n][3] (Caractere) := Ttulo do campo na tela
aCab[n][4] (Caractere) := Picture de formatao do get() do campo.
aCab[n][5] (Caractere) := Funo de validao do get() do campo.
aCab[n][6] (Caractere) := Nome da consulta padro que ser executada
para o campo via tecla F3
aCab[n][7] (Lgico) := Se o campo estar livre para digitao.
aRoda
Array contendo as informaes que sero exibidas no cabealho na forma de

Enchoice(), no mesmo formato que o aCab.
Array contendo as coordenadas da GetDados() na tela. Padro :=
{44,5,118,315}
Opo selecionada na MBrowse, ou que deseje ser passada para controle da
Modelo2, aonde:
2 Visualizar
3 - Incluir
4 - Alterar
5 - Excluir
Funo para validao da linha na GetDados()
Funo para validao na confirmao da tela de interface da Modelo2().
aGrid
nOpc
cLinhaOk
cTudoOk
Retorno:
Lgico
Indica se a tela da interface Modelo2() foi confirmada ou cancelada pelo

usurio.
Exemplo: Utilizao da Modelo2() para visualizao do Cadastro de Tabelas (SX5)
//+--------------------------------------------------------------------+
//| Rotina | MBRW2SX5| Autor | ARNALDO RAYMUNDO JR. | Data |01.01.2007 |
//+--------------------------------------------------------------------+
//| Descr. | UTILIZACAO DA MODELO2() PARA VISUALIZAO DO SX5.
|
//+--------------------------------------------------------------------+
//| Uso
| CURSO DE ADVPL
|
//+--------------------------------------------------------------------+
USER FUNCTION MBrw2Sx5()
Local cAlias
:= "SX5"
Private cCadastro
:= "Arquivo de Tabelas"
Private aRotina
:= {}
Private cDelFunc := ".T." // Validacao para a exclusao. Pode-se utilizar
ExecBlock
AADD(aRotina,{"Pesquisar"
AADD(aRotina,{"Visualizar"
,"AxPesqui"
,"U_SX52Vis"
,"U_SX52Inc"
,"U_SX52Alt"
,"U_SX52Exc"
,0,1})
,0,2})
,0,3})
,0,4})
,0,5})
dbSetOrder(1)
mBrowse( 6,1,22,75,cAlias)
Return
USER FUNCTION SX52INC(cAlias,nReg,nOpc)
//Local nUsado
Local cTitulo
Local aCab
2
Local aRoda
Local aGrid
modelo2 - Padrao:
:= 0
:= "Inclusao de itens - Arquivo de Tabelas"
:= {} // Array com descricao dos campos do Cabecalho do Modelo
:= {} // Array com descricao dos campos do Rodape do Modelo 2

:= {80,005,050,300} //Array com coordenadas da GetDados no
{44,5,118,315}
// Linha Inicial - Coluna Inicial - +Qts Linhas - +Qts
Colunas : {080,005,050,300}
Local cLinhaOk
:= "AllwaysTrue()" // Validacoes na linha da GetDados da
Modelo 2
Local cTudoOk
:= "AllwaysTrue()" // Validacao geral da GetDados da Modelo 2
Local lRetMod2 := .F. // Retorno da funo Modelo2 - .T. Confirmou / .F.
Cancelou
Local nColuna
:= 0
// Variaveis para GetDados()
Private aCols
:= {}
Private aHeader
:= {}
Exemplo (continuao):
// Variaveis para campos da Enchoice()
Private cX5Filial := xFilial("SX5")
Private cX5Tabela := SPACE(5)
// Montagem do array de cabealho
// AADD(aCab,{"Varivel"
,{L,C} ,"Ttulo","Picture","Valid","F3",lEnable})
AADD(aCab,{"cX5Filial" ,{015,010} ,"Filial","@!",,,.F.})
AADD(aCab,{"cX5Tabela" ,{015,080} ,"Tabela","@!",,,.T.})
// Montagem do aHeader
AADD(aHeader,{"Chave"
,"X5_CHAVE","@!",5,0,"AllwaysTrue()",;
"","C","","R"})
AADD(aHeader,{"Descricao"
,"X5_DESCRI","@!",40,0,"AllwaysTrue()",;
"","C","","R"})
// Montagem do aCols
aCols := Array(1,Len(aHeader)+1)
// Inicializao do aCols
For nColuna := 1 to Len(aHeader)
If aHeader[nColuna][8] == "C"
aCols[1][nColuna] := SPACE(aHeader[nColuna][4])
ElseIf aHeader[nColuna][8] == "N"
aCols[1][nColuna] := 0
ElseIf aHeader[nColuna][8] == "D"
aCols[1][nColuna] := CTOD("")
ElseIf aHeader[nColuna][8] == "L"
aCols[1][nColuna] := .F.
ElseIf aHeader[nColuna][8] == "M"
aCols[1][nColuna] := ""
Endif
Next nColuna
aCols[1][Len(aHeader)+1] := .F. // Linha no deletada
lRetMod2 := Modelo2(cTitulo,aCab,aRoda,aGrid,nOpc,cLinhaOk,cTudoOk)
IF lRetMod2
//MsgInfo("Voc confirmou a operao","MBRW2SX5")
For nLinha := 1 to len(aCols)
// Campos de Cabealho
Reclock("SX5",.T.)
SX5->X5_FILIAL := cX5Filial
SX5->X5_TABELA := cX5Tabela
// Campos do aCols
//SX5->X5_CHAVE := aCols[nLinha][1]
//SX5->X5_DESCRI := aCols[nLinha][2]
For nColuna := 1 to Len(aHeader)
SX5->&(aHeader[nColuna][2]) := aCols[nLinha][nColuna]
Next nColuna
MsUnLock()
Next nLinha
ELSE
MsgAlert("Voc cancelou a operao","MBRW2SX5")
ENDIF
Return
22.3. Modelo3()
O nome Modelo 3, assim como a Modelo 2 foi conceituado pela Microsiga por se tratar de um
prottipo de tela para entrada de dados. Inicialmente vamos desmistifica dois pontos:
Funo Modelo3() Trata-se de uma funo pronta que contempla o prottipo
Modelo 3, porm, este um assunto que no iremos tratar aqui, visto que
uma funcionalidade simples que quando necessrio intervir em algo na rotina
no h muito recurso para tal.
Prottipo Modelo 3 Trata-se de uma tela, como a figura abaixo, onde seu
objetivo efetuar a manuteno em vrios registros de uma s vez relacionada
a outro registro de outra tabela, ou seja, aqui teremos o relacionamento de
registros pai e filho, ento preciso se preocupar com este relacionamento.
Por exemplo: efetuar a manuteno em um pedido de vendas, onde ter um
registro em uma tabela referente cabea do pedido e outra tabela com os
registros referentes aos itens deste pedido de vendas.
Para ganharmos tempo no ser apresentado aqui toda a explicao e montagens para a
funo EnchoiceBar, comando MsDialog, Say e MsGet e para os vetores aHeader e
aCOLS, entretanto todos estes estaro na codificao do cdigo fonte. A figura abaixo mostra
exatamente o que a tela prottipo Modelo 3:
Figura: Prottipo Modelo 3
Este prottipo constitudo de MsDialog, EnchoiceBar, Enchoice, MsGetDados, Say e Get.

Diante dos expostos at o momento houve um novo nome para ns, ele a funo Enchoice, o
que ?
Funo Enchoice() Objeto MsMGet()
A funo Enchoice ou o objeto MsMGet so recursos baseados no dicionrio de dados para
verificar campos obrigatrios, validaes, gatilhos, consulta padro e etc. Assim tambm para
criar pastas de cadastros. Estes podem ser usados tanto com variveis de memrias com o
escopo Private como diretamente os campos da tabela que se refere. A diferena entre a funo
Enchoice e o objeto MsMGet que a funo no retorna o nome da varivel de objeto
exportvel criado.
A estrutura para montar um programa com o prottipo modelo 3 semelhante ao prottipo
modelo 2, porm a diferena real a utilizao da funo Enchoice ou o objeto MsMGet, para
este documento iremos trabalhar com a funo.
Sintaxe: Enchoice( cAlias, nReg, nOpc, aAc, cOpc, cTextExclui, aAcho, aPos,
aCpos, nNum, nColMens, cMensagem, cTudOk, oObj, lVirtual)
Parmetros:
cAlias
nReg
uPar1
uPar2
uPar3
aAcho
aPos
aCpos
uPar4
uPar5
uPar6
uPar7
oWnd
uPar8
lMemoria
lColuna
uPar9
lSemPastas
Alias do dados a serem cadastrados.

Nmero do registro da tabela a ser editado.
Parmetro reservado.
Parmetro reservado.
Parmetro reservado.
Vetor com os campos que sero apresentados pela MsMGet.
Vetor com as coordenadas onde a MsMGet ser criada no
formato {coord. superior, coord. esquerda, coord. direita,
coord. inferior}.Funo executada para validar o contexto da
linha atual do aCols.
Parmetro reservado. Nome dos campos do tipo caracter que
utilizaro incremento automtico. Este parmetro deve ser no
formato +<nome do primeiro campo>+<nome do segundo
campo>+....
Parmetro reservado.
Parmetro reservado.
Parmetro reservado.
Objeto no qual a MsMGet ser criada.
Parmetro reservado.
Indica se ser usado variveis de memria ou os campos da
tabela para cadastramento dos dados. Valor padro falso.
Indica se a MsMGet ser apresentada com um objeto por linha
(uma coluna). Valor padro falso. Parmetro reservado.
Parmetro reservado.
Indica se no ser usado as Pastas de Cadastro na MsMGet.
aCols.
Vale lembrar que ns programadores reaproveitamos muito o que j existe, isto para
simplesmente ganharmos tempo, e no caso da utilizao da funo Enchoice preciso criar as
variveis de memrias que levam o mesmo nome dos campos da tabela em questo. Por
exemplo o campo A2_NOME da tabela SA2 (cadastro de fornecedores) quando queremos
referenciar o campo usa-se o prefixo da tabela e o campo em questo, desta forma:
SA2->A2_NOME
Agora quando queremos referenciar a uma varivel que est com o contedo do mesmo
campo criamos outro recurso, desta forma:
M->A2_NOME
E para criar variveis com o nome do campo utilizamos um cdigo de bloco (code-block) e
mais um lao de leitura para atribuir valores iniciais a cada uma dela. Ento fica assim o
procedimento:
Private bCampo
:= { |nField| Field(nField) }
E em outro momento aproveitamos est varivel bCampo para facilitar a atribuio, veja o
exemplo abaixo :
For nX := 1 To FCount()
M->&( Eval( bCampo, nX ) ) := Atribuio inicial ou atribuio de valor
Next nX
Ou seja, fazer para todos os campos, e a cada campo criar a varivel com a atribuio inicial
ou atribuio de valor.
22.3.1.
Estrutura de um programa utilizando a Modelo3()
O exemplo abaixo demonstra a montagem de um programa para a utilizao do prottipo

Modelo 3. Antes de iniciarmos o exemplo vamos estruturar o programa.
Linhas
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
Programa
Funo principal;
Acesso a tabela principal e sua ordem;
Chamada da funo MBrowse;
Funo de visualizao, alterao e excluso;
Acesso ao primeiro registro da chave em que est posicionado na MBrowse;
Construo das variveis de memria M->???;
Montagem do vetor aCOLS de todos os registros referente a chave principal em que est
posicionado na MBrowse;
Execuo da funo Enchoice;
Se for operao diferente de visualizao e clicou no boto OK;
A operao e de Alterao?
Chamar a funo para alterar os dados;
Caso contrrio
Chamar a funo para excluir os dados;
Fim da funo de visualizao, alterao e excluso.
Funo de incluso;
Construo das variveis de memria M->???;
Montagem do vetor aCOLS com o seu contedo conforme o inicializador padro do campo ou
vazio, pois trata-se de uma incluso;
Se clicou no boto OK;
Chamar a funo para incluir os dados;
Fim da funo de incluso.
Rotina principal
//+--------------------------------------------------------------------+
//| Rotina | xModelo3 | Autor | Robson Luiz (rleg) | Data | 01.01.2007 |
//+--------------------------------------------------------------------+
//| Descr. | Funo exemplo do prottipo Modelo3.
|
//+--------------------------------------------------------------------+
//| Uso
|
//+--------------------------------------------------------------------+
#Include "Protheus.ch"
User Function xModelo3()
Private cCadastro := "Prottipo Modelo 3"
Private aRotina := {}
Private oCliente
Private oTotal
Private cCliente := ""
Private nTotal := 0
Private bCampo := {|nField| FieldName(nField) }
Private
Private
Private
Private
Private
aSize := {}
aInfo := {}
aObj := {}
aPObj := {}
aPGet := {}
// Retorna a rea til das janelas Protheus

aSize := MsAdvSize()
// Ser utilizado trs reas na janela
// 1 - Enchoice, sendo 80 pontos pixel
// 2 - MsGetDados, o que sobrar em pontos pixel para este objeto
// 3 - Rodap que a prpria janela, sendo 15 pontos pixel
AADD( aObj, { 100, 080, .T., .F. })
AADD( aObj, { 100, 100, .T., .T. })
AADD( aObj, { 100, 015, .T., .F. })
// Clculo automtico da dimenses dos objetos (altura/largura) em pixel
aInfo := { aSize[1], aSize[2], aSize[3], aSize[4], 3, 3 }
aPObj := MsObjSize( aInfo, aObj )
// Clculo automtico de dimenses dos objetos MSGET
aPGet := MsObjGetPos( (aSize[3] - aSize[1]), 315, { {004, 024, 240, 270} } )
AADD(
AADD(
AADD(
AADD(
AADD(
aRotina,
aRotina,
aRotina,
aRotina,
aRotina,
{"Pesquisar"
{"Visualizar"
{"Incluir"
{"Alterar"
{"Excluir"
,"AxPesqui" ,0,1})
,'U_Mod3Mnt',0,2})
,'U_Mod3Inc',0,3})
,'U_Mod3Mnt',0,4})
,'U_Mod3Mnt',0,5})
dbSelectArea("ZA1")
dbSetOrder(1)
dbGoTop()
MBrowse(,,,,"ZA1")
Return
Funo de Incluso
//+--------------------------------------------------------------------+
//| Rotina | Mod3Inc | Autor | Robson Luiz (rleg) | Data | 01.01.2007 |
//+--------------------------------------------------------------------+
//| Descr. | Rotina para incluir dados.
|
//+--------------------------------------------------------------------+
//| Uso
|
//+--------------------------------------------------------------------+
User Function Mod3Inc( cAlias, nReg, nOpc )
Local oDlg
Local oGet
Local nX := 0
Local nOpcA := 0
Private
Private
Private
Private
aHeader := {}
aCOLS := {}
aGets := {}
aTela := {}
dbSetOrder(1)
M->&( Eval( bCampo, nX ) ) := CriaVar( FieldName( nX ), .T. )
Next nX
Mod3aHeader()
Mod3aCOLS( nOpc )
DEFINE MSDIALOG oDlg TITLE cCadastro FROM ;
aSize[7],aSize[1] TO aSize[6],aSize[5] OF oMainWnd PIXEL
EnChoice( cAlias, nReg, nOpc, , , , , aPObj[1])
// Atualizao do nome do cliente
@ aPObj[3,1],aPGet[1,1] SAY "Cliente: " SIZE 70,7 OF oDlg PIXEL
@ aPObj[3,1],aPGet[1,2] SAY oCliente VAR cCliente SIZE 98,7 OF oDlg PIXEL
// Atualizao do total
@ aPObj[3,1],aPGet[1,3] SAY "Valor Total: " SIZE 70,7 OF oDlg PIXEL
@ aPObj[3,1],aPGet[1,4] SAY oTotal VAR nTotal ;
PICT "@E 9,999,999,999.99" SIZE 70,7 OF oDlg PIXEL
oGet := MSGetDados():New(aPObj[2,1],aPObj[2,2],aPObj[2,3],aPObj[2,4],;
nOpc,"U_Mod3LOk()",".T.","+ZA2_ITEM",.T.)
ACTIVATE MSDIALOG oDlg ON INIT EnchoiceBar(oDlg,;
{|| IIF( Mod3TOk().And.Obrigatorio( aGets, aTela ), ( nOpcA := 1, oDlg:End() ),
NIL) },;
{|| oDlg:End() })
If nOpcA == 1 .And. nOpc == 3
Mod3Grv( nOpc )
ConfirmSXE()
Endif
Return
Funo de Visualizao, Alterao e Excluso
//+--------------------------------------------------------------------+
//| Rotina | Mod3Mnt | Autor | Robson Luiz (rleg) | Data | 01.01.2007 |
//+--------------------------------------------------------------------+
//| Descr. | Rotina para Visualizar, Alterar e Excluir dados.
|
//+--------------------------------------------------------------------+
//| Uso
|
//+--------------------------------------------------------------------+
User Function Mod3Mnt( cAlias, nReg, nOpc )
Local oDlg
Local oGet
Local nX := 0
Local nOpcA := 0
Private aCOLS := {}
Private aGets := {}
Private aTela := {}
Private aREG := {}
dbSetOrder(1)
M->&( Eval( bCampo, nX ) ) := FieldGet( nX )
Next nX
Mod3aHeader()
Mod3aCOLS( nOpc )
DEFINE MSDIALOG oDlg TITLE cCadastro FROM ;
aSize[7],aSize[1] TO aSize[6],aSize[5] OF oMainWnd PIXEL
EnChoice( cAlias, nReg, nOpc, , , , , aPObj[1])
// Atualizao do nome do cliente
@ aPObj[3,1],aPGet[1,1] SAY "Cliente: " SIZE 70,7 OF oDlg PIXEL
@ aPObj[3,1],aPGet[1,2] SAY oCliente VAR cCliente SIZE 98,7 OF oDlg PIXEL
// Atualizao do total
@ aPObj[3,1],aPGet[1,3] SAY "Valor Total: " SIZE 70,7 OF oDlg PIXEL
@ aPObj[3,1],aPGet[1,4] SAY oTotal VAR nTotal PICTURE ;
"@E 9,999,999,999.99" SIZE 70,7 OF oDlg PIXEL
U_Mod3Cli()
oGet := MSGetDados():New(aPObj[2,1],aPObj[2,2],aPObj[2,3],aPObj[2,4],;
nOpc,"U_Mod3LOk()",".T.","+ZA2_ITEM",.T.)
ACTIVATE MSDIALOG oDlg ON INIT EnchoiceBar(oDlg,;
{|| IIF( Mod3TOk().And.Obrigatorio( aGets, aTela ), ( nOpcA := 1, oDlg:End() ),
NIL ) },;
{|| oDlg:End() })
If nOpcA == 1 .And. ( nOpc == 4 .Or. nOpc == 5 )
Mod3Grv( nOpc, aREG )
Endif
Return
Funo para montar o vetor aHeader
//+--------------------------------------------------------------------+
//| Rotina | Mod3aHeader | Autor | Robson Luiz (rleg) |Data|01.01.2007 |
//+--------------------------------------------------------------------+
//| Descr. | Rotina para montar o vetor aHeader.
|
//+--------------------------------------------------------------------+
//| Uso
|
//+--------------------------------------------------------------------+
Static Function Mod3aHeader()
dbSelectArea("SX3")
dbSetOrder(1)
dbSeek("ZA2")
While !EOF() .And. X3_ARQUIVO == "ZA2"
If X3Uso(X3_USADO) .And. cNivel >= X3_NIVEL
AADD( aHeader, { Trim( X3Titulo() ),;
X3_CAMPO,;
X3_PICTURE,;
X3_TAMANHO,;
X3_DECIMAL,;
X3_VALID,;
X3_USADO,;
X3_TIPO,;
X3_ARQUIVO,;
X3_CONTEXT})
Endif
dbSkip()
End
RestArea(aArea)
Return
Funo para montar o vetor aCols
//+--------------------------------------------------------------------+
//| Rotina | Mod3aCOLS | Autor | Robson Luiz (rleg) |Data | 01.01.2007 |
//+--------------------------------------------------------------------+
//| Descr. | Rotina para montar o vetor aCOLS.
|
//+--------------------------------------------------------------------+
//| Uso
|
//+--------------------------------------------------------------------+
Static Function Mod3aCOLS( nOpc )
Local cChave := ""
Local cAlias := "ZA2"
Local nI := 0
If nOpc <> 3
cChave := ZA1->ZA1_NUM
dbSetOrder(1)
dbSeek( xFilial( cAlias ) + cChave )
Continuao:
While !EOF() .And. ZA2->( ZA2_FILIAL + ZA2_NUM ) == xFilial( cAlias ) +
cChave
AADD( aREG, ZA2->( RecNo() ) )
If aHeader[nI,10] == "V"
aCOLS[Len(aCOLS),nI] := CriaVar(aHeader[nI,2],.T.)
Else
aCOLS[Len(aCOLS),nI] :=
FieldGet(FieldPos(aHeader[nI,2]))
Endif
Next nI
aCOLS[Len(aCOLS),Len(aHeader)+1] := .F.
dbSkip()
End
Else
aCOLS[1, nI] := CriaVar( aHeader[nI, 2], .T. )
Next nI
aCOLS[1, GdFieldPos("ZA2_ITEM")] := "01"
aCOLS[1, Len( aHeader )+1 ] := .F.
Endif
Restarea( aArea )
Return
Funo para atribuir o nome do cliente a varivel
//+--------------------------------------------------------------------+
//| Rotina | Mod3Cli | Autor | Robson Luiz (rleg)
|Data | 01.01.2007 |
//+--------------------------------------------------------------------+
//| Descr. | Rotina para atualizar a varivel com o nome do cliente.
|
//+--------------------------------------------------------------------+
//| Uso
|
//+--------------------------------------------------------------------+
User Function Mod3Cli()
cCliente := Posicione( "SA1", 1, xFilial("SA1") + M->(ZA1_CLIENT + ZA1_LOJA),
"A1_NREDUZ" )
oCliente:Refresh()
Return(.T.)
Funo para validar a mudana de linha na MsGetDados()

//+--------------------------------------------------------------------+
//| Rotina | Mod3LOk | Autor | Robson Luiz (rleg)
|Data | 01.01.2007 |
//+--------------------------------------------------------------------+
//| Descr. | Rotina para atualizar a varivel com o total dos itens.
|
//+--------------------------------------------------------------------+
//| Uso
|
//+--------------------------------------------------------------------+
User Function Mod3LOk()
Local nI := 0
nTotal := 0
If aCOLS[nI,Len(aHeader)+1]
Loop
Endif
nTotal+=Round(aCOLS[nI,GdFieldPos("ZA2_QTDVEN")]*;
aCOLS[nI,GdFieldPos("ZA2_PRCVEN")],2)
Next nI
oTotal:Refresh()
Return(.T.)
Funo para validar se todas as linhas esto preenchidas
//+--------------------------------------------------------------------+
//| Rotina | Mod3TOk | Autor | Robson Luiz (rleg)
|Data | 01.01.2007 |
//+--------------------------------------------------------------------+
//| Descr. | Rotina para validar os itens se foram preenchidos.
|
//+--------------------------------------------------------------------+
//| Uso
|
//+--------------------------------------------------------------------+
Static Function Mod3TOk()
Local nI := 0
Local lRet := .T.
For nI := 1 To Len(aCOLS)
Loop
Endif
If Empty(aCOLS[nI,GdFieldPos("ZA2_PRODUT")]) .And. lRet
MsgAlert("Campo PRODUTO preenchimento obrigatorio",cCadastro)
lRet := .F.
Endif
If Empty(aCOLS[nI,GdFieldPos("ZA2_QTDVEN")]) .And. lRet
MsgAlert("Campo QUANTIDADE preenchimento obrigatorio",cCadastro)
lRet := .F.
Endif
If Empty(aCOLS[nI,GdFieldPos("ZA2_PRCVEN")]) .And. lRet
MsgAlert("Campo PRECO UNITARIO preenchimento obrigatorio",cCadastro)
lRet := .F.
Endif
If !lRet
Exit
Endif
Next i
Return( lRet )
Funo para efetuar a gravao dos dados em ZA1 e ZA2 na incluso, alterao e
excluso.
//+--------------------------------------------------------------------+
//| Rotina | Mod3Grv | Autor | Robson Luiz (rleg)
|Data | 01.01.2007 |
//+--------------------------------------------------------------------+
//| Descr. | Rotina para efetuar a gravao nas tabelas.
|
//+--------------------------------------------------------------------+
//| Uso
|
//+--------------------------------------------------------------------+
Static Function Mod3Grv( nOpc, aAltera )
Local nX := 0
Local nI := 0
// Se for incluso
If nOpc == 3
// Grava os itens
dbSelectArea("ZA2")
dbSetOrder(1)
For nX := 1 To Len( aCOLS )
If !aCOLS[ nX, Len( aCOLS ) + 1 ]
RecLock( "ZA2", .T. )
FieldPut( FieldPos( Trim( aHeader[nI, 2] ) ),
aCOLS[nX,nI] )
Next nI
ZA2->ZA2_NUM := M->ZA1_NUM
MsUnLock()
Endif
Next nX
// Grava o Cabealho
dbSelectArea( "ZA1" )
If "FILIAL" $ FieldName( nX )
FieldPut( nX, xFilial( "ZA1" ) )
Else
FieldPut( nX, M->&( Eval( bCampo, nX ) ) )
Endif
Next nX
MsUnLock()
Endif
// Se for alterao
If nOpc == 4
// Grava os itens conforme as alteraes
dbSelectArea("ZA2")
dbSetOrder(1)
For nX := 1 To Len( aCOLS )
If nX <= Len( aREG )
dbGoto( aREG[nX] )
RecLock("ZA2",.F.)
If aCOLS[ nX, Len( aHeader ) + 1 ]
dbDelete()
Endif
Else
Continuao:
If !aCOLS[ nX, Len( aHeader ) + 1 ]
Endif
Endif
If !aCOLS[ nX, Len(aHeader)+1 ]
FieldPut( FieldPos( Trim( aHeader[ nI, 2] ) ),;
aCOLS[ nX, nI ] )
Next nI
ZA2->ZA2_NUM := M->ZA1_NUM
Endif
MsUnLock()
Next nX
// Grava o Cabealho
dbSelectArea("ZA1")
RecLock( "ZA1", .F. )
If "FILIAL" $ FieldName( nX )
FieldPut( nX, xFilial("ZA1"))
Else
FieldPut( nX, M->&( Eval( bCampo, nX ) ) )
Endif
Next
MsUnLock()
Endif
// Se for excluso
If nOpc == 5
// Deleta os Itens
dbSelectArea("ZA2")
dbSetOrder(1)
dbSeek(xFilial("ZA2") + M->ZA1_NUM)
While !EOF() .And. ZA2->(ZA2_FILIAL + ZA2_NUM) == xFilial("ZA2") +;
M->ZA1_NUM
RecLock("ZA2")
dbDelete()
MsUnLock()
dbSkip()
End
// Deleta o Cabealho
dbSelectArea("ZA1")
RecLock("ZA1",.F.)
dbDelete()
MsUnLock()
Endif
Return
22.3.2.
Funo Modelo3()
A funo Modelo3) uma interface pr-definida pela Microsiga que implementa de forma
padronizada os compontes necessrios a manipulao de estruturas de dados nas quais o
cabealho e os itens da informao esto em tabelas separadas.
Seu objetivo atuar como um facilitador de codificao, permitindo a utilizao dos recursos
bsicos dos seguintes componentes visuais:
MsDialog()
Enchoice()
EnchoiceBar()
MsNewGetDados()
A funo Modelo3() no implementa as regras de visualizao,

incluso, alterao e excluso, como uma AxCadastro() ou
AxFunction().
A inicializao dos campos utilizados na Enchoice() deve ser realizadas
pela rotina que suporta a execuo da Modelo3(), normalmente
atravs do uso da funo RegToMemory().
Da mesma forma, o Browse deve ser tratado por esta rotina, sendo
comum a Modelo3() estar vinculada ao uso de uma MBrowse().
Sintaxe: Modelo3 ([cTitulo], [cAliasE], [cAliasGetD], [aCposE], [cLinOk],

[cTudOk], [nOpcE], [nOpcG], [cFieldOk])
Parmetros:
cTitulo
cAliasE
cAliasGetD
aCposE
cLinhaOk
cTudoOk
nOpcE
nOpcG
cFieldOk
Ttulo da janela
Alias da tabela que ser utilizada na Enchoice
Alias da tabela que ser utilizada na GetDados
Nome dos campos, pertencentes ao Alias especificado o parmetro cAliasE,
que devero ser exibidos na Enchoice:
AADD(aCposE,{nome_campo})
Funo para validao da linha na GetDados()
Funo para validao na confirmao da tela de interface da Modelo2().
Enchoice da Modelo3, aonde:
2 Visualizar
3 - Incluir
4 - Alterar
5 - Excluir
GetDados da Modelo3, aonde:
2 Visualizar
3 - Incluir
4 - Alterar
5 - Excluir
Validao dos campos da Enchoice()
Retorno:
Lgico
Indica se a tela da interface Modelo2() foi confirmada ou cancelada pelo

usurio.
Exemplo: Utilizao da Modelo3() para Pedidos de Vendas (SC5,SC6)
#INCLUDE "protheus.ch"
//+--------------------------------------------------------------------+
//| Rotina | MBRWMOD3| Autor | ARNALDO RAYMUNDO JR. |Data | 01.01.2007 |
//+--------------------------------------------------------------------+
//| Descr. | EXEMPLO DE UTILIZACAO DA MODELO3().
|
//+--------------------------------------------------------------------+
//| Uso
| CURSO DE ADVPL
|
//+--------------------------------------------------------------------+
User Function MbrwMod3()
Private cCadastro
:= "Pedidos de Venda"
Private aRotina
:= {}
Private cDelFunc := ".T." // Validacao para a exclusao. Pode-se utilizar
ExecBlock
Private cAlias
:= "SC5"
AADD(aRotina,{
AADD(aRotina,{
AADD(aRotina,{
AADD(aRotina,{
AADD(aRotina,{
"Pesquisa","AxPesqui"
"Visual" ,"U_Mod3All"
"Inclui" ,"U_Mod3All"
"Altera" ,"U_Mod3All"
"Exclui" ,"U_Mod3All"
,0,1})
,0,2})
,0,3})
,0,4})
,0,5})
dbSetOrder(1)
mBrowse( 6,1,22,75,cAlias)
Return
User Function Mod3All(cAlias,nReg,nOpcx)
Local
Local
Local
Local
Local
Local
Local
Local
cTitulo :=
cAliasE :=
cAliasG :=
cLinOk :=
cTudOk :=
cFieldOk:=
aCposE :=
nUsado, nX
"Cadastro de Pedidos de Venda"

"SC5"
"SC6"
"AllwaysTrue()"
"AllwaysTrue()"
"AllwaysTrue()"
{}
:= 0
//
// Opcoes de acesso para a Modelo 3
//
Do Case
Case nOpcx==3; nOpcE:=3 ; nOpcG:=3
// 3 - "INCLUIR"
// 4 - "ALTERAR"
// 2 - "VISUALIZAR"
// 5 - "EXCLUIR"
EndCase
//
// Cria variaveis M->????? da Enchoice
//
RegToMemory("SC5",(nOpcx==3 .or. nOpcx==4 )) // Se for inclusao ou alteracao
permite alterar o conteudo das variaveis de memoria
//
// Cria aHeader e aCols da GetDados
//
nUsado:=0
dbSelectArea("SX3")
dbSeek("SC6")
aHeader:={}
While !Eof().And.(x3_arquivo=="SC6")
If Alltrim(x3_campo)=="C6_ITEM"
dbSkip()
Loop
Endif
If X3USO(x3_usado).And.cNivel>=x3_nivel
nUsado:=nUsado+1
Aadd(aHeader,{ TRIM(x3_titulo), x3_campo, x3_picture,;
x3_tamanho, x3_decimal,"AllwaysTrue()",;
x3_usado, x3_tipo, x3_arquivo, x3_context } )
Endif
dbSkip()
End
If nOpcx==3 // Incluir
aCols:={Array(nUsado+1)}
aCols[1,nUsado+1]:=.F.
For nX:=1 to nUsado
aCols[1,nX]:=CriaVar(aHeader[nX,2])
Next
Else
aCols:={}
dbSelectArea("SC6")
dbSetOrder(1)
dbSeek(xFilial()+M->C5_NUM)
While !eof().and.C6_NUM==M->C5_NUM
AADD(aCols,Array(nUsado+1))
For nX:=1 to nUsado
aCols[Len(aCols),nX]:=FieldGet(FieldPos(aHeader[nX,2]))
Next
aCols[Len(aCols),nUsado+1]:=.F.
dbSkip()
End
Endif
If Len(aCols)>0
//
// Executa a Modelo 3
//
aCposE := {"C5_CLIENTE"}
lRetMod3 := Modelo3(cTitulo, cAliasE, cAliasG, aCposE, cLinOk, cTudOk,;

nOpcE, nOpcG,cFieldOk)
//
// Executar processamento
//
If lRetMod3
Aviso("Modelo3()","Confirmada operacao!",{"Ok"})
Endif
Endif
Return
22.4. Mbrowse()
A Mbrowse() uma funcionalidade de cadastro que permite a utilizao de recursos mais
aprimorados na visualizao e manipulao das informaes do sistema, possuindo os
seguintes componentes:
Parametrizao para funes especficas para as aes de visualizao, incluso,

alterao e excluso de informaes, o que viabiliza a manuteno de informaes com
estrutura de cabealhos e itens.
Recursos adicionais como identificadores de status de registros, legendas e filtros para

as informaes.
Sintaxe: MBrowse(nLin1, nCol1, nLin2, nCol2, cAlias, aFixe, cCpo, nPar08,

cFun, nClickDef, aColors, cTopFun, cBotFun, nPar14, bInitBloc,
lNoMnuFilter, lSeeAll, lChgAll)
Parmetros:
nLin1
Nmero da Linha Inicial
nCol1
Nmero da Coluna Inicial
nLin2
Nmero da Linha Final
nCol2
Nmero da Coluna Final
cAlias
Alias do arquivo que ser visualizado no browse.

Para utilizar a funo MBrowse com arquivos de trabalho, o alias do
arquivo de trabalho deve ser obrigatoriamente 'TRB' e o parmetro
aFixe torna-se obrigatrio.
Array bi-dimensional contendo os nomes dos campos fixos prdefinidos, obrigando a exibio de uma ou mais colunas ou a definio
das colunas quando a funo utilizada com arquivos de trabalho.
A estrutura do array diferente para arquivos que fazem parte do
dicionrio de dados e para arquivos de trabalho.
Arquivos que fazem parte do dicionrios de dados
aFixe
[n][1]=>Descrio do campo
[n][2]=>Nome do campo
Arquivos de trabalho
[n][1]=>Descrio do campo
[n][2]=>Nome do campo
[n][3]=>Tipo
[n][4]=>Tamanho
[n][5]=>Decimal
[n][6]=>Picture
Parmetros:
cCpo
Campo a ser validado se est vazio ou no para exibio do bitmap de

status. Quando esse parmetro utilizado, a primeira coluna do browse
ser um bitmap indicando o status do registro, conforme as condies
configuradas nos parmetros cCpo, cFun e aColors.
nPar08
Parmetro reservado.
cFun
nClickDef
aColors
cTopFun
cBotFun
nPar14
bInitBloc
lNoMnuFilter
lSeeAll
lChgAll
Funo que retornar um valor lgico para exibio do bitmap de

status.
Quando esse parmetro utilizado, o parmetro cCpo
automaticamente desconsiderado.
Nmero da opo do aRotina que ser executada quando for efetuado
um duplo clique em um registro do browse. O default executar a
rotina de visualizao.
Array bi-dimensional para possibilitar o uso de diferentes bitmaps de
status.
[n][1]=>Funo que retornar um valor lgico para a exibio do
bitmap
[n][2]=>Nome do bitmap que ser exibido quando a funo retornar
.T. (True).
O nome do bitmap deve ser um resource do repositrio e quando esse
parmetro utilizado os parmetros cCpo e cFun so
automaticamente desconsiderados.
Funo que retorna o limite superior do filtro baseado na chave de
ndice selecionada.
Esse parmetro deve ser utilizado em conjunto com o parmetro
cBotFun.
Funo que retorna o limite inferior do filtro baseado na chave de ndice
selecionada.
Esse parmetro deve ser utilizado em conjunto com o parmetro
cTopFun.
Parmetro reservado.
Bloco de cdigo que ser executado no ON INIT da janela do browse. O
bloco de cdigo receber como parmetro o objeto da janela do
browse.
Valor lgico que define se a opo de filtro ser exibida no menu da
MBrowse.
.T. => No exibe a opo no menu
.F. => (default) Exibe a opo no menu.
A opo de filtro na MBrowse est disponvel apenas para TopConnect.
Identifica se o Browse dever mostrar todas as filiais.
O valor default .F. ( False ), no mostra todas as filiais. Caso os
parmetros cTopFun ou cBotFun sejam informados esse parmetro
ser configurado automaticamente para .F. ( False )
Parmetro vlido partir da verso 8.11.
A funo SetBrwSeeAll muda o valor default desse parmetro.
Identifica se o registro de outra filial est autorizado para alteraes.
O valor default .F. ( False ), no permite alterar registros de outras
filiais. Quando esse parmetro est configurado para .T. ( True ), o
parmetro lSeeAll configurado automaticamente para .T. ( True ).
Caso os parmetros cTopFun ou cBotFun sejam informados esse
parmetro ser configurado automaticamente para .F. ( False ).
Parmetro vlido partir da verso 8.11.
A funo SetBrwChgAll muda o valor default desse parmetro.
Variveis private adicionais

Array contendo as funes que sero executadas pela Mbrowse, nele
ser definido o tipo de operao a ser executada (incluso, alterao,
excluso, visualizao, pesquisa, etc. ), e sua estrutura composta de
5 (cinco) dimenses:
[n][1] - Ttulo;
[n][2] Rotina;
[n][3] Reservado;
[n][4] Operao (1 - pesquisa; 2 - visualizao; 3 - incluso; 4 alterao; 5 - excluso);
aRotina
Ele ainda pode ser parametrizado com as funes bsicas da

AxCadastro conforme abaixo:
,"AxInclui",0,3})
,"AxAltera",0,4})
,"AxDeleta",0,5})
cCadastro
Ttulo do browse que ser exibido.
Informaes passadas para funes do aRotina:
Ao definir as funes no array aRotina, se o nome da funo no for especificado com (), a
Mbrowse passar como parmetros as seguintes variveis de controle:
cAlias
Nome da rea de trabalho definida para a Mbrowse
nReg
Recno do registro posicionado no Browse
nOpc
Posio da opo utilizada na Mbrowse de acordo com a ordem da

funo no array a Rotina.
A posio das funes no array aRotina define o contedo de uma varivel de
controle que ser repassada para as funes chamadas a partir da Mbrowse,
convencionada como nOpc. Desta forma, para manter o padro da aplicao
ERP a ordem a ser seguida na definio do aRotina :
1.
2.
3.
4.
5.
6.
Pesquisar
Visualizar
Incluir
Alterar
Excluir
Livre
Exemplo: Funo Mbrowse()

/*/
+----------------------------------------------------------------------------| Funo
| MBRWSA1
|
+----------------------------------------------------------------------------| Descrio | Exemplo de utilizao da funo MBROWSE()
|
+----------------------------------------------------------------------------| Uso
| Curso ADVPL
|
+----------------------------------------------------------------------------/*/
Local cAlias
:= "SA1"
Private cCadastro := "Cadastro de Clientes"
Private aRotina
:= {}
,"AxPesqui",0,1})
,"AxVisual",0,2})
AADD(aRotina,{"Incluir" ,"AxInclui",0,3})
AADD(aRotina,{"Alterar" ,"AxAltera",0,4})
AADD(aRotina,{"Excluir" ,"AxDeleta",0,5})
dbSetOrder(1)
Return Nil
Exemplo: Funo Inclui() substituindo a funo AxInclui() Chamada da Mbrowse()
/*/
+----------------------------------------------------------------------------| Funo
| MBRWSA1
|
+----------------------------------------------------------------------------| Descrio | Exemplo de utilizao da funo MBROWSE()
|
+----------------------------------------------------------------------------| Uso
| Curso ADVPL
|
+----------------------------------------------------------------------------/*/
Local cAlias
:= "SA1"
Private cCadastro
:= "Cadastro de Clientes"
Private aRotina
:= {}
,"AxPesqui" ,0,1})
,"AxVisual" ,0,2})
AADD(aRotina,{"Incluir" ,"U_Inclui"
,0,3})
AADD(aRotina,{"Alterar" ,"AxAltera" ,0,4})
AADD(aRotina,{"Excluir" ,"AxDeleta" ,0,5})
dbSetOrder(1)
Return Nil
Exemplo: Funo Inclui() substituindo a funo AxInclui() Funo Inclui()
/*/
+----------------------------------------------------------------------------| Funo
| INCLUI
|
+----------------------------------------------------------------------------| Descrio | Funo de incluso especfica chamando a AXINCLUI()
|
+----------------------------------------------------------------------------| Uso
| Curso ADVPL
|
+----------------------------------------------------------------------------/*/
User Function Inclui(cAlias, nReg, nOpc)
Local nOpcao
:= 0
nOpcao := AxInclui(cAlias,nReg,nOpc,,,,cTudoOk)
If nOpcao == 1
MsgInfo(Incluso concluda com sucesso!)
ElseIf
== 2
MsgInfo(Incluso cancelada!)
Endif
Return Nil
Exemplo: Determinando a opo do aRotina pela informao recebida em nOpc

/*/
+----------------------------------------------------------------------------| Funo
| EXCLUI
|
+----------------------------------------------------------------------------| Descrio | Funo de excluso especifica chamando a AxDeleta
|
+----------------------------------------------------------------------------| Uso
| Curso ADVPL
|
+----------------------------------------------------------------------------/*/
User Function Exclui(cAlias, nReg, nOpc)
Local nOpcao
:= 0
nOpcao := AxDeleta(cAlias,nReg,aRotina[nOpc,4])
// Identifica corretamente a opo definida para o funo em aRotinas com mais
// do que os 5 elementos padres.
If nOpcao == 1
MsgInfo(Excluso realizada com sucesso!)
ElseIf
== 2
MsgInfo(Excluso cancelada!)
Endif
Return Nil
22.4.1.
AxFunctions()
Conforme mencionado nos tpicos sobre as interfaces padres AxCadastro() e Mbrowse(),

existem funes padres da aplicao ERP que permitem a visualizao, incluso, alterao e
excluso de dados em formato simples.
Estas funes so padres na definio da interface AxCadastro() e podem ser utilizadas
tambm da construo no array aRotina utilizado pela Mbrowse(), as quais esto listadas a
seguir:
AXPESQUI()
AXVISUAL()
AXINCLUI()
AXALTERA()
AXDELETA()
AXPESQUI()
Sintaxe
AXPESQUI()
Descrio
Funo de pesquisa padro em registros exibidos pelos browses do sistema,

a qual posiciona o browse no registro pesquisado. Exibe uma tela que
permite a seleo do ndice a ser utilizado na pesquisa e a digitao das
informaes que compe a chave de busca.
AXVISUAL()
Sintaxe
Descrio
AXVISUAL(cAlias, nReg, nOpc, aAcho, nColMens, cMensagem, cFunc,;

aButtons, lMaximized )
Funo de visualizao padro das informaes de um registro, no formato
AXINCLUI()
Sintaxe
Descrio
AxInclui(cAlias, nReg, nOpc, aAcho, cFunc, aCpos, cTudoOk, lF3,;

Funo de incluso padro das informaes de um registro, no formato
AXALTERA()
Sintaxe
Descrio
AxAltera(cAlias, nReg, nOpc, aAcho, cFunc, aCpos, cTudoOk, lF3,;

Funo de alterao padro das informaes de um registro, no formato
AXDELETA()
Sintaxe
Descrio
AXDELETA(cAlias, nReg, nOpc, cTransact, aCpos, aButtons, aParam,;

aAuto, lMaximized)
Funo de excluso padro das informaes de um registro, no formato
22.4.2.
FilBrowse()
A FilBrowse() uma funcionalidade que permite a utilizao de filtros na MBrowse().
Sintaxe: FilBrowse(cAlias, aQuery, cFiltro, lShowProc)
Parmetros:
cAlias
Alias ativo definido para a Mbrowse()

Este parmetro dever ser inicializado sempre vazio e sua passagem
obrigatoriamente por referncia, pois, seu retorno ser enviado para a
funo EndFilBrw().
aQuery
[1]=>Nome do Arquivo Fsico

[2]=>Ordem correspondente ao Sindex
cFiltro
Condio de filtro para a MBrowse()
lShowProc
Habilita (.T.) ou desabilita (.F.) a apresentao da mensagem

Selecionando registros ..., no processamento.
22.4.3.
EndFilBrw()
A EndFilBrw() uma funcionalidade que permite eliminar o filtro e o arquivo temporrio

criados pela FilBrowse().
Sintaxe: EndFilBrw(cAlias, aQuery)
Parmetros:
cAlias

Array de retorno passado por referncia para a FilBrowse().
aQuery
[1]=>Nome do Arquivo Fsico

[2]=>Ordem correspondente ao Sindex
22.4.4.
PesqBrw()
A PesqBrw() uma funcionalidade que permite a pesquisa dentro da MBrowse(). Esta funo
dever obrigatoriamente substituir a funo AxPesqui, no array do aRotina, sempre que for
utilizada a funo FilBrowse().
Sintaxe: PesqBrw(cAlias , nReg, bBrwFilter)
Parmetros:
cAlias
nReg
Nmero do registro
Bloco de Cdigo que contm a FilBrowse()
bBrwFilter
22.4.5.
Ex: bBrwFilter := { || FilBrowse(cAlias, aQuery, cFiltro, lShowProc) }
BrwLegenda ()
A BrwLegenda() uma funcionalidade que permite a incluso de legendas na MBrowse().
Sintaxe: BrwLegenda(cCadastro , cTitulo, aLegenda)
Parmetros:
cCadastro
Mesma varivel utilizada para a MBrowse, que identifica o cadastro que

est em uso no momento
cTitulo
Ttulo (identificao) da Legenda

Array contendo de definio da cor e do texto, explicativo sobre o que
ela representa na MBrowse
aLegenda
Ex: {{Cor,Texto}}
Lista de cores disponveis no Protheus
BR_AMARELO
BR_AZUL
BR_BRANCO
BR_CINZA
BR_LARANJA
BR_MARRON
BR_VERDE
BR_VERMELHO
BR_PINK
BR_PRETO
Exemplo: Mbrowse() utilizando as funes acessrias
/*/
+----------------------------------------------------------------------------| Programa | MBrwSA2
| Autor | SERGIO FUZINAKA | Data |
|
+----------------------------------------------------------------------------| Descrio | Exemplo da MBrowse utilizando a tabela de Cadastro de
|
|
| Fornecedores
|
+----------------------------------------------------------------------------| Uso
| Curso de ADVPL
|
+----------------------------------------------------------------------------/*/
Local aCores := {}
Local cFiltra := "A2_FILIAL == '"+xFilial('SA2')+"' .And. A2_EST == 'SP'"
Private
Private
Private
Private
cCadastro :=
aRotina
:=
aIndexSA2 :=
bFiltraBrw:=
"Cadastro de Fornecedores"
{}
{}
{ || FilBrowse(cAlias,@aIndexSA2,@cFiltra) }
AADD(aRotina,{"Legenda"
,"PesqBrw"
,"AxVisual"
,"U_BInclui"
,"U_BAltera"
,"U_BDeleta"
,"U_BLegenda"
,0,1})
,0,2})
,0,3})
,0,4})
,0,5})
,0,3})
/*
-- CORES DISPONIVEIS PARA LEGENDA -BR_AMARELO
BR_AZUL
BR_BRANCO
BR_CINZA
BR_LARANJA
BR_MARRON
BR_VERDE
BR_VERMELHO
BR_PINK
BR_PRETO
*/
AADD(aCores,{"A2_TIPO == 'F'"
AADD(aCores,{"A2_TIPO == 'J'"
AADD(aCores,{"A2_TIPO == 'X'"
AADD(aCores,{"A2_TIPO == 'R'"
AADD(aCores,{"Empty(A2_TIPO)"
,"BR_VERDE"
,"BR_AMARELO"
,"BR_LARANJA"
,"BR_MARRON"
,"BR_PRETO"
})
})
})
})
})
dbSetOrder(1)
//+-----------------------------------------------------------//| Cria o filtro na MBrowse utilizando a funo FilBrowse
//+-----------------------------------------------------------Eval(bFiltraBrw)
dbGoTop()
mBrowse(6,1,22,75,cAlias,,,,,,aCores)
//+-----------------------------------------------//| Deleta o filtro utilizado na funo FilBrowse
//+-----------------------------------------------EndFilBrw(cAlias,aIndexSA2)
Return Nil
//+--------------------------------------//|Funo: BInclui - Rotina de Incluso
//+--------------------------------------User Function BInclui(cAlias,nReg,nOpc)
Local nOpcao := 0
nOpcao := AxInclui(cAlias,nReg,nOpc)
If nOpcao == 1
MsgInfo("Incluso efetuada com sucesso!")
Else
MsgInfo("Incluso cancelada!")
Endif
Return Nil
//+----------------------------------------//|Funo: BAltera - Rotina de Alterao
//+----------------------------------------User Function BAltera(cAlias,nReg,nOpc)
Local nOpcao := 0
nOpcao := AxAltera(cAlias,nReg,nOpc)
If nOpcao == 1
MsgInfo("Alterao efetuada com sucesso!")
Else
MsgInfo("Alterao cancelada!")
Endif
Return Nil
//+----------------------------------------//|Funo: BDeleta - Rotina de Excluso
//+----------------------------------------User Function BDeleta(cAlias,nReg,nOpc)
Local nOpcao := 0
nOpcao := AxDeleta(cAlias,nReg,nOpc)
If nOpcao == 1
MsgInfo("Excluso efetuada com sucesso!")
Else
MsgInfo("Excluso cancelada!")
Endif
Return Nil
//+------------------------------------------//|Funo: BLegenda - Rotina de Legenda
//+------------------------------------------User Function BLegenda()
Local aLegenda := {}
AADD(aLegenda,{"BR_VERDE"
AADD(aLegenda,{"BR_AMARELO"
AADD(aLegenda,{"BR_LARANJA"
AADD(aLegenda,{"BR_MARRON"
AADD(aLegenda,{"BR_PRETO"
,"Pessoa Fsica" })
,"Pessoa Jurdica"
,"Exportao"
,"Fornecedor Rural"
,"No Classificado"
BrwLegenda(cCadastro, "Legenda", aLegenda)

Return Nil
})
})
})
})
22.5. MarkBrowse()
A funo MarkBrow() permite que os elementos de um browse, sejam marcados ou
desmarcados. Para utilizao da MarkBrow() necessrio declarar as variveis cCadastro e
aRotina como Private, antes da chamada da funo.
Sintaxe: MarkBrow (cAlias, cCampo, cCpo, aCampos, lInvert, cMarca, cCtrlM,

uPar8, cExpIni, cExpFim, cAval, bParBloco)
Parmetros:
cAlias
cCampo
Campo do arquivo onde ser feito o controle (gravao) da marca.

Campo onde ser feita a validao para marcao e exibio do bitmap
de status.
Vetor de colunas a serem exibidas no browse, deve conter as seguintes
dimenses:
cCpo
aCampos
[n][1]
[n][2]
[n][3]
[n][4]
lInvert
Inverte a marcao.
cMarca
String a ser gravada no campo especificado para marcao.
cCtrlM
Funo a ser executada caso deseje marcar todos elementos.
uPar8
Parmetro reservado.
cExpIni
cExpFim
nome do campo;
- Nulo (Nil);
- Ttulo do campo;
- Mscara (picture).
Funo que retorna o contedo inicial do filtro baseada na chave de

ndice selecionada.
Funo que retorna o contedo final do filtro baseada na chave de
ndice selecionada.
cAval
Funo a ser executada no duplo clique em um elemento no browse.
bParBloco
Bloco de cdigo a ser executado na inicializao da janela
Informaes passadas para funes do aRotina:
Ao definir as funes no array aRotina, se o nome da funo no for especificado com (), a
MarkBrowse passar como parmetros as seguintes variveis de controle:
cAlias
Nome da rea de trabalho definida para a Mbrowse
nReg
Recno do registro posicionado no Browse
nOpc
Posio da opo utilizada na Mbrowse de acordo com a ordem da

funo no array a Rotina.
cMarca
Marca em uso pela MarkBrw()
lInverte
Indica se foi utilizada a inverso da seleo dos itens no browse.
Exemplo: Funo MarkBrow() e acessrias
/*/
+----------------------------------------------------------------------------| Programa | MkBrwSA1 | Autor | ARNALDO RAYMUNDO JR. | Data |
|
+----------------------------------------------------------------------------| Desc.
| MarkBrowse Genrico
|
+----------------------------------------------------------------------------| Uso
| Curso de ADVPL
|
+----------------------------------------------------------------------------/*/
USER FUNCTION MkBrwSA1()
Local
Local
Local
Local
aCpos
aCampos
nI
cAlias
:= {}
:= {}
:= 0
:= "SA1"
Private aRotina
:= {}
Private cCadastro
:= "Cadastro de Clientes"
Private aRecSel
:= {}
,"AxPesqui" ,0,1})
,"AxVisual" ,0,2})
,"AxInclui"
,0,3})
,"AxAltera" ,0,4})
,"AxDeleta" ,0,5})
AADD(aRotina,{"Visualizar Lote"
,"U_VisLote"
,0,5})
AADD(aCpos,
AADD(aCpos,
AADD(aCpos,
AADD(aCpos,
AADD(aCpos,
AADD(aCpos,
"A1_OK"
"A1_FILIAL"
"A1_COD"
"A1_LOJA"
"A1_NOME"
"A1_TIPO"
)
)
)
)
)
)
dbSelectArea("SX3")
dbSetOrder(2)
For nI := 1 To Len(aCpos)
IF dbSeek(aCpos[nI])
AADD(aCampos,{X3_CAMPO,"",IIF(nI==1,"",Trim(X3_TITULO)),;
Trim(X3_PICTURE)})
ENDIF
Next
DbSelectArea(cAlias)
DbSetOrder(1)
MarkBrow(cAlias,aCpos[1],"A1_TIPO == ' '",aCampos,.F.,GetMark(,"SA1","A1_OK"))
Return Nil
Exemplo: Funo VisLote() utilizao das funes acessrias da MarkBrow()
/*/
+----------------------------------------------------------------------------| Programa | VisLote()
|
+----------------------------------------------------------------------------| Desc.
| Funo utilizada para demonstrar o uso do recurso da MarkBrowse|
+----------------------------------------------------------------------------| Uso
| Curso de ADVPL
|
+----------------------------------------------------------------------------/*/
USER FUNCTION VisLote()
Local cMarca
:= ThisMark()
Local nX
:= 0
Local lInvert
:= ThisInv()
Local cTexto
:= ""
Local cEOL := CHR(10)+CHR(13)
Local oDlg
Local oMemo
DbSelectArea("SA1")
DbGoTop()
While SA1->(!EOF())
// IsMark("A1_OK", cMarca, lInverte)
IF SA1->A1_OK == cMarca .AND. !lInvert
AADD(aRecSel,{SA1->(Recno()),SA1->A1_COD, SA1->A1_LOJA, SA1->A1_NREDUZ})
ELSEIF SA1->A1_OK != cMarca .AND. lInvert
AADD(aRecSel,{SA1->(Recno()),SA1->A1_COD,SA1->A1_LOJA, SA1->A1_NREDUZ})
ENDIF
SA1->(dbSkip())
Enddo
IF Len(aRecSel) > 0
cTexto := "Cdigo | Loja | Nome Reduzido
"+cEol
//
"1234567890123456789012345678901234567890
//
"CCCCCC | LL | NNNNNNNNNNNNNNNNNNNN +cEol
For nX := 1 to Len(aRecSel)
cTexto += aRecSel[nX][2]+Space(1)+ "|"+Space(2) +
aRecSel[nX][3]+Space(3)+"|"
cTexto += Space(1)+SUBSTRING(aRecSel[nX][4],1,20)+Space(1)
cTexto += cEOL
Next nX
DEFINE MSDIALOG oDlg TITLE "Clientes Selecionados" From 000,000 TO 350,400
PIXEL
@ 005,005 GET oMemo VAR cTexto MEMO SIZE 150,150 OF oDlg PIXEL
oMemo:bRClicked := {||AllwaysTrue()}
DEFINE SBUTTON FROM 005,165 TYPE 1 ACTION oDlg:End() ENABLE OF oDlg PIXEL
LimpaMarca()
ENDIF
RETURN
Exemplo: Funo LimpaMarca() utilizao das funes acessrias da MarkBrow()
/*/
+----------------------------------------------------------------------------| Programa | LimpaMarca | Autor | ARNALDO RAYMUNDO JR. | Data |
|
+----------------------------------------------------------------------------| Desc.
| Funo utilizada para demonstrar o uso do recurso da MarkBrowse|
+----------------------------------------------------------------------------| Uso
| Curso de ADVPL
|
+----------------------------------------------------------------------------/*/
STATIC FUNCTION LimpaMarca()
Local nX := 0
For nX := 1 to Len(aRecSel)
SA1->(DbGoto(aRecSel[nX][1]))
RecLock("SA1",.F.)
SA1->A1_OK := SPACE(2)
MsUnLock()
Next nX
RETURN
23.
Arquivos e ndices Temporrios
23.1. Utilizao de arquivos e ndices temporrios

Os arquivos e ndices temporrios ou de trabalho, so geralmente utilizados em ambiente
CodeBase, pois, neste ambiente no h os recursos de Join e Order By, como existe nos
bancos de dados relacionais. Por este motivo quando necessitar gerar uma informao
ordenada e consolidada, ou seja, de vrias tabelas, deveremos recorrer ao uso dos arquivos e
dos ndices temporrios.
23.2. Funes para manipulao de arquivos e ndices temporrios

23.2.1.
CriaTrab()
A CriaTrab() uma funcionalidade que permite criar um arquivo fsico ou gerar um nome
aleatrio.
Sintaxe: CriaTrab(aCampo, lCriar, cExt)
Parmetros
aCampo
lCriar
cExt
Array com o nome, tipo, tamanho e decimal do campo a ser criado no

arquivo
Se verdadeiro (.T.) criar o arquivo, ou falso (.F.) somente retorna um
nome aleatrio
Qual extenso dever ser criado o arquivo de trabalho
Os arquivos criados com a funo CRIATRAB() sero gerados no diretrio

especificado como StartPath, de acordo com o RootPath configurado no .ini
da aplicao.
23.2.2.
dbUseArea()
A dbUseArea() uma funcionalidade que permite definir um arquivo de base de dados, com
uma rea de trabalho disponvel na aplicao.
Sintaxe: dbUseArea(lNewArea, cDriver, cName, cAlias, lShared, lReadOnly)
Parmetros
lNewArea
Indica se e um novo alias no conjunto de alias aberto
cDriver
Drive (RddName()) do arquivo -> DBFCDX / TOPCONN / DBFNTX
cName
Nome fsico da tabela que ser usado
cAlias
Alias que ser usado enquanto estive aberto
lShared
A tabela ter acesso exclusivo ou compartilhado
lReadOnly
Se verdadeiro a tabela ser somente leitura
23.2.3.
IndRegua()
A IndRegua() uma funcionalidade que permite criar ndices temporrios para o alias
especificado, podendo ou no ter um filtro.
Sintaxe: IndRegua(cAlias, cNIndex, cExpress, xOrdem, cFor, cMens, lShow)
Parmetros
cAlias
Alias da tabela onde ser efetuada o ndice/filtro temporrio
cNIndex
Nome do arquivo de trabalho retornado pela funo CriaTrab()
cExpress
Expresso utilizada na chave do novo ndice
xOrdem
Parmetro nulo
cFor
Expresso utilizada para filtro
cMens
Parmetro nulo
lShow
Apresentar a tela de progresso do ndice/filtro temporrio
Exemplo 01: Gerao de arquivo e ndice temporrios
/*/
+----------------------------------------------------------------------------| Programa | GeraTrab | Autor | ROBSON LUIZ
| Data |
|
+----------------------------------------------------------------------------| Desc.
| Utilizao de arquivos e ndices temporrios
|
+----------------------------------------------------------------------------| Uso
| Curso de ADVPL
|
+----------------------------------------------------------------------------/*/
User Function GeraTrab()
Local
Local
Local
Local
Local
aStru
aArqTRB
nI
cIndTRB
cNomArq
AADD(
AADD(
AADD(
AADD(
AADD(
AADD(
AADD(
AADD(
AADD(
AADD(
AADD(
AADD(
AADD(
AADD(
AADD(
AADD(
AADD(
AADD(
AADD(
AADD(
AADD(
AADD(
AADD(
AADD(
AADD(
AADD(
AADD(
aStru,
aStru,
aStru,
aStru,
aStru,
aStru,
aStru,
aStru,
aStru,
aStru,
aStru,
aStru,
aStru,
aStru,
aStru,
aStru,
aStru,
aStru,
aStru,
aStru,
aStru,
aStru,
aStru,
aStru,
aStru,
aStru,
aStru,
:=
:=
:=
:=
:=
{
{
{
{
{
{
{
{
{
{
{
{
{
{
{
{
{
{
{
{
{
{
{
{
{
{
{
{}
{}
0
""
""
"PRODUTO"
"DESCRICAO"
"GRUPO"
"DESCGRUPO"
"TIPO"
"DESCTIPO"
"CC"
"DESC_CC"
"SERIE"
"DOCTO"
"TIPONOTA"
"EMISSAO"
"CLIENTE"
"LOJA"
"NOME"
"QTDE"
"UNIT"
"TOTAL"
"ALIQICMS"
"VALICMS"
"ALIQIPI"
"VALIPI"
"VALMERC"
"TOTSEMICMS"
"VALPIS"
"LIQUIDO"
"CUSTO"
,"B1_COD"
,"B1_DESC"
,"BM_GRUPO"
,"BM_DESC"
,"B1_TIPO"
,"B1_DESC"
,"CTT_CC"
,"CTT_DESC"
,"D2_SERIE"
,"D2_COD"
,"D2_TP"
,"D2_EMISSAO"
,"D2_CLIENTE"
,"D2_LOJA"
,"A1_NOME"
,"D2_QUANT"
,"D2_PRCVEN"
,"D2_TOTAL"
,"D2_PICM"
,"D2_VALICM"
,"D2_IPI"
,"D2_VALIPI"
,"D2_TOTAL"
,"D2_TOTAL"
,"D2_TOTAL"
,"D2_TOTAL"
,"D2_TOTAL"
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
)
)
)
)
)
)
)
)
)
)
)
)
)
)
)
)
)
)
)
)
)
)
)
)
)
)
)
dbSelectArea("SX3")
dbSetOrder(2)
For nI := 1 To Len( aStru )
dbSeek( aStru[nI,2] )
AADD( aArqTRB, { aStru[nI,1], X3_TIPO, X3_TAMANHO, X3_DECIMAL } )
Next nI
// ndice que ser criado
cIndTRB := "PRODUTO+DTOS(EMISSAO)"
cNomArq := CriaTrab( aArqTRB, .T. )
dbUseArea( .T., "DBFCDX", cNomArq, "TRB", .T. ,.T. )
IndRegua( "TRB", cNomArq, cIndTRB )
dbSetOrder(1)
// ( ... ) fazer o processamento necessrio
dbSelectArea("TRB")
dbCloseArea()
If MsgYesNo("Apagar o arquivo gerado \system\"+cNomArq+".dbf ?",FunName())
Ferase(cNomArq+".dbf")
Ferase(cNomArq+OrdBagExt())
Endif
Return Nil
Quando criamos um arquivo ou um ndice temporrio (trabalho),

utilizando a funo Indregua, obrigatrio apag-los no final do rotina.
A utilizao de arquivo ou ndice temporrio, dever ser bem analisada

a fim de evitar lentido no processamentos da rotina.
O array aStru foi criado com base nos campos existentes no sistema,
ao invs de criarmos novas estruturas dos campos, utilizamos as j
existentes no dicionrios de dados (SX3).
Exemplo 02: Utilizando dois ndices temporrios com RDD DBFCDX
/*/
+----------------------------------------------------------------------------| Programa | IndTwoReg | Autor | MICHEL DANTAS
| Data |
|
+----------------------------------------------------------------------------| Desc.
| Utilizao de dois ndices temporrios com DBFCDX
|
+----------------------------------------------------------------------------| Uso
| Curso de ADVPL
|
+----------------------------------------------------------------------------/*/
User Function IndTwoReg()
LOCAL
LOCAL
LOCAL
LOCAL
LOCAL
nOrder
cArq1
cChave1
cArq2
cChave2
:=
:=
:=
:=
:=
0
CriaTrab(NIL,.F.)
"A1_FILIAL+A1_EST"
CriaTrab(NIL,.F.)
"A1_FILIAL+A1_NOME"
dbSelectArea("SA1")
IndRegua("SA1",cArq1,cChave1,,,"Selecionando Regs...")
IndRegua("SA1",cArq2,cChave2,,,"Selecionando Regs...")
nOrder := RetIndex("SA1")
dbSetIndex(cArq1+OrdBagExt())
dbSetIndex(cArq2+OrdBagExt())
Alert("Agora vai por estado")
dbsetOrder(nOrder+1)
dbGoTop()
While !Eof()
Alert("Estado : " + SA1->A1_EST +"
dbSkip()
End
"+" Nome
: " + SA1->A1_NOME)
"+" Nome
: " + SA1->A1_NOME)
Alert("Agora vai por nome")

dbSetOrder(nOrder+2)
dbGoTop()
While !Eof()
Alert("Estado : " + SA1->A1_EST +"
dbSkip()
End
RetIndex("SA1")
Ferase(cArq1+OrdBagext())
Ferase(cArq2+OrdBagext())
Return
24.
Relatrios no grficos
Os relatrios desenvolvidos em ADVPL possuem um padro de desenvolvimento que mais

depende de layout e tipos de parmetros do que qualquer outro tipo de informao, visto que
at o momento percebemos que a linguagem padro da Microsiga muito mais composta de
funes genricas do que de comandos.
Este tipo de relatrio caracterizado por um formato de impresso tipo PostScript, e permite
a gerao de um arquivo em formato texto (.txt), com uma extenso prpria da aplicao ERP
(.##R).
A estrutura de um relatrio no grfico baseada no uso da funo SetPrint(), complementada
pelo uso de outras funes acessrias, as quais esto detalhadas no Guia de Referncia Rpida
que acompanha este material.
24.1.1.
Estrutura de relatrios baseados na SetPrint()
Neste tpico ser demonstrada a construo de relatrio no grfico baseado no uso da funo
SetPrint() o qual atende os formatos de base de dados ISAM e Topconnect, porm no
contemplando a tecnologia Protheus Embedded SQL.
Linhas
1
2
3
4
5
6
7
8
9
Programa
Funo principal;
Atualizao do arquivo de perguntas atravs da funo especfica CriaSX1();
Definio as perguntas atravs da funo Pergunte();
Definio das ordens disponveis para impresso do relatrio;
Chamada da funo SetPrint;
Atualizao das configuraes de impresso com a funo SetDefault();
Execuo da rotina de impresso atravs da funo RptStatus()
10
11
12
13
14
15
16
17
18
19
20
21
Funo de processamento e impresso do relatrio

Definio dos filtros de impresso, avaliando o bando de dados em uso pela aplicao;
Atualizao da rgua de processamento com a quantidade de registros que ser processada;
Estrutura principal de repetio para impresso dos dados do relatrio;
Controle da impresso do cabealho utilizando a funo Cabec();
Impresso dos totais do relatrio;
Impresso do rodap da ltima pgina do relatrio utilizando a funo Roda();
Limpeza dos arquivos e ndices temporrios criados para o processamento();
Tratamento da visualizao do relatrio (impresso em disco) atravs da funo OurSpool()
Tratamentos adicionais ao relatrio, de acordo com necessidades especficas;
Liberao do buffer de impresso, seja para impressora, seja para limpeza do contedo
visualizado em tela, utilizando a funo MS_FLUSH()
22
Fim da funo de processamento e impresso do relatrio
23
24
25
Funo de atualizao do arquivo de perguntas

Opo 01: Adio individual de cada pergunta no SX1 utilizando a funo PUTSX1()
Criao de um array individual no formato utilizado pela PUTSX1() contendo apenas
as informaes da pergunta que ser adicionada no SX1.
Opo 02: Adio de um grupo de perguntas no SX1 utilizando a funo AJUSTASX1()
Criao de um array no formato utilizado pela AJUSTASX1() contendo todas as
perguntas que sero atualizadas.
25
26
Fim da funo de atualizao do arquivo de perguntas
Funo Principal
//+-----------------------------------------------------------------+
//| Rotina | Inform | Autor | Robson Luiz (rleg) | Data | 01.01.07 |
//+-----------------------------------------------------------------+
//| Descr. | Rotina para gerar relatrio utilizando as funes
|
//|
| SetPrint() e SetDefault().
|
//+-----------------------------------------------------------------+
//| Uso
|
//+-----------------------------------------------------------------+
User Function INFORM()
//+------------------------//| Declaraes de variveis
//+------------------------Local cDesc1
conforme"
Local cDesc2
Local cDesc3
:= "Este relatrio ir imprimir informaes do contas a pagar

:= "parmetros informado. Ser gerado um arquivo no diretrio "
:= "Spool - INFORM_????.XLS, onde ???? e o nome do usurio."
Private cString := "SE2"

Private Tamanho := "M"
Private aReturn := { "Zebrado",2,"Administrao",2,2,1,"",1 }
Private wnrel
:= "INFORM"
Private NomeProg := "INFORM"
Private nLastKey := 0
Private Limite
:= 132
Private Titulo
:= "Ttulo a Pagar - Ordem de "
Private cPerg
:= "INFORM"
Private nTipo
:= 0
Private cbCont
:= 0
Private cbTxt
:= "registro(s) lido(s)"
Private Li
:= 80
Private m_pag
:= 1
Private aOrd
:= {}
Private Cabec1
:= "PREFIXO TITULO PARCELA TIP EMISSAO VENCTO
Private Cabec1
+= "REAL VLR. ORIGINAL
PAGO
Private Cabec2
:= ""
/*
+---------------------| Parmetros do aReturn
+---------------------aReturn - Preenchido pelo SetPrint()
aReturn[1] - Reservado para formulrio
aReturn[2] - Reservado para numero de vias
aReturn[3] - Destinatrio
aReturn[4] - Formato 1=Paisagem 2=Retrato
aReturn[5] - Mdia 1-Disco 2=Impressora
aReturn[6] Porta ou arquivo 1-Lpt1... 4-Com1...
aReturn[7] - Expresso do filtro
aReturn[8] - Ordem a ser selecionada
aReturn[9] [10] [n] - Campos a processar se houver
*/
Continuao:
VENCTO"
SALDO "
AADD(
AADD(
AADD(
AADD(
AADD(
aOrd,
aOrd,
aOrd,
aOrd,
aOrd,
"Fornecedor"
"Titulo"
"Emisso"
"Vencimento"
"Vencto. Real"
)
)
)
)
)
//Parmetros de perguntas para o relatrio

//+-------------------------------------------------------------+
//| mv_par01 - Fornecedor de
? 999999
|
//| mv_par02 - Fornecedor ate
? 999999
|
//| mv_par03 - Tipo de
? XXX
|
//| mv_par04 - Tipo ate
? XXX
|
//| mv_par05 - Vencimento de
? 99/99/99
|
//| mv_par06 - Vencimento ate
? 99/99/99
|
//| mv_par07 - Aglut.Fornecedor
? Sim/No
|
//+-------------------------------------------------------------+
CriaSx1()
//+------------------------------------------------//| Disponibiliza para usurio digitar os parmetros
//+------------------------------------------------Pergunte(cPerg,.F.)
//cPerg -> Nome do grupo de perguntas, .T. mostra a tela,;
// .F. somente carrega as variveis
//+--------------------------------------------------//| Solicita ao usurio a parametrizao do relatrio.
//+--------------------------------------------------wnrel :=
SetPrint(cString,wnrel,cPerg,@Titulo,cDesc1,cDesc2,cDesc3,.F.,aOrd,.F., ;
Tamanho,.F.,.F.)
//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
//+-----------------------------------------------------------------//| Estabelece os padres para impresso, conforme escolha do usurio
//+-----------------------------------------------------------------SetDefault(aReturn,cString)
//+------------------------------------//| Verificar se ser reduzido ou normal
//+------------------------------------nTipo := IIF(aReturn[4] == 1, 15, 18)
//+-------------------//| Se teclar ESC, sair
//+-------------------If nLastKey == 27
Return
Endif
Continuao:
//+----------------------------------//| Chama funo que processa os dados

//+----------------------------------RptStatus({|lEnd| ImpRel(@lEnd) }, Titulo, "Processando e imprimindo dados,;
aguarde...", .T. )
Return
Funo de processamento e impresso
//+-----------------------------------------------------------------+
//| Rotina | ImpRel | Autor | Robson Luiz (rleg) | Data | 01.01.07 |
//+-----------------------------------------------------------------+
//| Descr. | Rotina de processamento e impresso.
|
//+-----------------------------------------------------------------+
//| Uso
|
//+-----------------------------------------------------------------+
Static Function ImpRel(lEnd)
Local
Local
Local
Local
Local
Local
Local
Local
Local
Local
Local
Local
Local
Local
Local
nIndice := 0
cArq := ""
cIndice := ""
cFiltro := ""
aCol := {}
cFornec := ""
nValor := 0
nPago := 0
nSaldo := 0
nT_Valor := 0
nT_Pago := 0
nT_Saldo := 0
cArqExcel := ""
cAliasImp
oExcelApp
Titulo += aOrd[aReturn[8]]
#IFNDEF TOP
cAliasImp := "SE2"
cFiltro
cFiltro
cFiltro
cFiltro
cFiltro
cFiltro
cFiltro
:=
+=
+=
+=
+=
+=
+=
"E2_FILIAL == '"+xFilial("SE2")+"' "

".And. E2_FORNECE >= '"+mv_par01+"' "
".And. E2_FORNECE <= '"+mv_par02+"' "
".And. E2_TIPO >= '"+mv_par03+"' "
".And. E2_TIPO <= '"+mv_par04+"' "
".And. Dtos(E2_VENCTO) >= '"+Dtos(mv_par05)+"' "
".And. Dtos(E2_VENCTO) <= '"+Dtos(mv_par06)+"' "
If aReturn[8] == 1 //Fornecedor
cIndice := "E2_FORNECE+E2_LOJA+E2_NUM"
Elseif aReturn[8] == 2 //Titulo
cIndice := "E2_NUM+E2_FORNECE+E2_LOJA"
Elseif aReturn[8] == 3 //Emissao
Continuao:
cIndice := "Dtos(E2_EMISSAO)+E2_FORNECE+E2_LOJA"
Elseif aReturn[8] == 4 //Vencimento
cIndice := "Dtos(E2_VENCTO)+E2_FORNECE+E2_LOJA"
Elseif aReturn[8] == 5 //Vencimento Real
cIndice := "Dtos(E2_VENCREA)+E2_FORNECE+E2_LOJA"
Endif
cArq := CriaTrab(NIL,.F.)
dbSelectArea(cAliasImp)
IndRegua(cAliasImp,cArq,cIndice,,cFiltro)
nIndice := RetIndex()
nIndice := nIndice + 1
dbSetIndex(cArq+OrdBagExt())
dbSetOrder(nIndice)
#ELSE
cAliasImp := GetNextAlias()
cQuery := "SELECT "
cQuery += "E2_PREFIXO, E2_NUM, E2_PARCELA, E2_TIPO, E2_FORNECE, E2_LOJA,
E2_NOMFOR, "
cQuery += "E2_EMISSAO, E2_VENCTO, E2_VENCREA, E2_VALOR, E2_SALDO "
cQuery += "FROM "+RetSqlName("SE2")+" "
cQuery += "WHERE E2_FILIAL = '"+xFilial("SE2")+"' "
cQuery += "AND E2_FORNECE >= '"+mv_par01+"' "
cQuery += "AND E2_FORNECE <= '"+mv_par02+"' "
cQuery += "AND E2_TIPO >= '"+mv_par03+"' "
cQuery += "AND E2_TIPO <= '"+mv_par04+"' "
cQuery += "AND E2_VENCTO >= '"+Dtos(mv_par05)+"' "
cQuery += "AND E2_VENCTO <= '"+Dtos(mv_par06)+"' "
cQuery += "AND D_E_L_E_T_ <> '*' "
cQuery += "ORDER BY "
If aReturn[8] == 1 //Fornecedor
cQuery += "E2_FORNECE,E2_LOJA,E2_NUM"
cQuery += "E2_NUM,E2_FORNECE,E2_LOJA"
cQuery += "E2_EMISSAO,E2_FORNECE,E2_LOJA"
cQuery += "E2_VENCTO,E2_FORNECE,E2_LOJA"
cQuery += "E2_VENCREA,E2_FORNECE,E2_LOJA"
Endif
dbUseArea( .T., "TOPCONN", TcGenQry(,,cQuery), cAliasImp, .T., .F. )
/* Instruo SQL Embedded
---------------------If aReturn[8] == 1 //Fornecedor
cOrder := "E2_FORNECE,E2_LOJA,E2_NUM"
cOrder := "E2_NUM,E2_FORNECE,E2_LOJA"
cOrder := "E2_EMISSAO,E2_FORNECE,E2_LOJA"
cOrder := "E2_VENCTO,E2_FORNECE,E2_LOJA"
Continuao:

cOrder := "E2_VENCREA,E2_FORNECE,E2_LOJA"
Endif
BeginSQL Alias cAliasImp
Column E2_EMISSAO As
Column E2_VENCTO As
Column E2_VENCREA As
Column E2_VALOR
As
Column E2_SALDO
As
%NoParser%
Date
Date
Date
Numeric(12)
Numeric(12)
SELECT
E2_PREFIXO, E2_NUM, E2_PARCELA, E2_TIPO, E2_FORNECE,
E2_LOJA, E2_NOMFOR, E2_EMISSAO, E2_VENCTO, E2_VENCREA, E2_VALOR,
E2_SALDO
FROM
%Table:SE2
WHERE
E2_FILIAL = %xFilial% AND
E2_FORNECE BETWEEN %Exp:mv_par01% AND %Exp:mv_par02% AND
E2_TIPO BETWEEN%Exp:mv_par03% AND %Exp:mv_par04% AND
E2_VENCTO BETWEEN %Exp:mv_par05% AND %Exp:mv_par06% AND
%NotDel%
ORDER BY %Order:cOrder%
EndSQL
*/
#ENDIF
dbGoTop()
SetRegua(0)
//+-------------------//| Coluna de impresso
//+-------------------AADD( aCol, 004 ) //Prefixo
AADD( aCol, 012 ) //Titulo
AADD( aCol, 024 ) //Parcela
AADD( aCol, 031 ) //Tipo
AADD( aCol, 036 ) //Emissao
AADD( aCol, 046 ) //Vencimento
AADD( aCol, 058 ) //Vencimento Real
AADD( aCol, 070 ) //Valor Original
AADD( aCol, 090 ) //Pago
AADD( aCol, 110 ) //Saldo
cFornec := (cAliasImp)->E2_FORNECE+(cAliasImp)->E2_LOJA
While !Eof() .And. !lEnd
If Li > 55
Cabec(Titulo,Cabec1,Cabec2,NomeProg,Tamanho,nTipo)
Endif
Continuao:
@ Li, aCol[1] PSay "Cod/Loj/Nome: "+(cAliasImp)->E2_FORNECE+;

"-"+(cAliasImp)->E2_LOJA+" "+(cAliasImp)->E2_NOMFOR
Li ++
While !Eof() .And. !lEnd .And.;
(cAliasImp)->E2_FORNECE+(cAliasImp)->E2_LOJA == cFornec
IncRegua()
If Li > 55
Cabec(Titulo,Cabec1,Cabec2,NomeProg,Tamanho,nTipo)
Endif
If mv_par07 == 2
@ Li, aCol[1] PSay (cAliasImp)->E2_PREFIXO
@ Li, aCol[2] PSay (cAliasImp)->E2_NUM
@ Li, aCol[3] PSay (cAliasImp)->E2_PARCELA
@ Li, aCol[4] PSay (cAliasImp)->E2_TIPO
@ Li, aCol[5] PSay (cAliasImp)->E2_EMISSAO
@ Li, aCol[6] PSay (cAliasImp)->E2_VENCTO
@ Li, aCol[7] PSay (cAliasImp)->E2_VENCREA
@ Li, aCol[8] PSay (cAliasImp)->E2_VALOR ;
PICTURE "@E 99,999,999,999.99"
@ Li, aCol[9] PSay (cAliasImp)->E2_VALOR -;
(cAliasImp)->E2_SALDO ;
PICTURE "@E 99,999,999,999.99"
@ Li, aCol[10] PSay (cAliasImp)->E2_SALDO ;
PICTURE "@E 99,999,999,999.99"
Li ++
Endif
nValor += (cAliasImp)->E2_VALOR
nPago += ((cAliasImp)->E2_VALOR-(cAliasImp)->E2_SALDO)
nSaldo += (cAliasImp)->E2_SALDO
nT_Valor += (cAliasImp)->E2_VALOR
nT_Pago += ((cAliasImp)->E2_VALOR-(cAliasImp)->E2_SALDO)
nT_Saldo += (cAliasImp)->E2_SALDO
dbSkip()
End
@ Li, 000 PSay
Li ++
@ Li, aCol[1]
@ Li, aCol[8]
@ Li, aCol[9]
@ Li, aCol[10]
Li +=2
cFornec
nValor
nPago
nSaldo
:=
:=
:=
:=
Replicate("-",Limite)
PSay
PSay
PSay
PSay
"TOTAL....."
nValor PICTURE "@E 99,999,999,999.99"
nPago PICTURE "@E 99,999,999,999.99"
nSaldo PICTURE "@E 99,999,999,999.99"
(cAliasImp)->E2_FORNECE+(cAliasImp)->E2_LOJA
0
0
0
End
Continuao:
If lEnd
@ Li, aCol[1] PSay cCancel
Return
Endif
@ Li,
Li ++
@ Li,
@ Li,
@ Li,
@ Li,
000 PSay Replicate("=",Limite)

aCol[1]
aCol[8]
aCol[9]
aCol[10]
PSay
PSay
PSay
PSay
"TOTAL GERAL....."
nT_Valor PICTURE "@E 99,999,999,999.99"
nT_Pago PICTURE "@E 99,999,999,999.99"
nT_Saldo PICTURE "@E 99,999,999,999.99"
If Li <> 80
Roda(cbCont,cbTxt,Tamanho)
Endif
//+---------------------------------------------------------------------//| Gera arquivo do tipo .DBF com extenso .XLS p/ usurio abrir no Excel
//+---------------------------------------------------------------------cArqExcel := __RELDIR+NomeProg+"_"+Substr(cUsuario,7,4)+".XLS"
Copy To &cArqExcel
#IFNDEF TOP
RetIndex(cAliasImp)
Set Filter To
#ELSE
dbCloseArea()
#ENDIF
dbSetOrder(1)
dbGoTop()
If aReturn[5] == 1
Set Printer TO
dbCommitAll()
OurSpool(wnrel)
EndIf
//+-----------------------//| Abrir planilha MS-Excel
//+-----------------------If mv_par08 == 1
__CopyFile(cArqExcel,"c:\"+NomeProg+"_"+Substr(cUsuario,7,4)+".XLS")
If ! ApOleClient("MsExcel")
MsgAlert("MsExcel no instalado")
Return
Endif
oExcelApp := MsExcel():New()
oExcelApp:WorkBooks:Open( "c:\"+NomeProg+"_"+Substr(cUsuario,7,4)+".XLS" )
oExcelApp:SetVisible(.T.)
Endif
Ms_Flush()
Return
Funo para gerar o grupo de parmetros no SX1
//+-----------------------------------------------------------------+
//| Rotina | CriaSX1 | Autor | Robson Luiz (rleg)| Data | 01.01.07 |
//+-----------------------------------------------------------------+
//| Descr. | Rotina para criar o grupo de parmetros.
|
//+-----------------------------------------------------------------+
//| Uso
|
//+-----------------------------------------------------------------+
Static Function CriaSx1()
Local aP := {}
Local i := 0
Local cSeq
Local cMvCh
Local cMvPar
Local aHelp := {}
/******
Parmetros da funo padro
--------------------------PutSX1(cGrupo,;cOrdem,;
cPergunt,cPerSpa,cPerEng,;
cVar,;
cTipo,;
nTamanho,;
nDecimal,;
nPresel,;
cGSC,;
cValid,;
cF3,;
cGrpSxg,;
cPyme,;
cVar01,;
cDef01,cDefSpa1,cDefEng1,;
cCnt01,;
aHelpPor,aHelpEng,aHelpSpa,;
cHelp)
Caracterstica do vetor p/ utilizao da funo SX1
--------------------------------------------------[n,1] --> texto da pergunta
[n,2] --> tipo do dado
[n,3] --> tamanho
[n,4] --> decimal
[n,5] --> objeto G=get ou C=choice
[n,6] --> validao
[n,7] --> F3
[n,8] --> definio 1
[n,9] --> definio 2
[n,10] -> definio 3
[n,11] -> definio 4
[n,12] -> definio 5
***/
Continuao:
AADD(aP,{"Fornecedor de","C",6,0,"G","","SA2",""
,""
,"","",""})
AADD(aP,{"Fornecedor ate","C",6,0,"G","(mv_par02>=mv_par01)","SA2",;
""
,""
,"","",""})
AADD(aP,{"Tipo de","C",3,0,"G","","05" ,""
,""
,"","",""})
AADD(aP,{"Tipo ate","C",3,0,"G","(mv_par04>=mv_par03)","05" ,""
,;
""
,"","",""})
AADD(aP,{"Vencimento de","D",8,0,"G","",""
,""
,""
,"","",""})
AADD(aP,{"Vencimento ate","D",8,0,"G","(mv_par06>=mv_par05)",""
,;
""
,""
,"","",""})
AADD(aP,{"Aglutinar pagto.de fornec.","N",1,0,"C","","",;
"Sim","No","","",""})
AADD(aP,{"Abrir planilha MS-Excel"
,"N",1,0,"C","","",;
"Sim","No","","",""})
AADD(aHelp,{"Informe o cdigo do fornecedor.","inicial."})
AADD(aHelp,{"Informe o cdigo do fornecedor.","final."})
AADD(aHelp,{"Tipo de ttulo inicial."})
AADD(aHelp,{"Tipo de ttulo final."})
AADD(aHelp,{"Digite a data do vencimento inicial."})
AADD(aHelp,{"Digite a data do vencimento final."})
AADD(aHelp,{"Aglutinar os ttulos do mesmo forne-",;
"cedor totalizando seus valores."})
AADD(aHelp,{"Ser gerada uma planilha para ",;
"MS-Excel, abrir esta planilha?"})
For i:=1 To Len(aP)
cSeq
:= StrZero(i,2,0)
cMvPar := "mv_par"+cSeq
cMvCh := "mv_ch"+IIF(i<=9,Chr(i+48),Chr(i+87))
PutSx1(cPerg,;
cSeq,;
aP[i,1],aP[i,1],aP[i,1],;
cMvCh,;
aP[i,2],;
aP[i,3],;
aP[i,4],;
0,;
aP[i,5],;
aP[i,6],;
aP[i,7],;
"",;
"",;
cMvPar,;
aP[i,8],aP[i,8],aP[i,8],;
"",;
aP[i,9],aP[i,9],aP[i,9],;
aP[i,10],aP[i,10],aP[i,10],;
aP[i,11],aP[i,11],aP[i,11],;
aP[i,12],aP[i,12],aP[i,12],;
aHelp[i],;
{},;
{},;
"")
Next i
Return
25.
Manipulao de arquivos I
25.1. Gerao e leitura de arquivos em formato texto

Arquivos do tipo texto (tambm conhecidos como padro TXT) so arquivos com registros de
tamanho varivel. A indicao do final de cada registro representada por dois bytes, 0D
0A em hexadecimal ou 13 10 em decimal ou, ainda, CR LF para padro ASCII.
Apesar do tamanho dos registros ser varivel, a maioria dos sistemas gera este tipo de arquivo
com registros de tamanho fixo, de acordo com um layout especfico que indica quais
so os dados gravados.
Para ilustrar estes procedimentos, sero gerados arquivos textos, com duas famlias de
funes:
1) Famlia: nesta famlia sero utilizadas as funes: FCreate(),
FSeek(), FOpen() e FRead().
FWrite(),
FClose(),
2) Famlia: nesta famlia sero utilizadas as funes: FT_FUse(), FT_FGoTop(),

FT_FLastRec(), FT_FEof(), FT_FReadLn(), FT_FSkip(), FT_FGoto(), FT_FRecno().
A diferena entre as duas famlias, est na leitura do arquivo texto.

Quando se tratar de arquivo texto com tamanho fixo das linhas, podero
ser utilizadas as duas famlias para leitura do arquivo, porm, quando se
tratar de arquivo texto com tamanho varivel das linhas, somente
poder ser utiliza a segunda famlia, representada pelas funes:
FT_FUse(), FT_FGoTo(), FT_FRecno(), FT_FGoTop(), FT_FLastRec(),
FT_FEof(), FT_FReadLn() e FT_FSkip().
1. Famlia de funes de gravao e leitura de arquivos texto

Exemplo: Gerao de arquivo TXT, utilizando a primeira famlia de funes
/*/
+----------------------------------------------------------------------------| Programa | GeraTXT
|
+----------------------------------------------------------------------------| Descrio | Gera o arquivo TXT, a partir do Cadastro de Clientes
|
+----------------------------------------------------------------------------| Uso
| Curso ADVPL
|
+----------------------------------------------------------------------------/*/
User Function GeraTXT()
//+--------------------------------+
//| Declarao de Variveis
|
//+--------------------------------+
Local oGeraTxt
Private cPerg
:= "EXPSA1"
Private cAlias
:= "SA1"
//CriaSx1(cPerg)
//Pergunte(cPerg,.F.)
dbSetOrder(1)
//+-----------------------------------+
//| Montagem da tela de processamento.|
//+-----------------------------------+
DEFINE MSDIALOG oGeraTxt TITLE OemToAnsi("Gerao de Arquivo Texto") ;
FROM 000,000 TO 200,400 PIXEL
@ 005,005 TO 095,195 OF oGeraTxt PIXEL
@ 010,020 Say " Este programa ira gerar um arquivo texto, conforme os parame- ";
OF oGeraTxt PIXEL
@ 018,020 Say " tros definidos pelo usurio, com os registros do arquivo de ";
OF oGeraTxt PIXEL
@ 026,020 Say " SA1 " OF oGeraTxt PIXEL
DEFINE SBUTTON FROM 070, 030 TYPE 1 ;
ACTION (OkGeraTxt(),oGeraTxt:End()) ENABLE OF oGeraTxt
ACTION (oGeraTxt:End()) ENABLE OF oGeraTxt
ACTION (Pergunte(cPerg,.T.)) ENABLE OF oGeraTxt
ACTIVATE DIALOG oGeraTxt CENTERED
Return Nil
/*/
+----------------------------------------------------------------------------| Funo
| OKGERATXT | Autor | SERGIO FUZINAKA | Data |
|
+----------------------------------------------------------------------------| Descrio | Funo chamada pelo boto OK na tela inicial de processamento. |
|
| Executa a gerao do arquivo texto.
|
+----------------------------------------------------------------------------/*/
Static Function OkGeraTxt
//+----------------------------------------------------------------------------//| Cria o arquivo texto
//+----------------------------------------------------------------------------Private cArqTxt := "\SYSTEM\EXPSA1.TXT"
Private nHdl
:= fCreate(cArqTxt)
If nHdl == -1
MsgAlert("O arquivo de nome "+cArqTxt+" no pode ser executado! Verifique os
parmetros.","Ateno!")
Return
Endif
// Inicializa a rgua de processamento

Processa({|| RunCont() },"Processando...")
Return Nil
/*/
+----------------------------------------------------------------------------| Funo
| RUNCONT | Autor | SERGIO FUZINAKA | Data |
|
+----------------------------------------------------------------------------| Descrio | Funo auxiliar chamada pela PROCESSA. A funo PROCESSA
|
|
| monta a janela com a rgua de processamento.
|
+----------------------------------------------------------------------------/*/
Static Function RunCont
Local cLin
dbGoTop()
ProcRegua(RecCount()) // Numero de registros a processar
While (cAlias)->(!EOF())
//Incrementa a rgua
IncProc()
cLin := (cAlias)->A1_FILIAL
cLin += (cAlias)->A1_COD
cLin += (cAlias)->A1_LOJA
cLin += (cAlias)->A1_NREDUZ
cLin += STRZERO((cAlias)->A1_MCOMPRA*100,16) // 14,2
cLin += DTOS((cAlias)->A1_ULTCOM)//AAAAMMDD
cLin += CRLF
//+-------------------------------------------------------------------+
//| Gravao no arquivo texto. Testa por erros durante a gravao da |
//| linha montada.
|
//+-------------------------------------------------------------------+
If fWrite(nHdl,cLin,Len(cLin)) != Len(cLin)
If !MsgAlert("Ocorreu um erro na gravao do arquivo."+;
"Continua?","Ateno!")
Exit
Endif
Endif
(cAlias)->(dbSkip())
EndDo
// O arquivo texto deve ser fechado, bem como o dialogo criado na funo
anterior
fClose(nHdl)
Return Nil
Note que para a gerao do arquivo TXT foram utilizadas, basicamente, as funes
FCreate, FWrite e FClose que, respectivamente, gera o arquivo, adiciona dados e fecha
o arquivo.
No exemplo, o formato estabelecido pela concatenao dos dados na
varivel cLin a qual utilizada na gravao dos dados. Para a leitura de dados TXT sero
utilizada as funes FOpen e FRead.
Exemplo: Leitura de arquivo TXT, utilizando a primeira famlia de funes
#Include "protheus.ch"
/*/
+----------------------------------------------------------------------| Programa | LeTXT
|
+----------------------------------------------------------------------| Descrio | Leitura de arquivo TXT
|
+----------------------------------------------------------------------| Uso
| Curso ADVPL
|
+----------------------------------------------------------------------/*/
User Function LeTXT()
//+-------------------------------------------------------------------+
//| Declarao de Variveis
|
//+-------------------------------------------------------------------+
Local cPerg := "IMPSA1"
Local oLeTxt
Private cAlias := "SA1"
//CriaSx1(cPerg)
//Pergunte(cPerg,.F.)
dbSetOrder(1)
//+-------------------------------------------------------------------+
// Montagem da tela de processamento
|
//+-------------------------------------------------------------------+
DEFINE MSDIALOG oLeTxt TITLE OemToAnsi("Leitura de Arquivo Texto");
FROM 000,000 TO 200,400 PIXEL
@ 005,005 TO 095,195 OF oLeTxt PIXEL
@ 10,020 Say " Este programa ira ler o contedo de um arquivo texto, conforme";
OF oLeTxt PIXEL
@ 18,020 Say " os parmetros definidos pelo usurio, com os registros do
arquivo";
OF oLeTxt PIXEL
@ 26,020 Say " SA1" OF oLeTxt PIXEL
ACTION (OkLeTxt(),oLeTxt:End()) ENABLE OF oLeTxt
ACTION (oLeTxt:End()) ENABLE OF oLeTxt
ACTION (Pergunte(cPerg,.T.)) ENABLE OF oLeTxt
ACTIVATE DIALOG oLeTxt CENTERED
Return Nil
/*/
+----------------------------------------------------------------------------| Funo
| OKLETXT
|
+----------------------------------------------------------------------------| Descrio | Funo chamada pelo boto OK na tela inicial de processamento |
|
| Executa a leitura do arquivo texto
|
+----------------------------------------------------------------------------/*/
Static Function OkLeTxt()
//+-------------------------------------------------------------------+
//| Abertura do arquivo texto
|
//+-------------------------------------------------------------------+
Private cArqTxt := "\SYSTEM\EXPSA1.TXT"
Private nHdl
:= fOpen(cArqTxt,68)
If nHdl == -1
MsgAlert("O arquivo de nome "+cArqTxt+" no pode ser aberto! Verifique os
parmetros.","Ateno!")
Return
Endif
// Inicializa a rgua de processamento
Processa({|| RunCont() },"Processando...")
Return Nil
/*/
+----------------------------------------------------------------------------| Funo
| RUNCONT
|
+----------------------------------------------------------------------------| Descrio | Funo auxiliar chamada pela PROCESSA. A funo PROCESSA
|
|
| monta a janela com a rgua de processamento.
|
+----------------------------------------------------------------------------/*/
Static Function RunCont
Local
Local
Local
Local
Local
Local
Local
nTamFile
nTamLin
cBuffer
nBtLidos
cFilSA1
cCodSA1
cLojaSA1
:= 0
:= 56
:= ""
:= 0
:= ""
:= ""
:= ""
//1234567890123456789012345678901234567890123456789012345678901234567890
//00000000010000000002000000000300000000040000000005000000000600000000070
//FFCCCCCCLLNNNNNNNNNNNNNNNNNNNNVVVVVVVVVVVVVVVVDDDDDDDD
//A1_FILIAL
- 01, 02 - TAM: 02
//A1_COD
- 03, 08 - TAM: 06
//A1_LOJA
- 09, 10 - TAM: 02
//A1_NREDUZ - 11, 30 - TAM: 20
//A1_MCOMPRA
- 31, 46 - TAM: 14,2
//A1_ULTCOM - 47, 54 - TAM: 08
nTamFile := fSeek(nHdl,0,2)
fSeek(nHdl,0,0)
cBuffer := Space(nTamLin) // Varivel para criao da linha do registro para
leitura
ProcRegua(nTamFile) // Numero de registros a processar
While nBtLidos < nTamFile
//Incrementa a rgua
IncProc()
// Leitura da primeira linha do arquivo texto
nBtLidos += fRead(nHdl,@cBuffer,nTamLin)
cFilSA1
cCodSA1
cLojaSA1
:= Substr(cBuffer,01,02) //- 01, 02 - TAM: 02

While .T.
IF dbSeek(cFilSA1+cCodSA1+cLojaSA1)
cCodSA1 := SOMA1(cCodSA1)
Loop
Else
Exit
Endif
Enddo
RecLock(cAlias,.T.)
(cAlias)->A1_FILIAL
(cAlias)->A1_COD
(cAlias)->A1_LOJA
(cAlias)->A1_NREDUZ
//- 11, 30 - TAM: 20
(cAlias)->A1_MCOMPRA
//- 31, 46 - TAM: 14,2
(cAlias)->A1_ULTCOM
//- 47, 54 - TAM: 08
MSUnLock()
:=
:=
:=
:=
cFilSA1 //- 01, 02 - TAM: 02

cCodSA1 //- 03, 08 - TAM: 06
cLojaSA1 //- 09, 10 - TAM: 02
Substr(cBuffer,11,20)
:= Val(Substr(cBuffer,31,16))/100
:= STOD(Substr(cBuffer,47,08))
EndDo
// O arquivo texto deve ser fechado, bem como o dialogo criado na funo
anterior.
fClose(nHdl)
Return Nil
2. Famlia de funes de gravao e leitura de arquivos texto

Exemplo: Leitura de arquivo TXT, utilizando a segunda famlia de funes
/*/
+----------------------------------------------------------------------------| Programa | LeArqTXT | Autor | Robson Luiz
| Data |
|
+----------------------------------------------------------------------------| Descrio | Leitura de arquivo TXT
|
+----------------------------------------------------------------------------| Uso
| Curso ADVPL
|
+----------------------------------------------------------------------------/*/
User Function LeArqTxt()
Private
Private
Private
Private
nOpc
cCadastro
aSay
aButton
:=
:=
:=
:=
0
"Ler arquivo texto"
{}
{}
AADD( aSay, "O objetivo desta rotina e efetuar a leitura em um arquivo texto" )
AADD( aButton, { 1,.T.,{|| nOpc := 1,FechaBatch()}})
AADD( aButton, { 2,.T.,{|| FechaBatch() }} )
FormBatch( cCadastro, aSay, aButton )
If nOpc == 1
Processa( {|| Import() }, "Processando..." )
Endif
Return Nil
//+------------------------------------------//| Funo - Import()
//+------------------------------------------Static Function Import()
Local
Local
Local
Local
cBuffer
cFileOpen
cTitulo1
cExtens
:=
:=
:=
:=
""
""
"Selecione o arquivo"
"Arquivo TXT | *.txt"
/***
* _________________________________________________________
* cGetFile(<ExpC1>,<ExpC2>,<ExpN1>,<ExpC3>,<ExpL1>,<ExpN2>)
*
* <ExpC1> - Expresso de filtro
* <ExpC2> - Titulo da janela
* <ExpN1> - Numero de mascara default 1 para *.Exe
* <ExpC3> - Diretrio inicial se necessrio
* <ExpL1> - .F. boto salvar - .T. boto abrir
* <ExpN2> - Mascara de bits para escolher as opes de visualizao do objeto
* (prconst.ch)
*/
cFileOpen := cGetFile(cExtens,cTitulo1,,cMainPath,.T.)
If !File(cFileOpen)
MsgAlert("Arquivo texto: "+cFileOpen+" no localizado",cCadastro)
Return
Endif
FT_FUSE(cFileOpen) //ABRIR
FT_FGOTOP() //PONTO NO TOPO
ProcRegua(FT_FLASTREC()) //QTOS REGISTROS LER
While !FT_FEOF()
IncProc()
//FACA ENQUANTO NAO FOR FIM DE ARQUIVO
// Capturar dados
cBuffer := FT_FREADLN() //LENDO LINHA
cMsg
cMsg
cMsg
cMsg
cMsg
cMsg
:=
+=
+=
+=
+=
+=
"Filial: "
+SubStr(cBuffer,01,02) +
"Cdigo: "
"Loja: "
"Nome fantasia: " +SubStr(cBuffer,11,15) +
"Valor: "
"Data: "
MsgInfo(cMsg)
FT_FSKIP()
EndDo
//prximo registro no arquivo txt
FT_FUSE() //fecha o arquivo txt

MsgInfo("Processo finalizada")
Return Nil
Chr(13)+Chr(10)
Chr(13)+Chr(10)
Chr(13)+Chr(10)
Chr(13)+Chr(10)
Chr(13)+Chr(10)
Chr(13)+Chr(10)
26.
Oficina de programao I
26.1. Interfaces com sintaxe clssica

A sintaxe convencional para definio de componentes visuais da linguagem ADVPL depende
diretamente no include especificado no cabealho do fonte. Os dois includes disponveis para o
ambiente ADVPL Protheus so:
RWMAKE.CH: permite a utilizao da sintaxe CLIPPER na definio dos componentes
visuais.
PROTHEUS.CH: permite a utilizao da sintaxe ADVPL convencional, a qual um
aprimoramento da sintaxe CLIPPER, com a incluso de novos atributos para os
componentes visuais disponibilizados no ERP Protheus.
Para ilustrar a diferena na utilizao destes dois includes, segue abaixo as diferentes
definies para o componentes Dialog e MsDialog:
Exemplo 01 Include Rwmake.ch
#include rwmake.ch
@ 0,0 TO 400,600 DIALOG oDlg TITLE "Janela em sintaxe Clipper"
ACTIVATE DIALOG oDlg CENTERED
Exemplo 02 Include Protheus.ch

DEFINE MSDIALOG oDlg TITLE "Janela em sintaxe ADVPL "FROM 000,000 TO 400,600
PIXEL
Ambas as sintaxes produziro o mesmo efeito quando compiladas e

executadas no ambiente Protheus, mas deve ser utilizada sempre a sintaxe
ADVPL atravs do uso do include PROTHEUS.CH
Os componentes da interface visual que sero tratados neste tpico, utilizando a sintaxe
clssica da linguagem ADVPL so:
BUTTON()
CHECKBOX()
COMBOBOX()
FOLDER()
MSDIALOG()
MSGET()
RADIO()
SAY()
SBUTTON()
BUTTON()
Sintaxe
Descrio
@ nLinha,nColuna BUTTON cTexto SIZE nLargura,nAltura UNIDADE

OF oObjetoRef ACTION AO
Define o componente visual Button, o qual permite a incluso de botes de
operao na tela da interface, os quais sero visualizados somente com um
texto simples para sua identificao.
CHECKBOX()
Sintaxe
Descrio
@ nLinha,nColuna CHECKBOX oCheckBox VAR VARIAVEL PROMPT

cTexto WHEN WHEN UNIDADE OF oObjetoRef SIZE nLargura,nAltura
MESSAGE cMensagem
Define o componente visual CheckBox, o qual permite a utilizao da uma
marca para habilitar ou no uma opo escolhida, sendo esta marca
acompanhada de um texto explicativo. Difere do RadioMenu pois cada
elemento do check nico, mas o Radio permite a utilizao de uma lista
junto com um controle de seleo.
COMBOBOX()
Sintaxe
Descrio
@ nLinha,nColuna COMBOBOX VARIAVEL ITEMS AITENS SIZE

nLargura,nAltura UNIDADE OF oObjetoRef
Define o componente visual ComboBox, o qual permite seleo de um item
dentro de uma lista de opes de textos simples no formato de um vetor.
FOLDER()
Sintaxe
Descrio
@ nLinha,nColuna FOLDER oFolder OF oObjetoRef PROMPT

&cTexto1,,&cTextoX PIXEL SIZE nLargura,nAltura
Define o componente visual Folder, o qual permite a incluso de diversos
Dialogs dentro de uma mesma interface visual. Um Folder pode ser
entendido como um array de Dialogs, aonde cada painel recebe seus
componentes e tem seus atributos definidos independentemente dos demais.
MSDIALOG()
Sintaxe
Descrio
DEFINE MSDIALOG oObjetoDLG TITLE cTitulo FROM nLinIni,nColIni

TO nLiFim,nColFim OF oObjetoRef UNIDADE
Define o componente MSDIALOG(), o qual utilizado como base para os
demais componentes da interface visual, pois um componente MSDIALOG()
uma janela da aplicao.
MSGET()
Sintaxe
Descrio
@ nLinha, nColuna MSGET VARIAVEL SIZE nLargura,nAltura

UNIDADE OF oObjetoRef F3 cF3 VALID VALID WHEN WHEN PICTURE
cPicture
Define o componente visual MSGET, o qual utilizado para captura de
informaes digitveis na tela da interface.
RADIO()
Sintaxe
Descrio
@ nLinha,nColuna RADIO oRadio VAR nRadio 3D SIZE

nLargura,nAltura <ITEMS PROMPT> cItem1,cItem2,...,cItemX OF
oObjetoRef UNIDADE ON CHANGE CHANGE ON CLICK CLICK
Define o componente visual Radio, tambm conhecido como RadioMenu, o
qual seleo de uma opo ou de mltiplas opes atravs de uma marca
para os itens exibidos de uma lista. Difere do componente CheckBox, pois
cada elemento de check sempre nico, e o Radio pode conter um ou mais
elementos.
SAY()
Sintaxe
Descrio
@ nLinha, nColuna SAY cTexto SIZE nLargura,nAltura UNIDADE OF

oObjetoRef
Define o componente visual SAY, o qual utilizado para exibio de textos
em uma tela de interface.
SBUTTON()
Sintaxe
Descrio
DEFINE SBUTTON FROM nLinha, nColuna TYPE N ACTION AO

STATUS OF oObjetoRef
Define o componente visual SButton, o qual permite a incluso de botes de
operao na tela da interface, os quais sero visualizados dependendo da
interface do sistema ERP utilizada somente com um texto simples para sua
identificao, ou com uma imagem (BitMap) pr-definido.
26.2. Rguas de processamento

Os indicadores de progresso ou rguas de processamento disponveis na linguagem ADVPL que
sero abordados neste material so:
RPTSTATUS()
PROCESSA()
MSNEWPROCESS()
MSAGUARDE()
MSGRUN()
26.2.1.
RptStatus()
Rgua de processamento simples, com apenas um indicador de progresso, utilizada no

processamento de relatrios do padro SetPrint().
Sintaxe: RptStatus(bAcao, cMensagem)
Retorno: Nil
Parmetros:
bAcao
cMensagem
Bloco de cdigo que especifica a ao que ser executada com

o acompanhamento da rgua de processamento.
Mensagem que ser exibida na rgua de processamento
durante a execuo.
Aparncia
Exemplo: Funo RPTStatus() e acessrias
/*/
+--------------------------------------------------------------------------| Funo
| GRPTSTATUS | Autor | ROBSON LUIZ
| Data |
|
+--------------------------------------------------------------------------| Descrio | Programa que demonstra a utilizao das funes RPTSTATUS() |
|
| SETREGUA() E INCREGUA()
|
+--------------------------------------------------------------------------| Uso
| Curso ADVPL
|
+--------------------------------------------------------------------------/*/
User Function
Local aSay
Local aButton
Local nOpc
Local cTitulo
Local cDesc1
conjunto"
Local cDesc2
GRptStatus()
:= {}
:= {}
:= 0
:= "Exemplo de Funes"
:= "Este programa exemplifica a utilizao da funo Processa() em
:= "com as funes de incremento ProcRegua() e IncProc()"
Private cPerg := "RPTSTA"

CriaSX1()
Pergunte(cPerg,.F.)
AADD( aSay, cDesc1 )
AADD( aButton, { 5, .T., {|| Pergunte(cPerg,.T. )
}} )
AADD( aButton, { 1, .T., {|| nOpc := 1, FechaBatch() }} )
AADD( aButton, { 2, .T., {|| FechaBatch()
}} )
FormBatch( cTitulo, aSay, aButton )
If nOpc <> 1
Return Nil
Endif
RptStatus( {|lEnd| RunProc(@lEnd)}, "Aguarde...","Executando rotina.", .T. )
Return Nil
Exemplo: Funes acessrias da RPTStatus()
/*/
+----------------------------------------------------------------------------| Funo
| RUNPROC
| Autor | ROBSON LUIZ
| Data |
|
+----------------------------------------------------------------------------| Descrio | Funo de processamento executada atravs da
RPTSTATUS()
|
+----------------------------------------------------------------------------| Uso
| Curso ADVPL
|
+----------------------------------------------------------------------------/*/
Static Function RunProc(lEnd)

Local nCnt := 0
dbSelectArea("SX5")
dbSetOrder(1)
dbSeek(xFilial("SX5")+mv_par01,.T.)
While !Eof() .And. X5_FILIAL == xFilial("SX5") .And. X5_TABELA <= mv_par02
nCnt++
dbSkip()
End
SetRegua(nCnt)
IncRegua()
If lEnd
MsgInfo(cCancel,"Fim")
Exit
Endif
dbSkip()
End
Return .T.
SETREGUA()
A funo SetRegua() utilizada para definir o valor mximo da rgua de progresso criada
atravs da funo RptStatus().
Sintaxe: SetRegua(nMaxProc)
Parmetros:
nMaxProc
Varivel que indica o valor mximo de processamento (passos) que sero

indicados pela rgua.
Retorno:
Nenhum
Exemplo:
...
dbSelectArea("SA1")
dbGoTop()
SetRegua(LastRec())
While !Eof()
IncRegua()
If Li > 60
...
INCREGUA()
A funo IncRegua() utilizada para incrementar valor na rgua de progresso criada atravs
da funo RptStatus()
Sintaxe: IncRegua(cMensagem)
Parmetros:
cMensagem
Mensagem que ser exibida e atualizada na rgua de processamento a cada

execuo da funo IncRegua(), sendo que a taxa de atualizao da
interface controlada pelo Binrio.
Retorno:
Nenhum
Exemplo:
...
dbSelectArea("SA1")
dbGoTop()
SetRegua(LastRec())
While !Eof()
IncRegua(Avaliando cliente:+SA1->A1_COD)
If Li > 60
...
26.2.2.
Processa()
Rgua de processamento simples, com apenas um indicador de progresso, utilizada no

processamento de rotinas.
Sintaxe: Processa(bAcao, cMensagem)
Retorno: Nil
Parmetros:
bAcao
cMensagem

durante a execuo.
Aparncia
Exemplo: Funo PROCESSA() e acessrias
/*/
+----------------------------------------------------------------------------| Funo
| GPROCES1
| Data |
|
+----------------------------------------------------------------------------| Descrio | Programa que demonstra a utilizao das funes PROCESSA()
|
|
| PROCREGUA() E INCPROC()
|
+----------------------------------------------------------------------------| Uso
| Curso ADVPL
|
+----------------------------------------------------------------------------/*/
User Function
Local aSay
Local aButton
Local nOpc
Local cTitulo
Local cDesc1
Local cDesc2
Local cDesc3
GProces1()
:= {}
:= {}
:= 0
:= "Exemplo de Funes"
:= "Este programa exemplifica a utilizao da funo Processa()"
:= " em conjunto com as funes de incremento ProcRegua() e"
:= " IncProc()"
Private cPerg := "PROCES"
CriaSX1()
Pergunte(cPerg,.F.)
AADD( aButton, { 5, .T., {|| Pergunte(cPerg,.T. )
}} )
AADD( aButton, { 1, .T., {|| nOpc := 1, FechaBatch() }} )
AADD( aButton, { 2, .T., {|| FechaBatch()
}} )
FormBatch( cTitulo, aSay, aButton )
If nOpc <> 1
Return Nil
Endif
Processa( {|lEnd| RunProc(@lEnd)}, "Aguarde...","Executando rotina.", .T. )
Return Nil
/*/
+----------------------------------------------------------------------------| Funo
| RUNPROC
| Data |
|
+----------------------------------------------------------------------------| Descrio | Funo de processamento executada atravs da
PROCRSSA()
|
+----------------------------------------------------------------------------| Uso
| Curso ADVPL
|
+----------------------------------------------------------------------------/*/
Static Function RunProc(lEnd)
Local nCnt := 0
dbSelectArea("SX5")
dbSetOrder(1)
dbEval( {|x| nCnt++ },,{||X5_FILIAL==xFilial("SX5").And.X5_TABELA<=mv_par02})
ProcRegua(nCnt)
IncProc("Processando tabela: "+SX5->X5_CHAVE)
If lEnd
MsgInfo(cCancela,"Fim")
Exit
Endif
dbSkip()
End
Return .T.
SETPROC()
A funo SetProc() utilizada para definir o valor mximo da rgua de progresso criada
atravs da funo Processa().
Sintaxe: Processa(nMaxProc)
Parmetros:
nMaxProc
Varivel que indica o valor mximo de processamento (passos) que sero

indicados pela rgua.
Retorno:
Nenhum
Exemplo:
...
dbSelectArea("SA1")
dbGoTop()
SetProc(LastRec())
While !Eof()
IncProc()
If Li > 60
...
INCPROC()
A funo IncProc() utilizada para incrementar valor na rgua de progresso criada atravs da
funo Processa()
Sintaxe: IncProc(cMensagem)
Parmetros:
cMensagem
Mensagem que ser exibida e atualizada na rgua de processamento a cada

execuo da funo IncProc(), sendo que a taxa de atualizao da interface
controlada pelo Binrio.
Retorno:
Nenhum
Exemplo:
...
dbSelectArea("SA1")
dbGoTop()
SetProc(LastRec())
While !Eof()
IncProc(Avaliando cliente:+SA1->A1_COD)
If Li > 60
...
26.2.3.
MsNewProcess().
Rgua de processamento dupla, possuindo dois indicadores de progresso independentes,

utilizada no processamento de rotinas.
Sintaxe: MsNewProcess():New(bAcao, cMensagem)
Retorno: oProcess objeto do tipo MsNewProcess()
Parmetros:
bAcao
cMensagem

durante a execuo.
Aparncia
Mtodos:
Activate()
SetRegua1()
IncRegua1()
SetRegua2()
IncRegua2()
Inicia a execuo do objeto MsNewProcess instanciado.

Define a quantidade de informaes que sero demonstradas
pelo indicador de progresso superior.
Parmetro: nMaxProc
Incrementa em uma unidade o indicador de progresso
superior, o qual ir demonstrar a evoluo do processamento
de acordo com a quantidade definida pelo mtodo
SetRegua1().
Parmetro: cMensagem
Define a quantidade de informaes que sero demonstradas
pelo indicador de progresso inferior.
Parmetro: nMaxProc
Incrementa em uma unidade o indicador de progresso inferior,
o qual ir demonstrar a evoluo do processamento de acordo
com a quantidade definida pelo mtodo SetRegua2().
Parmetro: cMensagem
Exemplo: Objeto MsNewProcess() e mtodos acessrios
/*/
+----------------------------------------------------------------------------| Funo
| GPROCES2
| Data |
|
+----------------------------------------------------------------------------| Descrio | Programa que demonstra a utilizao do objeto MsNewProcess()
|
|
| e seus mtodos IncReguaX() e SetReguaX()
|
+----------------------------------------------------------------------------| Uso
| Curso ADVPL
|
+----------------------------------------------------------------------------/*/
User Function GProces2()
Private oProcess := NIL
oProcess := MsNewProcess():New({|lEnd| RunProc(lEnd,oProcess)};
"Processando","Lendo...",.T.)
oProcess:Activate()
Return Nil
/*/
+----------------------------------------------------------------------------| Funo
| RUNPROC
| Data |
|
+----------------------------------------------------------------------------| Descrio | Funo de processamento executada atravs da MsNewProcess()
|
+----------------------------------------------------------------------------| Uso
| Curso ADVPL
|
+----------------------------------------------------------------------------/*/
Static Function RunProc(lEnd,oObj)
Local i := 0
Local aTabela := {}
Local nCnt := 0
aTabela := {{"00",0},{"13",0},{"35",0},{"T3",0}}
dbSelectArea("SX5")
cFilialSX5 := xFilial("SX5")
dbSetOrder(1)
For i:=1 To Len(aTabela)
dbSeek(cFilialSX5+aTabela[i,1])
While !Eof() .And. X5_FILIAL+X5_TABELA == cFilialSX5+aTabela[i,1]
If lEnd
Exit
Endif
nCnt++
dbSkip()
End
aTabela[i,2] := nCnt
nCnt := 0
Next i
oObj:SetRegua1(Len(aTabela))
For i:=1 To Len(aTabela)
If lEnd
Exit
Endif
oObj:IncRegua1("Lendo Tabela: "+aTabela[i,1])
dbSelectArea("SX5")
dbSeek(cFilialSX5+aTabela[i,1])
oObj:SetRegua2(aTabela[i,2])
While !Eof() .And. X5_FILIAL+X5_TABELA == cFilialSX5+aTabela[i,1]
oObj:IncRegua2("Lendo chave: "+X5_CHAVE)
If lEnd
Exit
Endif
dbSkip()
End
Next i
Return
26.2.4.
MsAguarde().
Indicador de processamento sem incremento.
Sintaxe: Processa(bAcao, cMensagem, cTitulo)
Retorno: Nil
Parmetros:
bAcao
cMensagem
cTitulo

durante a execuo.
Ttulo da janela da rgua de processamento.
Aparncia
Exemplo: MSAguarde()
/*/
+----------------------------------------------------------------------------| Funo
| GMSAGUARDE | Autor | ROBSON LUIZ
| Data |
|
+----------------------------------------------------------------------------| Descrio | Programa que demonstra a utilizao das funes MSAGUARDE()
|
|
| e MSPROCTXT()
|
+----------------------------------------------------------------------------| Uso
| Curso ADVPL
|
+----------------------------------------------------------------------------/*/
USER FUNCTION GMsAguarde()
PRIVATE lEnd := .F.
MsAguarde({|lEnd| RunProc(@lEnd)},"Aguarde...","Processando Clientes",.T.)
RETURN
/*/
+----------------------------------------------------------------------------| Funo
| RUNPROC
| Data |
|
+----------------------------------------------------------------------------| Descrio | Funo de processamento
|
+----------------------------------------------------------------------------| Uso
| Curso ADVPL
|
+----------------------------------------------------------------------------/*/
STATIC FUNCTION RunProc(lEnd)
dbSelectArea("SX5")
dbSetOrder(1)
dbGoTop()
While !Eof()
If lEnd
MsgInfo(cCancel,"Fim")
Exit
Endif
MsProcTxt("Tabela: "+SX5->X5_TABELA+" Chave: "+SX5->X5_CHAVE)
dbSkip()
End
RETURN
26.2.5.
MsgRun().
Indicador de processamento sem incremento.
Sintaxe: Processa(cMensagem, cTitulo, bAcao)
Retorno: Nil
Parmetros:
cMensagem
cTitulo
bAcao

durante a execuo.
Ttulo da janela da rgua de processamento.
Aparncia
Exemplo: MSGRun()
/*/
+----------------------------------------------------------------------------| Funo
| GMSGRUN
|Data |
|
+----------------------------------------------------------------------------| Descrio | Programa que demonstra a utilizao das funes MSGRUN()
|
|
| e DBEVAL()
|
+----------------------------------------------------------------------------| Uso
| Curso ADVPL
|
+----------------------------------------------------------------------------/*/
USER FUNCTION GMsgRun()
LOCAL nCnt := 0
dbSelectArea("SX1")
dbGoTop()
MsgRun("Lendo arquivo, aguarde...","Ttulo opcional",{|| dbEval({|x| nCnt++}) })
MsgInfo("Ufa!!!, li "+AllTrim(Str(nCnt))+" registros",FunName())
RETURN
26.3. ListBox()
A sintaxe clssica da linguagem ADVPL permite que o componente visual ListBox implemente
dois tipos distintos de objetos:
Lista simples: lista de apenas uma coluna no formato de um vetor, a qual no
necessita da especificao de um cabealho.
Lista com colunas: lista com diversas colunas que necessita de um cabealho no
formato de um aHeader (array de cabealho).
26.3.1.
ListBox simples
Sintaxe:
@ nLinha,nColuna LISTBOX oListbox VAR nLista ITEMS aLista SIZE nLargura,nAltura

OF oObjetoRef UNIDADE ON CHANGE CHANGE
Parmetros:
nLinha,nColuna
oListBox
nLista
aLista
nLargura,nAltura
oObjetoRef
UNIDADE
CHANGE
Posio do objeto ListBox em funo da janela em que ele

ser definido.
Objeto ListBox que ser criado.
Varivel numrica que contm o nmero do item
selecionado no ListBox.
Vetor simples contendo as strings que sero exibidas no
ListBox.
Dimenses do objeto ListBox.
Objeto dialog no qual o componente ser definido.
Unidade de medida das dimenses: PIXEL.
Funo ou lista de expresses que ser executada na
seleo de um item do ListBox.
Aparncia:
Exemplo: LISTBOX como lista simples
/*/
+----------------------------------------------------------------------------| Funo
| LISTBOXITE | Autor | ROBSON LUIZ
|Data |
|
+----------------------------------------------------------------------------| Descrio | Programa que demonstra a utilizao do LISTBOX() como lista
|
|
| simples.
|
+----------------------------------------------------------------------------| Uso
| Curso ADVPL
|
+----------------------------------------------------------------------------/*/
User Function ListBoxIte()
Local
Local
Local
Local
Local
Local
aVetor
oDlg
oLbx
cTitulo
nChave
cChave
:=
:=
:=
:=
:=
:=
{}
Nil
Nil
"Consulta Tabela"
0
""
dbSelectArea("SX5")
dbSetOrder(1)
dbSeek(xFilial("SX5"))
CursorWait()
//+-----------------------------------------+
//| Carrega o vetor conforme a condio |
//+-----------------------------------------+
While !Eof() .And. X5_FILIAL == xFilial("SX5") .And. X5_TABELA=="00"
AADD( aVetor, Trim(X5_CHAVE)+" - "+Capital(Trim(X5_DESCRI)) )
dbSkip()
End
CursorArrow()
If Len( aVetor ) == 0
Aviso( cTitulo, "No existe dados a consultar", {"Ok"} )
Return
Endif
//+-----------------------------------------------+
//| Monta a tela para usurio visualizar consulta |
//+-----------------------------------------------+
@ 10,10 LISTBOX oLbx VAR nChave ITEMS aVetor SIZE 230,95 OF oDlg PIXEL
oLbx:bChange := {|| cChave := SubStr(aVetor[nChave],1,2) }
DEFINE SBUTTON FROM 107,183 TYPE 14 ACTION LoadTable(cChave) ENABLE OF oDlg
DEFINE SBUTTON FROM 107,213 TYPE 1 ACTION oDlg:End() ENABLE OF oDlg
Return
Exemplo: LISTBOX como lista simples funes acessrias
/*/
+----------------------------------------------------------------------------| Funo
| LISTBOXITE | Autor | ROBSON LUIZ
|Data |
|
+----------------------------------------------------------------------------| Descrio | Funo que carrega os dados da tabela selecionada em um
|
|
| listbox.
|
+----------------------------------------------------------------------------| Uso
| Curso ADVPL
|
+----------------------------------------------------------------------------/*/
STATIC FUNCTION LoadTable(cTabela)
LOCAL aTabela := {}
LOCAL oDlg := NIL
LOCAL oLbx := NIL
dbSelectArea("SX5")
dbSeek(xFilial("SX5")+cTabela)
//+------------------------------------------------------------//| O vetor pode receber carga de duas maneiras, acompanhe... |
//+------------------------------------------------------------//| Utilizando While/End
|
//+------------------------------------------------------------dbEval({|| AADD(aTabela,{X5_CHAVE,Capital(X5_DESCRI)})},,{||
X5_TABELA==cTabela})
If Len(aTabela)==0
Aviso( "FIM", "Necessrio selecionar um item", {"Ok"} )
Return
Endif
DEFINE MSDIALOG oDlg TITLE "Dados da tabela selecionada" FROM 300,400 TO 540,900
PIXEL
@ 10,10 LISTBOX oLbx FIELDS HEADER "Tabela", "Descrio" SIZE 230,095 OF oDlg
PIXEL
oLbx:SetArray( aTabela )
oLbx:bLine := {|| {aTabela[oLbx:nAt,1],aTabela[oLbx:nAt,2]} }
ACTIVATE MSDIALOG oDlg
RETURN
26.3.2.
ListBox mltiplas colunas
Sintaxe:
@ nLinha,nColuna LISTBOX oListbox FIELDS HEADER Header1, , HeaderX SIZE

nLargura,nAltura OF oObjetoRef UNIDADE
Parmetros:
nLinha,nColuna
oListBox
nLista
Header1,...,HeaderX
nLargura,nAltura
oObjetoRef
UNIDADE
CHANGE
Mtodos:
SetArray()
Mtodo o objeto ListBox que define qual o

array contm os dados que sero exibidos no
grid.
Atributos:
bLine
Posio do objeto ListBox em funo da

janela em que ele ser definido.
Objeto ListBox que ser criado.
Varivel numrica que contm o nmero do
item selecionado no ListBox.
Strings identificando os ttulos das colunas do
Grid.
Dimenses do objeto ListBox.
Objeto dialog no qual o componente ser
definido.
Unidade de medida das dimenses: PIXEL.
Funo ou lista de expresses que ser
executada na seleo de um item do ListBox.
Atributo do objeto ListBox que vincula cada

linha,coluna do array, com cada cabealho do
grid.
Aparncia:
Exemplo: LISTBOX com grid
/*/
+----------------------------------------------------------------------------| Funo
| LIST_BOX
|Data |
|
+----------------------------------------------------------------------------| Descrio | Programa que demonstra a utilizao de um LISTBOX() com
|
|
| grid.
|
+----------------------------------------------------------------------------| Uso
| Curso ADVPL
|
+----------------------------------------------------------------------------/*/
User Function List_Box()
Local
Local
Local
Local
Local
aVetor := {}
oDlg
oLbx
cTitulo := "Cadastro de Bancos"
cFilSA6
dbSelectArea("SA6")
dbSetOrder(1)
cFilSA6 := xFilial("SA6")
dbSeek(cFilSA6)
// Carrega o vetor conforme a condio.
While !Eof() .And. A6_FILIAL == cFilSA6
AADD( aVetor, { A6_COD, A6_AGENCIA, A6_NUMCON, A6_NOME, A6_NREDUZ, A6_BAIRRO,
A6_MUN } )
dbSkip()
End
// Se no houver dados no vetor, avisar usurio e abandonar rotina.
If Len( aVetor ) == 0
Aviso( cTitulo, "No existe dados a consultar", {"Ok"} )
Return
Endif
// Monta a tela para usurio visualizar consulta.
// Primeira opo para montar o listbox.
@ 10,10 LISTBOX oLbx FIELDS HEADER ;
"Banco", "Agencia", "C/C", "Nome Banco", "Fantasia", "Bairro", "Municpio" ;
SIZE 230,95 OF oDlg PIXEL
oLbx:SetArray( aVetor )
oLbx:bLine := {|| {aVetor[oLbx:nAt,1],;
aVetor[oLbx:nAt,2],;
aVetor[oLbx:nAt,7]}}
// Segunda opo para monta o listbox
/*
oLbx :=
TWBrowse():New(10,10,230,95,,aCabecalho,,oDlg,,,,,,,,,,,,.F.,,.T.,,.F.,,,)
oLbx:SetArray( aVetor )
oLbx:bLine := {|| aEval(aVetor[oLbx:nAt],{|z,w| aVetor[oLbx:nAt,w] } ) }
*/
Return
26.4. ScrollBox()
O ScrollBox o objeto utilizado para permitir a um Dialog exibir barras de rolagem verticais e
Horizontais. Algumas aplicaes com objetos definem automaticamente o ScrollBox, tais como:
Enchoice() ou MsMGet()
NewGetDados()
ListBox()
Quando definido um objeto ScrollBox, os demais componentes da janela devero referenciar
este objeto e no mais o objeto Dialog.
Desta forma o ScrollBox atribudo a um objeto Dialog, e os componentes ao ScrollBox.
MsDialog() ScrollBox()
ScrollBox() Componentes Visuais
Sintaxe:
@
nLinha,nColuna
SCROLLBOX
oScrollBox
nLargura,nAltura OF oObjetoRef BORDER
HORIZONTAL
VERTICAL
Parmetros:
nLinha,nColuna
oScrollBox
HORIZONTAL
VERTICAL
nLargura,nAltura
oObjetoRef
BORDER
Posio do objeto ScrollBox em funo da

janela em que ele ser definido.
Objeto ScrollBox que ser criado.
Parmetro que quando definido habilita a
rgua de rolagem horizontal.
rgua de rolagem vertical.
Dimenses do objeto ScrollBox.
Objeto dialog no qual o componente ser
definido.
exibio de uma borda de delimitao do
ScrollBox em relao a outros objetos.
SIZE
Aparncia:
Exemplo: Utilizao de mltiplos ScrollBoxes
#INCLUDE "PROTHEUS.CH"
/*/
+-----------------------------------------------------------------------| Funo
| SCROLL()
|Data |
|
+-----------------------------------------------------------------------| Descrio | Programa que demonstra como montar uma enchoice apenas
|
|
| com variveis, incluindo o recurso de rolagem.
|
+-----------------------------------------------------------------------| Uso
| Curso ADVPL
|
+-----------------------------------------------------------------------/*/
USER FUNCTION Scroll()
LOCAL
LOCAL
LOCAL
LOCAL
LOCAL
LOCAL
LOCAL
LOCAL
LOCAL
LOCAL
LOCAL
LOCAL
LOCAL
LOCAL
oDlg := NIL
oScroll := NIL
oLbx1 := NIL
oLbx2 := NIL
bGet := NIL
oGet := NIL
aAIIPM := {}
aTitulo := {}
nTop := 5
nWidth := 0
cGet := ""
cPict := ""
cVar := ""
n := 0
PRIVATE
PRIVATE
PRIVATE
PRIVATE
cTitulo := "Consulta Parcelamento"

aSay := {}
cProcesso,cPrefixo,cTipo,cCliente,cLoja,cNome,cCGC
dData,nTotal,nUFESP,cStatus,cCond
cProcesso
cPrefixo
cTipo
cCliente
cLoja
cNome
cCGC
dData
nTotal
nUFESP
cStatus
cCond
:=
:=
:=
:=
:=
:=
:=
:=
:=
:=
:=
:=
"P00001"
"UNI"
"MAN"
"000001"
"01"
"JOSE DA SILVA SANTOS SOARES"
"00.000.000/0001-91"
"26/03/03"
5922.00
1000.00
"Z"
"001"
// Vetor para os campos no Scrooll Box

//+-------------------------------------+
//| aSay[n][1] - Titulo
|
//| aSay[n][2] - Tipo
|
//| aSay[n][3] - Tamanho
|
//| aSay[n][4] - Decimal
|
//| aSay[n][5] - Contedo/Varivel
|
//| aSay[n][6] - Formato
|
//+-------------------------------------+
AADD(aSay,{"Processo"
,"C",06,0,"cProcesso"
AADD(aSay,{"Prefixo"
,"C",03,0,"cPrefixo"
AADD(aSay,{"Tipo"
,"C",03,0,"cTipo"
AADD(aSay,{"Cliente"
,"C",06,0,"cCliente"
AADD(aSay,{"Loja"
,"C",02,0,"cLoja"
AADD(aSay,{"Nome"
,"C",30,0,"cNome"
AADD(aSay,{"CNPJ/CPF"
,"C",14,0,"cCGC"
AADD(aSay,{"Dt.Processo" ,"D",08,0,"dData"
AADD(aSay,{"Total R$"
,"N",17,2,"nTotal"
AADD(aSay,{"Total UFESP" ,"N",17,2,"nUFESP"
AADD(aSay,{"Status"
,"C",01,0,"cStatus"
AADD(aSay,{"Cond.Pagto" ,"C",03,0,"cCond"
,"@!"})
,"@!"})
,"@!"})
,"@!"})
,"@!"})
,"@!"})
,"@!"})
,"@!"})
,"@!"})
,"@!"})
,"@!"})
,"@!"})
// Vetor para List Box

AADD(aAIIPM,{"1234","DCD9815","26/03/03"})
AADD(aAIIPM,{"1234","DCD9815","26/03/03"})
AADD(aAIIPM,{"1234","DCD9815","26/03/03"})
// Vetor para List Box
AADD(aTitulo,{"A","26/03/03","26/03/03","1.974,00","100,00"})
AADD(aTitulo,{"A","26/03/03","26/03/03","1.974,00","100,00"})
AADD(aTitulo,{"A","26/03/03","26/03/03","1.974,00","100,00"})
DEFINE MSDIALOG
@ 013,002 TO
@ 013,195 TO
@ 083,195 TO
oDlg TITLE cTitulo FROM 122,0

154,192 LABEL "Parcelamento"
082,298 LABEL "Ttulos"
154,298 LABEL "AIIPM"
TO
OF
OF
OF
432,600 OF oDlg PIXEL

oDlg PIXEL
oDlg PIXEL
oDlg PIXEL
//scrollbox
@ 019,006 SCROLLBOX oScroll HORIZONTAL VERTICAL SIZE 131,182 OF oDlg BORDER
For n:=1 TO Len(aSay)
bGet := &("{|| '"+aSay[n][1]+"'}")
cVar := aSay[n][5]
cGet := "{|u| IIF(PCount()>0,"+cVar+":=u,"+cVar+")}"
cPict := aSay[n][6]
TSay():New(nTop,5,bGet,oScroll,,,.F.,.F.,.F.,.T.,,,;
GetTextWidth(0,Trim(aSay[n][1])),15,;
.F.,.F.,.F.,.F.,.F.)
oGet:=TGet():New(nTop-2,40,&cGet,oScroll,,7,cPict,,,,,.F.,,.T.,;
,.F.,,.F.,.F.,,.T.,.F.,,(cVar),,,,.T.)
nTop+=11
Next n
//listbox ttulos
@ 019,199 LISTBOX oLbx1 FIELDS HEADER ;
"Parcela","Vencto","Vencto.Real","Valor R$","Qtd.UFESP";
COLSIZES 21,24,33,63,100;
SIZE 095,059 OF oDlg PIXEL
oLbx1:SetArray( aTitulo )
oLbx1:bLine := {||{aTitulo[oLbx1:nAt,1],aTitulo[oLbx1:nAt,2],;
aTitulo[oLbx1:nAt,3],aTitulo[oLbx1:nAt,4],aTitulo[oLbx1:nAt,5]}}
//listbox aiipm
@ 089,199 LISTBOX oLbx2 FIELDS HEADER "AIIPM","Placa","Data Multa" ;
COLSIZES 24,21,30 SIZE 095,061 OF oDlg PIXEL
oLbx2:SetArray( aAIIPM )
oLbx2:bLine :=
{||{aAIIPM[oLbx2:nAt,1],aAIIPM[oLbx2:nAt,2],aAIIPM[oLbx2:nAt,3]}}
ACTIVATE MSDIALOG oDlg CENTER ON INIT
EnchoiceBar(oDlg,{||oDlg:End()},{||oDlg:End()})
RETURN
26.5. ParamBox()
Implementa uma tela de parmetros, que no necessita da criao de um grupo de perguntas
no SX1, e com funcionalidades que a Pergunte() no disponibiliza, tais como CheckBox e
RadioButtons.
Cada componente da ParamBox ser associado a um parmetro Private denominado
MV_PARxx, de acordo com a ordem do componente na tela. Os parmetros da ParamBox
podem ser utilizados de forma independente em uma rotina especfica, ou complementando
opes de uma rotina padro.
Cuidados
A PARAMBOX define os parmetros seguindo o princpio das variveis MV_PARxx. Caso

ela seja utilizada em uma rotina em conjunto com parmetros padres (SX1 +
Pergunte()) necessrio salvar os parmetros padres, chamar a Parambox(), salvar o
retorno da Parambox() em variveis Private especficas (MVPARBOXxx) e depois
restaurar os parmetros padres, conforme o exemplo desta documentao.
O objeto COMBO() da PARAMBOX() possui um problema em seu retorno: Caso o combo

no seja selecionado, ele manter seu contedo como numrico, caso seja ele receber
o texto da opo e no o nmero da opo. O exemplo desta documentao ilustra o
tratamento de cdigo necessrio para proteger a aplicao.
Ao utilizar a ParamBox em uma funo que tambm utilize parmetros definidos pela
funo Pergunte() deve-se:
Salvar e restaurar os MV_PARs da Pergunte()
Definir variveis Private prprias para a ParamBox, as quais iro armazenar o
contedo das MV_PARs que esta retorna.
Sintaxe: ParamBox (aParamBox, cTitulo, aRet, bOk, aButtons, lCentered,;

nPosx, nPosy, oMainDlg, cLoad, lCanSave, lUserSave)
Retorno: lOK indica se a tela de parmetros foi cancelada ou confirmada
Parmetros:
aParamBox
cTitulo
aRet
bOk
aButtons
lCentered
nPosx
nPosy
oMainDlg
cLoad
lCanSave
lUserSave
Array de parmetros de acordo com a regra da ParamBox

Titulo da janela de parmetros
Array que ser passado por referencia e retornado com o
contedo de cada parmetro
Bloco de cdigo para validao do OK da tela de parmetros
Array contendo a regra para adio de novos botes (alm do
OK e Cancelar) // AADD(aButtons,{nType,bAction,cTexto})
Se a tela ser exibida centralizada, quando a mesma no
estiver vinculada a outra janela
Posio inicial -> linha (Linha final: nPosX+274)
Posio inicial -> coluna (Coluna final: nPosY+445)
Caso o ParamBox deva ser vinculado a uma outra tela
Nome do arquivo aonde as respostas do usurio sero salvas /
lidas
Se as respostas para as perguntas podem ser salvas
Se o usurio pode salvar sua prpria configurao.
Aparncia:
Regras do array aParamBox:
[1] Tipo do parmetro: Para cada tipo de parmetro as demais posies do array variam de
contedo conforme abaixo:
1[2]
[3]
[4]
[5]
[6]
[7]
[8]
[9]
MsGet
: Descrio
: String contendo o inicializador do campo
: String contendo a Picture do campo
: String contendo a validao
: Consulta F3
: String contendo a validao When
: Tamanho do MsGet
: Flag .T./.F. Parmetro Obrigatrio ?
2[2]
[3]
[4]
[5]
[6]
[7]
Combo
: Descrio
: Numrico contendo a opo inicial do combo
: Array contendo as opes do Combo
: Tamanho do Combo
: Validao
3[2]
[3]
[4]
[5]
[6]
[7]
Radio
: Descrio
: Numrico contendo a opo inicial do Radio
: Array contendo as opes do Radio
: Tamanho do Radio
: Validao
4[2]
[3]
[4]
[5]
[6]
[7]
CheckBox ( Com Say )

: Descrio
: Indicador Lgico contendo o inicial do Check
: Texto do CheckBox
: Tamanho do Radio
: Validao
5[2]
[3]
[4]
[5]
[6]
CheckBox ( linha inteira )

: Descrio
: Indicador Lgico contendo o inicial do Check
: Tamanho do Radio
: Validao
6 - File
[2] : Descrio
[3] : String contendo o inicializador do campo
[4] : String contendo a Picture do campo
[5] : String contendo a validao
[6] : String contendo a validao When
[7] : Tamanho do MsGet
[8] : Flag .T./.F. Parmetro Obrigatrio ?
[9] : Texto contendo os tipos de arquivo
Ex.: "Arquivos .CSV |*.CSV"
[10]: Diretrio inicial do CGETFILE()
[11]: Parmetros do CGETFILE()
7[2]
[3]
[4]
[5]
Montagem de expresso de filtro

: Descrio
: Alias da tabela
: Filtro inicial
: Opcional - Clausula When Boto Editar Filtro
8[2]
[3]
[4]
[5]
[6]
[7]
[8]
[9]
MsGet Password
: Descrio
: String contendo o inicializador do campo
: String contendo a Picture do campo
: String contendo a validao
: Consulta F3
: String contendo a validao When
: Tamanho do MsGet
9[2]
[3]
[4]
[5]
MsGet Say
: String Contendo o Texto a ser apresentado
: Tamanho da String
: Altura da String
: Negrito (lgico)
Exemplo: Utilizao da ParamBox()
/*/
+----------------------------------------------------------------------| Funo
| xParamBox
|Data |
|
+----------------------------------------------------------------------| Descrio | Programa que demonstra a utilizao da PARAMBOX como
|
|
| forma alternativa de disponibilizar parmetros em um
|
|
| processamento.
|
+----------------------------------------------------------------------| Uso
| Curso ADVPL
|
+----------------------------------------------------------------------/*/
User Function xParamBox()
Local aRet := {}
Local aParamBox := {}
Local aCombo :=
{"Janeiro","Fevereiro","Maro","Abril","Maio","Junho","Julho","Agosto","Setembro
","Outubro","Novembro","Dezembro"}
Local i
:= 0
Private cCadastro := "xParambox"
AADD(aParamBox,{1,"Produto",Space(15),"","","SB1","",0,.F.})
AADD(aParamBox,{2,"Tipo de cliente",1,aCombo,50,"",.F.})
AADD(aParamBox,{3,"Mostra
deletados",IIF(Set(_SET_DELETED),1,2),{"Sim","No"},50,"",.F.})
AADD(aParamBox,{4,"Marca todos ?",.F.,"Marque todos se necessrio
for.",50,"",.F.})
AADD(aParamBox,{5,"Marca todos ?",.F.,50,"",.F.})
AADD(aParamBox,{6,"Qual arquivo",Space(50),"","","",50,.F.,;
"Arquivo .DBF |*.DBF"})
AADD(aParamBox,{7,"Monte o filtro","SX5","X5_FILIAL==xFilial('SX5')"})
AADD(aParamBox,{8,"Digite a senha",Space(15),"","","","",80,.F.})
If ParamBox(aParamBox,"Teste Parmetros...",@aRet)
For i:=1 To Len(aRet)
MsgInfo(aRet[i],"Opo escolhida")
Next
Endif
Return
Exemplo: Protegendo os parmetros MV_PARs da Pergunte() em uso.
/*/
+----------------------------------------------------------------------------| Funo
| XPARBOX()
| Autor | ARNALDO RAYMUNDO JR.|Data |
|
+----------------------------------------------------------------------------| Descrio | Funo utilizando a PARAMBOX() e protegendo os MV_PARs
|
|
| ativos do programa principal.
|
+----------------------------------------------------------------------------| Uso
| Curso ADVPL
|
+----------------------------------------------------------------------------/*/
Static Function XPARBOX(cPerg)
Local
Local
Local
Local
Local
Local
Local
Local
aParamBox
:= {}
cTitulo
:= "Transferncia para Operao"
bOk
:= {|| .T.}
aButtons
:= {}; Local aRet := {}
nPosx; Local nPosy; Local nX := 0
cLoad
:= ""
lCentered
:= .T.; Local lCanSave := .F.; Local lUserSave := .F.
aParamAtu := Array(4)
// Salva as perguntas padres antes da chamada da ParamBox

For nX := 1 to Len(aParamAtu)
aParamAtu [nX]
:= &("Mv_Par"+StrZero(nX,2))
Next nX
AADD(aParamBox,{2,"Atualiza taxa de depreciao?", 2, {"Sim","No"}, 100,;
"AllwaysTrue()",.T.})
ParamBox(aParamBox, cTitulo, aRet, bOk, aButtons, lCentered, nPosx, nPosy,
/*oMainDlg*/ ,;
cLoad, lCanSave, lUserSave)
IF ValType(aRet) == "A" .AND. Len(aRet) == Len(aParamBox)
For nX := 1 to Len(aParamBox)
If aParamBox[nX][1] == 1
&("MvParBox"+StrZero(nX,2)) := aRet[nX]
ElseIf aParamBox[nX][1] == 2 .AND. ValType(aRet[nX]) == "C"
&("MvParBox"+StrZero(nX,2)) := aScan(aParamBox[nX][4],;
{|x| Alltrim(x) == aRet[nX]})
ElseIf aParamBox[nX][1] == 2 .AND. ValType(aRet[nX]) == "N"
Endif
Next nX
ENDIF
// Restaura as perguntas padres apos a chamada da ParamBox
For nX := 1 to Len(aParamAtu)
&("Mv_Par"+StrZero(nX,2)) := aParamAtu[nX]
Next nX
Return
MDULO 05: Introduo a orientao objetos

27.
Conceitos de orientao objetos
O termo orientao a objetos pressupe uma organizao de software em termos de coleo

de objetos discretos incorporando estrutura e comportamento prprios. Esta abordagem de
organizao essencialmente diferente do desenvolvimento tradicional de software, onde
estruturas de dados e rotinas so desenvolvidas de forma apenas fracamente acopladas.
Neste tpico sero os conceitos de programao orientada a objetos listados abaixo. Esta
breve viso geral do paradigma permitir entender melhor os conceitos associados
programao orientada a objetos e, em particular, s construes implementadas atravs da
linguagem ADVPL.
Objetos
Herana
Atributos
Mtodos
Classes
Abstrao
Generalizao
Encapsulamento
Polimorfismo
27.1. Definies
Objeto
Um objeto uma entidade do mundo real que tem uma identidade. Objetos podem
representar entidades concretas (um arquivo no meu computador, uma bicicleta) ou entidades
conceituais (uma estratgia de jogo, uma poltica de escalonamento em um sistema
operacional). Cada objeto ter sua identidade significa que dois objetos so distintos mesmo
que eles apresentem exatamente as mesmas caractersticas.
Embora objetos tenham existncia prpria no mundo real, em termos de linguagem de
programao um objeto necessita um mecanismo de identificao. Esta identificao de objeto
deve ser nica, uniforme e independente do contedo do objeto. Este um dos mecanismos
que permite a criao de colees de objetos, as quais so tambm objetos em si.
A estrutura de um objeto representada em termos de atributos. O comportamento de um
objeto representado pelo conjunto de operaes que podem ser executadas sobre o objeto.
Classe
Objetos com a mesma estrutura e o mesmo comportamento so agrupados em classes. Uma
classe uma abstrao que descreve propriedades importantes para uma aplicao e
simplesmente ignora o resto.
Cada classe descreve um conjunto (possivelmente infinito) de objetos individuais. Cada objeto
dito ser uma instncia de uma classe. Assim, cada instncia de uma classe tem seus prprios
valores para cada atributo, mas dividem os nomes dos atributos e mtodos com as outras
instncias da classe. Implicitamente, cada objeto contm uma referncia para sua prpria
classe, em outras palavras, ele sabe o que ele .
Figura: Representao de uma classe de objetos
Figura: Representao de um objeto instanciado de uma classe
Polimorfismo
Polimorfismo significa que a mesma operao pode se comportar de forma diferente em
classes diferentes. Por exemplo, a operao move quando aplicada a uma janela de um
sistema de interfaces tem um comportamento distinto do que quando aplicada a uma pea de
um jogo de xadrez. Um mtodo uma implementao especfica de uma operao para uma
certa classe.
Polimorfismo tambm implica que uma operao de uma mesma classe pode ser
implementada por mais de um mtodo. O usurio no precisa saber quantas implementaes
existem para uma operao, ou explicitar qual mtodo deve ser utilizado: a linguagem de
programao deve ser capaz de selecionar o mtodo correto a partir do nome da operao,
classe do objeto e argumentos para a operao. Desta forma, novas classes podem ser
adicionadas sem necessidade de modificao de cdigo j existente, pois cada classe apenas
define os seus mtodos e atributos.
No mundo real, alguns objetos e classes podem ser descritos como casos especiais, ou
especializaes, de outros objetos e classes. Por exemplo, a classe de computadores pessoais
com processador da linha 80x86 uma especializao de computadores pessoais, que por sua
vez uma especializao de computadores. No desejvel que tudo que j foi descrito para
computadores tenha de ser repetido para computadores pessoais ou para computadores
pessoais com processador da linha 80x86.
Herana
Herana o mecanismo do paradigma de orientao a objetos que permite compartilhar
atributos e operaes entre classes baseada em um relacionamento hierrquico. Uma classe
pode ser definida de forma genrica e depois refinada sucessivamente em termos de
subclasses ou classes derivadas. Cada subclasse incorpora, or herda, todas as propriedades de
sua superclasse (ou classe base) e adiciona suas propriedades nicas e particulares. As
propriedades da classe base no precisam ser repetidas em cada classe derivada. Esta
capacidade de fatorar as propriedades comuns de diversas classes em uma superclasse pode
reduzir dramaticamente a repetio de cdigo em um projeto ou programa, sendo uma das
principais vantagens da abordagem de orientao a objetos.
27.2. Conceitos Bsicos

A abordagem de orientao a objetos favorece a aplicao de diversos conceitos considerados
fundamentais para o desenvolvimento de bons programas, tais como abstrao e
encapsulamento.
Tais conceitos no so exclusivos desta abordagem, mas so suportados de forma melhor no
desenvolvimento orientado a objetos do que em outras metodologias.
Abstrao
Abstrao consiste de focalizar nos aspectos essenciais inerentes a uma entidade e ignorar
propriedades acidentais. Em termos de desenvolvimento de sistemas, isto significa
concentrar-se no que um objeto e faz antes de se decidir como ele ser implementado. O
uso de abstrao preserva a liberdade para tomar decises de desenvolvimento ou de
implementao apenas quando h um melhor entendimento do problema a ser resolvido.
Muitas linguagens de programao modernas suportam o conceito de abstrao de dados;
porm, o uso de abstrao juntamente com polimorfismo e herana, como suportado em
orientao a objetos, um mecanismo muito mais poderoso.
O uso apropriado de abstrao permite que um mesmo modelo conceitual (orientao a
objetos) seja utilizado para todas as fases de desenvolvimento de um sistema, desde sua
anlise at sua documentao.
Encapsulamento
Encapsulamento, tambm referido como esconder informao, consiste em separar os
aspectos externos de um objeto, os quais so acessveis a outros objetos, dos detalhes
internos de implementao do objeto, os quais permanecem escondidos dos outros objetos. O
uso de encapsulamento evita que um programa torne-se to interdependente que uma
pequena mudana tenha grandes efeitos colaterais.
O uso de encapsulamento permite que a implementao de um objeto possa ser modificada
sem afetar as aplicaes que usam este objeto. Motivos para modificar a implementao de
um objeto podem ser, por exemplo, melhoria de desempenho, correo de erros e mudana de
plataforma de execuo.
Assim como abstrao, o conceito de Encapsulamento no exclusivo da abordagem de
orientao a objetos. Entretanto, a habilidade de se combinar estrutura de dados e
comportamento em uma nica entidade torna a Encapsulamento mais elegante e mais
poderosa do que em linguagens convencionais que separam estruturas de dados e
comportamento.
Compartilhamento
Tcnicas de orientao a objetos promovem compartilhamento em diversos nveis distintos.
Herana de estrutura de dados e comportamento permite que estruturas comuns sejam
compartilhadas entre diversas classes derivadas similares sem redundncia. O
compartilhamento de cdigo usando herana uma das grandes vantagens da orientao a
objetos. Ainda mais importante que a economia de cdigo a clareza conceitual de reconhecer
que operaes diferentes so na verdade a mesma coisa, o que reduz o nmero de casos
distintos que devem ser entendidos e analisados.
O desenvolvimento orientado a objetos no apenas permite que a informao dentro de um

projeto seja compartilhada como tambm oferece a possibilidade de reaproveitar projetos e
cdigo em projetos futuros. As ferramentas para alcanar este compartilhamento, tais como
abstrao, Encapsulamento e herana, esto presentes na metodologia; uma estratgia de
reuso entre projetos a definio de bibliotecas de elementos reusveis. Entretanto,
orientao a objetos no uma frmula mgica para alcanar reusabilidade; para tanto,
preciso planejamento e disciplina para pensar em termos genricos, no voltados
simplesmente para a aplicao corrente.
27.3. O Modelo de Objetos (OMT)

Um modelo de objetos busca capturar a estrutura esttica de um sistema mostrando os
objetos existentes, seus relacionamentos, e atributos e operaes que caracterizam cada
classe de objetos. atravs do uso deste modelo que se enfatiza o desenvolvimento em
termos de objetos ao invs de mecanismos tradicionais de desenvolvimento baseado em
funcionalidades, permitindo uma representao mais prxima do mundo real.
Uma vez que as principais definies e conceitos da abordagem de orientao a objetos esto
definidos, possvel introduzir o modelo de objetos que ser adotado ao longo deste texto. O
modelo apresentado um subconjunto do modelo OMT (Object Modeling Technique), proposto
por Rumbaugh entre outros. Este modelo tambm introduz uma representao diagramtica
para este modelo, a qual ser tambm apresentada aqui.
27.3.1.
Objetos e Classes
Objeto definido neste modelo como um conceito, abstrao ou coisa com limites e
significados bem definidos para a aplicao em questo. Objetos tm dois propsitos:
promover o entendimento do mundo real e suportar uma base prtica para uma
implementao computacional. No existe uma maneira correta de decompor um problema
em objetos; esta decomposio depende do julgamento do projetista e da natureza do
problema. Todos os objetos tm identidade prpria e so distinguveis.
Uma classe de objetos descreve um grupo de objetos com propriedades (atributos) similares,
comportamentos (operaes) similares, relacionamentos comuns com outros objetos e uma
semntica comum. Por exemplo, Pessoa e Companhia so classes de objetos. Cada pessoa
tem um nome e uma idade; estes seriam os atributos comuns da classe. Companhias tambm
podem ter os mesmos atributos nome e idade definidos. Entretanto, devido distino
semntica elas provavelmente estariam agrupados em outra classe que no Pessoa. Como se
pode observar, o agrupamento em classes no leva em conta apenas o compartilhamento de
propriedades.
Todo objeto sabe a que classe ele pertence, ou seja, a classe de um objeto um atributo
implcito do objeto. Este conceito suportado na maior parte das linguagens de programao
orientada a objetos, inclusive em ADVPL.
OMT define dois tipos de diagramas de objetos, diagramas de classes e diagramas de
instncias. Um diagrama de classe um esquema, ou seja, um padro ou gabarito que
descreve as muitas possveis instncias de dados. Um diagrama de instncias descreve como
um conjunto particular de objetos est relacionado. Diagramas de instncias so teis para
apresentar exemplos e documentar casos de testes; diagramas de classes tm uso mais
amplos. A Figura abaixo apresenta a notao adotada para estes diagramas.
Figura: Representao diagramtica de OMT para classes e objetos
O agrupamento de objetos em classes um poderoso mecanismo de abstrao. Desta forma,

possvel generalizar definies comuns para uma classe de objetos, ao invs de repet-las
para cada objeto em particular. Esta uma das formas de reutilizao e economia que a
abordagem de orientao a objetos suporta.
27.3.2.
Atributos
Um atributo um valor de dado assumido pelos objetos de uma classe. Nome, idade e peso
so exemplos de atributos de objetos Pessoa. Cor, peso e modelo so possveis atributos de
objetos Carro. Cada atributo tem um valor para cada instncia de objeto. Por exemplo, o
atributo idade tem valor ``29'' no objeto Pedro Y. Em outras palavras, Pedro Y tem 29 anos de
idade. Diferentes instncias de objetos podem ter o mesmo valor para um dado atributo.
Cada nome de atributo nico para uma dada classe, mas no necessariamente nico entre
todas as classes. Por exemplo, ambos Pessoa e Companhia podem ter um atributo chamado
endereo.
No diagrama de classes, atributos so listados no segundo segmento da caixa que representa
a classe. O nome do atributo pode ser seguido por detalhes opcionais, tais como o tipo de
dado assumido e valor default. A Figura abaixo mostra esta representao.
Figura: Representao diagramtica de OMT para classes e objetos com atributos

No se deve confundir identificadores internos de objetos com atributos do mundo real.
Identificadores de objetos so uma convenincia de implementao, e no tm nenhum
significado para o domnio da aplicao. Por exemplo, CIC e RG no so identificadores de
objetos, mas sim verdadeiros atributos do mundo real.
27.3.3.
Operaes e Mtodos
Uma operao uma funo ou transformao que pode ser aplicada a ou por objetos em uma
classe. Por exemplo, abrir, salvar e imprimir so operaes que podem ser aplicadas a objetos
da classe Arquivo. Todos os objetos em uma classe compartilham as mesmas operaes.
Toda operao tem um objeto-alvo como um argumento implcito. O comportamento de uma
operao depende da classe de seu alvo. Como um objeto sabe qual sua classe, possvel
escolher a implementao correta da operao. Alm disto, outros argumentos (parmetros)
podem ser necessrios para uma operao.
Uma mesma operao pode se aplicar a diversas classes diferentes. Uma operao como esta
dita ser polimrfica, ou seja, ela pode assumir distintas formas em classes diferentes.
Um mtodo a implementao de uma operao para uma classe. Por exemplo, a operao
imprimir pode ser implementada de forma distinta, dependendo se o arquivo a ser impresso
contm apenas texto ASCII, um arquivo de um processador de texto ou binrio. Todos estes
mtodos executam a mesma operao: imprimir o arquivo; porm, cada mtodo ser
implementado por um diferente cdigo.
A assinatura de um mtodo dada pelo nmero e tipos de argumentos do mtodo, assim
como por seu valor de retorno. Uma estratgia de desenvolvimento recomendvel manter
assinaturas coerentes para mtodos implementando uma dada operao, assim como um
comportamento consistente entre as implementaes.
Em termos de diagramas OMT, operaes so listadas na terceira parte da caixa de uma
classe. Cada nome de operao pode ser seguida por detalhes opcionais, tais como lista de
argumentos e tipo de retorno. A lista de argumentos apresentada entre parnteses aps o
nome da operao. Uma lista de argumentos vazia indica que a operao no tem
argumentos; da ausncia da lista de argumentos no se pode concluir nada. O tipo de
resultado vem aps a lista de argumentos, sendo precedido por dois pontos (:). Caso a
operao retorne resultado, este no deve ser omitido, pois esta a forma de distingui-la de
operaes que no retornam resultado. Exemplos de representao de operaes em OMT so
apresentados na Figura abaixo:
Figura: Representao diagramtica de OMT para classes com atributos e operaes
27.3.4.
Sugestes de desenvolvimento
Na construo de um modelo para uma aplicao, as seguintes sugestes devem ser

observadas a fim de se obter resultados claros e consistentes:
No comece a construir um modelo de objetos simplesmente definindo classes,
associaes e heranas. A primeira coisa a se fazer entender o problema a ser
resolvido.
Tente manter seu modelo simples. Evite complicaes desnecessrias.
Escolha nomes cuidadosamente. Nomes so importantes e carregam conotaes
poderosas. Nomes devem ser descritivos, claros e no deixar ambigidades. A escolha
de bons nomes um dos aspectos mais difceis da modelagem.
No enterre apontadores ou outras referncias a objetos dentro de objetos como
atributos. Ao invs disto, modele estas referncias como associaes. Isto torna o
modelo mais claro e independente da implementao.
Tente evitar associaes que envolvam trs ou mais classes de objetos. Muitas vezes,
estes tipos de associaes podem ser decompostos em termos de associaes binrias,
tornando o modelo mais claro.
No transfira os atributos de ligao para dentro de uma das classes.
Tente evitar hierarquias de generalizao muito profundas.
No se surpreenda se o seu modelo necessitar vrias revises; isto o normal.
Sempre documente seus modelos de objetos. O diagrama pode especificar a estrutura
do modelo, mas nem sempre suficiente para descrever as razes por trs da definio
do modelo. Uma explicao escrita pode clarificar pontos tais como significado de
nomes e explicar a razo para cada classe e relacionamento.
Nem sempre todas as construes OMT so necessrias para descrever uma aplicao.
Use apenas aquelas que forem adequadas para o problema analisado.
28.
Orientao a objetos em ADVPL
Neste tpico ser detalhada a forma com a qual a linguagem ADVPL implementa os conceitos
de orientao a objetos e a sintaxe utilizada no desenvolvimento de aplicaes.
28.1. Sintaxe e operadores para orientao a objetos

Palavras reservadas
CLASS
CONSTRUCTOR
DATA
ENDCLASS
FROM
METHOD
SELF
CLASS
Descrio
Utilizada na declarao de uma classe de objetos, e para identificar a qual

classe um determinado mtodo est relacionado.
Sintaxe 1
CLASS <nome_da_classe>
Sintaxe 2
METHOD <nome_do_mtodo> CLASS <nome_da_classe>
CONSTRUCTOR
Descrio
Utilizada na especificao de um mtodo especial, definido como construtor,

o qual tem a funo de retornar um novo objeto com os atributos e mtodos
definidos na classe.
Sintaxe
METHOD <nome_do_mtodo()> CONSTRUCTOR
DATA
Descrio
Utilizada na declarao de um atributo da classe de objetos.
Sintaxe
DATA <nome_do_atributo>
ENDCLASS
Descrio
Utilizada na finalizao da declarao da classe.
Sintaxe
ENDCLASS
FROM
Descrio
Utilizada na declarao de uma classe, a qual ser uma instncia de uma

superclasse, recebendo os atributos e mtodos nela definidos,
implementando a herana entre classes.
Sintaxe
CLASS <nome_da_classe> FROM <nome_da_superclasse>
METHOD
Descrio
Utilizada na declarao do prottipo do mtodo de uma classe de objetos, e

na declarao do mtodo efetivamente desenvolvido.
Sintaxe 1
METHOD <nome_do_mtodo()>
Sintaxe 2
METHOD <nome_do_mtodo(<parmetros>)> CLASS <nome_da_classe>
SELF
Descrio
Utilizada principalmente pelo mtodo construtor para retornar o objeto

criado para a aplicao.
Sintaxe
Return SELF
Operadores especficos
Utilizado para referenciar um mtodo ou um atributo de um objeto j

instanciado.
Exemplo 1
cNome := oAluno:sNome
Exemplo 2
cNota := oAluno:GetNota(cCurso)
::
Utilizado pelos mtodos de uma classe para referenciar os atributos

disponveis para o objeto.
METHOD GetNota(cCurso) CLASS ALUNO
Local nPosCurso := 0
Local nNota := 0
nPosCurso := aScan(::aCursos,{|aCurso| aCurso[1] == cCurso})
Exemplo
IF nPosCurso > 0
nNota := ::aCursos[nPosCurso][2]
ENDIF
Return nNota
28.2. Estrutura de uma classe de objetos em ADVPL

Declarao da classe
A declarao de uma classe da linguagem ADVPL realizada de forma similar a declarao de
uma funo, com a diferena de que uma classe no possui diferenciao quanto a sua
procedncia, como uma Function() e uma User Function(), e no possui visibilidade limitada
como uma Static Function().
Exemplo:
CLASS Pessoa()
Definio dos atributos

Seguindo o mesmo princpio de variveis no tipadas, os atributos das classes em ADVPL no
precisam ter seu tipo especificado, sendo necessrio apenas determinar seus nomes.
Desta forma recomendado o uso da notao Hngara tambm para a definio dos atributos
de forma a facilitar a anlise, interpretao e utilizao da classe e seus objetos instanciados.
Exemplo:
CLASS Pessoa()
DATA cNome
DATA nIdade
Prototipao dos mtodos

A prototipao dos mtodos uma regra utilizada pelas linguagens orientadas a objetos,
atravs da qual so especificadas as operaes que podem ser realizadas pelo objeto,
diferenciando os mtodos de outras funes internas de uso da classe, e para especificar quais
so os mtodos construtores.
Em linguagens tipadas, na prototipao dos mtodos necessrio definir quais so os
parmetros recebidos e seus respectivos tipos, alm de definir o tipo do retorno que ser
fornecido. Em ADVPL necessrio apenas descrever a chamada do mtodo e caso necessrio
se o mesmo um construtor.
Exemplo:
CLASS Pessoa()
DATA cNome
DATA nIdade
METHOD Create() CONSTRUCTOR
METHOD SetNome()
METHOD SetIdade()
ENDCLASS
28.3. Implementao dos mtodos de uma classe em ADVPL

Mtodo Construtor
O mtodo construtor possui a caracterstica de retornar um objeto com o tipo da classe da qual
o mesmo foi instanciado. Por esta razo diz-se que o tipo do objeto instanciado a classe
daquele objeto.
Para produzir este efeito, o mtodo construtor utiliza a palavra reservada SELF, a qual
utilizada pela linguagem ADVPL para referncia a prpria classe daquele objeto.
Exemplo:
CLASS Pessoa()
DATA cNome
DATA nIdade
METHOD SetNome()
METHOD SetIdade()
ENDCLASS
METHOD Create(cNome, nIdade) CLASS Pessoa
::cNome := cNome
::nIdade := nIdade
Return SELF
Manipulao de atributos
Os atributos definidos para uma classe com a utilizao da palavra reservada DATA em sua
declarao podem ser manipulados por seus mtodos utilizando o operador ::.
A utilizao deste operador permite ao interpretador ADVPL diferenciar variveis comuns
criadas pelas funes e mtodos que utilizam este objeto dos atributos propriamente ditos.
Exemplo:
CLASS Pessoa()
DATA cNome
DATA nIdade
METHOD SetNome()
METHOD SetIdade()
ENDCLASS
METHOD Create(cNome, nIdade) CLASS Pessoa
::cNome := cNome
::nIdade := nIdade
Return SELF
Utilizao de funes em uma classe de objetos

Conforme mencionado anteriormente, a utilizao da palavra reservada METHOD permite ao
interpretador ADVPL diferenciar os mtodos que podem ser utilizados atravs da referncia do
objeto de funes internas descritas internamente na classe.
Isto permite a utilizao de funes tradicionais da linguagem ADVPL, como as Static
Functions() as quais sero visveis apenas a classe, e no podero ser referenciadas
diretamente pelo objeto.
Exemplo parte 01: Funo CadPessoa (usuria da classe Pessoa)
USER FUNCTION CadPessoa()
Local
Local
Local
Local
oPessoa
cNome :=
dNascimento:= CTOD()
aDados := {}
aDados := GetDados()
oPessoa := Pessoa():Create(cNome,dNascimento)
Return
Exemplo parte 02: Classe Pessoa

CLASS Pessoa()
DATA cNome
DATA nIdade
DATA dNascimento
METHOD SetNome()
METHOD SetIdade()
ENDCLASS
METHOD Create(cNome, dNascimento) CLASS Pessoa
::cNome := cNome
::dNascimento := dNascimento
::nIdade := CalcIdade(dNascimento)
Return SELF
STATIC FUNCTION CalcIdade(dNascimento)
Local nIdade
nIdade := dDataBase - dNascimento
RETURN nIdade
Herana entre classes

Seguindo o principio da orientao a objetos, a linguagem ADVPL permite que uma classe
receba por herana os mtodos e atributos definidos em uma outra classe, a qual tornasse a
superclasse desta instncia.
Para utilizar este recurso deve ser utilizada a palavra reservada FROM na declarao da
classe, especificando a superclasse que ser referenciada.
Em ADVPL o exemplo prtico desta situao a superclasse TSrvObject, a qual utilizada pela
maioria das classes e componentes da interface visual, como demonstrado no mdulo 06.
Exemplo parte 01: Declarao da classe Pessoa

CLASS Pessoa()
DATA cNome
DATA nIdade
DATA dNascimento
METHOD SetNome()
METHOD SetIdade()
ENDCLASS
Exemplo parte 02: Declarao da classe Aluno

CLASS Aluno() FROM Pessoa
DATA nID
DATA aCursos
METHOD
METHOD
METHOD
METHOD
METHOD
Create() CONSTRUCTOR
Inscrever()
Avaliar()
GetNota()
GetStatus()
ENDCLASS
// Os objetos da classe Aluno, possuem todos os mtodos e atributos da classe
Pessoa, alm
// dos mtodos e atributos declarados na prpria classe.
Construtor para classes com herana

Quanto utilizado o recurso de herana entre classes, o construtor da classe instanciada deve
receber um tratamento adicional, para que o objeto instanciado seja criado com os atributos e
mtodos definidos na superclasse.
Nestes casos, logo aps a definio do mtodo construtor da classe, dever ser executado o
mtodo construtor da superclasse.
Exemplo parte 03: Mtodo Construtor da classe Aluno
METHOD Create(cNome,dNascimento,nID)
:Create(cNome,dNascimento) // Chamada do mtodo construtor da classe Pessoa.
::nID := ID
Return SELF
MDULO 06: ADVPL Orientado objetos I

Neste mdulo sero tratados os componentes e objetos da interface visual da linguagem
ADVPL, permitindo o desenvolvimento de aplicaes com interfaces grficas com sintaxe
orientada a objetos.
29.
Componentes da interface visual do ADVPL
A linguagem ADVPL possui diversos componentes visuais e auxiliares, os quais podem ser
representados utilizando a estrutura abaixo:
Classes da Interface Visual

Tsrvobject
Classes Auxiliares
Tfont
Classes de Janelas
Msdialog
Tdialog
Twindow
Classes de Componentes
Tcontrol
Visuais
Brgetddb
Mscalend
Mscalendgrid
Msselbr
Msworktime
Sbutton
Tbar
Tbitmap
Tbrowsebutton
Tbtnbmp
Tbtnbmp2
Tbutton
Tcbrowse
Tcheckbox
Tcolortriangle
Tcombobox
Tfolder
Tfont
Tget
Tgroup
Thbutton
Tibrowser
Tlistbox
Tmenu
Tmenubar
Tmeter
Tmsgraphic
Tmsgbar
Tmultibtn
Tmultiget
Tolecontainer
Tpageview
Tpanel
Tradmenu
Tsbrowse
Tsay
Tscrollbox
Tsimpleeditor
Tslider
Visuais
Tsplitter
Ttabs
Ttoolbox
Twbrowse
Vcbrowse
Classes da interface visual

TSRVOBJECT()
Descrio
Classe abstrata inicial de todas as classes de interface do ADVPL. No deve

ser instanciada diretamente.
Classes auxiliares
TFONT()
Descrio
Classe de objetos que define a fonte do texto utilizado nos controles

visuais.
Classes de janelas
MSDIALOG()
Descrio
Classe de objetos que deve ser utilizada como padro de janela para
entrada de dados. MSDialog um tipo de janela dilogo modal, isto ,
no permite que outra janela ativa receba dados enquanto esta estiver
ativa.
TDIALOG()
Descrio
Classe de objetos do tipo dilogo de entrada de dados, sendo seu uso

reservado. Recomenda-se utilizar a classe MSDialog que herdada desta
classe.
TWINDOW()
Descrio
Classe de objetos do tipo dilogo principal de programa. Dever existir

apenas uma instncia deste objeto na execuo do programa.
Classes de componentes
TCONTROL()
Descrio
Classe abstrata comum entre todos os componentes visuais editveis.

No deve ser instanciada diretamente.
Classes de componentes visuais

BRGETDDB()
Descrio
Classe de objetos visuais do tipo Grid.
MSCALEND()
Descrio
Classe de objetos visuais do tipo Calendrio.
MSCALENDGRID()
Descrio
Classe de objetos visuais do tipo Grade de Perodos.
MSSELBR()
Descrio
Classe de objetos visuais do tipo controle - Grid
MSWORKTIME()
Descrio
Classe de objetos visuais do tipo controle - Barra de Perodo.
SBUTTON()
Descrio
Classe de objetos visuais do tipo boto, o qual pode possuir imagens

padres associadas ao seu tipo.
TBAR()
Descrio
Classe de objetos visuais do tipo Barra Superior.
TBITMAP()
Descrio
Classe de objetos visuais que permite a exibio de uma imagem.
TBROWSEBUTTON()
Descrio
Classe de objetos visuais do tipo boto no formato padro utilizado

em browses da aplicao.
TBTNBMP()
Descrio
Classe de objetos visuais do tipo boto, o qual permite que seja

vinculada uma imagem ao controle.
TBTNBMP2()
Descrio
Classe de objetos visuais do tipo boto, o qual permite a exibio de

uma imagem ou de um popup.
TBUTTON()
Descrio
Classe de objetos visuais do tipo boto, o qual permite a utilizao de

texto para sua identificao.
TCBROWSE()
Descrio
Classe de objetos visuais do tipo Grid.
TCHECKBOX()
Descrio
Classe de objetos visuais do tipo controle - CheckBox.
TCOLORTRIANGLE()
Descrio
Classe de objetos visuais do tipo Paleta de Cores.
TCOMBOBOX()
Descrio
Classe de objetos visuais do tipo tComboBox, a qual cria uma entrada

de dados com mltipla escolha com item definido em uma lista
vertical, acionada por F4 ou pelo boto esquerdo localizado na parte
direita do controle. A varivel associada ao controle ter o valor de
um dos itens selecionados ou no caso de uma lista indexada, o valor
de seu ndice.
TFOLDER()
Descrio
Classe de objetos visuais do tipo controle - Folder.
TGET()
Descrio
Classe de objetos visuais do tipo controle tGet, a qual cria um

controle que armazena ou altera o contedo de uma varivel atravs
de digitao. O contedo da varivel s modificado quando o
controle perde o foco de edio para outro controle.
TGROUP()
Descrio
Classe de objetos visuais do tipo painel tGroup, a qual cria um

painel onde controles visuais podem ser agrupados ou classificados.
Neste painel criada uma borda com ttulo em volta dos controles
agrupados.
THBUTTON()
Descrio
Classe de objetos visuais do tipo boto com hiperlink.
TIBROWSER()
Descrio
Classe de objetos visuais do tipo Pgina de Internet, sendo necessrio

incluir a clausula BrowserEnabled=1 no Config do Remote.INI
TLISTBOX()
Descrio
Classe de objetos visuais do tipo controle tListbox, a qual cria uma

janela com itens selecionveis e barra de rolagem. Ao selecionar um
item, uma varivel atualizada com o contedo do item selecionado.
TMENU()
Descrio
Classe de objetos visuais do tipo controle - Menu.
TMENUBAR()
Descrio
Classe de objetos visuais do tipo controle - Barra de Menu.
TMETER()
Descrio
Classe de objetos visuais do tipo controle tMeter, a qual exibe uma

rgua (gauge) de processamento, descrevendo o andamento de um
processo atravs da exibio de uma barra horizontal.
TMSGRAPHIC()
Descrio
Classe de objetos visuais do tipo controle - Grfico.
TMSGBAR()
Descrio
Classe de objetos visuais do tipo controle - Rodap.
TMULTIBTN()
Descrio
Classe de objetos visuais do tipo controle - Mltiplos botes.
TMULTIGET()
Descrio
Classe de objetos visuais do tipo controle - edio de texto de

mltiplas linhas.
TOLECONTAINER()
Descrio
Classe de objetos visuais do tipo controle, a qual permite a criao de

um boto vinculado a um objeto OLE.
TPAGEVIEW()
Descrio
Classe de objetos visuais do tipo controle, que permite a visualizao

de arquivos no formato gerado pelo spool de impresso do Protheus.
TPANEL()
Descrio
Classe de objetos visuais do tipo controle tPanel, a qual permite

criar um painel esttico, onde podem ser criados outros controles com
o objetivo de organizar ou agrupar componentes visuais.
TRADMENU()
Descrio
Classe de objetos visuais do tipo controle TRadMenu, a qual permite

criar um controle visual no formato Radio Button.
TSBROWSE()
Descrio
Classe de objetos visuais do tipo controle TSBrowse, a qual permite

criar um controle visual do tipo Grid.
TSAY()
Descrio
Classe de objetos visuais do tipo controle tSay, a qual exibe o

contedo de texto esttico sobre uma janela ou controle previamente
definidos.
TSCROLLBOX()
Descrio
Classe de objetos visuais do tipo controle tScrollbox, a qual permite

criar um painel com scroll deslizantes nas laterais (horizontais e
verticais) do controle.
TSIMPLEEDITOR()
Descrio
Classe de objetos visuais do tipo controle tSimpleEditor, a qual

permite criar um controle visual para edio de textos com recursos
simples, como o NotePad
TSLIDER()
Descrio
Classe de objetos visuais do tipo controle tSlider, a qual permite

criar um controle visual do tipo boto deslizante.
TSPLITTER()
Descrio
Classe de objetos visuais do tipo controle tSplitter, a qual permite

criar um controle visual do tipo divisor.
TTABS()
Descrio
Classe de objetos visuais do tipo controle TTabs, a qual permite

criar um controle visual do tipo pasta.
TTOOLBOX()
Descrio
Classe de objetos visuais do tipo controle tToolbox, a qual permite

criar um controle visual para agrupar diferentes objetos.
TWBROWSE()
Descrio
VCBROWSE()
Descrio
Classe de objetos visuais do tipo controle TWBrowse, a qual permite

Classe de objetos visuais do tipo controle VCBrowse, a qual permite
Documentao dos componentes da interface visual

Os componentes da interface visual da linguagem ADVPL utilizados neste treinamento esto
documentados na seo Guia de Referncia, ao final deste material.
Para visualizar a documentao completa de todos os componentes mencionados neste
captulo deve ser acesso o site DEM Documentao Eletrnica Microsiga
(dem.microsiga.com.br) conforme abaixo:
29.1. Particularidades dos componentes visuais

29.1.1.
Configurando as cores para os componentes
Os componentes visuais da linguagem ADVPL utilizam o padro de cores RGB.

As cores deste padro so definidas pela seguinte frmula, a qual deve ser avaliada tendo
como base a paleta de cores no formato RGB:
nCor := nVermelho + (nVerde * 256) + (nAzul * 65536)
Figura: Paleta de cores no formato RGB

Com base nesta paleta, podemos definir os valores das seguintes cores bsicas:
Cor
Preto
Azul
Verde
Ciano
Vermelho
Rosa
Amarelo
Branco
R
0
0
0
0
255
255
255
255
G
0
0
255
255
0
0
255
255
B
0
255
0
255
0
255
0
255
Valor
0
16711680
65280
16776960
255
16711935
65535
16777215
Para atribuir as cores aos objetos visuais devem ser observados os atributos utilizados para
estes fins em cada objeto, como por exemplo:
MSDIALOG()
nClrPane
Cor de fundo do painel
nClrText
Cor da fonte das letras do painel
TSAY()
nClrPane
nClrText
Funo RGB()
A linguagem ADVPL possui a funo RGB() a qual retorna o valor da cor a ser definido, de
acordo com a parametrizao de cada um dos elementos da paleta RGB.
RGB(nRed, nGreen, nBlue)
nRed
Valor de 0-255 para o elemento vermelho da paleta RGB
nGreen
Valor de 0-255 para o elemento verde da paleta RGB
nBlue
Valor de 0-255 para o elemento azul da paleta RGB
Retorno
Valor a ser definido para o atributo cor do componente
30.
Aplicaes com a interface visual do ADVPL
A linguagem ADVPL possui interfaces visuais pr-definidas que auxiliam no desenvolvimento

de aplicaes mais completas, combinando estas interfaces com os componentes visuais
demonstrados anteriormente.
Didaticamente as interfaces visuais pr-definidas da linguagem ADVPL podem ser divididas em
trs grupos:
Captura de informaes simples ou Multi-Gets;
Captura de mltiplas informaes ou Multi-Lines;
Barras de botes
30.1. Captura de informaes simples (Multi-Gets)

Em ADVPL, as telas de captura de informaes compostas por mltiplos campos digitveis
acompanhados de seus respectivos textos explicativos so comumente chamados de
Enchoices.
Um Enchoice pode ser facilmente entendida como diversos conjuntos de objetos TSay e TGet
alinhados de forma a visualizar ou capturar informaes, normalmente vinculadas a arquivos
de cadastros ou movimentaes simples.
Abaixo temos a visualizao de uma Enchoice para o arquivo padro do ERP Protheus de
Cadastro de Clientes (SA1):
Figura: Enchoice do Cadastro de Clientes do ERP Protheus
A linguagem ADVPL permite a implementao da Enchoice de duas formas similares:

Funo Enchoice: Sintaxe tradicionalmente utilizada em ADVPL, a qual no retorna
um objeto para a aplicao chamadora;
Classe MsMGet: Classe do objeto Enchoice, a qual permite a instanciao direta de um
objeto, tornando-o disponvel na aplicao chamadora.
A utilizao de um ou outro objeto depende unicamente da escolha do desenvolvedor j que os
parmetros para a funo Enchoice e para o mtodo New() da classe MsMGet so os mesmos,
lembrando que para manter a coerncia com uma aplicao escrita em orientao a objetos
dever ser utilizada a classe MsMGet().
30.1.1.
Enchoice()
Sintaxe: Enchoice( cAlias, nReg, nOpc, aCRA, cLetra, cTexto, aAcho, aPos,
aCpos, nModelo, nColMens, cMensagem, cTudoOk, oWnd, lF3,
lMemoria, lColumn, caTela, lNoFolder, lProperty)
Retorno: Nil
Parmetros:
cAlias
nReg
nOpc
aCRA
cLetra
cTexto
aAcho
aPos
aCpos
nModelo
nColMens
cMensagem
cTudoOk
oWnd
lF3
lMemoria
lColumn
caTela
lNoFolder
lProperty
Tabela cadastrada no Dicionrio de Tabelas (SX2) que ser

editada
Parmetro no utilizado
Nmero da linha do aRotina que definir o tipo de edio
(Incluso, Alterao, Excluso, Visualizao)
Vetor com nome dos campos que sero exibidos. Os campos
de usurio sempre sero exibidos se no existir no parmetro
um elemento com a expresso "NOUSER"
Vetor com coordenadas para criao da enchoice no formato
{<top>, <left>, <bottom>, <right>}
Vetor com nome dos campos que podero ser editados
Se for diferente de 1 desabilita execuo de gatilhos
estrangeiros
Expresso para validao da Enchoice
Objeto (janela, painel, etc.) onde a enchoice ser criada.
Indica se a enchoice esta sendo criada em uma consulta F3
para utilizar variveis de memria
Indica se a enchoice utilizar variveis de memria ou os
campos da tabela na edio
Indica se a apresentao dos campos ser em forma de
coluna
Nome da varivel tipo "private" que a enchoice utilizar no
lugar da propriedade aTela
Indica se a enchoice no ir utilizar as Pastas de Cadastro
(SXA)
Indica se a enchoice no utilizar as variveis aTela e aGets,
somente suas propriedades com os mesmos nomes
Exemplo: Utilizao da funo Enchoice()
/*/
+----------------------------------------------------------------------------| Funo
| MBRWENCH
|
+----------------------------------------------------------------------------| Descrio | Programa que demonstra a utilizao da funo Enchoice()
|
+----------------------------------------------------------------------------| Uso
| Curso ADVPL
|
+----------------------------------------------------------------------------/*/
User Function MrbwEnch()
Private cCadastro := " Cadastro de Clientes"
Private aRotina
:=
{{"Pesquisar"
, "axPesqui"
{"Visualizar"
, "U_ModEnc"
DbSelectArea("SA1")
DbSetOrder(1)
MBrowse(6,1,22,75,"SA1")
Return
User Function ModEnc(cAlias,nReg,nOpc)
Local aCpoEnch
Local aAlter
:= {}
:= {}
Local cAliasE
:=
Local aAlterEnch :=
Local aPos
:=
Local nModelo
:=
Local lF3
:=
Local lMemoria
:=
Local lColumn
:=
Local caTela
:=
Local lNoFolder
:=
Local lProperty
:=
Private oDlg
Private oGetD
Private oEnch
Private aTELA[0][0]
Private aGETS[0]
cAlias
{}
{000,000,400,600}
3
.F.
.T.
.F.
""
.F.
.F.
DbSelectArea("SX3")
DbSetOrder(1)
DbSeek(cAliasE)
, 0, 1},;
, 0, 2}}
While !Eof() .And. SX3->X3_ARQUIVO == cAliasE
If !(SX3->X3_CAMPO $ "A1_FILIAL") .And. cNivel >= SX3->X3_NIVEL .And.;
X3Uso(SX3->X3_USADO)
AADD(aCpoEnch,SX3->X3_CAMPO)
EndIf
DbSkip()
End
aAlterEnch := aClone(aCpoEnch)
DEFINE MSDIALOG oDlg TITLE cCadastro FROM 000,000 TO 400,600 PIXEL
RegToMemory("SA1", If(nOpc==3,.T.,.F.))
Enchoice(cAliasE, nReg, nOpc, /*aCRA*/, /*cLetra*/, /*cTexto*/, ;
aCpoEnch, aPos, aAlterEnch, nModelo, /*nColMens*/,;
/*cMensagem*/,/*cTudoOk*/, oDlg, lF3, lMemoria, lColumn,;
caTela, lNoFolder, lProperty)
Return
30.1.2.
MsMGet()
Sintaxe: MsMGet():New( cAlias, nReg, nOpc, aCRA, cLetra, cTexto, aAcho,

aPos, aCpos, nModelo, nColMens, cMensagem, cTudoOk, oWnd, lF3,
Retorno: oMsMGet objeto do tipo MsMGet()

Parmetros:
cAlias
nReg
nOpc
aCRA
cLetra
cTexto
aAcho
aPos
aCpos
nModelo
nColMens
cMensagem
cTudoOk
oWnd
lF3

editada
estrangeiros
lMemoria

coluna
(SXA)
lColumn
caTela
lNoFolder
lProperty
Exemplo: Utilizao do objeto MsMGet()
/*/
+----------------------------------------------------------------------------| Funo
| MBRWMSGET | Autor | ARNALDO RAYMUNDO JR. |Data |
|
+----------------------------------------------------------------------------| Descrio | Programa que demonstra a utilizao do objeto MsMget()
|
+----------------------------------------------------------------------------| Uso
| Curso ADVPL
|
+----------------------------------------------------------------------------/*/
User Function MrbwMsGet()
Private aRotina
:=
{{"Pesquisar"
, "axPesqui"
{"Visualizar"
, "U_ModEnc"
DbSelectArea("SA1")
DbSetOrder(1)
MBrowse(6,1,22,75,"SA1")
Return
Local aCpoEnch
:= {}
Local aAlter
:= {}
Local cAliasE
Local aAlterEnch :=
Local aPos
:=
Local nModelo
:=
Local lF3
:=
Local lMemoria
:=
Local lColumn
Local caTela
Local lNoFolder
:=
Local lProperty
:=
Private oDlg
Private oGetD
Private oEnch
Private aTELA[0][0]
Private aGETS[0]
:= cAlias
{}
{000,000,400,600}
3
.F.
.T.
:= .F.
:= ""
.F.
.F.
, 0, 1},;
, 0, 2}}
DbSelectArea("SX3")
DbSetOrder(1)
DbSeek(cAliasE)
If !(SX3->X3_CAMPO $ "A1_FILIAL") .And. cNivel >= SX3->X3_NIVEL .And.
EndIf
DbSkip()
End
oDlg
:= MSDIALOG():New(000,000,400,600,cCadastro,,,,,,,,,.T.)
RegToMemory(cAliasE, If(nOpc==3,.T.,.F.))
oEnch := MsMGet():New(cAliasE, nReg, nOpc, /*aCRA*/, /*cLetra*/,;
/*cTexto*/, aCpoEnch, aPos, aAlterEnch, nModelo, /*nColMens*/,;
/*cMensagem*/, /*cTudoOk*/,oDlg,lF3,lMemoria,lColumn, caTela,;
lNoFolder, lProperty)
oDlg:lCentered := .T.
oDlg:Activate()
Return
30.2. Captura de mltiplas informaes (Multi-Lines)

A linguagem ADVPL permite a utilizao de basicamente dois tipos de objetos do tipo grid, ou
como tambm so conhecidos: multi-line:
Grids digitveis: permitem a visualizao e captura de informaes, comumente
utilizados em interfaces de cadastro e manuteno, tais como:
MSGETDB()
MSGETDADOS()
MSNEWGETDADOS()
Grids no digitveis: permitem somente a visualizao de informaes, comumente
utilizados como browses do ERP Protheus, tais como:
TWBROWSE()
MAWNDBROWSE()
MBROWSE()
Neste tpico sero tratadas as grids digitveis disponveis na linguagem ADVPL para o
desenvolvimento de interfaces de cadastros e manuteno de informaes.
30.2.1.
MsGetDB()
A classe de objetos visuais MsGetDB() permite a criao de um grid digitvel com uma ou mais
colunas, baseado em uma tabela temporria.
Sintaxe:
MsGetDB():New(nTop, nLeft, nBottom, nRight, nOpc, cLinhaOk,

cTudoOk, cIniCpos, lDelete, aAlter, nFreeze, lEmpty, uPar1, cTRB,
cFieldOk, lCondicional, lAppend, oWnd, lDisparos, uPar2, cDelOk,
cSuperDel)
Retorno: oMsGetDB objeto do tipo MsGetDB()
Parmetros:
nTop
nLeft
nBottom
nRight
nOpc
cLinhaOk
cTudoOk
cIniCpos
lDelete
aAlter
nFreeze
lEmpty
uPar1
cFieldOk
cTRB
lCondicional
lAppend
cDelOk
lDisparos
uPar2
cSuperDel
oWnd
Distancia entre a MsGetDB e o extremidade superior do

objeto que a contm.
Distancia entre a MsGetDB e o extremidade esquerda do
objeto que a contm.
Distancia entre a MsGetDB e o extremidade inferior do objeto
que a contm.
Distancia entre a MsGetDB e o extremidade direita do objeto
que a contm.
Posio do elemento do vetor aRotina que a MsGetDB usar
como referncia.
aCols.
Funo executada para validar o contexto geral da MsGetDB
(todo aCols).
Habilita a opo de excluir linhas do aCols. Valor padro
falso.
Indica qual coluna no ficara congelada na exibio.
Parmetro reservado.
Alias da tabela temporria.
Reservado
Indica se a MsGetDB ira criar uma linha em branco
automaticamente quando for incluso.
aCols.
Indica se ser utilizado o Dicionrio de Dados para consulta
padro, inicializao padro e gatilhos.
Parmetro reservado.
-Funo
executada
quando
pressionada
as
teclas
<Ctrl>+<Delete>.
Objeto no qual a MsGetDB ser criada.
Aparncia:
Variveis private:
aRotina
Vetor com as rotinas que sero executadas na MBrowse e

que definira o tipo de operao que esta sendo executada
(incluso, alterao, excluso, visualizao, pesquisa, ...) no
formato:
{cTitulo, cRotina, nOpo, nAcesso}, aonde:
nOpo segue o padro do ERP Protheus para:
12345-
aHeader
Pesquisar
Visualizar
Incluir
Alterar
Excluir
Vetor com informaes das colunas no formato:

{cTitulo, cCampo, cPicture, nTamanho, nDecimais,;
cValidao, cReservado, cTipo, xReservado1, xReservado2}
A tabela temporria utilizada pela MsGetDB dever ser criada
com base no aHeader mais um ltimo campo tipo lgico que
determina se a linha foi excluda.
lRefresh
Varivel tipo lgica para uso reservado.
Variveis pblicas:
nBrLin
Funes de validao:
cLinhaOk
cTudoOk
Indica qual a linha posicionada do aCols.
Funo de validao na mudana das linhas da grid. No

pode ser definida como Static Function.
Funo de validao da confirmao da operao com o grid.
No pode ser definida como Static Function.
Mtodos adicionais:
ForceRefresh()
Atualiza a MsGetDB com a tabela e posiciona na primeira

linha.
Exemplo: Utilizao do objeto MsGetDB()
/*/
+----------------------------------------------------------------------------| Funo
| GETDBSA1
| Autor | MICROSIGA
|Data |
|
+----------------------------------------------------------------------------| Descrio | Programa que demonstra a utilizao do objeto MsGetDB()
|
+----------------------------------------------------------------------------| Uso
| Curso ADVPL
|
+----------------------------------------------------------------------------/*/
User Function GetDbSA1()
Local
Local
Local
Local
Local
nI
oDlg
oGetDB
nUsado := 0
aStruct := {}
Private
Private
Private
Private
lRefresh := .T.
aHeader := {}
aCols := {}
aRotina := {{"Pesquisar", "AxPesqui", 0, 1},;
{"Visualizar", "AxVisual", 0, 2},;
{"Incluir", "AxInclui", 0, 3},;
{"Alterar", "AxAltera", 0, 4},;
{"Excluir", "AxDeleta", 0, 5}}
DbSelectArea("SX3")
DbSetOrder(1)
DbSeek("SA1")
While !Eof() .and. SX3->X3_ARQUIVO == "SA1"
If X3Uso(SX3->X3_USADO) .and. cNivel >= SX3->X3_NIVEL
nUsado++
AADD(aHeader,{Trim(X3Titulo()),;
SX3->X3_CAMPO,;
SX3->X3_PICTURE,;
SX3->X3_TAMANHO,;
SX3->X3_DECIMAL,;
SX3->X3_VALID,;
"",;
SX3->X3_TIPO,;
"",;
"" })
AADD(aStruct,{SX3->X3_CAMPO,SX3->X3_TIPO,SX3->X3_TAMANHO,;
SX3->X3_DECIMAL})
EndIf
DbSkip()
End
AADD(aStruct,{"FLAG","L",1,0})
cCriaTrab := CriaTrab(aStruct,.T.)
DbUseArea(.T.,__LocalDriver,cCriaTrab,,.T.,.F.)
oDlg
:= MSDIALOG():New(000,000,300,400, MsGetDB SA1,,,,,,,,,.T.)
oGetDB := MsGetDB():New(05,05,145,195,3,"U_LINHAOK", "U_TUDOOK", "+A1_COD", ;

.T.,{"A1_NOME"},1,.F.,,cCriaTrab,"U_FIELDOK",,.T.,oDlg, .T., ,"U_DELOK",;
"U_SUPERDEL")
oDlg:Activate()
DbSelectArea(cCriaTrab)
DbCloseArea()
Return
User Function LINHAOK()
ApMsgStop("LINHAOK")
Return .T.
User Function TUDOOK()
Return .T.
User Function DELOK()
ApMsgStop("DELOK")
Return .T.
User Function SUPERDEL()
ApMsgStop("SUPERDEL")
Return .T.
User Function FIELDOK()
ApMsgStop("FIELDOK")
Return .T.
30.2.2.
MsGetDados()
A classe de objetos visuais MsGetDados() permite a criao de um grid digitvel com uma ou
mais colunas, baseado em um array.
Sintaxe: MsGetDados():New( nTop, nLeft, nBottom, nRight, nOpc, cLinhaOk,

cTudoOk, cIniCpos, lDelete, aAlter, uPar1, lEmpty, nMax, cFieldOk,
cSuperDel, uPar2, cDelOk, oWnd)
Retorno: oMsGetDados objeto do tipo MsGetDados()
Parmetros:
nTop
nLeft
nBottom
nRight
nOpc
cLinhaOk
cTudoOk
cIniCpos
lDelete
aAlter
uPar1
lEmpty
nMax
cFieldOk
cSuperDel
uPar2
cDelOk
oWnd

objeto que a contm.
objeto que a contm.
objeto que a contm.
objeto que a contm.
aCols.
Habilita excluir linhas do aCols. Valor padro falso.
Parmetro reservado.
Funo
executada
quando
pressionada
as
teclas
<Ctrl>+<Delete>.
Parmetro reservado.
aCols.
Aparncia:
Variveis private:
aRotina

formato:
6- Pesquisar
7- Visualizar
8- Incluir
9- Alterar
10- Excluir
aHeader

lRefresh
Variveis pblicas:
N
Funes de validao:
cLinhaOk
cTudoOk

Mtodos adicionais:
ForceRefresh()
Hide()
Show()
Atualiza a MsGetDados com a tabela e posiciona na primeira

linha.
Oculta a MsGetDados.
Mostra a MsGetDados.
Exemplo: Utilizao do objeto MsGetDados()
/*/
+----------------------------------------------------------------------------| Funo
| GETDADOSA1 | Autor | MICROSIGA
|Data |
|
+----------------------------------------------------------------------------| Descrio | Programa que demonstra a utilizao do objeto MSGETADOS()
|
+----------------------------------------------------------------------------| Uso
| Curso ADVPL
|
+----------------------------------------------------------------------------/*/
User Function GetDadoSA1()
Local nI
Local oDlg
Local oGetDados
Local nUsado := 0
Private lRefresh := .T.
Private aCols := {}
Private aRotina := {{"Pesquisar", "AxPesqui", 0, 1},;
DbSelectArea("SX3")
DbSetOrder(1)
DbSeek("SA1")
nUsado++
SX3->X3_CAMPO,;
SX3->X3_PICTURE,;
SX3->X3_TAMANHO,;
SX3->X3_DECIMAL,;
SX3->X3_VALID,;
"",;
SX3->X3_TIPO,;
"",;
"" })
EndIf
DbSkip()
End
For nI := 1 To nUsado
aCols[1][nI] := CriaVar(aHeader[nI][2])
Next
aCols[1][nUsado+1] := .F.
oDlg
:= MSDIALOG():New(000,000,300,400, MsGetDados SA1,,,,,,,,,.T.)
oGetDados := MsGetDados():New(05, 05, 145, 195, 4, "U_LINHAOK", "U_TUDOOK",;

"+A1_COD", .T., {"A1_NOME"}, , .F., 200, "U_FIELDOK", "U_SUPERDEL",,;
"U_DELOK", oDlg)
oDlg:Activate()
Return
Return .T.
Return .T.
ApMsgStop("DELOK")
Return .T.
Return .T.
Return .T.
30.2.3.
MsNewGetDados()
A classe de objetos visuais MsNewGetDados() permite a criao de um grid digitvel com uma
ou mais colunas, baseado em um array.
Sintaxe: MsNewGetDados():New(nSuperior, nEsquerda ,nInferior, nDireita,

nOpc, cLinOk, cTudoOk, cIniCpos, aAlterGDa, nFreeze, nMax,
cFieldOk, cSuperDel, cDelOk, oDLG, aHeader, aCols)
Retorno: oMsGetDados objeto do tipo MsNewGetDados()
Parmetros:
nSuperior
nEsquerda
nInferior
nDireita
nOpc
cLinOk
cTudoOk
cIniCpos
aAlterGDa
nFreeze
Distancia entre a MsNewGetDados e o extremidade superior

do objeto que a contem
Distancia entre a MsNewGetDados e o extremidade esquerda
Distancia entre a MsNewGetDados e o extremidade inferior do
objeto que a contem
Distancia entre a MsNewGetDados e o extremidade direita do
objeto que a contem
Operao em execuo: 2- Visualizar, 3- Incluir, 4- Alterar, 5Excluir
aCols
MsNewGetDados (todo aCols)
automtico.
Campos alterveis da GetDados
Campos estticos na GetDados, partindo sempre da posio
inicial da getdados aonde:
1- Primeiro campo congelado
2- Primeiro e segundo campos congelados...
nMax
cFieldOk
cSuperDel
cDelOk
oDLG
aHeader
aCols
Nmero mximo de linhas permitidas. Valor padro 99

Funo executada na validao do campo
<Ctrl>+<Delete>
aCols
Objeto no qual a MsNewGetDados ser criada
Array a ser tratado internamente na MsNewGetDados como
aHeader
aCols
Aparncia:
Variveis private:
aRotina

formato:
12345-
aHeader
Pesquisar
Visualizar
Incluir
Alterar
Excluir

lRefresh

Variveis pblicas:
Funes de validao:
cLinhaOk

cTudoOk
Mtodos adicionais:
ForceRefresh()
Atualiza a MsNewGetDados com a tabela e posiciona na

primeira linha.
Oculta a MsNewGetDados.
Mostra a MsNewGetDados.
Hide()
Show()
Exemplo: Utilizao dos objetos MsNewGetDados() e MsMGet()
/*/
+----------------------------------------------------------------------------| Funo
| MBRWGETD
| Autor | ARNALDO RAYMUNDO JR. |Data |
|
+----------------------------------------------------------------------------| Descrio | Programa que demonstra a utilizao dos objetos
|
|
| MsNewGetDados() e MsMGet() combinados
|
+----------------------------------------------------------------------------| Uso
| Curso ADVPL
|
+----------------------------------------------------------------------------/*/
User Function MrbwGetD()
Private cCadastro := "Pedidos de Venda"
Private aRotina
:=
{{"Pesquisar"
{"Visualizar"
{"Incluir"
, "axPesqui"
, "U_ModGtd"
, "U_ModGtd"
DbSelectArea("SC5")
DbSetOrder(1)
MBrowse(6,1,22,75,"SC5")
Return
User Function ModGtd(cAlias,nReg,nOpc)
Local
Local
Local
Local
Local
Local
nX
nUsado
aButtons
aCpoEnch
cAliasE
aAlterEnch
:=
:=
:=
:=
:=
:=
0
0
{}
{}
cAlias
{}
, 0, 1},;
, 0, 2},;
, 0, 3}}
Local
Local
Local
Local
Local
Local
Local
Local
Local
Local
Local
Local
Local
Local
Local
Local
Local
Local
Local
Local
Local
Local
Local
Local
Local
aPos
nModelo
lF3
lMemoria
lColumn
caTela
lNoFolder
lProperty
aCpoGDa
cAliasGD
nSuperior
nEsquerda
nInferior
nDireita
cLinOk
cTudoOk
cIniCpos
nFreeze
nMax
cFieldOk
cSuperDel
cDelOk
aHeader
aCols
aAlterGDa
Private
Private
Private
Private
Private
:=
:=
:=
:=
:=
:=
:=
:=
{000,000,080,400}
3
.F.
.T.
:= .F.
:= ""
.F.
.F.
:= {}
"SC6"
:= 081
:= 000
:= 250
:= 400
:= "AllwaysTrue"
:= "AllwaysTrue"
:= "C6_ITEM"
:= 000
:= 999
:= "AllwaysTrue"
:= ""
:= "AllwaysFalse"
:= {}
:= {}
{}
oDlg
oGetD
oEnch
aTELA[0][0]
aGETS[0]
DbSelectArea("SX3")
DbSetOrder(1)
DbSeek(cAliasE)
If !(SX3->X3_CAMPO $ "C5_FILIAL") .And. cNivel >= SX3->X3_NIVEL .And.;
EndIf
DbSkip()
End
DbSelectArea("SX3")
DbSetOrder(1)
MsSeek(cAliasGD)
While !Eof() .And. SX3->X3_ARQUIVO == cAliasGD
If
!(AllTrim(SX3->X3_CAMPO) $ "C6_FILIAL") .And.;
cNivel >= SX3->X3_NIVEL .And. X3Uso(SX3->X3_USADO)
AADD(aCpoGDa,SX3->X3_CAMPO)
EndIf
DbSkip()
End
aAlterGDa := aClone(aCpoGDa)
nUsado:=0
dbSelectArea("SX3")
dbSeek("SC6")
aHeader:={}
nUsado:=nUsado+1
AADD(aHeader,{ TRIM(x3_titulo), x3_campo, x3_picture,x3_tamanho,;
x3_decimal,"AllwaysTrue()",x3_usado, x3_tipo, x3_arquivo, x3_context } )
Endif
dbSkip()
End
If nOpc==3 // Incluir
For nX:=1 to nUsado
IF aHeader[nX,2] == "C6_ITEM"
aCols[1,nX]:= "0001"
ELSE
ENDIF
Next
Else
aCols:={}
dbSelectArea("SC6")
dbSetOrder(1)
For nX:=1 to nUsado
Next
dbSkip()
End
Endif
oDlg
:= MSDIALOG():New(000,000,400,600, cCadastro,,,,,,,,,.T.)
RegToMemory("SC5", If(nOpc==3,.T.,.F.))
oEnch := MsMGet():New(cAliasE,nReg,nOpc,/*aCRA*/,/*cLetra*/,/*cTexto*/,;
aCpoEnch,aPos,aAlterEnch, nModelo, /*nColMens*/, /*cMensagem*/,;
/*cTudoOk*/, oDlg,lF3, lMemoria,lColumn,caTela,lNoFolder,;
lProperty)
oGetD:= MsNewGetDados():New(nSuperior, nEsquerda, nInferior, nDireita,;
nOpc,cLinOk,cTudoOk, cIniCpos, aAlterGDa, nFreeze, nMax,cFieldOk,;
cSuperDel,cDelOk, oDLG, aHeader, aCols)
oDlg:bInit := {|| EnchoiceBar(oDlg, {||oDlg:End()},{||oDlg:End()},,aButtons)}
oDlg:Activate()
Return
30.2.3.1.
Definindo cores personalizadas para o objeto MsNewGetDados()
Conforme visto no tpico sobre definio das propriedades de cores para os componentes
visuais, cada objeto possui caractersticas que devem ser respeitadas para correta utilizao
deste recurso.
Atributos adicionais:
lUseDefaultColors
Mtodos adicionais:
SetBlkBackColor
Atributo que dever ser definido como .F. para que as

alteraes nas cores sejam permitidas.
Mtodo que define a cor que ser utilizada para cada linha do
grid. No necessrio utilizar o mtodo Refresh() aps a
definio da cor por este mtodo.
Aparncia:
Exemplo: Definindo cores personalizadas para o objeto MsNewGetDados()
/*/
+----------------------------------------------------------------------------| Funo
| MRBWGTCL
|
|
|
| MsNewGetDados() e MsMGet() combinados e tratamento de cores
|
+----------------------------------------------------------------------------| Uso
| Curso ADVPL
|
+----------------------------------------------------------------------------/*/
User Function MrbwGtCl()
Private aRotina
:=
{{"Pesquisar"
{"Visualizar"
{"Incluir"
, "axPesqui"
, "U_ModGtd"
, "U_ModGtd"
DbSelectArea("SC5")
DbSetOrder(1)
MBrowse(6,1,22,75,"SC5")
Return
Local nX
:= 0
Local nUsado
Local
Local
Local
Local
Local
Local
Local
Local
Local
Local
Local
Local
Local
Local
Local
Local
Local
Local
Local
Local
Local
Local
Local
aButtons
aCpoEnch
cAliasE
aAlterEnch
aPos
nModelo
lF3
lMemoria
lColumn
caTela
lNoFolder
lProperty
aCpoGDa
cAliasGD
nSuperior
nEsquerda
nInferior
nDireita
cLinOk
cTudoOk
cIniCpos
nFreeze
nMax
:= 0
:= {}
:= {}
:= cAlias
{}
{000,000,080,400}
3
.F.
.T.
:= .F.
:= ""
:= .F.
:= .F.
:= {}
:= "SC6"
:= 081
:= 000
:= 250
:= 400
:= "AllwaysTrue"
:= "AllwaysTrue"
:= "C6_ITEM"
:= 000
:= 999
:=
:=
:=
:=
:=
, 0, 1},;
, 0, 2},;
, 0, 3}}
Local
Local
Local
Local
Local
Local
cFieldOk
cSuperDel
cDelOk
aHeader
aCols
aAlterGDa
Private
Private
Private
Private
Private
:=
:=
:=
:=
:=
"AllwaysTrue"
""
"AllwaysFalse"
{}
{}
:= {}
oDlg
oGetD
oEnch
aTELA[0][0]
aGETS[0]
DbSelectArea("SX3")
DbSetOrder(1)
DbSeek(cAliasE)
EndIf
DbSkip()
End
DbSelectArea("SX3")
DbSetOrder(1)
MsSeek(cAliasGD)
If
!(AllTrim(SX3->X3_CAMPO) $ "C6_FILIAL") .And. cNivel >= SX3>X3_NIVEL .And. X3Uso(SX3->X3_USADO)
EndIf
DbSkip()
End
nUsado:=0
dbSelectArea("SX3")
dbSeek("SC6")
aHeader:={}
nUsado:=nUsado+1
AADD(aHeader,{ TRIM(x3_titulo), x3_campo, x3_picture,;
Endif
dbSkip()
End
For nX:=1 to nUsado
aCols[1,nX]:= "0001"
ELSE
ENDIF
Next
Else
aCols:={}
dbSelectArea("SC6")
dbSetOrder(1)
For nX:=1 to nUsado
Next
dbSkip()
End
Endif
oDlg := MSDIALOG():New(000,000,400,600, cCadastro,,,,,,,,,.T.)
oEnch := MsMGet():New(cAliasE,nReg,nOpc,/*aCRA*/,/*cLetra*/, /*cTexto*/,;
aCpoEnch,aPos, aAlterEnch, nModelo, /*nColMens*/, /*cMensagem*/,;
cTudoOk,oDlg,lF3, lMemoria,lColumn,caTela,lNoFolder,lProperty)
oGetD:= MsNewGetDados():New(nSuperior,nEsquerda,nInferior,nDireita, nOpc,;
cLinOk,cTudoOk,cIniCpos,aAlterGDa,nFreeze,nMax,cFieldOk, cSuperDel,;
cDelOk, oDLG, aHeader, aCols)
// Tratamento para definio de cores especficas,
// logo aps a declarao da MsNewGetDados
oGetD:oBrowse:lUseDefaultColors := .F.
oGetD:oBrowse:SetBlkBackColor({|| GETDCLR(oGetD:aCols,oGetD:nAt,aHeader)})
oDlg:bInit := {|| EnchoiceBar(oDlg, {||oDlg:End()}, {||oDlg:End()},,aButtons)}
oDlg:Activate()
Return
// Funo para tratamento das regras de cores para a grid da MsNewGetDados
Static Function GETDCLR(aLinha,nLinha,aHeader)
Local
Local
Local
Local
Local
nCor2
nCor3
nPosProd
nUsado
nRet
:=
:=
:=
:=
:=
16776960 // Ciano - RGB(0,255,255)

16777215 // Branco - RGB(255,255,255)
aScan(aHeader,{|x| Alltrim(x[2]) == "C6_PRODUTO"})
Len(aHeader)+1
nCor3
If !Empty(aLinha[nLinha][nPosProd]) .AND. aLinha[nLinha][nUsado]

nRet := nCor2
ElseIf !Empty(aLinha[nLinha][nPosProd]) .AND. !aLinha[nLinha][nUsado]
nRet := nCor3
Endif
Return nRet
30.3. Barras de botes

A linguagem ADVPL permite a implementao de barras de botes utilizando funes prdefinidas desenvolvidas com o objetivo de facilitar sua utilizao, ou atravs da utilizao
direta dos componentes visuais disponveis. Dentre os recursos da linguagem que podem ser
utilizados com esta finalidade sero abordados:
Funo EnchoiceBar: Sintaxe tradicionalmente utilizada em ADVPL, a qual no
retorna um objeto para a aplicao chamadora;
Classe TBar: Classe do objeto TBar(), a qual permite a instanciao direta de um
objeto do tipo barra de botes superior, tornando-o disponvel na aplicao chamadora.
Classe ButtonBar: Classe do objeto ButtonBar(), a qual permite a instanciao direta
de um objeto barra de botes genrico, o qual pode ser utilizado em qualquer posio
da tela, tornando-o disponvel na aplicao chamadora.
30.3.1.
EnchoiceBar()
Funo que cria uma barra de botes no formato padro utilizado pelas interfaces de cadastro
da aplicao Protheus.
Esta barra possui os botes padres para confirmar ou cancelar a interface e ainda permite a
adio de botes adicionais com a utilizao do parmetro aButtons.
Sintaxe:
EnchoiceBar( oDlg, bOk, bCancel, lMsgDel, aButtons, nRecno, cAlias)
Parmetros:
oDlg
bOk
bCancel
lMsgDel
aButtons
nRecno
cAlias
Dialog onde ir criar a barra de botes

Bloco de cdigo a ser executado no boto Ok
Bloco de cdigo a ser executado no boto Cancelar
Exibe dialog para confirmar a excluso
Array contendo botes adicionais.
aArray[n][1] -> Imagem do boto
aArray[n][2] -> bloco de cdigo contendo a ao do boto
aArray[n][3] -> ttulo do boto
Registro a ser posicionado aps a execuo do boto Ok.
Alias do registro a ser posicionado aps a execuo do boto
Ok. Se o parmetro nRecno for informado, o cAlias passa ser
obrigatrio.
Aparncia:
Exemplo: Utilizao da funo EnchoiceBar()
/*/
+----------------------------------------------------------------------------| Funo
| DENCHBAR
|
+----------------------------------------------------------------------------| Descrio | Programa que demonstra a utilizao da funo
|
|
| EnchoiceBar()
|
+----------------------------------------------------------------------------| Uso
| Curso ADVPL
|
+----------------------------------------------------------------------------/*/
User Function DEnchBar()
Local oDlg, oBtn
Local aButtons := {}
DEFINE MSDIALOG oDlg TITLE "Teste EnchoiceBar" FROM 000,000 TO 400,600 PIXEL OF;
oMainWnd
AADD( aButtons, {"HISTORIC", {|| TestHist()}, "Histrico...",;
"Histrico",{|| .T.}} )
@ -15,-15 BUTTON oBtn PROMPT "..." SIZE 1,1 PIXEL OF oDlg
ACTIVATE MSDIALOG oDlg ;
ON INIT (EnchoiceBar(oDlg,{||lOk:=.T.,oDlg:End()},{||oDlg:End()},,@aButtons))
Return
30.3.2.
TBar()
Classe de objetos visuais que permite a implementao de um componente do tipo barra de

botes para a parte superior de uma janela previamente definida.
Sintaxe: New(oWnd, nBtnWidth, nBtnHeight, l3D, cMode, oCursor, cResource,

lNoAutoAdjust)
Retorno: oTBar objeto do tipo TBar()
Parmetros:
oWnd
Objeto, opcional. Janela ou controle onde o boto dever ser

criado.
nBtnWidth
Numrico, opcional. Largura do boto contido na barra
nBtnHeight
Numrico, opcional. Altura do boto contido na barra
l3D
Lgico, opcional. Define tipo da barra
cMode
No utilizado.
oCursor
cResource
lNoAutoAdjust
Objeto, opcional. Define Cursor ao posicionar o mouse sobre a

barra.
Caracter, opcional. Imagem do recurso a ser inserido como
fundo da barra.
Lgico.
Aparncia:
#include 'protheus.ch'
/*/
+----------------------------------------------------------------------------| Funo
| TSTBAR
| Autor | MICROSIGA
|Data |
|
+----------------------------------------------------------------------------| Descrio | Programa que demonstra a utilizao do objeto TBar()
|
+----------------------------------------------------------------------------| Uso
| Curso ADVPL
|
+----------------------------------------------------------------------------/*/
User Function TstTBar()
Local oDlg
oDlg
:= MSDIALOG():New(000,000,305,505, 'Exemplo - TBAR',,,,,,,,,.T.)
oTBar := TBar():New( oDlg,25,32,.T.,,,,.F. )
oTBtnBmp2_1 := TBtnBmp2():New( 00, 00, 35, 25, 'copyuser' ,,,,;
{||Alert('TBtnBmp2_1')}, oTBar,'msGetEx',,.F.,.F. )
oTBtnBmp2_2 := TBtnBmp2():New( 00, 00, 35, 25, 'critica'
{||},oTBar,'Critica',,.F.,.F. )
,,,,;
oTBtnBmp2_3 := TBtnBmp2():New( 00, 00, 35, 25, 'bmpcpo'

{||},oTBar,'PCO',,.F.,.F. )
,,,,;
oTBtnBmp2_4 := TBtnBmp2():New( 00, 00, 35, 25, 'preco'

{||},oTBar,'Preo' ,,.F.,.F. )
,,,,;
oDlg:Activate()
Return
30.3.3.
ButtonBar
A sintaxe ButtonBar a forma clssica utilizada na linguagem ADVPL para implementar um

objeto da classe TBar(), o qual possui as caractersticas mencionadas no tpico anterior.
Sintaxe:
DEFINE BUTTONBAR oBar SIZE nWidth, nHeight 3D MODE OF oDlg
CURSOR
Retorno: ().
Parmetros:
oBar
nWidth
nHeight
3D
oDlg
MODE
Objeto do tipo TBar() que ser criado com a utilizao da

sintaxe ButtonBar().
Numrico, opcional. Largura do boto contido na barra.
Numrico, opcional. Altura do boto contido na barra.
Se definido habilita a visualizao em 3D da barra de botes.
criado.
Define a forma de orientao do objeto ButtonBar utilizando
os seguintes termos pr-definidos:
TOP, BOTTOM, FLOAT
CURSOR
Objeto, opcional. Define Cursor ao posicionar o mouse sobre

a barra.
A sintaxe ButtonBar requer a adio dos botes como recursos adicionais da barra
previamente definida utilizando a sintaxe abaixo:
Botes: BUTTON RESOURCE
Sintaxe adicional:
DEFINE BUTTON RESOURCE cBitMap OF oBar ACTION cAcao TOOLTIP
cTexto
Parmetros:
cBitMap
Nome da imagem disponvel na aplicao.
oBar
Objeto do tipo TBar() no qual o boto ser adicionado.
cAcao
Funo ou lista de expresses que determina a ao que ser

realizada pelo boto.
Texto no estilo tooltip text que ser exibido quando o
cursor do mouse for posicionado sobre o boto na barra de
ferramentas.
cTexto
Aparncia:
Exemplo: Utilizao da sintaxe ButtonBar
/*/
+----------------------------------------------------------------------| Funo
| TstBBar
| Autor | MICROSIGA
|Data |
|
+----------------------------------------------------------------------| Descrio | Programa que demonstra a utilizao do objeto TBar()
|
+----------------------------------------------------------------------| Uso
| Curso ADVPL
|
+----------------------------------------------------------------------/*/
User Function TstBBar()
Local oDlg
Local oBtn1
Local oBtn2
oDlg
:= MSDIALOG():New(000,000,305,505, 'Exemplo - BUTTONBAR',,,,,,,,,.T.)
DEFINE BUTTONBAR oBar SIZE 25,25 3D TOP OF oDlg

DEFINE
DEFINE
DEFINE
DEFINE
ACTION
BUTTON RESOURCE "S4WB005N" OF oBar

BUTTON oBtn1 RESOURCE "S4WB008N" OF
Calculadora() TOOLTIP "Calculadora"
oBtn1:cTitle:="Calc"
DEFINE BUTTON RESOURCE "S4WB009N"
ACTION HelProg() TOOLTIP "Ajuda"
ACTION NaoDisp() TOOLTIP "Recortar"

ACTION NaoDisp() TOOLTIP "Copiar"
ACTION NaoDisp() TOOLTIP "Colar"
oBar GROUP;
OF oBar ACTION Agenda() TOOLTIP "Agenda"

OF oBar ACTION OurSpool() TOOLTIP "Spool"
OF oBar GROUP;
DEFINE BUTTON oBtn2 RESOURCE "PARAMETROS" OF oBar GROUP;

ACTION Sx1C020() TOOLTIP "Parmetros"
oBtn2:cTitle:="Param."
DEFINE
BUTTON oBtOk RESOURCE "FINAL" OF oBar GROUP;
ACTION oDlg:End()TOOLTIP "Sair"
oBar:bRClicked := {|| AllwaysTrue()}
oDlg:Activate()
Return
30.3.4.
Imagens pr-definidas para as barras de botes
Conforme mencionado nos tpicos anteriores, os botes visuais do tipo barra de botes
permitem a definio de itens com aes e imagens vinculadas.
Dentre os objetos e funes mencionados, foi citada a EnchoiceBar(), a qual permite a adio
de botes adicionais atravs do parmetro aButton, sendo que os itens deste array devem
possuir o seguinte formato:
Sintaxe: AADD(aButtons,{cBitMap, bAcao, cTexto})
Estrutura:
cBitMap
bAcao
cTexto
Nome da imagem pr-definida existente na aplicao ERP que

ser vinculada ao boto.
Bloco de cdigo que define a ao que ser executada com a
utilizao do boto.
Texto no estilo tooltip text que ser exibido quando o cursor
do mouse for posicionado sobre o boto na barra de
ferramentas.
Alguns BitMaps disponveis:

DESTINOS
DISCAGEM
EDIT
EDITABLE
EXCLUIR
FORM
GRAF2D
GRAF3D
LINE
NOTE
OBJETIVO
OK
PENDENTE
PRECO
PRODUTO
S4SB014N
S4WB001N
S4WB005N
S4WB006N
S4WB007N
S4WB008N
S4WB009N
S4WB010N
S4WB011N
S4WB013N
S4WB014A
S4WB016N
SIMULACA
VENDEDOR
USER
Exemplo:
AADD(aButtons,{"USER",{||AllwaysTrue()},"Usurio"})
APNDICES
BOAS PRTICAS DE PROGRAMAO
31.
Arredondamento
Algumas operaes numricas podem causar diferenas de arredondamento. Isso ocorre

devido a diferenas no armazenamento de variveis numricas nos diversos processadores,
diferena esta, inclusive, presente no ADVPL, mesmo antes do surgimento do Protheus.
Para evitar esses problemas de arredondamento, deve ser utilizada a funo Round(),
principalmente antes de realizar uma comparao e antes de se utilizar a funo Int().
Desse modo, assegura-se que o resultado ser correto independentemente do processador ou
plataforma.
Exemplo 01:
If (Valor/30) == 50
If Round(Valor/30, 0) == 50
// pode ser falso ou invlido

// correto
Exemplo 02:
M->EE8_QTDEM1 := Int(M->EE8_SLDINI/M->EE8_QE) // pode ser falso ou invlido

M->EE8_QTDEM1 := Int(Round(M->EE8_SLDINI/M->EE8_QE,10)) // correto
32.
Utilizao de Identao
obrigatria a utilizao da identao, pois torna o cdigo muito mais legvel. Veja os
exemplos abaixo:
While !SB1->(Eof())
If mv_par01 == SB1->B1_COD
dbSkip()
Loop
Endif
Do Case
Case SB1->B1_LOCAL == 01 .OR. SB1->B1_LOCAL == 02
TrataLocal(SB1->B1_COD, SB1->B1_LOCAL)
Case SB1->B1_LOCAL == 03
TrataDefeito(SB1->B1_COD)
OtherWise
TrataCompra(SB1->B1_COD, SB1->B1_LOCAL)
EndCase
dbSkip()
EndDo
A utilizao da identao seguindo as estruturas de controle de fluxo (while, IF, caso etc.)
torna a compreenso do cdigo muito mais fcil:
While !SB1->(Eof())
If mv_par01 == SB1->B1_COD
dbSkip()
Loop
Endif
Do Case
Case SB1->B1_LOCAL == 01 .OR. SB1->B1_LOCAL == 02
TrataLocal(SB1->B1_COD, SB1->B1_LOCAL)
Case SB1->B1_LOCAL == 03
TrataDefeito(SB1->B1_COD)
OtherWise
TrataCompra(SB1->B1_COD, SB1->B1_LOCAL)
EndCase
dbSkip()
EndDo
Para identar o cdigo utilize a tecla <TAB> e na ferramenta DEV-Studio, a qual pode ser
configurada atravs da opo Preferncias:
33.
Capitulao de Palavras-Chave

a leitura do cdigo fonte. O cdigo a seguir:
Local ncnt while ( ncnt++ < 10 ) ntotal += ncnt * 2 enddo
Ficaria melhor com as palavras chaves e variveis capituladas:

Local nCnt While ( nCnt++ < 10 ) nTotal += nCnt * 2 EndDo
Para funes de manipulao de dados que comecem por db, a capitulao

s ser efetuada aps o db:
dbSeek()
dbSelectArea()
33.1. Palavras em maisculo

A regra utilizar caracteres em maisculo para:
Constantes:
#define NUMLINES 60 #define NUMPAGES 1000
Variveis de memria:
M-> CT2_CRCONV M->CT2_MCONVER := CriaVar("CT2_CONVER")
Campos:
SC6->C6_NUMPED
Querys:
SELECT * FROM...
34.
A notao hngara consiste em adicionar os prefixos aos nomes de variveis, de modo a

facilmente se identificar seu tipo. Isto facilita na criao de cdigos-fonte extensos, pois
usando a Notao Hngara, voc no precisa ficar o tempo todo voltando definio de uma
varivel para se lembrar qual o tipo de dados que deve ser colocado nela. Variveis devem
ter um prefixo de Notao Hngara em minsculas, seguido de um nome que identifique a
funo da varivel, sendo que a inicial de cada palavra deve ser maiscula.
obrigatria a utilizao desta notao para nomear variveis.
Notao
a
b
c
d
l
n
o
x
35.
Tipo de dado
Array
Bloco de cdigo
Caracter
Data
Lgico
Numrico
Objeto
Indefinido
Exemplo
aValores
bSeek
cNome
dDataBase
lContinua
nValor
oMainWindow
xConteudo
Tcnicas de programao eficiente
Para o desenvolvimento de sistemas e a programao de rotinas, sempre esperado que

qualquer cdigo escrito seja:
Funcionalmente correto
Eficiente
Legvel
Reutilizvel
Extensvel
Portvel
Aps anos de experincia na utilizao de linguagens padro xBase e do desenvolvimento da

linguagem ADVPL, algumas tcnicas para uma programao otimizada e eficiente foram
reconhecidas. A utilizao das tcnicas a seguir, visa buscar o mximo aproveitamento dos
recursos da linguagem com o objetivo de criar programas com estas caractersticas.
Criao de funes segundo a necessidade
Observe o cdigo de exemplo:
User Function GetAnswer(lDefault)

Local lOk
lOk := GetOk(lDefault)
If lOk
Return .T.
Else
Return .F.
Endif
Return nil
Utilizando-se apenas o critrio "a funo funciona corretamente?", a funo GetAnswer

perfeita. Recebe um parmetro lgico com a resposta padro e retorna um valor lgico
dependente da opo escolhida pelo usurio em uma funo de dilogo "sim/no" designada
para isso. Pode entretanto ser melhorada, particularmente se eficincia for considerada como
um critrio para um cdigo melhor. Eficincia tipicamente envolve a utilizao de poucos
recursos de mquina, poucos chamadas de funes ou tornar mais rpido um processo.
Segundo esse raciocnio, poderia se produzir o seguinte cdigo:

Return If( GetOk(lDefault), .T., .F.)
O cdigo acima ainda pode ser aprimorado conforme abaixo:

Return GetOk(lDefault)
Com a otimizao do cdigo da funo GetAnswer(), pode facilmente verificar que a mesma
no realiza nada adicional chamada de GetOk(), podendo ser substituda por uma chamada
direta desta, continuando a funcionar corretamente.
Codificao auto-documentvel
Nenhum comentrio substitui um cdigo claramente escrito, e este no um acidente.
cVar := "
" // 11 espaos
O tamanho da varivel cVar no evidente por si s e no facilmente verificado. Estes

mesmos 10 espaos estariam mais bvios e ainda assim garantidos se a instruo fosse escrita
como:
cVar := Space(11)
O mesmo princpio pode ser aplicado para qualquer string longa de caracteres repetidos. A
funo Replicate pode ser utilizada como a seguir:
cVar := Replicate( "*", 80 )
Este tipo de programao deixa o cdigo fcil de digitar, fcil de ler e mais flexvel.
Utilizao de solues simples

Simplicidade na criao de instrues torna a programao e at mesmo a execuo mais
rpida. Considere a linha de cdigo:
If nVar > 0 .Or. nVar < 0
Se o valor da varivel nVar for igual a zero (0) no momento da execuo desta linha de
cdigo, ambas as comparaes separadas pelo operador lgico .Or. sero efetuadas: Aps ser
avaliada, a primeira comparao ir falhar. A segunda comparao ser ento avaliada e
falhar tambm. Como resultado, o cdigo existente dentro da estrutura de fluxo If no ser
executado. Tal cdigo somente ser executado quando o valor desta varivel for maior OU
menor do que zero. Ou seja, sempre que for DIFERENTE de zero, o que torna a linha a seguir
mais eficiente:
If nVar != 0
Este tipo de alterao torna o cdigo mais legvel e o processamento mais rpido, evitando a
avaliao de instrues desnecessariamente.
Existem outras situaes onde a simplificao pode ser utilizada. A expresso de avaliao a
seguir:
If cVar == "A" .Or. cVar == "B" .Or
cVar == "C" .Or. cVar == "D"
Pode ser substitudo pelo operador de conteno:
If cVar $ "ABCD"
Opo por flexibilidade

A melhor soluo aquela que envolve o problema imediato e previne problemas no futuro.
@nRow,nCol PSAY cVar Picture "!!!!!!!!!!!!!!!!!!!!"
Exceto contando-se os caracteres, no existe maneira de saber se o nmero de caracteres de

exclamao o esperado. Enquanto isto um problema, existem algo mais grave. A expresso
de picture esttica. Se no futuro for necessrio ajustar o tamanho da varivel cVar, ser
necessrio localizar todos os lugares no cdigo onde esta mscara de picture est sendo
utilizada para ajuste manual.
Existe uma opo de soluo de auto-ajuste disponvel que fcil de digitar e tem a garantia
de executar a tarefa igualmente (tornar todos os caracteres maisculos):
@nRow,nCol PSAY cVar Picture "@!"
Opo da praticidade ao drama

Se a soluo parece complexa, provavelmente porque o caminho escolhido est levando a
isso. Deve-se sempre se perguntar porque algum desenvolveria uma linguagem que requisite
tantos comandos complicados para fazer algo simples. Na grande maioria dos casos, existe
uma soluo mais simples. O exemplo abaixo deixa isso bem claro:
@ 10,25 Say Substr(cCep,1,5) + "-" + Substr(cCep,6,3) Picture "!!!!!!!!!"
Este cdigo pode ser escrito de uma forma muito mais simples, conforme demonstrado abaixo:
@ 10,25 Say cCep Picture "@R 99999-999"
Utilizao de operadores de incremento/decremento

Utilizados devidamente, os operadores de incremento e decremento tornam o cdigo mais fcil
de ler e possivelmente um pouco mais rpidos. Ao contrrio de escrever adies simples como:
nVar := nVar + 1
nVar := nVar -1
Pode-se escrev-las assim:
++nVar
--nVar
Deve-se apenas
podem aparecer
utilizada dentro
resultado. Para
ADVPL.
tomar cuidado com a precedncia destes operadores, pois o "++" ou o "--"

antes ou depois de uma varivel, e em alguns casos quando a varivel for
de uma expresso, a prefixao ou sufixao destes operadores afetar o
maiores detalhes, consulte a documentao de operadores da linguagem
Evitar passos desnecessrios

Existe uma diferena entre um bom hbito e perda de tempo. Algumas vezes estes conceitos
podem estar muito prximos, mas um modo de diferenci-los balancear os benefcios de
realizar alguma ao contra o problema que resultaria se no fosse executada. Observe o
exemplo:
Local nCnt := 0
For nCnt := 1 To 10
<cdigo>
Next nCnt
Inicializar a varivel no momento da declarao no um problema. Se o 0 fosse necessrio

no exemplo, teria sido til a inicializao na declarao. Mas neste caso a estrutura de
repetio For...Next atribui o seu valor imediatamente com 1, portanto no houve ganho em
atribuir a varivel com 0 no comeo.
Neste exemplo no h nenhum ponto negativo e nada errado ocorrer se a varivel no for
inicializada, portanto aconselhvel evitar este tipo de inicializao, pois no torna o cdigo
mais seguro e tambm no expressa a inteno do cdigo mais claramente.
Porm note este exemplo, onde a varivel no inicializada:
Local nCnt
While ( nCnt++ < 10 )
<cdigo>
EndDo
Em ADVPL, variveis no inicializadas sempre tem seu valor contendo nulo (nil) a princpio, o
que far com que uma exceo em tempo de execuo acontea quando a instruo de
repetio while for executada.
Diferentemente do primeiro exemplo, onde a inicializao da varivel no fazia diferena
alguma, neste segundo exemplo a inicializao absolutamente necessria. Deve-se procurar
inicializar variveis numricas com zero (0) e variveis caracter com string nula ("") apenas
quando realmente necessrio.
Utilizao de alternativas
Quando se est trabalhando em uma simples rotina, deve-se tomar algum tempo para
explorar duas ou trs diferentes abordagens. Quando se est trabalhando em algo mais
complexo, deve-se planejar prototipar algumas a mais. Considere o seguinte cdigo:
If cHair = "A"
Replace hair With "Loira"
Else
If cHair = "B"
Replace hair With "Morena"
Else
If cHair = "C"
Replace hair With "Ruiva"
Else
If cHair = "D"
Replace hair With "Grisalho"
Else
Replace hair With "Preto"
Endif
Endif
Endif
Endif
Um cdigo de uma nica letra, (A at E), foi informado para indicar a cor de cabelo. Este
cdigo foi ento convertido e armazenado como uma string. Pode-se notar que a cor "Preto"
ser atribuda se nenhuma outra opo for verdadeira.
Uma alternativa que reduz o nvel de identao torna o cdigo mais fcil de ler enquanto reduz
o nmero de comandos replace:
Do Case
Case cHair == "A"
cColor := "Loira"
Case cHair == "B"
cColor := "Morena"
Case cHair == "C"
cColor := "Ruiva"
Case cHair == "D"
cColor := "Grisalho"
OtherWise
cColor := "Preto"
EndCase
Replace hair With cColor
Utilizao de arquivos de cabealho quando necessrio

Se um arquivo de cdigo criado se referencia a comandos para interpretao e tratamento de
arquivos XML, este deve se incluir o arquivo de cabealho prprio para tais comandos
(XMLXFUN.CH no exemplo). Porm no deve-se incluir arquivos de cabealho apenas por
segurana. Se no se est referenciando nenhuma das constantes ou utilizando nenhum dos
comandos contidos em um destes arquivos, a incluso apenas tornar a compilao mais
demorada.
Constantes em maisculo
Isto uma conveno que faz sentido. Em ADVPL, como em C por exemplo, a regra utilizar
todos os caracteres de uma constante em maisculo, a fim de que possam ser claramente
reconhecidos como constantes no cdigo, e que no seja necessrios lembrar onde foram
declarados.
Utilizao de identao
Este um hbito que todo programador deve desenvolver. No consome muito esforo para
manter o cdigo alinhado durante o trabalho, porm quando necessrio pode-se utilizar a
ferramenta TOTVS DevStudio para a re-identao de cdigo. Para maiores detalhes, consulte a
documentao sobre a identao de cdigos fontes disponvel nos demais tpicos deste
material.
Utilizao de espaos em branco
Espaos em branco extras tornam o cdigo mais fcil para a leitura. No necessrio imensas
reas em branco, mas agrupar pedaos de cdigo atravs da utilizao de espaos em branco
funciona muito bem. Costuma-se separar parmetros com espaos em branco.
Quebra de linhas muito longas
Com o objetivo de tornar o cdigo mais fcil de ler e imprimir, as linhas do cdigo no devem
estender o limite da tela ou do papel. Podem ser "quebradas" em mais de uma linha de texto
utilizando o ponto-e-vrgula (;).
Capitulao de palavras-chave
a leitura do cdigo fonte.
Avaliando o cdigo a seguir:
local ncnt
while ( ncnt++ < 10 )
ntotal += ncnt * 2
enddo
O mesmo ficaria muito mais claro se re-escrito conforme abaixo:
Local nCnt
While ( nCnt++ < 10 )
nTotal += nCnt * 2
EndDo

A Notao Hngara muito comum entre programadores xBase e de outras linguagens. A
documentao do ADVPL utiliza esta notao para a descrio das funes e comandos e
aconselhvel sua utilizao na criao de rotinas, pois ajuda a evitar pequenos erros e facilita
a leitura do cdigo. Para maiores detalhes, consulte a documentao sobre a utilizao da
Notao Hngara de cdigos fontes disponvel nos demais tpicos deste material.
Utilizao de nomes significantes para variveis
A principal vantagem da liberdade na criao dos nomes de variveis a facilidade de
identificao da sua utilidade. Portanto deve-se utilizar essa facilidade o mximo possvel.
Nomes sem sentido apenas tornaro difcil a identificao da utilidade de uma determinada
varivel, assim como nomes extremamente curtos. Nem sempre a utilizao de uma varivel
chamada i a melhor sada. Claro, no convm criar uma varivel com um nome muito longo
que ser utilizada como um contador, e referenciada muitas vezes no cdigo. O bom senso
deve ser utilizado.
Criar variveis como nNumero ou dData tambm no ajudam na identificao. A Notao
Hngara j est sendo utilizada para isso e o objetivo do nome da varivel deveria ser
identificar sua utilizao, no o tipo de dado utilizado. Deve-se procurar substituir tais
variveis por algo como nTotal ou dCompra.
O mesmo vlido para nomes de funes, que devem descrever um pouco sobre o que a
funo faz. Novamente nomes extremamente curtos no so aconselhveis.
Utilizao de comentrios
Comentrios so muito teis na documentao de programas criados e para facilitar a
identificao de processos importantes no futuro e devem sempre ser utilizados.
Sempre que possvel, funes criadas devem ter uma breve descrio do seu objetivo,
parmetros e retorno. Alm de servir como documentao, os comentrios embelezam o
cdigo ao separar as funes umas das outras. Os comentrios devem ser utilizados com bom
senso, pois reescrever a sintaxe ADVPL em portugus torna-se apenas perda de tempo:
If nLastKey == 27 // Se o nLastKey for igual a 27
Criao de mensagens sistmicas significantes e consistentes

Seja oferecendo assistncia, exibindo mensagens de aviso ou mantendo o usurio informado
do estado de algum processo, as mensagens devem refletir o tom geral e a importncia da
aplicao. Em termos gerais, deve-se evitar ser muito informal e ao mesmo tempo muito
tcnico.
"Aguarde. Reindexando (FILIAL+COD+ LOCAL) do arquivo: \DADOSADV\SB1990.DBF"
Esse tipo de mensagem pode dar informaes demais para o usurio e deix-lo sentindo-se
desconfortvel se no souber o que significa "reindexando", etc. E de fato, o usurio no devia
ser incomodado com tais detalhes. Apenas a frase "Aguarde, indexando." funcionaria
corretamente, assim como palavras "processando" ou "reorganizando".
Outra boa idia evitar a referencia a um item corrente de uma tabela como um "registro":
"Deletar este registro?"
Se a operao estiver sendo efetuada em um arquivo de clientes, o usurio deve ser

questionado sobre a remoo do cliente corrente, se possvel informando valores de
identificao como o cdigo ou o nome.
Evitar abreviao de comandos em 4 letras
Apesar do ADVPL suportar a abreviao de comandos em quatro letras (por exemplo, repl no
lugar de replace) no h necessidade de utilizar tal funcionalidade. Isto apenas torna o cdigo
mais difcil de ler e no torna a compilao mais rpida ou simples.
Evitar "disfarces" no cdigo
No deve-se criar constantes para expresses complexas. Isto tornar o cdigo muito difcil de
compreender e poder causar erros primrios, pois pode-se imaginar que uma atribuio
efetuada a uma varivel quando na verdade h toda uma expresso disfarada:
#define NUMLINES aPrintDefs[1]

#define NUMPAGES aPrintDefs[2]
#define ISDISK
aReturn[5]
If ISDISK == 1
NUMLINES := 55
Endif
NUMPAGES += 1
A impresso que se tem aps uma leitura deste cdigo de que valores esto sendo atribudos
s variveis ou que constantes esto sendo utilizadas. Se o objetivo flexibilidade, o cdigo
anterior deve ser substitudo por:
#define NUMLINES 1
#define NUMPAGES 2
#define ISDISK
5
If aReturn[ISDISK] == 1
aPrintDefs[ NUMLINES ] := 55
Endif
aPrintDefs[ NUMPAGES ] += 1
Evitar cdigo de segurana desnecessrio

Dada sua natureza binria, tudo pode ou no acontecer dentro de um computador. Adicionar
pedaos de cdigo apenas para "garantir a segurana" freqentemente utilizado como uma
desculpa para evitar corrigir o problema real. Isto pode incluir a checagem para validar
intervalos de datas ou para tipos de dados corretos, o que comumente utilizando em
funes:
Static Function MultMalor( nVal )

If ValType( nVal ) != "N"
nVal := 0
Endif
Return ( nVal * nVal )
O ganho irrisrio na checagem do tipo de dado do parmetro j que nenhum programa

corretamente escrito em execuo poderia enviar uma string ou uma data para a funo. De
fato, este tipo de "captura" o que torna a depurao difcil, j que o retorno ser sempre um
valor vlido (mesmo que o parmetro recebido seja de tipo de dado incorreto). Se esta
captura no tiver sido efetuada quando um possvel erro de tipo de dado invlido ocorrer, o
cdigo pode ser corrigido para que este erro no mais acontea.
Isolamento de strings de texto
No caso de mensagens e strings de texto, a centralizao um bom negcio. Pode-se colocar
mensagens, caminhos para arquivos, e mesmo outros valores em um local especfico. Isto os
torna acessveis de qualquer lugar no programa e fceis de gerenciar.
Por exemplo, se existe uma mensagem comum como "Imprimindo, por favor aguarde..."
em muitas partes do cdigo, corre-se o risco de no seguir um padro para uma das
mensagens em algum lugar do cdigo. E mant-las em um nico lugar, como um arquivo de
cabealho, torna fcil a produo de documentao e a internacionalizao em outros idiomas.
LISTAS DE EXERCCIOS
Mdulo 04.1.: Desenvolvendo aplicaes em ADVPL
01
Desenvolver um programa que implemente a funo AxCadastro() para a

tabela padro do sistema SA2 Cadastro de Fornecedores.
02
Implementar no AxCadastro() desenvolvido no item anterior as funes de

validao de alterao e validao de excluso.
03
Desenvolver um programa que implemente a funo Mbrowse() utilizando as

funes padres de cadastro, para a tabela padro do sistema SA2 Cadastro
de Fornecedores.
04
Implementar no Mbrowse() desenvolvido no item anterior a funo de

legenda.
05
Implementar no Mbrowse() desenvolvido no item anterior uma funo

especfica de incluso utilizando os recursos adicionais da funo AxInclui().
06
Desenvolver um programa que implemente uma MarkBrowse utilizando as

funes padres de cadastro, para a tabela padro do sistema SA2 Cadastro
de Fornecedores.
07
Implementar na MarkBrowse() desenvolvida no item anterior uma funo para

excluso de mltiplos registros da tabela padro do sistema SA2 Cadastro
de Fornecedores.
08
Desenvolver um programa que implemente uma MarkBrowse() para a tabela

padro do sistema SA1 Cadastro de Cliente, contemplando uma funo que
permita a visualizao dos dados principais de mltiplos clientes selecionados.
09
Desenvolver um programa que implemente uma Modelo2() para a tabela

padro do sistema SX5 Cadastro de tabelas, contemplando a funcionalidade
de incluso.
10
Implementar na Modelo2() desenvolvida no item anterior as funcionalidades

de Visualizao, Alterao e Excluso.
11
Desenvolver um programa que implemente uma Modelo3() para as tabelas

padres do sistema SF1 Cabealho do Documento de Entrada e SD1 Itens
do documento de entrada, contemplando as funcionalidades de Visualizao e
Incluso.
12
Implementar na Modelo3() desenvolvida no item anterior as funcionalidades e

Alterao e Excluso.
13
Desenvolver um programa que crie um arquivo de trabalho com estrutura

similar ao SA1 e receba as informaes desta tabela.
14
Implementar na rotina desenvolvida no item anterior, um MarkBrowse que

permite a seleo e visualizao de apenas um registro selecionado.
15
Desenvolver um programa que implemente um relatrio que permita a

impresso de uma listagem simples dos dados da tabela padro SA1
Cadastro de clientes.
16
Desenvolver um programa que implemente um relatrio que permita a

impresso de uma listagem simples das notas fiscais e seus respectivos itens.
17
Desenvolver um programa que realize a exportao dos itens marcados no

SA1 Cadastro de Clientes para um arquivo no formato .TXT em um diretrio
especificado pelo usurio.
18
Desenvolver um programa que realize a importao das informaes contidas

em um arquivo no formato .TXT selecionado pelo usurio e as atualize no SA1
Cadastro de Clientes.
19
Desenvolver o mesmo programa do item anterior utilizando as funes da

famlia FT.
Mdulo 04.2.: Oficina de Programao I
20
Desenvolver uma aplicao visual que implemente cada um dos componentes

disponveis no fonte DIALOG_OBJETOS.PRW.
21
Implementar as rotinas de importao e exportao desenvolvidas nos itens

anterior as rguas de processamento mais adequadas.
22
Substituir em uma das rotinas desenvolvidas anteriormente a funo

Pergunte() pela funo ParamBox().
23
Desenvolver uma rotina que implementar um ListBox simples que permita

visualizar as tabelas cadastradas no SX5 Cadastro de Tabelas.
25
Implementar na rotina desenvolvida no item anterior a opo de visualizao

dos itens de uma das tabelas selecionadas, demonstrando-os em uma ListBox
Grid.
26
Desenvolver uma rotina que implemente uma Modelo2() utilizando os

componentes visuais necessrios, complementados com os recursos de
rolagem do objeto ScrollBox().
Mdulo 05: Introduo a orientao objetos
27
Implementar a classe Aluno() com os mtodos New(), BuscaAluno() e

SalvaAluno().
28
Desenvolver a interface visual

implementada anteriormente.
29
Implementar na rotina desenvolvida no item anterior os recursos necessrios

para persistir as informaes e recuperar os dados de itens previamente
salvos.
para
interagir
com
classe
Aluno()
Mdulo 06: ADVPL orientado objetos I
30
Desenvolver uma rotina que implemente uma Enchoice() para o SA1

Cadastro de clientes.
31
Adequar a rotina desenvolvida no item anterior para permitir o uso da classe

de objetos MsMGet().
32
Desenvolver uma interface de cadastro combinando os recursos de um objeto

MsMGet() e um objeto MsNewGetDados() causando o mesmo efeito de uma
interface no padro da Modelo3().
33
Implementar na rotina desenvolvida no item anterior o uso da funo

EnchoiceBar() com um boto que permita ao usurio visualizar um dos itens
exibidos na interface.
34
Adequar a rotina desenvolvida no item anterior de forma a substituir o uso da

funo EnchoiceBar() pela classe de objeto TBar().
35
Converter a sintaxe clssica utilizada no fonte DIALOG_OBJETOS.PRW para a

sintaxe orientada a objetos.
36
Converter a sintaxe clssica dos fontes ListBox para a sintaxe orientada a

objetos.
Projeto: Avaliao prtica do treinamento de ADVPL Intermedirio

Objetivos do projeto
Contemplar o contedo do curso e estimular a prtica da programao utilizando a linguagem
ADVPL;
Acrescentar um grau de desafio ao treinamento;
Regras para entrega e apresentao
Dever ser entregue na data estabelecida pelo instrutor, contendo os fontes e demais arquivos
necessrios. A avaliao do projeto ser realizada aps a entrega, no prazo estabelecido pelo
instrutor;
Pode ser realizado em grupos de at 03 pessoas. Caso existam alunos sem grupos, estes podero
integrar equipes j formadas com o total de membros estabelecido, mediante aprovao do
instrutor;
Avaliao do projeto
Mesmo peso da prova terica, podendo substitu-la integralmente.
Sero considerados os quesitos:
Funcionalidades
Clareza da programao
Apresentao
Otimizao de tcnicas e recursos apresentados no treinamento
Funcionalidades que compe o projeto
Desenvolver uma aplicao utilizando a linguagem ADVPL que contemple as seguintes funcionalidades:
01
Efetue a leitura de um arquivo em formato .TXT com os dados necessrios

para realizar o cadastro de fornecedores no sistema Protheus, e grave estas
informaes em um arquivo intermedirio.
A partir da seleo dos registros disponveis neste arquivo intermedirio, o
usurio poder:
02
Imprimir os itens selecionados;

Efetivar os itens selecionados, gravando-os no SA2 Cadastro de
Fornecedores;
Estornar itens j efetivados, eliminando-os do SA2 - Cadastro de
Fornecedores;
Excluir os registros selecionados do arquivo intermedirio;
Excluir todos os registros importados de um arquivo em formato .TXT
especificado.
Visualizar as informaes do registro gerado no arquivo intermedirio;
Visualizar o registro gerado no SA2 Cadastro de Fornecedores a
partir de um item selecionado no arquivo intermedirio.
MDULO 07: ADVPL Orientado objetos II

Neste mdulo sero tratados os componentes e objetos da interface visual da linguagem
ADVPL, permitindo o desenvolvimento de aplicaes com interfaces grficas com sintaxe
orientada a objetos.
36.
Componentes da interface visual do ADVPL
A linguagem ADVPL possui diversos componentes visuais e auxiliares, os quais podem ser
representados utilizando a estrutura abaixo:
Classes da Interface Visual

Tsrvobject
Classes Auxiliares
Tfont
Classes de Janelas
Msdialog
Tdialog
Twindow
Tcontrol
Visuais
Brgetddb
Mscalend
Mscalendgrid
Msselbr
Msworktime
Sbutton
Tbar
Tbitmap
Tbrowsebutton
Tbtnbmp
Tbtnbmp2
Tbutton
Tcbrowse
Tcheckbox
Tcolortriangle
Tcombobox
Tfolder
Tfont
Tget
Tgroup
Thbutton
Tibrowser
Tlistbox
Tmenu
Tmenubar
Tmeter
Tmsgraphic
Tmsgbar
Tmultibtn
Tmultiget
Tolecontainer
Tpageview
Tpanel
Tradmenu
Tsbrowse
Tsay
Tscrollbox
Tsimpleeditor
Tslider
Visuais
Tsplitter
Ttabs
Ttoolbox
Twbrowse
Vcbrowse
Atributos comuns as classes de componentes visuais

cCaption
cF3
cMsg
cName
cTooltip
cVariable
lPassword
lReadOnly
lShowHint
lVisibleControl
nHeight
nLeft
nTop
nWidth
Picture
Ttulo ou contedo do objeto.

Consulta F3 ao qual o objeto est vinculado, quando o
mesmo do tipo get.
Mensagem exibida na barra de status da janela principal
quando o objeto ganha foco.
Nome do objeto
Mensagem exibida quando objeto exibe seu tooltip.
Varivel que receber o contedo selecionado ou digitado no
objeto, quando o mesmo for to tipo get ou similar.
Indica se o texto digitado no objeto ser exibido no formato
de password, quando o mesmo do tipo get.
Flag que indica se o objeto pode ou no ser editado.
Flag que ativa .T. ou desativa .F. a exibio do tooltip do
objeto.
Se .T. o objeto visvel, se .F. o objeto invisvel.
Altura em pixels.
Coordenada horizontal em pixels.
Coordenada vertical em pixels.
Largura em pixels.
Picture de digitao do objeto, quando o mesmo do tipo
get.
Eventos comuns as classes de componentes visuais

bAction
bChange
bF3
bGotFocus
blClicked
blDblClick
bLostFocus
brClicked
bValid
bWhen
Bloco de cdigo executado quando o objeto utilizado,

quando o mesmo do tipo boto ou similar.
Bloco de cdigo executado quando ocorre uma mundana na
seleo de itens que compe o objeto, como por exemplo
em listas ou grids.
Bloco de cdigo executado quando utilizado o recurso de
consulta F3 vinculado ao objeto.
Executado quando objeto ganha foco.
Executado quando acionado click do boto esquerdo do
mouse sobre o objeto.
Executado quando acionado duplo click do boto esquerdo
do mouse sobre o objeto.
Executado quando objeto perde foco.
Executado quando acionado click do boto direito do mouse
sobre o objeto.
Executado quando o contedo do objeto modificado e
dever ser validado. Deve retornar .T. se o contedo
vlido e .F. se contedo invlido.
Executado quando h movimentao de foco na janela.Se
retornar .T. o objeto continua habilitado, se retornar .F. o
objeto ser desabilitado.
Classes da interface visual

TSRVOBJECT()
Descrio: Classe abstrata inicial de todas as classes de interface do ADVPL. No deve

ser instanciada diretamente.
Propriedades:
nLeft
nTop
nWidth
nHeight
cCaption
cTooltip
lShowHint
cMsg
nClrText
nClrPane
bWhen
bValid
blClicked
brClicked
blDblClick
oWnd
lVisible
Cargo
bLostFocus
bGotFocus

Largura em pixels.
Altura em pixels.
Ttulo ou contedo do objeto.
Flag que ativa .T. ou desativa .F. a exibio do tooltip do
objeto.
Mensagem exibida na barra de status da janela principal
quando o objeto ganha foco.
Cor do texto do objeto.
Cor do fundo do objeto.
Executado quando h movimentao de foco na janela.Se
retornar .T. o objeto continua habilitado, se retornar .F. o
objeto ser desabilitado.
Executado quando o contedo do objeto modificado e
dever ser validado. Deve retornar .T. se o contedo
vlido e .F. se contedo invlido.
Executado quando acionado click do boto esquerdo do
mouse sobre o objeto.
Executado quando acionado click do boto direito do mouse
sobre o objeto.
Executado quando acionado duplo click do boto esquerdo
do mouse sobre o objeto.
Janela onde o objeto foi criado.
Se .T. o objeto visvel, se .F. o objeto invisvel.
Contedo associado ao objeto.
Executado quando objeto perde foco.
Executado quando objeto ganha foco.
Construtor: No pode ser instanciada.
Parmetros:
Nenhum
Mtodos auxiliares:
SetFocus
Descrio: Fora mudana do foco de entrada de dados para o controle.
Sintaxe: SetFocus( )
Parmetros:
Nenhum
Retorno:
Nil
Hide
Descrio: Torna objeto invisvel.
Sintaxe: Hide( )
Parmetros:
Nenhum
Retorno:
Nil
Show
Descrio: Torna objeto visvel.
Sintaxe: Show( )
Parmetros:
Nenhum
Retorno:
Nil
Enable
Descrio: Habilita o objeto.
Sintaxe: Enable( )
Parmetros:
Nenhum
Retorno:
Nil
Disable
Descrio: Desabilita o objeto.
Sintaxe: Disable( )
Parmetros:
Nenhum
Retorno:
Nil
Refresh
Descrio: Fora atualizao (sincronia) de propriedades entre o programa e o
Protheus Remote.
Sintaxe: Refresh( )
Parmetros:
Nenhum
Retorno:
Nil
Exemplo:
CLASS TCONTROL FROM TSRVOBJECT
Classes auxiliares
TFONT()
Descrio: Classe de objetos que define a fonte do texto utilizado nos controles
visuais.
Propriedades:
-
Herdadas as classes superiores
Construtor: New([acName], [nPar2], [anHeight], [lPar4], [alBold], [nPar6],

[lPar7], [nPar8], [alItalic], [alUnderline])
Parmetros:
acName
nPar2
anHeight
lPar4
alBold
nPar6
lPar7
nPar8
alItalic
alUnderline
Caractere, opcional. Nome da fonte, o padro Arial.

Reservado.
Numrico, opcional. Tamanho da fonte. O padro -11.
Reservado.
Lgico, opcional. Se .T. o estilo da fonte ser negrito.
Reservado.
Reservado.
Reservado.
Lgico, opcional. Se .T. o estilo da fonte ser itlico.
Lgico, opcional. Se .T. o estilo da fonte ser sublinhado.
Aparncia:
Exemplo:
User Function Teste()
Local oDlg, oSay
DEFINE MSDIALOG oDlg FROM 0,0 TO 200,200 TITLE 'My dialog' PIXEL
// Cria font para uso
oFont:= TFont():New('Courier New',,-14,.T.)
// Apresenta o tSay com a fonte Courier New
oSay := TSay():New( 10, 10, {|| 'Mensagem'},oDlg,, oFont,,,, .T.,
CLR_WHITE,CLR_RED )
oSay:lTransparent:= .F.
Return
Classes de janelas
MSDIALOG()
Descrio: Classe de objetos que deve ser utilizada como padro de janela para
entrada de dados. MSDialog um tipo de janela dilogo modal, isto
, no permite que outra janela ativa receba dados enquanto esta
estiver ativa.
Propriedades:
-
Construtor: New([anTop], [anLeft], [anBottom], [anRight], [acCaption],

[cPar6], [nPar7], [lPar8], [nPar9], [anClrText], [anClrBack], [oPar12],
[aoWnd], [alPixel], [oPar15], [oPar16], [lPar17])
Parmetros:
anTop
anLeft
anBotom
anRight
acCaption
cPar6
nPar7
lPar8
nPar9
anClrText
anClrBack
oPar12
aoWnd
alPixel
oPar15
oPar16
nPar17
Numrico, opcional. Coordenada vertical superior em pixels

ou caracteres.
Numrico, opcional. Coordenada horizontal esquerda em
pixels ou caracteres.
Numrico, opcional. Coordenada vertical inferior em pixels
ou caracteres.
Numrico, opcional. Coordenada horizontal direita em pixels
ou caracteres.
Caractere, opcional. Ttulo da janela.
Reservado.
Reservado.
Reservado.
Reservado.
Numrico,opcional. Cor do texto.
Numrico,opcional. Cor de fundo.
Reservado.
Objeto, opcional. Janela me da janela a ser criada, padro
a janela principal do programa.
Lgico, opcional. Se .T. considera as coordenadas passadas
em pixels, se .F. considera caracteres.
Reservado.
Reservado.
Reservado.
Aparncia:
Exemplo:
// cria dilogo
Local oDlg := MSDialog():New(10,10,300,300,'Meu
dialogo',,,,,CLR_BLACK,CLR_WHITE,,,.T.)
// ativa dilogo centralizado
oDlg:Activate(,,,.T.,{||msgstop('validou!'),.T.},,{||msgstop('iniciando'
)} )
Return
TDIALOG()
Descrio: Classe de objetos do tipo dilogo de entrada de dados, sendo seu

uso reservado. Recomenda-se utilizar a classe MSDialog que
herdada desta classe.
Propriedades:
-
Construtor: New([anTop], [anLeft], [anBottom], [anRight], [acCaption],

[cPar6], [nPar7], [lPar8], [nPar9], [anClrText], [anClrBack], [oPar12],
[aoWnd], [alPixel], [oPar15], [oPar16], [nPar17], [anWidth],
[anHeight])
Parmetros:
anTop
anLeft
anBotom
anRight
Numrico, opcional. Coordenada

ou caracteres.
ou caracteres.
vertical superior em pixels

horizontal esquerda em
vertical inferior em pixels
horizontal direita em pixels
ou caracteres.
Reservado.
Reservado.
Reservado.
Reservado.
Numrico,opcional. Cor do texto.
Numrico,opcional. Cor de fundo.
Reservado.
Objeto, opcional. Janela me da janela a ser criada, padro
a janela principal do programa.
em pixels, se .F. considera caracteres.
Reservado.
Reservado.
Reservado.
Numrico, opcional. Largura da janela em pixels.
Numrico, opcional. Altura da janela em pixels.
acCaption
cPar6
nPar7
lPar8
nPar9
anClrText
anClrBack
oPar12
aoWnd
alPixel
oPar15
oPar16
nPar17
anWidth
anHeight
Mtodos auxiliares:
Activate
Descrio: Ativa (exibe) o dilogo. Chamar somente uma vez este
mtodo.
Sintaxe: Activate([bPar1], [bPar2], [bPar3], [alCentered], [abValid],
[lPar6], [abInit], [bPar8], [bPar9] )
Parmetros:
bPar1
bPar2
bPar3
Reservado.
Reservado.
Reservado.
Lgico, opcional. Se .T. exibe a janela centralizada, .F.
padro.
Bloco de cdigo, opcional. Deve retornar .T. se contedo
do dilogo vlido, se retornar .F. o dilogo no fechar
quando solicitada de encerrar.
Reservado.
Bloco de cdigo, opcional. Executado quando o dilogo
inicia exibio.
Reservado.
Reservado.
alCentered
abValid
lPar6
abInit
bPar8
bPar9
Retorno:
Nenhum
End
Descrio: Encerra (fecha) o dilogo.
Sintaxe: End( )
Parmetros:
Nenhum
Retorno: Lgico .T. se o dilogo foi encerrado.

Lgico
Indica se o dilogo foi encerrado.
Aparncia:
Exemplo:
Local oDlg
// cria dilogo
oDlg := MSDialog():New(10,10,300,300,'Meu
dialogo',,,,,CLR_BLACK,CLR_WHITE,,,.T.)
oDlg:Activate(,,,.T.,{||msgstop('validou!'),.T.},,{||msgstop('iniciando..
.')} )
/* os comandos abaixo proporcionam o mesmo resultado
// cria dilogo
DEFINE DIALOG oDlg TITLE 'Meu dialogo' FROM 10,10 TO 300,300 COLOR
CLR_BLACK,CLR_WHITE PIXEL
ACTIVATE DIALOG oDlg CENTER ON INIT (msgstop('iniciando...')) VALID
(msgstop('validou!'),.T.)
*/
Return Nil
TWINDOW()
Descrio: Classe de objetos do tipo dilogo principal de programa. Dever

existir apenas uma instncia deste objeto na execuo do programa.
Propriedades:
-
Herdadas das classes superiores
Construtor: New( [anTop], [anLeft],[anBottom], [anRight], [acTitle], [nPar6],

[oPar7] ,[oPar8],[oPar9], [aoParent], [lPar11], [lPar12], [anClrFore],
[anClrBack], [oPar15], [cPar16], [lPar17], [lPar18], [lPar19],
[lPar20], [alPixel] );
Parmetros:
nTop
nLeft
nBottom
nRight
cTitle
nPar6
oPar7
oPar8
oPar9
oParent
lPar11
lPar12
nClrFore
nClrText
oPar15
cPar16
lPar17
lPar18
lPar19
lPar20
lPixel

ou caracteres.
ou caracteres.
Numrico, opcional. Coordenada horizontal inferior em pixels
ou caracteres.
Reservado.
Reservado.
Reservado.
Reservado.
Objeto, opcional. Janela me da janela corrente.
Reservado.
Reservado.
Numrico, opcional. Cor de fundo da janela.
Numrico, opcional. Cor do texto da janela.
Reservado.
Reservado.
Reservado.
Reservado.
Reservado.
Reservado.
Lgico, opcional. Se .T. (padro) considera coordenadas
passadas em pixels, se .F. considera caracteres.
Mtodos auxiliares:
Activate
Descrio: Ativa (exibe) a janela. Chamar esse mtodo apenas uma vez.
Sintaxe: Activate([acShow], [bPar2], [bPar3], [bPar4], [bPar5], [bPar6],
[ abInit ], [bPar8], [bPar9], [bPar10], [bPar11], [bPar12] ,[bPar13],
[bPar14], [bPar15], [abValid], [bPar17], [bPar18] ).
Parmetros:
acShow
bPar2
bPar3
bPar4
bPar5
bPar6
abInit
bPar8
bPar9
bPar10
bPar11
bPar12
bPar13
bPar14
bPar15
abValid
bPar17
bPar18
Caracter, opcional. ICONIZED para janela iconizada ou

MAXIMIZED para janela maximizada.
Reservado.
Reservado.
Reservado.
Reservado.
Reservado.
Bloco de cdigo. Executado quando janela est sendo
exibida.
Reservado.
Reservado.
Reservado.
Reservado.
Reservado.
Reservado.
Reservado.
Reservado.
Bloco de cdigo. Executado quando a janela for solicitada
de fechar. Dever retornar .T. se o contedo da janela for
vlido, ou .F. se no. Se o bloco retornar .F. a janela no
fechar.
Reservado.
Reservado.
Retorno:
Nenhum
End
Descrio: Solicita encerramento da janela.
Sintaxe: End( )
Parmetros:
Nenhum

Lgico
Indica se a janela foi encerrada.
Center
Descrio: Centraliza a janela.
Sintaxe: Center( )
Parmetros:
Nenhum

Nenhum
Aparncia:
Exemplo:
Local oWindow
Local abInit:= {||conout('ativando!')}
Local abValid:= {||conout('encerrando!'),.T.}
oWindow:= tWindow():New( 10, 10, 200, 200, 'Meu
programa',,,,,,,,CLR_WHITE,CLR_BLACK,,,,,,,.T. )
oWindow:Activate('MAXIMIZED',,,,,,abInit,,,,,,,,,abValid,,)
/* os comandos abaixo proporcionam o mesmo resultado
DEFINE WINDOW oWindow FROM 10, 10 TO 200,200 PIXEL TITLE 'Meu programa'
COLOR CLR_WHITE,CLR_BLACK
ACTIVATE WINDOW oWindow MAXIMIZED ON INIT abInit VALID abValid
*/
Return
.
Classes de componentes
TCONTROL()
Descrio: Classe abstrata comum entre todos os componentes visuais

editveis. No deve ser instanciada diretamente.
Propriedades:
Numrico. Alinhamento do controle no espao
disponibilizado pelo seu objeto parente. 0 = Nenhum
(padro), 1= no topo, 2 = no rodap, 3= a esquerda, 4 = a
direita e 5 = em todo o parente.
Lgico. Se .T. indica que o contedo da varivel associada
ao controle foi modificado.
Lgico. Se .T. o contedo da varivel associada ao controle
permanecer apenas para leitura.
Numrico. Handle (identificador) do objeto sobre o qual o
controle foi criado.
Bloco de cdigo. Executado quando o estado ou contedo do
controle modificado pela ao sobre o controle.
Align
lModified
lReadOnly
hParent
bChange
Construtor: No pode ser instanciada.
Parmetros:
Nenhum
Mtodos auxiliares:
SetFocus
Descrio: Fora mudana do foco de entrada de dados para o controle.
Sintaxe: SetFocus( )
Parmetros:
Nenhum
Retorno:
Nil
Exemplo:
CLASS TSay FROM Tcontrol
Classes de componentes visuais

BRGETDDB()
Descrio: Classe de objetos visuais do tipo Grid.
Propriedades:
+
nAt
nLen
Herdadas da classe superior

Linha atualmente selecionada / posicionada no objeto
Nmero total de linhas do objeto
Construtor: New([nRow], [nCol], [nWidth], [nHeigth], [bFields], [aHeaders],

[aColSizes], [oDlg], [cField], [uValue1], [uValue2], [uChange],
[uLDblClick], [uRClick], [oFont], [oCursor], [nClrFore], [nClrBack],
[cMsg], [lUpdate], [cAlias], [lPixel], [bWhen], [lDesign], [bValid],
[aAlter], [oMother])
Parmetros:
nRow
nCol
nWidth
nHeight
bFields
aHeaders
aColSizes
oDlg
cField
uValue1
uValue2
bChange
bLDblClick
bRClick
oFont
oCursor
nClrFore
nClrBack
cMsg
lUpdate
cAlias
lPixel
bWhen
lDesign
Numrico, opcional. Coordenada vertical

Numrico, opcional. Coordenada horizontal
Numrico, opcional. Largura do objeto
Numrico, opcional. Altura do objeto
Bloco de cdigo, Lista de Campos
Vetor, Descrio dos campos para no cabealho
Vetor, Largura das colunas
Objeto, opcional. Janela ou controle onde o divisor dever
ser criado.
Caracter, opcional. Campos necessrios ao filtro
Indefinido, opcional. Inicio do intervalo para o filtro
Indefinido, opcional. Fim do intervalo para o filtro
Bloco de cdigo, opcional. Executado quando o item
selecionado alterado.
Bloco de cdigo, opcional. Executado quando acionado duplo
click do boto esquerdo do mouse sobre o controle.
No utilizado
Objeto, opcional. Fonte
Objeto, opcional. Tipo do Cursor
Caracter, opcional. Mesamge ao posicionar o mouse sobre o
objeto
No utilizado
Caracter, opcional se objeto utilizado com Vetor, obrigatorio
se utilizado com Tabela
Bloco de cdigo, opcional. Executado quando mudana de
foco de entrada de dados est sendo efetuada na janela
onde o controle foi criado. O bloco deve retornar .T. se o
controle deve permanecer habilitado ou .F. se no.
No Utilizado

controle deve ser validado, deve retornar .T. se o contedo
for vlido e .F. quando o contedo for invlido.
No Utilizado
No Utilizado
bValid
aAlter
oMother
Mtodos auxiliares:
GoUp
Descrio: Salta uma linha para cima.
Sintaxe: GoUp( )
Parmetros:
Nenhum
Retorno:
Nil
GoDown
Descrio: Salta uma linha para baixo.
Sintaxe: GoDown( )
Parmetros:
Nenhum
Retorno:
Nil
GoTop
Descrio: Salta para primeira linha.
Sintaxe: GoTop( )
Parmetros:
Nenhum
Retorno:
Nil
GoBottom
Descrio: Salta para ultima linha.
Sintaxe: GoBottom( )
Parmetros:
Nenhum
Retorno:
Nil
RowCount
Descrio: Retorna numero de linhas visiveis.
Sintaxe: RowCount( )
Parmetros:
Nenhum
Retorno:
Nil
Aparncia:
Exemplo:
Local oDlg
DEFINE MSDIALOG oDlg FROM 0,0 TO 302,402 PIXEL TITLE 'Exemplo'
DbSelectArea('SA1')
oBrowse := BrGetDDB():New(
1,1,200,150,,,,oDlg,,,,,,,,,,,,.F.,'SA1',.T.,,.F.,,, )
oBrowse:AddColumn(TCColumn():New('Codigo',{||SA1->A1_COD
},,,,'LEFT',,.F.,.F.,,,,.F.,))
oBrowse:AddColumn(TCColumn():New('Loja' ,{||SA1>A1_LOJA},,,,'LEFT',,.F.,.F.,,,,.F.,))
oBrowse:AddColumn(TCColumn():New('Nome' ,{||SA1>A1_NOME},,,,'LEFT',,.F.,.F.,,,,.F.,))
// Principais commandos
TButton():New(160,001,'GoUp()',oDlg,{|| oBrowse:GoUp()
},40,10,,,,.T.)
TButton():New(170,001,'GoDown()',oDlg,{|| oBrowse:GoDown()
},40,10,,,,.T.)
TButton():New(180,001,'GoTop()',oDlg,{|| oBrowse:GoTop()
},40,10,,,,.T.)
TButton():New(190,001,'GoBottom()' , oDlg,{|| oBrowse:GoBottom()
},40,10,,,,.T.)
TButton():New(160,060,'nAt (Linha selecionada)',oDlg,;
{|| Alert (oBrowse:nAt)},80,10,,,,.T.)
TButton():New(170,060,'nRowCount (Nr de linhas visiveis)',oDlg,;
{|| Alert(oBrowse:nRowCount()) },80,10,,,,.T.)
TButton():New(180,060, 'nLen (Numero total de linhas)', oDlg,;
{|| Alert(oBrowse:nLen) },80,10,,,,.T.)

Return NIL
MSCALEND()
Descrio: Classe de objetos visuais do tipo Calendrio.
Propriedades:
+
bChange
bChangeMes
dDiaAtu

Bloco de cdigo executado na mudana de seleo de um
dia.
Bloco de cdigo executado na mundaa de seleo de um
ms.
Dia atualmente selecionado
Construtor: New([nRow], [nCol], [oDlg], [lCanMultSel])
Parmetros:
nRow
nCol
oDlg
lCanMultSel

ser criado.
Logico, opcional. Permite seleo de multiplos dias
Aparncia:
Exemplo:
user function Calend_Ex()
DEFINE MSDIALOG oDlg FROM 0,0 TO 1000,1000 PIXEL TITLE 'Exemplo de
MsCalend'
// Cria objeto
oCalend:=MsCalend():New(01,01,oDlg,.T.)
// Code-Block para mudana de Dia
oCalend:bChange := {|| Alert('Dia Selecionado: ' +
dtoc(oCalend:dDiaAtu)) }
// Code-Block para mudana de mes
oCalend:bChangeMes := {|| alert('Mes alterado') }
Return
MSCALENDGRID()
Descrio: Classe de objetos visuais do tipo Grade de Perodos.
Propriedades:
bAction
bRClick
Bloco de cdigo. Executado quando o boto esquerdo do

mouse pressionado.
Bloco de cdigo. Executado quando o boto direito do mouse
pressionado.
Construtor: New([aoWnd], [anRow], [anCol], [anHeight], [anWidth],

[dDateIni], [nResolution], [abWhen], [abAction], [nDefColor],
[bRClick], [lFillAll])
Parmetros:
aoWnd
anRow
anCol
anHeight
anWidth
dDateIni
nResolution
abWhen
abAction
nDefColor
bRClick
lFillAll

criado.
Numrico, opcional.
carateres.
Numrico, opcional.
caracteres.
Numrico, opcional.
Numrico, opcional.
Coordenada vertical em pixels ou

Coordenada horizontal em pixels ou
Altura do boto em pixels.
Largura do boto em pixels.
Data, Data inicial do Calendrio

Numrico, Resoluo a ser aplicada na grid do Calendrio
Bloco de cdigo, opcional. Bloco que dever ser acionado
quando o boto for pressionado.
Numrico, opcional. Cor do Fundo da Grid.
Bloco de cdigo, opcional. Executado quando acionado o
boto direito do mouse sobre o controle.
Lgico, opcional. Preenche todo o periodo
Mtodos auxiliares:
Add
Descrio: Adiciona periodo na Grid.
Sintaxe: Add(cCaption, nLin, nInitial, nFinal, nColor, cDescri )
Parmetros:
cCaption
nLin
nInitial
nFinal
Caracter. Descrio a ser inserida a esquerda da Grid

Numerico. Numero da linha a ser inserido o item
Numerico. Dia inicial
Numerico. Dia Final
nColor
cDescri
Numerico. Cor que destacara o item

Caracter, Opicional. Descrio do tipo tooltip(hint) do item
Retorno:
Nil
Aparncia:
Exemplo:
Local oDlg
nResolution := 1
oMsCalendGrid := MsCalendGrid():New( oDlg, 01, 01, 500,300,;
date(), nResolution, ,{|x,y| Alert(x) },;
RGB(255,255,196), {|x,y|Alert(x,y)}, .T.
)
oMsCalendGrid:Add('caption 01', 1, 10, 20, RGB(255,000,0),
'Descricao 01')
'Descricao 02')
'Descricao 03')
Return NIL
MSSELBR()
Descrio: Classe de objetos visuais do tipo controle - Grid
Propriedades:
+
nAt
nLen

Construtor: New([nRow], [nCol], [nWidth], [nHeigth], [bFields], [aHeaders],

[aColSizes], [oDlg], [cField], [uValue1], [uValue2], [uChange],
[uLDblClick], [uRClick], [oFont], [oCursor], [nClrFore], [nClrBack],
[cMsg], [lUpdate], [cAlias], [lPixel], [bWhen], [lDesign], [bValid])
Parmetros:
nRow
nCol
nWidth
nHeight
bFields
aHeaders
aColSizes
oDlg
cField
uValue1
uValue2
bChange
bLDblClick
bRClick
oFont
oCursor
nClrFore
nClrBack
cMsg
lUpdate
cAlias
lPixel
bWhen
lDesign
bValid

ser criado.
No utilizado
objeto
No utilizado
No Utilizado
Mtodos auxiliares:
GoUp
Sintaxe: GoUp( )
Parmetros:
Nenhum
Retorno:
Nil
GoDown
Sintaxe: GoDown( )
Parmetros:
Nenhum
Retorno:
Nil
GoTop
Sintaxe: GoTop( )
Parmetros:
Nenhum
Retorno:
Nil
GoBottom
Parmetros:
Nenhum
Retorno:
Nil
RowCount
Parmetros:
Nenhum
Retorno:
Nil
Aparncia:
Exemplo:
Local oDlg
DbSelectArea('SA1')
oBrowse := MsSelBr():New(
1,1,200,150,,,,oDlg,,,,,,,,,,,,.F.,'SA1',.T.,,.F.,,, )
oBrowse:AddColumn(TCColumn():New('Codigo',{||SA1->A1_COD
},,,,'LEFT',,.F.,.F.,,,,.F.,))
oBrowse:AddColumn(TCColumn():New('Loja' ,{||SA1>A1_LOJA},,,,'LEFT',,.F.,.F.,,,,.F.,))
oBrowse:AddColumn(TCColumn():New('Nome' ,{||SA1>A1_NOME},,,,'LEFT',,.F.,.F.,,,,.F.,))
},40,10,,,,.T.)
},40,10,,,,.T.)
},40,10,,,,.T.)
},40,10,,,,.T.)
TButton():New(160,060,'nAt (Linha selecionada)',oDlg,{||
Alert(oBrowse:nAt)},80,10,,,,.T.)

Return NIL
.
MSWORKTIME()
Descrio: Classe de objetos visuais do tipo controle - Barra de Perodo.
Propriedades:
bChange
Bloco de cdigo. Executado ao disparar qualquer ao sobre

o objeto.
Construtor: New([aoWnd], [anRow], [anCol], [anHeight],

[nResolution], [cValue], [abWhen], [abChange])
Parmetros:
aoWnd
anRow
anCol
[anWidth],

criado.
carateres.
caracteres.
Numrico, opcional. Altura do boto em pixels.
Numrico, opcional. Largura do boto em pixels.
Numrico, Resoluo a ser aplicada na grid do Calendrio
Caracter, opcional. Descritivo
anHeight
anWidth
nResolution
cValue
abWhen
abChange
Mtodos auxiliares:
GetValue
Descrio: Retorna os item selecionados no formato XX X XX.
Sintaxe: GetValue()
Parmetros:
Nenhum
Retorno:
Caracter
Retorna os item selecionados no formato XX X XX.
GetInterTime
Descrio: Retorna periodo selecionado.
Sintaxe: GetInterTime()
Parmetros:
Nenhum
Retorno:
Caracter
Retorna o perodo selecionada no formato HH:MM:SS
SetResol
Descrio: Define a resoluo da demonstrao da barra de perodos.
Sintaxe: SetResol (nResolution)
Parmetros:
nResolution
Resoluo
Retorno:
Nil
SetValue
Descrio: Atribui um determindo contedo para um objeto ou atributo
de um objeto.
Sintaxe: SetValue(xValue, cPicture)
Parmetros:
xValue
cPicture
Valor que ser atribudo ao objeto ou atributo do objeto.

Picture de formao opcional para o contedo atribudo.
Retorno:
Nenhum
Aparncia:
Exemplo:
Local oDlg
oMsWorkTime := MsWorkTime():New(oDlg,04,04,280,133,0,'',{||.T.},;
{|oWorkTime|Alert('GetValue():
'+oWorkTime:GetValue()+chr(13)+;
'GetInterTime():
'+oWorkTime:GetInterTime())} )
oMsWorkTime:SetValue('X X XX X')
Return NIL
SBUTTON()
Descrio: Classe de objetos visuais do tipo boto que Define o componente

visual SButton, o qual permite a incluso de botes de operao na
tela da interface, os quais sero visualizados dependendo da
interface do sistema ERP utilizada somente com um texto simples
para sua identificao, ou com uma imagem (BitMap) pr-definido.
Propriedades:
Bloco de cdigo. Executado ao precionar o boto esquerdo
do mouse.
bAction
Construtor: New([nTop], [nLeft],

[cMsg], [bWhen])
Parmetros:
Parmetro
[bAction],
[oWnd],
[lEnable],
Tipo / Descrio
carateres.
caracteres.
Numrico. Tipo do Boto
criado.
Logico, opcional. Habilita/Desabilita boto
nTop
nLeft
nType
bAction
oWnd
lEnable
cMsg
abWhen
[nType],
Mtodos auxiliares:
Create
Descrio: Retorna Mtodo construtor opcional da classe.
Sintaxe: Create()
Parmetros:
Nenhum
Retorno:
Objeto
Objeto da classe Sbutton com todos os atributos com

contedos padres.
Aparncia:
Exemplo:
Local oDlg
oSButton1 := SButton():New( 01,01,1,{||Alert('SButton
01')},oDlg,.T.,,)
02')},oDlg,.T.,,)
03')},oDlg,.T.,,)
04')},oDlg,.T.,,)
Return NIL
TBAR()
Descrio: Classe de objetos visuais que permite a implementao de um

componente do tipo barra de botes para a parte superior de uma
janela previamente definida.
Propriedades:
-
Construtor:
Parmetros:
oWnd

criado.
nBtnWidth
nBtnHeight
l3D
cMode
No utilizado.
oCursor
cResource
lNoAutoAdjust
Herdados das classes superiores.

barra.
fundo da barra.
Lgico.
Aparncia:
Exemplo:
/*/
+-----------------------------------------------------------------------| Funo
| TSTBAR
| Autor | MICROSIGA
|Data |
|
+-----------------------------------------------------------------------| Descrio | Programa que demonstra a utilizao do objeto TBar()
|
+-----------------------------------------------------------------------| Uso
| Curso ADVPL
|
+-----------------------------------------------------------------------/*/
Local oDlg
oDlg
,,,,;

{||},oTBar,'PCO',,.F.,.F. )
,,,,;

{||},oTBar,'Preo' ,,.F.,.F. )
,,,,;
oDlg:Activate()
Return
TBITMAP()
Descrio: Classe de objetos visuais que permite a exibio de uma imagem.
Propriedades:
cResName
cBmpFile
lStretch
lAutoSize
lTransparent
Caractere, Nome do resource

Caractere, Nome do arquivo
Lgico, opcional. Strech da imagem
Lgico, opcional. Tamanho automtico
Lgico, opcional. Transparente
Construtor: New([anTop], [anLeft], [anWidth], [anHeight], [acResName],

[acBmpFile], [alNoBorder], [aoWnd], [abLClicked], [abRClicked],
[alScroll], [alStretch], [aoCursor], [acMsg], [alUpdate], [abWhen],
[alPixel], [abValid], [alDesign], [alIsIcon], [alIsJpeg] )
Parmetros:
anTop
anLeft
anWidth
anHeight
acResName
acBmpFile
alNoBorder
aoWnd
abLClicked
abRClicked
alScroll
alStretch
aoCursor
acMsg
alUpdate
abWhen
alPixel
abValid
alDesign
alIsIcon
alIsJpeg

carateres.
caracteres.
Numrico, opcional. Largura em pixels.
Numrico, opcional. Altura em pixels.
Caractere, Nome do resource.
Caractere, Nome do arquivo.
Lgico, opcional. Exibe borda
Objeto, opcional. Janela ou controle onde a imagem dever
ser criada.
boto esquerdo do mouse for pressionado.
boto direito do mouse for pressionado.
Lgico, opcional. Ativa o scroll
Lgico, opcional. Strech da imagem
Objeto, opcional. Cursor a ser exibido
No utilizado
No utilizado
Lgico, opcional. Utiliza coordenadas em pixel
Bloco de cdigo, opcional. Bloco que dever ser acionado na
validao.
No utilizado
Lgico, opcional. cone. No utilizado a partir da verso
Protheus 8
Lgico, opcional. Jpeg. No utilizado a partir da verso
Protheus 8
Mtodos auxiliares:
Create
Descrio: Retorna Mtodo construtor opcional da classe.
Sintaxe: Create()
Parmetros:
Nenhum
Retorno:
Objeto
Objeto da classe TBar com todos os atributos com

contedos padres.
SetBmp
Descrio: Mtodo para carregar uma imagem do repositrio.
Sintaxe: SetBmp( acResName )
Parmetros:
acResName
Retorno:
Nenhum
Load
Descrio: Mtodo para carregar uma imagem do repositrio ou local.
Sintaxe: Load( acResName, acBmpFile )
Parmetros:
acResName
acBmpFile

Retorno:
Nenhum
Aparncia:
Exemplo:
User Function tBitmapTst()

Local oDlg
Local oBmp
DEFINE MSDIALOG oDlg TITLE '' FROM 0,0 TO 280,330 PIXEL
@ 10, 10 BITMAP oBmp RESOURCE 'totvs.bmp' SIZE 150,150 OF oDlg PIXEL
oBmp:lAutoSize := .T.
Return
.
TBROWSEBUTTON()
Descrio: Classe de objetos visuais do tipo boto no formato padro utilizado

em browses da aplicao.
Propriedades:
bAction

do mouse.
Construtor: New([nRow], [nCol], [cCaption], [oWnd], [bAction], [nWidth],

[nHeight], [nHelpId], [oFont], [lDefault], [lPixel], [lDesign], [cMsg],
[lUpdate], [bWhen], [bValid], [lCancel])
Parmetros:
nRow
nCol
cCaption
oWnd
bAction
nWidth
nHeight
nHelpId
oFont
lDefault
lPixel

carateres.
caracteres.
Caractere, opcional. Titulo do boto.
criado.
Numrico, opcional. Largura do boto em pixels
Reservado
Objeto, opcional. Objeto tipo tFont com propriedades da
fonte utilizada para o ttulo do boto.
Reservado
em pixels, se .F. (padro) considera em caracteres.
lDesign
cMsg
lUpdate
bWhen
bValid
lCancel
Reservado
Reservado
Reservado
Reservado
Reservado
Aparncia:
Exemplo:
Local oDlg
oTBrowseButton := TBrowseButton():New( 01,01,'TBrowseButton',oDlg,;
{||Alert('TBrowseButton')},40,10,,,.F.,.T.,.F.,,.F.,,,)
Return NIL
TBTNBMP()
Descrio: Classe de objetos visuais do tipo boto, o qual permite que seja
vinculada uma imagem ao controle.
Propriedades:
bAction

do mouse.
Construtor: NewBar([cResName1], [cResName2], [cBmpFile1], [cBmpFile2],

[cMsg], [bAction], [lGroup], [oWnd], [lAdjust], [bWhen], [cToolTip],
[lPressed],
[bDrop],
[cAction],
[nPos],
[cPrompt],
[oFont],
[cResName3], [cBmpFile3], [lBorder])
Parmetros:
cResName1
cResName2
cBmpFile1
cBmpFile2
cMsg
bAction
lGroup
oWnd
lAdjust
bWhen
cToolTip
lPressed
bDrop
cAction
nPos
cPrompt
oFont
cResName3
cBmpFile3
lBorder

Caractere, NO UTILIZADO
Caractere, Mensagem de Hint
Bloco de cdigo. Ao executada
Lgico. Define grupo
Objeto, opcional. Janela ou controle onde a boto dever ser
criado
Lgico, NO UTILIZADO
No utilizado
No utilizado
No utilizado
No utilizado
Caracter, opcional. Caption do boto.
controle.
No utilizado
No utilizado
No utilizado
Mtodos auxiliares:
LoadBitmaps
Descrio: Atribui ao boto os bitmaps ou recursos para exibio.
Sintaxe:
LoadBitmaps([cResName1],
[cResName2],
[cBmpFile1],
[cBmpFile2], [cResName3], [cBmpFile3])
Parmetros:
cResName1
cResName2
cBmpFile1
cBmpFile2
cResName3
cBmpFile3
Caractere,
Caractere,
Caractere,
Caractere,
Caractere,
Caractere,
Nome
Nome
Nome
Nome
Nome
Nome
do
do
do
do
do
do
resource
resource
arquivo BMP
arquivo BMP
resource
resource
Retorno:
Nenhum
SetPopUpMenu
Descrio: Seta o objeto do tipo TMenu referente ao boto.
Sintaxe: SetPopupMenu(oMenu)
Parmetros:
Nenhum
Retorno:
Nenhum
Aparncia:
Exemplo:
Local oDlg
oTBar := TBar():New( oDlg,25,32,.T.,,,,.F. ) // Orig: 25,45
oTBtnBmp1 := TBtnBmp() :NewBar('RPMNEW',,,,'Msg 01',;
{||Alert('TBtnBmp
01')},.F.,oTBar,.T.,{||.T.},,.F.,,,1,,,,,.T. )
oTBtnBmp2 := TBtnBmp() :NewBar('copyuser',,,,'Msg 02',;
{||Alert('TBtnBmp
02')},.F.,oTBar,.T.,{||.T.},,.F.,,,1,,,,,.T. )
Return NIL
TBTNBMP2()
Descrio: Classe de objetos visuais do tipo boto, o qual permite a exibio de

uma imagem ou de um popup.
Propriedades:
-
Herdadas das classes superiores.
Construtor: New([anTop], [anLeft], [anWidth], [anHeight], [acResName1],

[acResName2], [acBmpFile1], [acBmpFile2],[abAction], [aoWnd],
[acMsg], [abWhen], [lAdjuste], [lUpdate])
Parmetros:
anTop
anLeft
anWidth
anHeight
acResName1
acResName2
acBmpFile1
acBmpFile2
abAction
aoWnd
acMsg
abWhen
lAdjust
lUpdate

carateres.
caracteres.
Bloco de cdigo. Ao executada
criado
Lgico, NO UTILIZADO
Lgico, NO UTILIZADO
Mtodos auxiliares:
LoadBitmaps
Descrio: Atribui ao boto os bitmaps ou recursos para exibio.
Sintaxe:
LoadBitmaps([cResName1],
[cResName2],
[cBmpFile1],
[cBmpFile2], [cResName3], [cBmpFile3])
Parmetros:
cResName1
cResName2
cBmpFile1
cBmpFile2
cResName3
cBmpFile3
Caractere,
Caractere,
Caractere,
Caractere,
Caractere,
Caractere,
Nome
Nome
Nome
Nome
Nome
Nome
do
do
do
do
do
do
resource
resource
arquivo BMP
arquivo BMP
resource
resource
Retorno:
Nenhum
SetPopUpMenu
Descrio: Seta o objeto do tipo TMenu referente ao boto.
Sintaxe: SetPopupMenu(oMenu)
Parmetros:
Nenhum
Retorno:
Nenhum
Aparncia:
Exemplo:
Local oBtn := TBtnBmp2():New( 10, 10, 25, 25, 'printer_r2' , , , , , oDlg,
, , )
Exemplo 2 (Popup)
#INCLUDE 'PROTHEUS.CH'
User Function BtnBmpPopUp
Local oDlg
Local oBtn
oBtn := TBtnBmp2():New( 10, 10, 13, 13, 'IBF-MENU.BMP' , 'IBF-MENU.BMP' ,
, , , oDlg, , , .T.)
oBtn:SetPopupmenu(TShowMenu())
Return
/**************************/
Static Function TShowMenu()
Local oMenu
oMenu := TMenu():New(0,0,0,0,.T.)
oMenu:Add(TMenuItem():New(,'Detalhes', 'Detalhes',,, ,,,,,,,,,.T.))
oMenu:Add(TMenuItem():New(,'Add Info', 'Add Info',,, ,,,,,,,,,.T.))
Return oMenu
TBUTTON()
Descrio: Classe de objetos visuais do tipo boto, o qual permite a utilizao

de texto para sua identificao.
Propriedades:
lProcessing
bAction
Lgico. Se .T. indica o boto est efetuando uma ao.

Bloco de cdigo. Executado quando o boto pressionado.
Construtor: New([anRow], [anCol], [acCaption], [aoWnd], [abAction],

[anWidth],
[anHeight],
[nPar8],
[aoFont],
[lPar10],
[alPixel],[lPar12],[cPar13], [lPar14], [abWhen], [bPar16], [lPar17])
Parmetros:
Parmetro
anRow
anCol
acCaption
aoWnd
abAction
anWidth
anHeight
nPar8
aoFont
Tipo / Descrio
carateres.
caracteres.
criado.
Reservado.
lPar10
alPixel
lPar12
cPar13
lPar14
abWhen
bPar16
lPar17
Reservado.
em pixels, se .F. (padro) considera em caracteres.
Reservado.
Reservado.
Reservado.
Reservado.
Reservado.
Aparncia:
Exemplo:
User Function TesteGet()
Local oDlg, oButton, oCombo, cCombo
aItems:= {'item1','item2','item3'}
cCombo:= aItems[2]
DEFINE MSDIALOG oDlg FROM 0,0 TO 300,300 PIXEL TITLE 'Meu Combo'
oCombo:= tComboBox():New(10,10,{|u|if(PCount()>0,cCombo:=u,cCombo)},;
aItems,100,20,oDlg,,{||MsgStop('Mudou item')},,,,.T.,,,,,,,,,'cCombo')
// Boto para fechar a janela
oButton:=tButton():New(30,10,'fechar',oDlg,{||oDlg:End()},100,20,,,,.T.)
MsgStop( 'O valor '+cCombo )
Return NIL
TCBROWSE()
Descrio: Classe de objetos visuais do tipo Grid.
Propriedades:
+
nAt
nLen

Construtor: New([nRow], [nCol], [nWidth], [nHeigth],[bFields], [aHeaders],

[aColSizes],
[oDlg],
[cField],
[uValue1],
[uValue2],
[uChange],[{|nRow,nCol,nFlags|[uLDblClick]}],
[{|nRow,nCol,nFlags|[uRClick]}], [oFont], [oCursor], [nClrFore],
[nClrBack], [cMsg], [lUpdate], [cAlias], [lPixel], [{uWhen}],
[lDesign], [bValid], [lHScroll], [lVScroll])
Parmetros:
nRow
nCol
nWidth
nHeight
bFields
aHeaders
aColSizes
oDlg
cField
uValue1
uValue2
bChange
bLDblClick
bRClick
oFont
oCursor
nClrFore
nClrBack
cMsg
lUpdate
cAlias
lPixel
bWhen
lDesign
bValid

ser criado.
No utilizado
objeto
No utilizado
No Utilizado

Lgico, opcional. Se .T., habilita barra de rolagem
horizontal.
Lgico, opcional. Se .T., habilita barra de rolagem vertical.
lHScroll
lVScroll
Mtodos auxiliares:
GoUp
Sintaxe: GoUp( )
Parmetros:
Nenhum
Retorno:
Nil
GoDown
Sintaxe: GoDown( )
Parmetros:
Nenhum
Retorno:
Nil
GoTop
Sintaxe: GoTop( )
Parmetros:
Nenhum
Retorno:
Nil
GoBottom
Parmetros:
Nenhum
Retorno:
Nil
RowCount
Parmetros:
Nenhum
Retorno:
Nil
Aparncia:
Exemplo:
user function TcBrowse_EX()
Local oOK
:= LoadBitmap(GetResources(),'br_verde')
Local oNO
:= LoadBitmap(GetResources(),'br_vermelho')
Local aList := {} // Vetor com elementos do Browse
Local nX
// Cria Vetor para teste
for nX := 1 to 100
aListAux := {.T., strzero(nX,10), 'Descrio do Produto '+;
strzero(nX,3), 1000.22+nX}
aadd(aList, aListAux)
next
DEFINE MSDIALOG oDlg FROM 0,0 TO 520,600 PIXEL TITLE 'Exemplo da TCBrowse'
// Cria objeto de fonte que sera usado na Browse
Define Font oFont Name 'Courier New' Size 0, -12
// Cria Browse
oList := TCBrowse():New( 01 , 01, 300, 200,,;
'','Codigo','Descrio','Valor'},{20,50,50,50},;
oDlg,,,,,{||},,oFont,,,,,.F.,,.T.,,.F.,,, )
// Seta o vetor a ser utilizado
oList:SetArray(aList)
// Monta a linha a ser exibina no Browse
oList:bLine := {||{ If(aList[oList:nAt,01],oOK,oNO),;
aList[oList:nAt,02],;
aList[oList:nAt,03],;
Transform(aList[oList:nAT,04],'@E 99,999,999,999.99') } }
// Evento de DuploClick (troca o valor do primeiro elemento do Vetor)
oList:bLDblClick := {|| aList[oList:nAt][1] :=;
!aList[oList:nAt][1],oList:DrawSelect() }
oBtn := TButton():New( 210, 001,'GoUp()' , oDlg,{||oList:GoUp()},;
40, 010,,,.F.,.T.,.F.,,.F.,,,.F. )
oBtn := TButton():New( 220, 001,'GoDown()', oDlg,{||oList:GoDown()},;
40, 010,,,.F.,.T.,.F.,,.F.,,,.F. )
oBtn := TButton():New( 230, 001,'GoTop()' , oDlg,{||oList:GoTop()}, ;
40, 010,,,.F.,.T.,.F.,,.F.,,,.F. )
oBtn := TButton():New( 240, 001,'GoBottom()', oDlg,{||oList:GoBottom()},;
40, 010,,,.F.,.T.,.F.,,.F.,,,.F. )
oBtn := TButton():New( 210, 060, 'nAt (Linha selecionada)'
,;
oDlg,{|| Alert(oList:nAt)},;
90, 010,,,.F.,.T.,.F.,,.F.,,,.F. )
oBtn := TButton():New( 220, 060, 'nRowCount (Nr de linhas visiveis)',
oDlg,;{|| Alert(oList:nRowCount()) }, 90, 010,,,.F.,.T.,.F.,,.F.,,,.F. )
oBtn := TButton():New( 230, 060, 'nLen (Numero total de linhas)', oDlg,;
{|| Alert(oList:nLen) }, 90, 010,,,.F.,.T.,.F.,,.F.,,,.F. )
oBtn := TButton():New( 240, 060, 'lEditCell (Edita a celula)', oDlg,;
{|| lEditCell(@aList,oList,'@!',3) }, 90, 010,,,.F.,.T.,.F.,,.F.,,,.F. )
return
TCHECKBOX()
Descrio: Classe de objetos visuais do tipo controle - CheckBox.
Propriedades:
bLClicked
bSetGet
bWhen
bValid
Bloco de cdigo disparado ao clique do mouse no objeto

Bloco de cdigo disparado na mudana de item selecionado,
responsavel pela mudana de valor da variavel numerica
que indica o item selecionado.
Bloco de cdigo recebe um lgico e de True permite
alterao, se False no permite.
Bloco de cdigo executado na saida do objeto.
Construtor: New([nRow], [nCol], [cCaption], [bSetGet], [oDlg], [nWidth],

[nHeight], [aHelpIds], [bLClicked], [oFont], [bValid], [nClrText],
[nClrPane], [lDesign], [lPixel], [cMsg], [lUpdate], [bWhen])
Parmetros:
nRow
nCol
cCaption
bSetGet
oDlg
nWidth
nHeight
aHelpIds
bLClicked
oFont
bValid
nClrText
nClrPane
lDesign
lPixel
cMsg
lUpdate
bWhen

Caracter, Texto descritivo
Code-block, opcional, Responsvel pela setagem de valor
ser criado.
No utilizado
Bloco de cdigo, opcional. Executado ao clique do mouse.
No utilizado
objeto
No utilizado
Aparncia:
Exemplo:
user function TCheckBox()
DEFINE MSDIALOG oDlg FROM 0,0 TO 270,400 PIXEL TITLE 'Exemplo da
TCBrowse'
lCheck1 := .T.
oCheck1 := TCheckBox():New(01,01,'CheckBox 001',,oDlg,
100,210,,,,,,,,.T.,,,)
100,210,,,,,,,,.T.,,,)
100,210,,,,,,,,.T.,,,)
oCheck4 :=TCheckBox():New(31,01,'CheckBox 004',,oDlg,
100,210,,,,,,,,.T.,,,)
oCheck5 := TCheckBox():New(41,01,'CheckBox
005',,oDlg,100,210,,,,,,,,.T.,,,)
// Seta Eventos do primeiro Check

oCheck1:bSetGet
:= {|| lCheck1 }
oCheck1:bLClicked := {|| lCheck1:=!lCheck1 }
oCheck1:bWhen
:= {|| .T. }
oCheck1:bValid
:= {|| Alert('bValid') }
// Principais comandos
oBtn := TButton():New( 060, 001, 'Retorna estado do CheckBox
001',;
oDlg,{|| Alert(lCheck1) }, 120,
010,,,.F.,.T.,.F.,,.F.,,,.F. )
return
TCOLORTRIANGLE()
Descrio: Classe de objetos visuais do tipo Paleta de Cores.
Propriedades:
-
Construtor: New([anRow], [anCol], [aoWnd], [anWidth], [anHeight] )
Parmetros:
carateres.
caracteres.
Objeto, opcional. Janela ou controle onde a paleta dever
ser criada.
Numrico, opcional. Largura da paleta em pixels.
Numrico, opcional. Altura da paleta em pixels.
anRow
anCol
aoWnd
anWidth
anHeight
Mtodos auxiliares:
Create
Descrio: Mtodo construtor opcional da classe.
Sintaxe: Create(aoWnd)
Parmetros:
aoWnd

ser criada.
Retorno:
Objeto
Objeto do tipo TColorTriangule com os atributos definidos

com contedo padro.
RetColor
Descrio: Retorna o RGB da cor selecionada
Sintaxe: RetColor ( )
Parmetros:
Nenhum
Retorno:
Numrico
Valor que representa do RGB da cor.
SetColorIni
Descrio: Define a cor inicial selecionada para o controle.
Sintaxe: SetColorIni (nColor )
Parmetros:
nColor
Valor da cor inicial no padro RGB.
Retorno:
Nenhum
SetColor
Descrio: Define a cor corrente.
Sintaxe: SetColor (nColor )
Parmetros:
nColor
Valor da cor inicial no padro RGB.
Retorno:
Nenhum
SetSizeTriangule
Descrio: Define o tamanho do tringulo de configurao das cores.
Sintaxe: SetSizeTriangule (nWidh, nHeight)
Parmetros:
nWidth
nHeight
Numrico. Largura
Numrico.Altura
Retorno:
Nenhum
Aparncia:
Exemplo:
User Function tColor()

Local oDlg, oColorT
DEFINE MSDIALOG oDlg FROM 0,0 TO 500,600 PIXEL TITLE Cores
// Usando o mtodo create
oColorT := tColorTriangle():Create( oDlg )
oColorT:SetColorIni( nColorIni )
Return Nil
TCOMBOBOX()
Descrio: Classe de objetos visuais do tipo tComboBox, a qual cria uma

entrada de dados com mltipla escolha com item definido em uma
lista vertical, acionada por F4 ou pelo boto esquerdo localizado na
parte direita do controle. A varivel associada ao controle ter o
valor de um dos itens selecionados ou no caso de uma lista
indexada, o valor de seu ndice.
Propriedades:
aItems
nAt
Array. Lista de itens, caracteres, a serem exibidos. Pode ter

os seguintes formatos: a) Seqencial, exemplo:
{item1,item2,...,itemN} ou b) Indexada, exemplo:
{a=item1,b=item2, ..., n=itemN}.
Numrico. Posio do item selecionado.
Construtor: New([anRow], [anCol], [abSetGet], [anItems], [anWidth],

[anHeight], [aoWnd], [nPar8], [abChange], [abValid], [anClrText],
[anClrBack], [alPixel], [aoFont], [cPar15], [lPar16], [abWhen],
[lPar18], [aPar19], [bPar20], [cPar21], [acReadVar])
Parmetros:
Parmetro
anRow
anCol
abSetGet
anItems
anWidth

caracteres.
caracteres.
Bloco de cdigo, opcional. Bloco de cdigo no formato {|u|
if( Pcount( )>0, <var>:= u, <var> ) } que o controle utiliza
para atualizar a varivel <var>. <var> deve ser tipo
caracter. Se a lista for seqencial, o controle atualizar
<var> com o contedo do item selecionado, se a lista for
indexada, <var> ser atualizada com o valor do ndice do
item selecionado.
Array, opcional. Lista de items, caracteres, a serem exibidos.
Pode ter os seguintes formatos: a) Seqencial, exemplo:
{item1,item2,...,itemN} ou b) Indexada, exemplo:
{a=item1,b=item2, ..., n=itemN}.
anHeight

criado.
Reservado.
modifica o item selecionado.
controle.
Reservado.
Reservado.
Reservado.
Reservado.
Reservado.
Reservado.
aoWnd
nPar8
abChange
abValid
anClrBack
anClrText
alPixel
aoFont
cPar15
lPar16
abWhen
lPar18
aPar19
bPar20
cPar21
acReadVar
Mtodos auxiliares:
Select
Descrio: Muda o item selecionado no combobox.
Sintaxe: Select( [anItem] )
Parmetros:
anItem
Numrico, opcional. Posio do item a ser selecionado.
Retorno:
Nenhum
Aparncia:
Exemplo:
Local oDlg, oButton, oCombo, cCombo
aItems:= {'item1','item2','item3'}
cCombo:= aItems[2]
DEFINE MSDIALOG oDlg FROM 0,0 TO 300,300 PIXEL TITLE 'Meu Combo'
oCombo:= tComboBox():New(10,10,{|u|if(PCount()>0,cCombo:=u,cCombo)},;
aItems,100,20,oDlg,,{||MsgStop('Mudou item')},,,,.T.,,,,,,,,,'cCombo')
MsgStop( 'O valor '+cCombo )
Return NIL
TFOLDER()
Descrio: Classe de objetos visuais do tipo controle - Folder.
Propriedades:
aPrompts
aDialogs
nOption
bSetOption
Array, Titulo dos folders

Array, Nome dos dilogos
Numrico, Folder selecionado
Bloco de cdigo, Executado na seleo do folder
Construtor: New([anTop], [anLeft], [aPrompts], [aDialogs], [aoWnd],

[anOption], [anClrFore], [anClrBack], [alPixel], [alDesign], [anWidth],
[anHeight], [acMsg], [alAllWidth])
Parmetros:
carateres.
caracteres.
Array, Nome dos dilogos
criado
Numrico, opcional. Folder selecionado
Numrico, opcional. Cor de frente
Numrico, opcional. Cor de fundo
Lgico, opcional. NO USADO
anTop
anLeft
aPrompts
aDialogs
aoWnd
anOption
anClrFore
anClrBack
alPixel
alDesign
anWidth
anHeight
acMsg
alAllWidth
Mtodos auxiliares:
SetOption
Descrio: Seleciona folder desejado
Sintaxe: SetOption( nOption )
Parmetros:
nOption
Numrico. Folder a ser selecionado
Retorno:
Nenhum
AddItem
Descrio: Insere um folder
Sintaxe: AddItem ( cItem, lVisible )
Parmetros:
cItem
lVisible
Caractere. Ttulo do Folder

Lgico. Visvel
Retorno:
Nenhum
aEnable
Descrio: Habilita/Desabilita um folder
Sintaxe: aEnable( nItem, lEnable )
Parmetros:
nItem
lEnable
Numrico. Folder para habilitar/desabilitar

Lgico. Habilita/Desabilita
Retorno:
Nenhum
Aparncia:
Exemplo:
Local oFolder
Local aFolder := { 'Folder 1', 'Folder 2', 'Folder 3' }
oFolder := TFolder():New( 0, 0, aFolder, aFolder, oDlg,,,, .T., , 200,;
200 )
TGET()
Descrio: Classe de objetos visuais do tipo controle tGet, a qual cria um

controle que armazena ou altera o contedo de uma varivel atravs
de digitao. O contedo da varivel s modificado quando o
controle perde o foco de edio para outro controle.
Propriedades:
lPassword
Picture
Lgico. Se .T. o controle se comporta como entrada de

dados de senha, exibindo asteriscos * para esconder o
contedo digitado.
Caractere. Mscara de formatao do contedo a ser
exibido.
Construtor: New([anRow], [anCol], [abSetGet], [aoWnd], [anWidth],

[anHeight], [acPict], [abValid], [anClrFore], [anClrBack], [aoFont],
[lPar12], [oPar13], [alPixel], [cPar15], [lPar16], [abWhen], [lPar18],
[lPar19],
[abChange],
[alReadOnly],
[alPassword],
[cPar23],
[acReadVar], [cPar25], [lPar26], [nPar27], [lPar28])
Parmetros:
anRow
anCol
abSetGet
aoWnd
anWidth
anHeight
acPict
abValid
anClrFore
anClrBack
aoFont

caracteres.
caracteres.
caracter, numrico ou data.
criado.
Caractere, opcional. Mscara de formatao do contedo a
ser exibido.
lPar12
oPar13
alPixel
cPar15
lPar16
abWhen
lPar18
lPar19
abChange
alReadOnly
alPassword
cPar23
acReadVar
cPar25
lPar26
nPar27
lPar28
controle.
Reservado.
Reservado.
Reservado.
Reservado.
Reservado.
Reservado.
modifica o valor da varivel associada.
Lgico, opcional. Se .T. o controle no poder ser editado.
Lgico, opcional. Se .T. o controle exibir asteriscos * no
lugar dos caracteres exibidos pelo controle para simular
entrada de senha.
Reservado.
Reservado.
Reservado.
Reservado.
Reservado.
Aparncia:
Exemplo:
Local oDlg, oButton, oCombo, cCombo, nGet1:=0
DEFINE MSDIALOG oDlg FROM 0,0 TO 300,300 PIXEL TITLE 'Meu Get'
oGet1:= TGet():New(10,10,{|u| if(PCount()>0,nGet1:=u,nGet1)}, oDlg,;
100,20,'@E 999,999.99',;
{|o|nGet1>1000.00},,,,,,.T.,,,,,,,,,,'nGet1')
MsgStop( 'O valor '+Transform(nGet1,'@E 999,999.00') )
Return NIL
TGROUP()
Descrio: Classe de objetos visuais do tipo painel tGroup, a qual cria um

painel onde controles visuais podem ser agrupados ou classificados.
Neste painel criada uma borda com ttulo em volta dos controles
agrupados.
Propriedades:
-
Construtor: New([anTop], [anLeft], [anBottom], [anRight],

[aoWnd], [anClrText], [anClrPane], [alPixel], [lPar10])
Parmetros:
anTop
anLeft
anBottom
anRight
acCaption
aoWnd
anClrText
anClrPane
alPixel
lPar10
[acCaption],

ou caracteres.
ou caracteres.
Numrico, opcional. Coordenada horizontal direita em pixels
ou caracteres.
Caractere, opcional. Ttulo do grupo.
criado.
Numrico, opcional. Cor do texto.
Numrico, opcional. Cor do fundo.
Reservado.
Aparncia:
Exemplo:
Local oDlg, oButton, oCombo, cCombo, cGet1:='Teste'
DEFINE MSDIALOG oDlg FROM 0,0 TO 300,300 PIXEL TITLE 'Meu test'
oGroup:= tGroup():New(10,10,130,130,'grupo de gets',oDlg,,,.T.)
@ 18,16 MSGET oGet1 VAR cGet1 SIZE 100,10 OF oGroup PIXEL
@ 38,16 MSGET oGet2 VAR cGet1 SIZE 100,10 OF oGroup PIXEL
THBUTTON()
Descrio: Classe de objetos visuais do tipo boto com hiperlink.
Propriedades:
bAction
Bloco de cdigo. Executado quando o boto pressionado.
Construtor: New([anRow], [anCol], [acCaption],

[anWidth], [anHeight], [aoFont], [abWhen])
Parmetros:
Parmetro
anRow
anCol
acCaption
aoWnd
abAction
anWidth
anHeight
aoFont
abWhen
[aoWnd],
[abAction],
Tipo / Descrio
carateres.
caracteres.
criado.
Mtodos auxiliares:
Create
Sintaxe: Create(aoWnd)
Parmetros:
aoWnd

ser criada.
Retorno:
Objeto
Objeto do tipo THButton com os atributos definidos com

contedo padro.
Aparncia:
Exemplo:
#include hbutton.ch
User Function MyhBtn()
Local oDlg, ohBtn
DEFINE MSDIALOG oDlg FROM 0,0 TO 500,600 PIXEL TITLE Meu hButton
ohBtn:= tHButton():Create( oDlg )
ohBtn:nTop
:= 100
ohBtn:nLeft
:= 10
ohBtn:nWidth
:= 100
ohBtn:nHeight
:= 30
ohBtn:cCaption := 'hButton'
ohBtn:blClicked := { || MsgStop( 'Cliquei' ) }
// Usando o command
@ 200,100 HBUTTON ohBtn PROMPT 'Exemplo hButton' SIZE 100,30 ACTION
MsgStop('Cliquei') OF oDlg MESSAGE 'hButton'
Return Nil
TIBROWSER()
Descrio: Classe de objetos visuais do tipo Pgina de Internet, sendo

necessrio incluir a clausula BrowserEnabled=1 no Config do
Remote.INI
Propriedades:
-
Construtor: New([nRow], [nCol], [nWidth], [nHeight], [cPager], [oWnd])
Parmetros:
nRow
nCol
nWidth
nHeigth
cPage
oWnd

carateres.
caracteres
Numrico, opcional. Largura em pixels
Caracter. Enredeo URL da pgina de Internet
criado
Aparncia:
Exemplo:
Local oDlg
// Habilitar no Remote(Config) -> BrowserEnabled=1
oTIBrowser:=
TIBrowser():New(0,0,306,134,'http://www.microsiga.com.br',oDlg )
Return NIL
TLISTBOX()
Descrio: Classe de objetos visuais do tipo controle tListbox, a qual cria uma
janela com itens selecionveis e barra de rolagem. Ao selecionar um
item, uma varivel atualizada com o contedo do item selecionado.
Propriedades:
nAt
aItems
Numrico. Posio do item selecionado.

Array de items caracteres. Lista do itens selecionveis.
Construtor:
New([anRow], [anCol], [abSetGet], [aaItems], [anWidth],
[anHeigth],
[abChange],
[aoWnd],
[abValid],
[anClrFore],
[anClrBack], [alPixel], [lPar13], [abLDBLClick], [aoFont], [cPar16],
[lPar17], [abWhen], [aPar19], [bPar20], [lPar21], [lPar22],
[abRightClick] )
Parmetros:
anRow
anCol
abSetGet
aaItems
anWidth
anHeight
abChange
aoWnd
abValid
anClrFore
anClrBack
alPixel
lPar13
abLDBLClick
aoFont
cPar16
lPar17
abWhen

caracteres.
caracteres.
if( Pcount( )>0, <var>:= u, <var> )} que o controle utiliza
caracter ou numrica.
Array de items caracteres, opcional. Lista de items
selecionveis.
criado.
Reservado.
controle.
Reservado.
Reservado.
aPar19
bPar20
lPar21
lPar22
Reservado.
Reservado.
Reservado.
Reservado.
Bloco de cdigo, opcional. Executado quando acionado click
do boto direito do mouse sobre o controle.
abRightClick
Mtodos auxiliares:
Select
Descrio: Fora a seleo de um item.
Sintaxe: Select( [anItem] )
Parmetros:
nItem
Numrico, opcional. Posio do item a ser selecionado.
Retorno:
Nenhum
Add
Descrio: Adiciona novo item.
Sintaxe: Add( cText, nPos )
Parmetros:
cText
nPos
Caractere, obrigatrio. Texto do item.

Numrico, obrigatrio. Se 0 ou maior que o nmero de
itens, insere o item no final da lista. Se valor entre 1 e
nmero de itens, insere o item na posio informada,
empurrando o item anterior para baixo.
Retorno:
Nenhum
Modify
Descrio: Modifica o texto de um item.
Sintaxe: Modify( cText, nPos )
Parmetros:
cText
nPos
Caractere, obrigatrio. Novo texto do item.

Numrico, obrigatrio. Posio a ser modificada deve ser
maior que 0 e menor ou igual que o nmero de itens.
Retorno:
Nenhum
Del
Descrio: Remove um item.
Sintaxe: Del( nPos )
Parmetros:
nPos
Numrico, obrigatrio. Posio a ser excluida, deve ser

maior que 0 e menor ou igual que o nmero de itens.
Retorno:
Nenhum
Len
Descrio: Retorna o nmero de itens.
Sintaxe: Len( )
Parmetros:
Nenhum
Retorno:
Numrico
Nmero de itens.
Reset
Descrio: Apaga todos os itens.
Sintaxe: Reset( )
Parmetros:
Nenhum
Retorno:
Nenhum
Aparncia:
Exemplo:
Local oDlg, oList, nList:= 1
Local aItems:={}
Aadd(aItems,'Item 1')
DEFINE MSDIALOG oDlg FROM 0,0 TO 400,400 PIXEL TITLE 'Teste'
oList:= tListBox():New(10,10,{|u|if(Pcount()>0,nList:=u,nList)};
,aItems,100,100,,oDlg,,,,.T.)
Return NIL
TMENU()
Descrio: Classe de objetos visuais do tipo controle - Menu.
Propriedades:
-
Construtor: New ([nTop], [nLeft], [nHeight], [nWidth], [lPopUp], [cBmpName],

[oWnd],
[nClrNoSelect],
[nClrSelect],
[cArrowUpNoSel],
[cArrowUpSel], [cArrowDownNoSel], [cArrowDownSel])
Parmetros:
nTop
nLeft
nHeight
nWidth
lPopUp
cBmpName
oWnd
nClrNoSelect
nClrSelect
cArrowUpNoSel
cArrowUpSel
cArrowDownNoSel
cArrowDownSel
Numrico, opcional. Coordenada vertical em pixels.

Numrico, opcional. Coordenada horizontal em pixels.
Lgico. Define se o objeto ser um PoPup
Caracter opcional. Figura do Menu
Objeto, opcional. Janela ou controle onde a boto dever
ser criado
Numerico opcional. Cor quando no selecionado
Numerico opcional. Cor quando selecionado
Caracter opcional, Define a figura da seta para cima
quando no selecionado o item.
Caracter opcional, Define a figura da seta para cima
quando selecionado o item.
Caracter opcional, Define a figura da seta para baixo
quando no selecionado o item.
Caracter opcional, Define a figura da seta para baixo
quando selecionado o item.
Aparncia:
Exemplo:
Local oDlg
oMenu := TMenu():New( 0,0,0,0,.F.,'',oDlg,CLR_WHITE,CLR_BLACK)
// Adiciona Item ao Menu Principal
oMenuItem1 := TMenuItem():New2( oMenu:Owner(),'Item 001','Item
001',,,)
oMenu:Add( oMenuItem1 )
// Adiciona sub-Itens
oMenuItem2 := TMenuItem():New2( oMenu:Owner(),'Sub-Item
001',,,{||Alert('TMenuItem')})
oMenuItem3 := TMenuItem():New2( oMenu:Owner(),'Sub-Item
002',,,{||Alert('TMenuItem')})
oMenuItem1:Add( oMenuItem2 )
oMenuItem1:Add( oMenuItem3 )
Return NIL
TMENUBAR()
Descrio: Classe de objetos visuais do tipo controle - Barra de Menu.
Propriedades:
-
Construtor: New([oWnd])
Parmetros:
oWnd

criado.
Aparncia:
Exemplo:
Local oDlg
// Monta um Menu Suspenso
TMenuBar := TMenuBar():New(oDlg)
TMenuBar:nClrPane := RGB(183,208,248) // Cor de fundo do Menu
oTMenu1 := TMenu():New(0,0,0,0,.T.,,oDlg)
oTMenu2 := TMenu():New(0,0,0,0,.T.,,oDlg)
TMenuBar:AddItem('Arquivo' , oTMenu1, .T.)
TMenuBar:AddItem('Relatorio', oTMenu2, .T.)
// Cria Itens do Menu
oTMenuItem := TMenuItem():New(oDlg,'TMenuItem 01',,,,;
{||Alert('TMenuItem 01')},,'AVGLBPAR1',,,,,,,.T.)
oTMenu1:Add(oTMenuItem)
oTMenuItem := TMenuItem():New(oDlg,'TMenuItem 02',,,,;
{||Alert('TMenuItem 02')},,,,,,,,,.T.)
Return NIL
TMETER()
Descrio: Classe de objetos visuais do tipo controle tMeter, a qual exibe uma
rgua (gauge) de processamento, descrevendo o andamento de um
processo atravs da exibio de uma barra horizontal.
Propriedades:
nTotal
lPercentage
nClrBar
Numrico. Nmero total de passos at o preenchimento da

rgua de processo.
Lgico. Se .T. considera o passo de movimentao em
porcentagem.
Numrico. Cor da barra de andamento.
Construtor: New([anRow], [anCol], [abSetGet], [anTotal], [aoWnd], [anWidth],

[anHeight], [lPar8], [alPixel], [oPar10], [cPar11], [alNoPerc],
[anClrPane], [nPar14], [anClrBar], [nPar16], [lPar17])
Parmetros:
anRow
anCol
abSetGet
anTotal

caracteres.
caracteres.
numrico.
Numrico, opcional. Numero total de passos at o
preenchimento da rgua de processo.
Objeto, opcional. Janela ou controle onde o controle sera

criado.
Reservado.
Reservado.
Reservado.
Lgico, opcional. Se .T. (padro) no considera os passos de
atualizao em porcentagem.
Reservado.
Numrico, opcional. Cor da barra de andamento.
Reservado.
Reservado.
aoWnd
anWidth
anHeight
lPar8
alPixel
oPar10
cPar11
alNoPerc
anClrPane
nPar14
anClrBar
nPar16
lPar17
Mtodos auxiliares:
Set
Descrio: Atualiza a posio da rgua de processamento.
Sintaxe: Set( [nVal] )
Parmetros:
nVal
Numrico, opcional. Novo valor da posio da rgua de

processamento.
Retorno:
Nenhum
Aparncia:
Exemplo:
STATIC lRunning:=.F., lStop:=.F.
Local oDlg, oMeter, nMeter:=0, oBtn1, oBtn2
DEFINE MSDIALOG oDlg FROM 0,0 TO 400,400 TITLE 'Teste' Pixel
oMeter:= tMeter():New(10,10,{|u|if(Pcount()>0,nMeter:=u,nMeter)};
,100,oDlg,100,16,,.T.) // cria a rgua
// boto para ativar andamento da rgua
@ 30,10 BUTTON oBtn1 PROMPT 'Run ' OF oDlg PIXEL ACTION RunMeter(oMeter)
@ 50,10 BUTTON oBtn2 PROMPT 'Stop' OF oDlg PIXEL ACTION lStop:=.T.
Return NIL
STATIC Function RunMeter(oMeter)
If lRunning
Return
Endif
lRunning:= .T.
oMeter:Set(0)
// inicia a rgua
While .T. .and. !lStop
Sleep(1000) // pra 1 segundo
ProcessMessages() // atualiza a pintura da janela, processa mensagens do
windows
nCurrent:= Eval(oMeter:bSetGet) // pega valor corrente da rgua
nCurrent+=10 // atualiza rgua
oMeter:Set(nCurrent)
if nCurrent==oMeter:nTotal
Return
endif
Enddo
lRunning:= .F.
lStop:= .F.
Return
TMSGRAPHIC()
Descrio: Classe de objetos visuais do tipo controle - Grfico.
Propriedades:
l3D
lAxisVisib
Lgico, opcional Grfico em 3D

Lgico, opcional Mostra eixos do grfico
Construtor:
New([anRow],
[anCol],
[aoWnd],
[anClrBack], [anWidth], [anHeight])
Parmetros:
anRow
anCol
aoWnd
aoFont
anClrText
anClrBack
anWidth
anHeight
[aoFont],
[anClrText],

ser criada.
Objeto, opcional. Fonte utilizada no grfico.
Lgico, opcional. Exibe borda
ser criada.
Mtodos auxiliares:
CreateSerie
Descrio: Mtodo para criao de uma serie para o grfico.
Sintaxe:
CreateSerie(
[nSerieType],
[cLegend],
[nDecimals],
[lShowValues] )
Parmetros:
nSerieType
cLegend
nDecimals
lShowValues
Numrico. Indica o tipo do grfico

GRP_LINE
1
GRP_AREA
2
GRP_POINT
3
GRP_BAR
4
GRP_PIE
10
Caractere, opcional. Legenda da srie.
Numrico, opcional. Numero de casas decimais dos
valores.
Lgico, opcional. Mostra valores
Retorno:
Numrico
Numero da srie criada.
Add
Descrio: Mtodo para adicionar um item ao grfico.
Sintaxe: Add(nSerie, nVal, cLegend, nColor )
Parmetros:
nSerie
nVal
cLegend
nColor
Numrico. Serie a ser inserido o item.

Numrico. Valor do item.
Caractere. Legenda do item.
Numrico, Cor do item.
Retorno:
Nenhum
SetGradiente
Descrio: Mtodo para setar o fundo do grfico com uma cor gradiente
em determinada direo.
Sintaxe: SetGradient(nDirection, StartColor, EndColor )
Parmetros:
nDirection
StartColor
EndColor
Numrico. Indica direo do gradiente.

GDTOPBOTTOM 1
GDBOTTOMTOP 2
GDLEFTRIGHT 3
GDRIGHTLEFT 4
Numrico. Cor inicial.
Numrico. Cor final.
Retorno:
Nenhum
SetTitle
Descrio: Define o titulo do grfico.
Sintaxe: SetTitle(cTitle, cTitle2, Color, Aligment, lFoot)
Parmetros:
cTitle
cTitle2
Color
Aligment
lFoot
Caractere. Primeiro titulo.

Caractere. Segundo titulo.
Numrico. Cor do titulo.
Numrico. Alinhamento do titulo.
A_LEFTJUST 1
A_RIGHTJUS 2
A_CENTER 3
Lgico. Indica titulo no rodap do grfico.
Retorno:
Nenhum
SetLegenProp
Descrio: Mtodo para setar propriedades da legenda.
Sintaxe: SetLegenProp(Align, Color, Style, Visible )
Parmetros:
Align
Color
Style
Visible
Numerico. Alinhamento da legenda.

GRP_SCRTOP 1
GRP_SCRLEFT 2
GRP_SCRBOTTOM 3
GRP_SCRRIGHT 4
Numrico. Cor da legenda.
Numrico. Estilo da legenda.
GRP_AUTO 1
GRP_SERIES 2
GRP_VALUES 3
GRPLASTVAL 4
Lgico. Indica de o titulo ser visvel.
Retorno:
Nenhum
SetMargins
Descrio: Mtodo para setar as margens superior, inferior e laterais do
grfico.
Sintaxe: SetMargins(nTop, nLeft, nBottom, nRight )
Parmetros:
nTop
nLeft
nBottom
nRight
Numrico.
Numrico.
Numrico.
Numrico.
Posio
Posio
Posio
Posio
em
em
em
em
relao
relao
relao
relao
ao topo do grfico.
a esquerda.
ao rodap.
a direita.
Retorno:
Nenhum
SetRangeY
Descrio: Define a escala dos valores do eixo Y
Sintaxe: SetRangeY (min, max, delta).
Parmetros:
Min
Max
delta
valor inicial
valor final
intervalo entre os valores [ opcional, calculado
automaticamente ]
Retorno:
Nenhum
SaveToBMP
Descrio: Mtodo para salvar o grfico atual em um bitmap no
server(Obsoleto, ver SaveToImage).
Sintaxe: SaveToBMP(BmpName, PathToWrite )
Parmetros:
BmpName
PathToWrite
Caractere, Nome do da figura a ser salva.

Caractere. Path no Server onde ser salva a figura.
Retorno:
Lgico
Indica se a imagem foi salva corretamente.
SaveToImage
Descrio: Mtodo para salvar o grfico atual em um formato de prdeterminado no server.
Sintaxe: SaveToImage(BmpName, PathToWrite, TypeImage)
Parmetros:
BmpName
PathToWrite
Caractere, Nome do da figura a ser salva.

Caractere. Path no Server onde ser salva a figura.
Caractere. Tipo da Figura (Default 'JPEG')
Tipos suportados: JPEG, PNG, BMP
TypeImage
Retorno:
Lgico
Indica se a imagem foi salva corretamente.
DelSerie
Descrio: Mtodo para deletar uma srie do grafico.
Sintaxe: DelSerie ( nSerie )
Parmetros:
nSerie
Numrico. Serie a ser deletada.
Retorno:
Lgico
Indica se a sria foi removida do grfico
ZoomIn
Descrio: Mtodo para efetuar zoom interno ( + ).
Sintaxe: ZoomIn()
Parmetros:
Nenhum
Retorno:
Nenhum
ZoomOut
Descrio: Mtodo para efetuar zoom externo ( - ).
Sintaxe: ZoomOut()
Parmetros:
Nenhum
Retorno:
Nenhum
Aparncia:
Exemplo:
#include 'MSGRAPHI.CH'
User Function tMsGraphicTst()
@ 001, 001 MSGRAPHIC oGraphic SIZE 120,120 OF oDlg
oGraphic:SetTitle('Titulo do Grafico', DTOC(Date()), CLR_BLACK,
A_LEFTJUST, GRP_TITLE )
oGraphic:SetMargins(2,6,6,6)
oGraphic:SetGradient(GDBOTTOMTOP, CLR_HGRAY, CLR_WHITE)
oGraphic:SetLegenProp(GRP_SCRRIGHT, CLR_HGRAY, GRP_AUTO,.T.)
nSerie
:=
oGraphic:CreateSerie( 10 )
oGraphic:l3D := .T. // Grafico em 3D
oGraphic:lAxisVisib
:= .T.
// Mostra os eixos
// Itens do Grafico
oGraphic:Add(nSerie,
200,
180,
210,
110,
100,
080,
110,
'Item01',
'Item02',
'Item03',
'Item04',
'Item05',
'Item06',
'Item07',
CLR_BLUE
CLR_RED
CLR_BLUE
CLR_BLUE
CLR_BLUE
CLR_BLUE
CLR_BLUE
@ 001, 124 BUTTON 'Salva Grafico' SIZE

oGraphic:SaveToBMP('Exemplo.bmp','\web\')
@ 020, 124 BUTTON 'Zoom IN'
SIZE
oGraphic:ZoomIn()
@ 040, 124 BUTTON 'Zoom OUT'
SIZE
oGraphic:ZoomOut()
@ 060, 124 BUTTON 'Deleta Serie' SIZE
oGraphic:DelSerie(nSerie)
Return
)
)
)
)
)
)
)
40,14 OF oDlg PIXEL ACTION

TMSGBAR()
Descrio: Classe de objetos visuais do tipo controle - Rodap.
Propriedades:
-
Construtor: New ([oWnd], [cPrompt,], [lCentered], [lClock], [lDate], [lKbd],

[nClrFore], [nClrBack], [oFont], [lInset], [imageName])
Parmetros:
criado
Caracter. Descrio na Barra
Logico. Define centralizao do texto
Nao utilizado
Nao utilizado
Nao utilizado
Numerico, opcional. Define cor da fonte da barra
Numerico, opcional. Define cor do fundo da barra
Nao utilizado
Caracter, opcional. Insere figura lateral esquerda
oWnd
cPrompt
lCentered
lClock
lDate
lKbd
nClrFore
nClrBack
oFont
lInset
imageName
Mtodos auxiliares:
AddItem
Descrio: Mtodo insere um subitem no rodap
Sintaxe: AddItem( oTMsgItem )
Parmetros:
Objeto do tipo TMsgItem que ser inserido como subitem
do rodap.
oTMsgItem
Retorno:
Nenhum
SetMsg
Descrio: Define a descrio da barra de rodap
Sintaxe: SetMsg(cTexto )
Parmetros:
cTexto
Texto a ser inserido na barra
Retorno:
Nenhum
Aparncia:
Exemplo:
Local oDlg
oTMsgBar := TMsgBar():New(oDlg, 'MP10 | Totvs/Software',
.F.,.F.,.F.,.F., RGB(116,116,116),,,.F.)
oTMsgItem1 := TMsgItem():New( oTMsgBar,'oTMsgItem1', 204,,,, .T.,
{||})
{||Alert('Item da Barra Acionado')} )
Return NIL
TMSGITEM()
Descrio: Classe de objetos visuais do tipo controle utilizado para adicionar

mensagens em outros objetos, como barras e menus.
Propriedades:
-
Construtor: New( <oMsgBar>, <cMsg>, <nSize>, <oFont>, <nClrFore>,

<nClrBack>, lEnable , [<{bAction}>], cImagem )
Parmetros:
oMsgBar
cMsg
nSize
oFont
nClrFore
nClrBack
lEnable
bAction
cImagem
Objeto do tipo barra ou menu no qual ser adicionado o item

de mensagem.
Mensagem que ser exibida pelo objeto
Tamanho da fonte do texto
Fonte do texto
Cor da fonte do texto
Cor do fundo do objeto
Indica se o objeto est habilitado.
Bloco de cdigo executado quando o objeto ativado
Imagem a ser vinculada no objeto.
Aparncia:
Exemplo:
Local oDlg
oTMsgBar := TMsgBar():New(oDlg, 'MP10 | Totvs/Software',
.F.,.F.,.F.,.F., RGB(116,116,116),,,.F.)
{||})
{||Alert('Item da Barra Acionado')} )
Return NIL
.
TMULTIBTN()
Descrio: Classe de objetos visuais do tipo controle - Mltiplos botes.
Propriedades:
bAction

do mouse.
Construtor: New([nRow], [nCol], [cTitle], [oWnd], [bAction],

[nHeight], [imgName], [ori], [cMsg], [btnPerLine])
Parmetros:
nRow
nCol
oWnd
bAction
nWidth
nHeigth
imgName
ori
cMsg
btnPerLine
[nWidth],

carateres.
caracteres
criado
Caracter. Imagem a ser inserida ao lado esquerdo do
componente
Numerico, opcional. Orientao dos botes.
Numerico, opcional. Quantidade de botes por linha
Mtodos auxiliares:
LoadImage
Descrio: Muda a figura a esquerda do componente
Sintaxe: LoadImage(cImagem)
Parmetros:
cImagem
Nome da imagem que ser carregada pelo objeto
Retorno:
Nenhum
AddButton
Descrio: Insere um boto
Sintaxe: AddButton(cTexto)
Parmetros:
cTexto
Texto para exibio no boto inserido.
Retorno:
Nenhum
SetTitle
Descrio: Muda o titulo e o numero de botes por linha
Sintaxe: SetTitle(cTexto, nBotoes)
Parmetros:
cTexto
nBotoes
Texto que ser atribudo aos botes

Nmero de botes por linha
Retorno:
Nenhum
SetFonts
Descrio: Muda a font do titulo e dos botes
Sintaxe: SetTitle(cFontTit, nSizeTit, nFontBut, nSizeBut)
Parmetros:
cFontTit
nSizeTit
nFontBut
nSizeBut
Nome da fonte que ser atribuda ao ttulo

Tamanho da fonte do ttulo
Nome da fonte que ser atribuda aos botes
Tamanho da fonte dos botes
Retorno:
Nenhum
Aparncia:
Exemplo:
Local oDlg
otMultiBtn := tMultiBtn():New( 01,01,'cTitle1',oDlg,;
{|x|Alert(Str(x)) },200,150,'afastamento',0,'cTitle',3
)
otMultiBtn:SetFonts('Tahoma',16,'Tahoma',10)
otMultiBtn:AddButton('btn01')
Return NIL
.
TMULTIGET()
Descrio: Classe de objetos visuais do tipo controle - edio de texto de

mltiplas linhas.
Propriedades:
lWordWrap
Lgico. Se .T., faz quebra automtica de linhas.
Construtor: New([anRow], [anCol], [abSetGet], [aoWnd], [anWidth],

[anHeight], [aoFont], [alHScroll], [anClrFore], [anClrBack], [oPar11],
[alPixel],
[cPar13],
[lPar14],
[abWhen],
[lPar16],
[lPar17],
[alReadOnly],
[abValid],
[bPar20],
[lPar21],
[alNoBorder],
[alNoVScroll])
Parmetros:
Parmetro
anRow
anCol
abSetGet
aoWnd
anWidth
anHeight
aoFont
alHScroll
anClrFore
anClrBack
oPar11
alPixel
cPar13
lPar14
abWhen
lPar16
lPar17
alReadOnly
abValid
bPar20
lPar21

caracteres.
caracteres.
caracter.
criado.
controle.
horizontal.
Reservado.
Reservado.
Reservado.
Reservado.
Reservado.
Lgico, opcional. Se .T. o controle so permitira leitura.
Reservado.
Reservado.
alNoBorder
alNoVScroll
Lgico, opcional. Se .T. cria controle sem borda.

Mtodos auxiliares:
EnableVScroll
Descrio: Habilita a barra de rolagem vertical.
Sintaxe: EnableVScroll( lEnable )
Parmetros:
Lgico, obrigatrio. Se .T. habilita se .F. desabilita a barra
de rolagem.
lEnable
Retorno:
Nenhum
EnableHScroll
Descrio: Habilita a barra de rolagem horizontal.
Sintaxe: EnableHScroll( lEnable )
Parmetros:
Lgico, obrigatrio. Se .T. habilita se .F. desabilita a barra
de rolagem.
lEnable
Retorno:
Nenhum
Aparncia:
Exemplo:
Local oDlg, oMemo, cMemo:= space(50)
DEFINE MSDIALOG oDlg FROM 0,0 TO 400,400 PIXEL TITLE My test
oMemo:= tMultiget():New(10,10,{|u|if(Pcount()>0,cMemo:=u,cMemo)};
,oDlg,100,100,,,,,,.T.)
@ 200,10 BUTTON oBtn PROMPT Fecha OF oDlg PIXEL ACTION oDlg:End()
MsgStop(cMemo)
Return NIL
TOLECONTAINER()
Descrio: Classe de objetos visuais do tipo controle, a qual permite a criao

de um boto vinculado a um objeto OLE.
Propriedades:
-
Construtor: New([nRow], [nCol], [nWidth], [nHeight], [oWnd], [lAutoActivate],

[cFileName])
Parmetros:
nRow
nCol
nWidth
nHeight
oWnd
lAutoActivate
cFileName
Numrico, opcional.
carateres.
Numrico, opcional.
caracteres.
Numrico, opcional.
Numrico, opcional.

Largura do boto em pixels
Altura do boto em pixels.

criado.
Nao utilizado
Caracter. Endereo do arquivo Ole a ser aberto
Mtodos auxiliares:
OpenFromFile
Descrio: Abre arquivo do tipo OLE.
Sintaxe: New([cFileName, [lAsIcon], [allowInPlace])
Parmetros:
cFileName
lAsIcon
allowInPlace
Caracter. Endereo do arquivo Ole a ser aberto

Logico. Define objeto Ole como Icone
Logico opcional. Permite abertura de arquivo local
Retorno:
Nenhum
Aparncia:
Exemplo:
Local oDlg
// TOleContainer
oTOleContainer := TOleContainer():New(
05,05,306,134,oDlg,.T.,'C:\Lixo\TesteRemote.doc' )
Return NIL
TPAGEVIEW()
Descrio: Classe de objetos visuais do tipo controle, que permite a

visualizao de arquivos no formato gerado pelo spool de impresso
do Protheus.
Propriedades:
-
Construtor: New([nCol], [nRow], [nWidth], [nHeight], [oPrinter], [oWnd],

[nPageWidth], [nPageHeight])
Parmetros:
Numrico, opcional.
carateres.
Numrico, opcional.
caracteres
Numrico, opcional.
Numrico, opcional.
nCol
nRow
nWidth
nHeigth
oPrinter

Largura em pixels
Altura em pixels.
Objeto do tipo TMsPrinter()

criado
Numrico, opcional. Largura em pixels da pagina
Numrico, opcional. Altura em pixels da pagina
oWnd
nPageWidth
nPageHeight
Mtodos auxiliares:
PageSize
Descrio: Define o tamanho da pagina.
Sintaxe: AddItem(nLargura, nAltura)
Parmetros:
nLargura
nAltura
Lagura da pgina
Altura da pgina
Retorno:
Nenhum
PrintPage
Descrio: Imprime uma determinada pgina.
Sintaxe: PrintPage(nNrPagina)
Parmetros:
nNrPagina
Pgina que ser impressa
Retorno:
Nenhum
Aparncia:
Exemplo:
Local oDlg
// TPageView
__RelDir := WSPLRelDir()
oPrinter := TMsPrinter():New()
oPrinter:SetFile(__RELDIR + 'matr020.prt',.F.)
oTPageView := TPageView():New(
0,0,500,300,oPrinter,oTFolder2:aDialogs[07],550,350 )
oTPageView:Reset(400,400)
oTPageView:PrintPage(1)
oTPageView:Show()
oTPageView:nZoom := 150
Return NIL
TPANEL()
Descrio: Classe de objetos visuais do tipo controle tPanel, a qual permite

criar um painel esttico, onde podem ser criados outros controles
com o objetivo de organizar ou agrupar componentes visuais.
Propriedades:
-
Construtor: New([anRow], [anCol], [acText], [aoWnd], [aoFont], [alCentered],

[lPar6], [anClrText], [anClrBack], [anWidth], [anHeight], [alLowered],
[alRaised])
Parmetros:
anRow
anCol
acText
aoWnd
alCentered
lPar6
anClrText
anClrBack
anWidth
anHeight
alLowered
alRaised

Caractere, opcional. Texto a ser exibido ao fundo.
Objeto, opcional. Janela ou controle onde ser criado o
objeto.
Lgico, opcional. Se .T. exibe o texto de ttulo ao centro do
controle.
Reservado.
Lgico, opcional. Se .T. exibe o painel rebaixado em relao
ao controle de fundo.
Lgico, opcional. Se .T. exibe a borda do controle rebaixada
em relao ao controle de fundo.
Aparncia:
Exemplo:
oPanel:= tPanel():New(10,10,,oDlg,,,,,CLR_BLUE,100,100) // cria o
painel
@ 10,10 BUTTON oBtn1 PROMPT 'hide' OF oPanel ACTION oPanel:Hide() // cria
boto sobre o painel
@ 200,10 BUTTON oBtn2 PROMPT 'show' OF oDlg ACTION oPanel:Show() // cria
boto fora o painel
Return
TRADMENU()
Descrio: Classe de objetos visuais do tipo controle TRadMenu, a qual

permite criar um controle visual no formato Radio Button.
Propriedades:
bChange
bSetGet
bWhen
bValid
Bloco de cdigo disparado na mudana de item selecionado

Bloco de cdigo disparado na mudana de item selecionado,
responsavel pela mudana de valor da variavel numerica
que indica o item selecionado.
Bloco de cdigo que permite ou no a alterao do objeto
Bloco de cdigo executado na saida do objeto.
Construtor: New([nRow], [nCol], [aItems], [bSetGet], [oDlg], [aHelpIds],

[bChange], [nClrText], [nClrPane], [cMsg], [lUpdate], [bWhen],
[nWidth], [nHeight], [bValid], [lDesign], [l3d], [lPixel])
Parmetros:
nRow
nCol
aItems
bSetGet
oDlg
aHelpIds
bChange
nClrText
nClrPane
cMsg
lUpdate
bWhen

Vetor, elementos do Radio
Code-block, Responsvel pela setagem de valor
ser criado.
No utilizado
objeto
No utilizado
nWidth
nHeight

No utilizado
No utilizado
bValid
lDesign
l3d
lPixel
Mtodos auxiliares:
SetOption
Descrio: Seleciona um item.
Sintaxe: SetOption(nItem)
Parmetros:
nItem
Item que ser selecionado
Retorno:
Nenhum
EnableItem
Descrio: Habilita/Desabilita um Item
Sintaxe: EnableItem(nItem, lStatus)
Parmetros:
nItem
lStatus
Item que ser modificado

Status que ser atribudo ( .T. Enable , .F. Disable)
Retorno:
Nenhum
Enable
Descrio: Habilita um item.
Sintaxe: Enable(nItem)
Parmetros:
nItem
Item que ser habilitado
Retorno:
Nenhum
Disable
Descrio: Desabilita um item
Sintaxe: Disable(nItem)
Parmetros:
nItem
Item que ser desabilitado
Retorno:
Nenhum
Aparncia:
Exemplo:
user function TRadMenu()
DEFINE MSDIALOG oDlg FROM 0,0 TO 270,400 PIXEL TITLE 'Exemplo da
TCBrowse'
// Variavel numerica que guarda o item selecionado do Radio
nRadio := 1
// Cria o Objeto
oRadio := TRadMenu():New
(01,01,{'Item01','Item02','Item03','Item04','Item05'},;
,oDlg,,,,,,,,200,200,,,,.T.)
// Seta Eventos
oRadio:bchange
:= {|| Alert('bChange') }
oRadio:bSetGet
:= {|u|Iif (PCount()==0,nRadio,nRadio:=u)}
oRadio:bWhen
:= {|| .T. }
oRadio:bValid
:= {|| Alert('bValid') }
// Principais comandos
oBtn := TButton():New( 060, 001, 'Retorna item selecionado',;
oDlg,{|| Alert(nRadio)
}, 120,
010,,,.F.,.T.,.F.,,.F.,,,.F. )
oBtn := TButton():New( 070, 001, 'SetOption(2) (Seta um
item)',;
oDlg,{|| oRadio:SetOption(2)
}, 120,
010,,,.F.,.T.,.F.,,.F.,,,.F. )
oBtn := TButton():New( 080, 001, 'EnableItem(2,.T.) (Habilita
item)',;
oDlg,{|| oRadio:EnableItem(2,.T.) }, 120,
010,,,.F.,.T.,.F.,,.F.,,,.F. )
oBtn := TButton():New( 090, 001, 'EnableItem(2,.F.)
(Desabilita item)',;
oDlg,{|| oRadio:EnableItem(2,.F.) }, 120,
010,,,.F.,.T.,.F.,,.F.,,,.F. )
oBtn := TButton():New( 100, 001, 'Enable(3) (Habilita
item)',;
oDlg,{|| oRadio:Enable(3)
}, 120,
010,,,.F.,.T.,.F.,,.F.,,,.F. )
oBtn := TButton():New( 110, 001, 'Disable(3) (Desabilita
item)',;
oDlg,{|| oRadio:Disable(3)
}, 120,
010,,,.F.,.T.,.F.,,.F.,,,.F. )
Return
TSBROWSE()
Descrio: Classe de objetos visuais do tipo controle TSBrowse, a qual

permite criar um controle visual do tipo Grid.
Propriedades:
+
nAt
nLen

Construtor: New([nRow], [nCol], [nWidth], [nHeight], [oWnd], [bChange],

[nHWidth], [oFont], [nLines])
Parmetros:
nRow
nCol
nWidth
nHeight

ser criado.
Bloco de cdigo, na mudana de linha
No utilizado
Nmerico. Nr de linhas por clula
oWnd
bChange
nHWidth
oFont
nLines
Mtodos auxiliares:
GoUp
Sintaxe: GoUp( )
Parmetros:
Nenhum
Retorno:
Nil
GoDown
Sintaxe: GoDown( )
Parmetros:
Nenhum
Retorno:
Nil
GoTop
Sintaxe: GoTop( )
Parmetros:
Nenhum
Retorno:
Nil
GoBottom
Parmetros:
Nenhum
Retorno:
Nil
RowCount
Parmetros:
Nenhum
Retorno:
Nil
LEditCell
Descrio: Edita o valor de uma coluna.
Sintaxe: lEditCell( aList, oList, cPicture, nCol )
Parmetros:
aList
oList
cPicture
nCol
Vetor da Browse onde esto os valores da mesma

Objeto, Browse a ser editado
Caracter, picture necessria para edio do campo
Numrico, coluna a ser editada.
Retorno:
Nil
Aparncia:
Exemplo:
Local oDlg
aBrowse
001'},;
:= {{'CLIENTE 001','RUA CLIENTE 001','BAIRRO CLIENTE

{'CLIENTE 001','RUA CLIENTE 001','BAIRRO CLIENTE
001'},;
{'CLIENTE 001','RUA CLIENTE 001','BAIRRO CLIENTE 001'}
}
oBrowse := TSBrowse():New(01,01,245,150,oDlg,,16,,5)
nForeCor := CLR_GRAY
nBackCor := CLR_WHITE
oBrowse:AddColumn( TcColumn():New('Nome',,,{|| nForeCor },{||
nBackCor }) )
oBrowse:AddColumn( TcColumn():New('Endereo',,,{|| nForeCor },{||
nBackCor }) )
oBrowse:AddColumn( TcColumn():New('Bairro',,,{|| nForeCor },{||
nBackCor }) )
oBrowse:SetArray(aBrowse)
},40,10,,,,.T.)
},40,10,,,,.T.)
},40,10,,,,.T.)
},40,10,,,,.T.)
TButton():New( 190, 060, 'lEditCell (Edita a celula)', oDlg,;
{|| lEditCell(@aBrowse,oBrowse,'@!',3)
},40,10,,,,.T.)

Return NIL
.
TSAY()
Descrio: Classe de objetos visuais do tipo controle tSay, a qual exibe o

contedo de texto esttico sobre uma janela ou controle
previamente definidos.
Propriedades:
lWordWrap
lTransparent
Lgico. Se .T. quebra o texto em vrias linhas de maneira a

enquadrar o contedo na rea determinada para o controle,
sendo o padro .F.
Lgico. Se .T. a cor de fundo do controle ignorada
assumindo o contedo ou cor do controle ou janela ao
fundo, sendo o padro .T.
Construtor: New([anRow], [anCol], [abText], [aoWnd], [acPicture], [aoFont],

[lPar7], [lPar8], [lPar9], [alPixels], [anClrText], [anClrBack],
[anWidth], [anHeight], [lPar15], [lPar16], [lPar17], [lPar18], [lPar19])
Parmetros:
anRow
anCol
abText
aoWnd
acPicture
aoFont
lPar7
lPar8
lPar9
alPixels
anClrText
anClrBack
anWidth
anHeight
lPar15
lPar16
lPar17
lPar18
lPar19

caracteres.
caracteres.
Codeblock, opcional. Quando executado deve retornar uma
cadeia de caracteres a ser exibida.
Objeto, opcional. Janela ou dilogo onde o controle ser
criado.
Caractere, opcional. Picture de formatao do contedo a
ser exibido.
Objeto, opcional. Objeto tipo tFont para configurao do tipo
de fonte que ser utilizado para exibir o contedo.
Reservado.
Reservado.
Reservado.
Lgico, opcional. Se .T. considera coordenadas passadas em
pixels se .F., padro, considera as coordenadas passadas em
caracteres.
Numrico, opcional. Cor do contedo do controle.
Reservado.
Reservado.
Reservado.
Reservado.
Reservado.
Aparncia:
Exemplo:
oSay:= tSay():New(01,01,{||'para exibir'},oDlg,,,,;
,,.T.,CLR_RED,CLR_WHITE,100,20)
Return
TSCROLLBOX()
Descrio: Classe de objetos visuais do tipo controle tScrollbox, a qual

permite criar um painel com scroll deslizantes nas laterais
(horizontais e verticais) do controle.
Propriedades:
-
Construtor: New([aoWnd], [anTop], [anLeft],

[alVertical], [alHorizontal], [alBorder])
Parmetros:
aoWnd
anTop
anLeft
anHeight
anWidth
alVertical
alHorizontal
alBorder
[anHeight],
[anWidth],

criado.
Lgico, opcional. Se .T. exibe a barra de scroll vertical.
Lgico, opcional. Se .T. exibe a barra de scroll horizontal.
Lgico, opcional. Se .T. exibe a borda do controle.
Aparncia:
Exemplo:
Local oDlg, oScr, oGet1, oGet2, oGet3
Local cGet1, cGet2, cGet3
cGet1:= Space(10)
cGet2:= Space(10)
cGet3:= Space(10)
oScr:= TScrollBox():New(oDlg,10,10,100,100,.T.,.T.,.T.) // cria controles
dentro do scrollbox
@ 10,10 MSGET oGet1 VAR cGet1 SIZE 100,10 OF oScr PIXEL
Return
TSIMPLEEDITOR()
Descrio: Classe de objetos visuais do tipo controle tSimpleEditor, a qual

permite criar um controle visual para edio de textos com recursos
simples, como o NotePad
Propriedades:
-
Construtor: New([anRow], [anCol], [aoWnd], [anWidth], [anHeight],[ acText],

[alReadOnly])
Parmetros:
anRow
anCol
aoWnd
anWidth
anHeight
acText
alReadOnly

carateres.
caracteres.
Janela ou controle onde o editor dever ser criado.
Numrico, opcional. Largura do editor em pixels.
Numrico, opcional. Altura do editor em pixels.
Texto, opcional. Inserido na inicializao do objeto.
Lgico, opcional. Permite ou no a edio do texto
Mtodos auxiliares:
Create
Sintaxe: Create( aoWnd )
Parmetros:
aoWnd
Objeto, opcional. Janela ou controle onde o editor dever

ser criado.
Retorno:
Objeto
Objeto do tipo TsimpleEditor.
Load
Descrio: Carrega um texto para o editor.
Sintaxe: Load( acTexto )
Parmetros:
acTexto
Texto. Texto que inicializar o editor.
Retorno:
Nenhum
TextBold
Descrio: Texto em Negrito.
Sintaxe: TextBold( alBold )
Parmetros:
alBold
Lgico. Habilita ou Desabilita a sesso do texto como

Negrito.
Retorno:
Nenhum
TextUnderline
Descrio: Texto Sublinhado.
Sintaxe: TextUnderline( alUnderline )
Parmetros:
alUnderline
Lgico. Habilita ou Desabilita a sesso do texto

Sublinhado.
Retorno:
Nenhum
TextItalic
Descrio: Texto Itlico.
Sintaxe: TextItalic( alItalic )
Parmetros:
alItalic
Lgico. Habilita ou Desabilita a sesso do texto Itlico.
Retorno:
Nenhum
TextFamily
Descrio: Famlia de fontes.
Sintaxe: TextFamily( acFamily )
Parmetros:
acFamily
Texto. Nome da famlia da fonte a ser usada na sesso do

texto.
Retorno:
Nenhum
TextSize
Descrio: Tamanho da fonte.
Sintaxe: TextSize( anSize )
Parmetros:
anSize
Numrico. Tamanho da fonte utilizada na sesso do texto.
Retorno:
Nenhum
TextStyle
Descrio: Estilo do pargrafo.
Sintaxe: TextStyle( anStyle )
Parmetros:
Numrico. Estilo do pargrafo a ser utilizada na sesso do
texto.
anStyle
1
2
3
4
5
6
7
Normal
Disco (Bullet)
Circulo (Bullet)
Quadrado (Bullet)
Ordem decimal
Ordem alfanumrica minsculo
Ordem alfanumrica maisculo
Retorno:
Nenhum
TextAlign
Descrio: Alinhamento do texto.
Sintaxe: TextAlign( anAlign )
Parmetros:
anAlign
Numrico. Tipo do alinhamento do pargrafo.

1 Esquerda
2 Direita
3 Centralizado
4 Justificado
Retorno:
Nenhum
TextFormat
Descrio: Formato do texto.
Sintaxe: TextFormat( anFormat )
Parmetros:
anFormat
Numrico. Formato do texto

1 Html
2 Plain Text
Retorno:
Nenhum
RetText
Descrio: Retorna o texto em formato string.
Sintaxe: RetText( void )
Parmetros:
void
Retorna uma string com o contedo do editor
Retorno:
Nenhum
RetTextSel
Descrio: Retorna o texto selecionado em formato string..
Sintaxe: RetText()
Parmetros:
Nenhum
Retorno:
String
Texto selecionado.
TextStatus
Descrio: Retorna um array com as propriedades do texto posicionado.
Sintaxe: TextStatus()
Parmetros:
Nenhum
Retorno:
Retorna um array com as seguintes propriedades
Array
1
2
3
4
5
6
Lgico Negrito
Lgico Itlico
Lgico Sublinhado
Caracter RGB da cor
Caracter Tamanho da fonte
Caracter Fonte
Aparncia:
Exemplo:
User Function MyEditor()

Local oDlg, oEditor
DEFINE MSDIALOG oDlg FROM 0,0 TO 500,600 PIXEL TITLE Meu Editor
oEdit := tSimpleEditor():Create( oDlg )
oEdit:nTop
:= 10
oEdit:nLeft
:= 10
oEdit:nWidth
:= 600
oEdit:nHeight
:= 500
// Usando o mtodo new

oEdit := tSimpEdit():New( 0, 0, oDlg, 500, 600 )

Return Nil
TSLIDER()
Descrio: Classe de objetos visuais do tipo controle tSlider, a qual permite

criar um controle visual do tipo boto deslizante.
Propriedades:
bChange
Bloco de cdigo. Executado toda vez que o valor alterado

retornando o novo valor.
Construtor: New([anRow], [anCol], [aoWnd],

[anHeight], [acMsg], [abWhen])
Parmetros:
anRow
anCol
aoWnd
abChange
anWidth
anHeight
acMsg
abWhen
[abChange],
[anWidth],
Numrico, opcional. Coordenada vertical em pixels

Numrico, opcional. Coordenada horizontal em pixels
criado.
quando o boto for movimentado.
Caracter, opcional. Mensagem de hint do boto
Mtodos auxiliares:
Create
Descrio: Mtodo construtor da classe.
Parmetros:
aoWnd
Objeto, opcional. Janela ou controle onde o boto dever

ser criado.
Retorno:
Objeto
Objeto do tipo TSlide criado.
setRange
Descrio: Especifica a faixa de valores.
Sintaxe: setRange( min, max )
Parmetros:
Min
Max
Nmrico. Valor mnimo do boto.

Nmrico. Valor mximo do boto.
Retorno:
Nenhum
setMarks
Descrio: Especifica o tipo de marcao do boto.
Sintaxe: setMarks( nTipo )
Parmetros:
nTipo
Max
Nmrico. Tipo de marcao do boto.

1Nmrico. Valor mximo do boto.
0 Sem marcao
1 Acima (esquerda se vertical)
2 Abaixo (direita se vertical)
3 Ambos os lados
Retorno:
Nenhum
setInterval
Descrio: Especifica a distncia entre um marcador e outro.
Sintaxe: setInterval( nInterval )
Parmetros:
nInterval
Nmrico. Valor entre os marcadores
Retorno:
Nenhum
setValue
Descrio: Especifica um valor para o boto.
Sintaxe: setValue( nVal )
Parmetros:
nVal
Nmrico. Valor do boto
Retorno:
Nenhum
setStep
Descrio: Especifica o valor dos passos do boto.
Sintaxe: setStep( nStep )
Parmetros:
nStep
Nmrico. Valor do passo do boto
Retorno:
Nenhum
setOrient
Descrio: Especifica a orientao do boto, horizontal ou vertical.
Sintaxe: setOrient( nOrient )
Parmetros:
nOrient
Nmrico. Orientao do boto

0 Horizontal
1 Vertical
Retorno:
Nenhum
Aparncia:
Exemplo:
#include hbutton.ch
User Function MytSlider()
Local oDlg, oSlider
DEFINE MSDIALOG oDlg FROM 0,0 TO 500,600 PIXEL TITLE Meu tSlider
oSlider:= tSlider():Create( oDlg )
oSlider:nTop
:= 100
oSlider:nLeft
:= 10
oSlider:nWidth
:= 100
oSlider:nHeight
:= 30
// Usando o command
@ 100, 10 SLIDER oSlider SIZE 30, 100 OF oDlg MESSAGE 'tSlider'
Return Nil
TSPLITTER()
Descrio: Classe de objetos visuais do tipo controle tSplitter, a qual permite

criar um controle visual do tipo divisor.
Propriedades:
-
Herdadas as classes superiores.
Construtor: New( [anRow],

[anOrientation] )
Parmetros:
anRow
anCol
aoWnd
anWidth
anHeight
anOrientation
[anCol],
[aoWnd],
[anWidth],
[anHeight],

ser criado.
Numrico, opcional. Sentido no qual devero ser criado os
divisores.
0 Horizontal
1 Vertical
Mtodos auxiliares:
Create
Descrio: Mtodo construtor da classe.
Parmetros:
aoWnd

ser criado.
Retorno:
Objeto
Objeto do tipo Tsplitter gerado.
setOrient
Descrio: Especifica a orientao do divisor, horizontal ou vertical.
Sintaxe: setOrient( nOrient )
Parmetros:
nOrient
Nmrico. Orientao do boto

0 Horizontal
1 Vertical
Retorno:
Nenhum
setChildCollapse
Descrio: Especifica se os elementos podem ser collapsibles.
Sintaxe: setChildCollpse( lColl )
Parmetros:
lColl
Lgico. Ativa / Desativa
Retorno:
Nenhum
setCollapse
Descrio: Especifica o objeto que pode ser collapsible.
Sintaxe: setCollapse( oObj, lColl )
Parmetros:
oObj
lColl
Objeto. Controle a ser collapsed

Retorno:
Nenhum
movToLast
Descrio: Coloca o objeto como ultimo das divises.
Sintaxe: movToLast( oObj )
Parmetros:
oObj
Objeto. Controle a posicionado
Retorno:
Nenhum
movToFirst
Descrio: Coloca o objeto como primeiro das divises.
Sintaxe: movToFirst( oObj )
Parmetros:
oObj
Objeto. Controle a ser posicionado
Retorno:
Nenhum
setOpaqueResize
Descrio: Especifica se o resize deve ser opaco.
Sintaxe: setOpaqueResize( lOpaq )
Parmetros:
lOpaq
Retorno:
Nenhum
setResizeMode
Descrio: Especifica o mode de resize do objeto..
Sintaxe: setResizeMode ( oObj, nMode )
Parmetros:
oObj
nMode
Objeto. Controle a ser resized

Numrico. Modo do resize
0 Stretch
1- KeepSize
2 FollowSizeHint
3 Auto
Retorno:
Nenhum
Aparncia:
Exemplo:
#include hbutton.ch
User Function MytSplitter()
Local oDlg, oSplitter, oPanel1, oPanel2, oPanel3
DEFINE MSDIALOG oDlg FROM 0,0 TO 500,600 PIXEL TITLE Meu tSplitter
oSplitter := tSplitter():Create( oDlg )
@ 1, 1 MSPANEL oPanel1 OF oSplitter
// Usando o command
@ 1, 1 SPLITTER oSplitter
@ 1, 1 MSPANEL oPanel1 OF
SIZE 100, 100 OF oDlg

oSplitter
oSplitter
oSplitter

Return Nil
TTABS()
Descrio: Classe de objetos visuais do tipo controle TTabs, a qual permite

criar um controle visual do tipo pasta.
Propriedades:
-
Construtor: New([anTop], [anLeft], [aPrompts], [bAction], [oWnd], [nOption],

[nClrFore], [nClrBack], [lPixel], [lDesign], [nWidth], [nHeigth],
[cMsg])
Parmetros:
anTop
anLeft
aPrompts
bAction
oWnd
nOption
nClrFore
nClrBack
lPixel

carateres.
caracteres
Bloco de codigo, Disparado na troca da aba.
criado
Numrico, opcional. Folder selecionado
Numrico, opcional. Cor de frente
Numrico, opcional. Cor de fundo
lDesign
nWidth
nHeigth
cMsg

Mtodos auxiliares:
AddItem
Descrio: Adiciona uma aba na pasta
Sintaxe: AddItem(cTtulo)
Parmetros:
cTtulo
Ttulo da aba que ser adicionada
Retorno:
Nenhum
SetOption
Descrio: Seleciona a Aba
Sintaxe: SetOption( nNrAba )
Parmetros:
nNrAba
Nmero que identifica a posio da aba que ser

selecionada.
Retorno:
Nenhum
Aparncia:
Exemplo:
Local oDlg
oTTabs := TTabs():New(01,01,{'Aba01','Aba02','Aba03'},;
{||oPanel01:LVISIBLECONTROL:=(oTTabs:nOption==1)},;
oDlg,,RGB(255,0,0),RGB(255,255,0),.T.,,120,120,)
oPanel01 := TPanel():New( 000, 000,'',oTTabs,,,,,,100,100,,.T. )
oPanel01:lVisibleControl := .T.
oBtn01 := TButton():New( 01,01,'TButton01',oPanel01,;
{||oTTabs:SetOption(2)}, 037,
012,,,.F.,.T.,.F.,,.F.,,,.F. )
Return NIL
TTOOLBOX()
Descrio: Classe de objetos visuais do tipo controle tToolbox, a qual permite

criar um controle visual para agrupar diferentes objetos.
Propriedades:
bChangeGrp
Bloco de cdigo. Executado na troca entre os grupos

existentes.
Construtor: New([anRow], [anCol], [aoWnd], [anWidth], [anHeight], [aoFont],

[acMsg]], [abWhen])
Parmetros:
anRow
anCol
aoWnd
anWidth
anHeight
aoFont
acMsg
abWhen

carateres.
caracteres.
criado.
Mensagem, opcional. Tooltip/Hint do componente.
Mtodos auxiliares:
Create
Parmetros:
aoWnd
Objeto, opcional. Janela ou controle onde o boto dever

ser criado.
Retorno:
Objeto
Objeto do tipo TtoolBox gerado.
addGroup
Descrio: Adiciona um grupo
Sintaxe: addGroup( aoObj, acName, aoIcon )
Parmetros:
aoObj
acName
aoIcon
Objeto. Objeto Pai que vai ser inserido no grupo.

Caractere. Descrio do grupo
Objeto, opcional. cone para o grupo
Retorno:
Nenhum
removeGroup
Descrio: Remove um grupo
Sintaxe: removeGroup( aoObj )
Parmetros:
aoObj
Objeto. Objeto Pai que vai ser removido do grupo.
Retorno:
Nenhum
setCurrentGroup
Descrio: Define o grupo corrente
Sintaxe: setCurrentGroup( aoObj )
Parmetros:
aoObj
Objeto. Objeto Pai que ser definido como grupo corrente.
Retorno:
Nenhum
Aparncia:
Exemplo:
User Function MytToolbox()
Local oDlg, oTb
DEFINE MSDIALOG oDlg FROM 0,0 TO 500,600 PIXEL TITLE Meu Toolbox
oTb:= tToolbox():Create( oDlg )
oTb:nTop
:= 100
oTb:nLeft
:= 10
oTb:nWidth
:= 100
oTb:nHeight
:= 30
oTb:Add( oPanel, Opo 1, oIcone)
// Usando o command
@ 200,100 TOOLBOX oTb SIZE 100,30 OF oDlg
TOOLBOX oTb ADDGROUP TITLE Opo 1 OBJECT oPanel ICON oIcone
Return Nil
TWBROWSE()
Descrio: Classe de objetos visuais do tipo controle TWBrowse, a qual

Propriedades:
+
nAt
nLen


[aColSizes],
[oDlg],
[cField],
[uValue1],
[uValue2],
Parmetros:
nRow
nCol
nWidth
nHeight
bFields
aHeaders
aColSizes
oDlg
cField
uValue1
uValue2
bChange
bLDblClick
bRClick
oFont
oCursor
nClrFore
nClrBack
cMsg
lUpdate
cAlias
lPixel
bWhen
lDesign
bValid

ser criado.
No utilizado
objeto
No utilizado
No Utilizado

horizontal.
lHScroll
lVScroll
Mtodos auxiliares:
GoUp
Sintaxe: GoUp( )
Parmetros:
Nenhum
Retorno:
Nil
GoDown
Sintaxe: GoDown( )
Parmetros:
Nenhum
Retorno:
Nil
GoTop
Sintaxe: GoTop( )
Parmetros:
Nenhum
Retorno:
Nil
GoBottom
Parmetros:
Nenhum
Retorno:
Nil
RowCount
Parmetros:
Nenhum
Retorno:
Nil
LEditCell
Parmetros:
aList
oList
cPicture
nCol

Retorno:
Nil
Aparncia:
Exemplo:
Local oDlg
Local oOK := LoadBitmap(GetResources(),'br_verde')
Local oNO := LoadBitmap(GetResources(),'br_vermelho')
oBrowse := TWBrowse():New( 01 , 01, 245, 150,,;
{'','Codigo','Descrio'},{20,30,30}, oDlg, ,,,,;
{||},,,,,,,.F.,,.T.,,.F.,,, )
aBrowse
:= {{.T.,'CLIENTE 001','RUA CLIENTE 001','BAIRRO CLIENTE
001'},;
{.F.,'CLIENTE 002','RUA CLIENTE 002','BAIRRO CLIENTE
002'},;
{.T.,'CLIENTE 003','RUA CLIENTE 003','BAIRRO CLIENTE
003'} }
oBrowse:bLine := {||{;
If(aBrowse[oBrowse:nAt,01],oOK,oNO),;
aBrowse[oBrowse:nAt,02],;
aBrowse[oBrowse:nAt,04] } }
oBrowse:bLDblClick := ;
{|| aBrowse[oBrowse:nAt][1] :=
!aBrowse[oBrowse:nAt][1],oBrowse:DrawSelect()}
},40,10,,,,.T.)
},40,10,,,,.T.)
},40,10,,,,.T.)
},40,10,,,,.T.)
TButton():New(190,060, 'lEditCell (Edita a celula)', oDlg,;
},80,10,,,,.T.)
Return NIL
VCBROWSE()
Descrio: Classe de objetos visuais do tipo controle VCBrowse, a qual

Propriedades:
+
nAt
nLen


[aColSizes],
[oDlg],
[cField],
[uValue1],
[uValue2],
Parmetros:
nRow
nCol
nWidth
nHeight
bFields
aHeaders
aColSizes
oDlg
cField
uValue1
uValue2
bChange
bLDblClick
bRClick
oFont
oCursor
nClrFore
nClrBack
cMsg
lUpdate
cAlias
lPixel
bWhen
lDesign

ser criado.
No utilizado
objeto
No utilizado
No Utilizado

horizontal.
bValid
lHScroll
lVScroll
Mtodos auxiliares:
GoUp
Sintaxe: GoUp( )
Parmetros:
Nenhum
Retorno:
Nil
GoDown
Sintaxe: GoDown( )
Parmetros:
Nenhum
Retorno:
Nil
GoTop
Sintaxe: GoTop( )
Parmetros:
Nenhum
Retorno:
Nil
GoBottom
Parmetros:
Nenhum
Retorno:
Nil
RowCount
Parmetros:
Nenhum
Retorno:
Nil
LEditCell
Parmetros:
aList
oList
cPicture
nCol

Retorno:
Nil
Aparncia:
Exemplo:
Local oDlg
Local oOK := LoadBitmap(GetResources(),'br_verde')
Local oNO := LoadBitmap(GetResources(),'br_vermelho')
oBrowse := VCBrowse():New( 01 , 01, 245, 150,,;
{'','Codigo','Descrio'},{20,30,30}, oDlg, ,,,,;
{||},,,,,,,.F.,,.T.,,.F.,,, )
aBrowse
:= {{.T.,'CLIENTE 001','RUA CLIENTE 001','BAIRRO CLIENTE
001'},;
{.F.,'CLIENTE 002','RUA CLIENTE 002','BAIRRO CLIENTE
002'},;
{.T.,'CLIENTE 003','RUA CLIENTE 003','BAIRRO CLIENTE
003'} }
oBrowse:bLine := {||{;
If(aBrowse[oBrowse:nAt,01],oOK,oNO),;
aBrowse[oBrowse:nAt,04] } }
oBrowse:bLDblClick :=;
{|| aBrowse[oBrowse:nAt][1] :=
!aBrowse[oBrowse:nAt][1],oBrowse:DrawSelect()}
},40,10,,,,.T.)
},40,10,,,,.T.)
},40,10,,,,.T.)
},40,10,,,,.T.)
TButton():New(190,060, 'lEditCell (Edita a celula)', oDlg,;
},40,10,,,,.T.)
Return NIL
Documentao dos componentes da interface visual

Os componentes da interface visual da linguagem ADVPL utilizados neste treinamento esto
documentados na seo Guia de Referncia, ao final deste material.
Para visualizar a documentao completa de todos os componentes mencionados neste
captulo deve ser acesso o site DEM Documentao Eletrnica Microsiga
(dem.microsiga.com.br) conforme abaixo:
36.1. Particularidades dos componentes visuais

36.1.1.
Configurando as cores para os componentes
Os componentes visuais da linguagem ADVPL utilizam o padro de cores RGB.

As cores deste padro so definidas pela seguinte frmula, a qual deve ser avaliada tendo
como base a paleta de cores no formato RGB:
nCor := nVermelho + (nVerde * 256) + (nAzul * 65536)
Figura: Paleta de cores no formato RGB

Com base nesta paleta, podemos definir os valores das seguintes cores bsicas:
Cor
Preto
Azul
Verde
Ciano
Vermelho
Rosa
Amarelo
Branco
R
0
0
0
0
255
255
255
255
G
0
0
255
255
0
0
255
255
B
0
255
0
255
0
255
0
255
Valor
0
16711680
65280
16776960
255
16711935
65535
16777215
Para atribuir as cores aos objetos visuais devem ser observados os atributos utilizados para
estes fins em cada objeto, como por exemplo:
MSDIALOG()
nClrPane
nClrText
TSAY()
nClrPane
nClrText
Funo RGB()
A linguagem ADVPL possui a funo RGB() a qual retorna o valor da cor a ser definido, de
acordo com a parametrizao de cada um dos elementos da paleta RGB.
RGB(nRed, nGreen, nBlue)
nRed
Valor de 0-255 para o elemento vermelho da paleta RGB
nGreen
Valor de 0-255 para o elemento verde da paleta RGB
nBlue
Valor de 0-255 para o elemento azul da paleta RGB
Retorno
Valor a ser definido para o atributo cor do componente
37.
Aplicaes com a interface visual do ADVPL
A linguagem ADVPL possui interfaces visuais pr-definidas que auxiliam no desenvolvimento

de aplicaes mais completas, combinando estas interfaces com os componentes visuais
demonstrados anteriormente.
Didaticamente as interfaces visuais pr-definidas da linguagem ADVPL podem ser divididas em
trs grupos:
Captura de informaes simples ou Multi-Gets;
Captura de mltiplas informaes ou Multi-Lines;
Barras de botes
37.1. Captura de informaes simples (Multi-Gets)

Em ADVPL, as telas de captura de informaes compostas por mltiplos campos digitveis
acompanhados de seus respectivos textos explicativos so comumente chamados de
Enchoices.
Um Enchoice pode ser facilmente entendida como diversos conjuntos de objetos TSay e TGet
alinhados de forma a visualizar ou capturar informaes, normalmente vinculadas a arquivos
de cadastros ou movimentaes simples.
Abaixo temos a visualizao de uma Enchoice para o arquivo padro do ERP Protheus de
Cadastro de Clientes (SA1):
Figura: Enchoice do Cadastro de Clientes do ERP Protheus
A linguagem ADVPL permite a implementao da Enchoice de duas formas similares:

Funo Enchoice: Sintaxe tradicionalmente utilizada em ADVPL, a qual no retorna
um objeto para a aplicao chamadora;
Classe MsMGet: Classe do objeto Enchoice, a qual permite a instanciao direta de um
objeto, tornando-o disponvel na aplicao chamadora.
A utilizao de um ou outro objeto depende unicamente da escolha do desenvolvedor j que os
parmetros para a funo Enchoice e para o mtodo New() da classe MsMGet so os mesmos,
lembrando que para manter a coerncia com uma aplicao escrita em orientao a objetos
dever ser utilizada a classe MsMGet().
37.1.1.
Enchoice()
Sintaxe: Enchoice( cAlias, nReg, nOpc, aCRA, cLetra, cTexto, aAcho, aPos,
aCpos, nModelo, nColMens, cMensagem, cTudoOk, oWnd, lF3,
Retorno: Nil
Parmetros:
cAlias
nReg
nOpc
aCRA
cLetra
cTexto
aAcho
aPos
aCpos
nModelo
nColMens
cMensagem
cTudoOk
oWnd
lF3
lMemoria
lColumn
caTela
lNoFolder
lProperty

editada
estrangeiros
coluna
(SXA)
Exemplo: Utilizao da funo Enchoice()
/*/
+----------------------------------------------------------------------------| Funo
| MBRWENCH
|
+----------------------------------------------------------------------------| Descrio | Programa que demonstra a utilizao da funo Enchoice()
|
+----------------------------------------------------------------------------| Uso
| Curso ADVPL
|
+----------------------------------------------------------------------------/*/
User Function MrbwEnch()
Private aRotina
:=
{{"Pesquisar"
, "axPesqui"
{"Visualizar"
, "U_ModEnc"
DbSelectArea("SA1")
DbSetOrder(1)
MBrowse(6,1,22,75,"SA1")
Return
Local aCpoEnch
Local aAlter
:= {}
:= {}
Local cAliasE
:=
Local aAlterEnch :=
Local aPos
:=
Local nModelo
:=
Local lF3
:=
Local lMemoria
:=
Local lColumn
:=
Local caTela
:=
Local lNoFolder
:=
Local lProperty
:=
Private oDlg
Private oGetD
Private oEnch
Private aTELA[0][0]
Private aGETS[0]
cAlias
{}
{000,000,400,600}
3
.F.
.T.
.F.
""
.F.
.F.
DbSelectArea("SX3")
DbSetOrder(1)
DbSeek(cAliasE)
, 0, 1},;
, 0, 2}}
If !(SX3->X3_CAMPO $ "A1_FILIAL") .And. cNivel >= SX3->X3_NIVEL .And.;
EndIf
DbSkip()
End
RegToMemory("SA1", If(nOpc==3,.T.,.F.))
Enchoice(cAliasE, nReg, nOpc, /*aCRA*/, /*cLetra*/, /*cTexto*/, ;
aCpoEnch, aPos, aAlterEnch, nModelo, /*nColMens*/,;
/*cMensagem*/,/*cTudoOk*/, oDlg, lF3, lMemoria, lColumn,;
caTela, lNoFolder, lProperty)
Return
37.1.2.
MsMGet()
Sintaxe: MsMGet():New( cAlias, nReg, nOpc, aCRA, cLetra, cTexto, aAcho,

aPos, aCpos, nModelo, nColMens, cMensagem, cTudoOk, oWnd, lF3,
Retorno: oMsMGet objeto do tipo MsMGet()

Parmetros:
cAlias
nReg
nOpc
aCRA
cLetra
cTexto
aAcho
aPos
aCpos
nModelo
nColMens
cMensagem
cTudoOk
oWnd
lF3

editada
estrangeiros
lMemoria

coluna
(SXA)
lColumn
caTela
lNoFolder
lProperty
Exemplo: Utilizao do objeto MsMGet()
/*/
+----------------------------------------------------------------------------| Funo
| MBRWMSGET | Autor | ARNALDO RAYMUNDO JR. |Data |
|
+----------------------------------------------------------------------------| Descrio | Programa que demonstra a utilizao do objeto MsMget()
|
+----------------------------------------------------------------------------| Uso
| Curso ADVPL
|
+----------------------------------------------------------------------------/*/
User Function MrbwMsGet()
Private aRotina
:=
{{"Pesquisar"
, "axPesqui"
{"Visualizar"
, "U_ModEnc"
DbSelectArea("SA1")
DbSetOrder(1)
MBrowse(6,1,22,75,"SA1")
Return
Local aCpoEnch
:= {}
Local aAlter
:= {}
Local cAliasE
Local aAlterEnch :=
Local aPos
:=
Local nModelo
:=
Local lF3
:=
Local lMemoria
:=
Local lColumn
Local caTela
Local lNoFolder
:=
Local lProperty
:=
Private oDlg
Private oGetD
Private oEnch
Private aTELA[0][0]
Private aGETS[0]
:= cAlias
{}
{000,000,400,600}
3
.F.
.T.
:= .F.
:= ""
.F.
.F.
, 0, 1},;
, 0, 2}}
DbSelectArea("SX3")
DbSetOrder(1)
DbSeek(cAliasE)
If !(SX3->X3_CAMPO $ "A1_FILIAL") .And. cNivel >= SX3->X3_NIVEL .And.
EndIf
DbSkip()
End
oDlg
:= MSDIALOG():New(000,000,400,600,cCadastro,,,,,,,,,.T.)
RegToMemory(cAliasE, If(nOpc==3,.T.,.F.))
oEnch := MsMGet():New(cAliasE, nReg, nOpc, /*aCRA*/, /*cLetra*/,;
/*cTexto*/, aCpoEnch, aPos, aAlterEnch, nModelo, /*nColMens*/,;
/*cMensagem*/, /*cTudoOk*/,oDlg,lF3,lMemoria,lColumn, caTela,;
lNoFolder, lProperty)
oDlg:Activate()
Return
37.2. Captura de mltiplas informaes (Multi-Lines)

A linguagem ADVPL permite a utilizao de basicamente dois tipos de objetos do tipo grid, ou
como tambm so conhecidos: multi-line:
Grids digitveis: permitem a visualizao e captura de informaes, comumente
utilizados em interfaces de cadastro e manuteno, tais como:
MSGETDB()
MSGETDADOS()
MSNEWGETDADOS()
Grids no digitveis: permitem somente a visualizao de informaes, comumente
utilizados como browses do ERP Protheus, tais como:
TWBROWSE()
MAWNDBROWSE()
MBROWSE()
Neste tpico sero tratadas as grids digitveis disponveis na linguagem ADVPL para o
desenvolvimento de interfaces de cadastros e manuteno de informaes.
37.2.1.
MsGetDB()
A classe de objetos visuais MsGetDB() permite a criao de um grid digitvel com uma ou mais
colunas, baseado em uma tabela temporria.
Sintaxe:
MsGetDB():New(nTop, nLeft, nBottom, nRight, nOpc, cLinhaOk,

cTudoOk, cIniCpos, lDelete, aAlter, nFreeze, lEmpty, uPar1, cTRB,
cFieldOk, lCondicional, lAppend, oWnd, lDisparos, uPar2, cDelOk,
cSuperDel)
Retorno: oMsGetDB objeto do tipo MsGetDB()
Parmetros:
nTop
nLeft
nBottom
nRight
nOpc
cLinhaOk
cTudoOk
cIniCpos
lDelete
aAlter
nFreeze
lEmpty
uPar1
cFieldOk
cTRB
lCondicional
lAppend
cDelOk
lDisparos
uPar2
cSuperDel
oWnd
Distancia entre a MsGetDB e o extremidade superior do

objeto que a contm.
Distancia entre a MsGetDB e o extremidade esquerda do
objeto que a contm.
Distancia entre a MsGetDB e o extremidade inferior do objeto
que a contm.
Distancia entre a MsGetDB e o extremidade direita do objeto
que a contm.
Posio do elemento do vetor aRotina que a MsGetDB usar
como referncia.
aCols.
Funo executada para validar o contexto geral da MsGetDB
(todo aCols).
Habilita a opo de excluir linhas do aCols. Valor padro
falso.
Indica qual coluna no ficara congelada na exibio.
Parmetro reservado.
Alias da tabela temporria.
Reservado
Indica se a MsGetDB ira criar uma linha em branco
automaticamente quando for incluso.
aCols.
Indica se ser utilizado o Dicionrio de Dados para consulta
padro, inicializao padro e gatilhos.
Parmetro reservado.
-Funo
executada
quando
pressionada
as
teclas
<Ctrl>+<Delete>.
Objeto no qual a MsGetDB ser criada.
Aparncia:
Variveis private:
aRotina

formato:
11- Pesquisar
12- Visualizar
13- Incluir
14- Alterar
15- Excluir
aHeader

lRefresh
Variveis pblicas:
nBrLin
Funes de validao:
cLinhaOk
cTudoOk

Mtodos adicionais:
ForceRefresh()
Atualiza a MsGetDB com a tabela e posiciona na primeira

linha.
Exemplo: Utilizao do objeto MsGetDB()
/*/
+----------------------------------------------------------------------------| Funo
| GETDBSA1
| Autor | MICROSIGA
|Data |
|
+----------------------------------------------------------------------------| Descrio | Programa que demonstra a utilizao do objeto MsGetDB()
|
+----------------------------------------------------------------------------| Uso
| Curso ADVPL
|
+----------------------------------------------------------------------------/*/
User Function GetDbSA1()
Local
Local
Local
Local
Local
nI
oDlg
oGetDB
nUsado := 0
aStruct := {}
Private
Private
Private
Private
lRefresh := .T.
aHeader := {}
aCols := {}
aRotina := {{"Pesquisar", "AxPesqui", 0, 1},;
DbSelectArea("SX3")
DbSetOrder(1)
DbSeek("SA1")
nUsado++
SX3->X3_CAMPO,;
SX3->X3_PICTURE,;
SX3->X3_TAMANHO,;
SX3->X3_DECIMAL,;
SX3->X3_VALID,;
"",;
SX3->X3_TIPO,;
"",;
"" })
AADD(aStruct,{SX3->X3_CAMPO,SX3->X3_TIPO,SX3->X3_TAMANHO,;
SX3->X3_DECIMAL})
EndIf
DbSkip()
End
AADD(aStruct,{"FLAG","L",1,0})
cCriaTrab := CriaTrab(aStruct,.T.)
DbUseArea(.T.,__LocalDriver,cCriaTrab,,.T.,.F.)
oDlg
:= MSDIALOG():New(000,000,300,400, MsGetDB SA1,,,,,,,,,.T.)
oGetDB := MsGetDB():New(05,05,145,195,3,"U_LINHAOK", "U_TUDOOK", "+A1_COD", ;

.T.,{"A1_NOME"},1,.F.,,cCriaTrab,"U_FIELDOK",,.T.,oDlg, .T., ,"U_DELOK",;
"U_SUPERDEL")
oDlg:Activate()
DbSelectArea(cCriaTrab)
DbCloseArea()
Return
Return .T.
Return .T.
ApMsgStop("DELOK")
Return .T.
Return .T.
Return .T.
37.2.2.
MsGetDados()
A classe de objetos visuais MsGetDados() permite a criao de um grid digitvel com uma ou
mais colunas, baseado em um array.
Sintaxe: MsGetDados():New( nTop, nLeft, nBottom, nRight, nOpc, cLinhaOk,

cTudoOk, cIniCpos, lDelete, aAlter, uPar1, lEmpty, nMax, cFieldOk,
cSuperDel, uPar2, cDelOk, oWnd)
Retorno: oMsGetDados objeto do tipo MsGetDados()
Parmetros:
nTop
nLeft
nBottom
nRight
nOpc
cLinhaOk
cTudoOk
cIniCpos
lDelete
aAlter
uPar1
lEmpty
nMax
cFieldOk
cSuperDel
uPar2
cDelOk
oWnd

objeto que a contm.
objeto que a contm.
objeto que a contm.
objeto que a contm.
aCols.
Habilita excluir linhas do aCols. Valor padro falso.
Parmetro reservado.
Funo
executada
quando
pressionada
as
teclas
<Ctrl>+<Delete>.
Parmetro reservado.
aCols.
Aparncia:
Variveis private:
aRotina

formato:
16- Pesquisar
17- Visualizar
18- Incluir
19- Alterar
20- Excluir
aHeader

lRefresh
Variveis pblicas:
N
Funes de validao:
cLinhaOk
cTudoOk

Mtodos adicionais:
ForceRefresh()
Hide()
Show()
Atualiza a MsGetDados com a tabela e posiciona na primeira

linha.
Oculta a MsGetDados.
Mostra a MsGetDados.
Exemplo: Utilizao do objeto MsGetDados()
/*/
+----------------------------------------------------------------------------| Funo
| GETDADOSA1 | Autor | MICROSIGA
|Data |
|
+----------------------------------------------------------------------------| Descrio | Programa que demonstra a utilizao do objeto MSGETADOS()
|
+----------------------------------------------------------------------------| Uso
| Curso ADVPL
|
+----------------------------------------------------------------------------/*/
User Function GetDadoSA1()
Local nI
Local oDlg
Local oGetDados
Local nUsado := 0
Private lRefresh := .T.
Private aCols := {}
Private aRotina := {{"Pesquisar", "AxPesqui", 0, 1},;
DbSelectArea("SX3")
DbSetOrder(1)
DbSeek("SA1")
nUsado++
SX3->X3_CAMPO,;
SX3->X3_PICTURE,;
SX3->X3_TAMANHO,;
SX3->X3_DECIMAL,;
SX3->X3_VALID,;
"",;
SX3->X3_TIPO,;
"",;
"" })
EndIf
DbSkip()
End
For nI := 1 To nUsado
aCols[1][nI] := CriaVar(aHeader[nI][2])
Next
aCols[1][nUsado+1] := .F.
oDlg
:= MSDIALOG():New(000,000,300,400, MsGetDados SA1,,,,,,,,,.T.)
oGetDados := MsGetDados():New(05, 05, 145, 195, 4, "U_LINHAOK", "U_TUDOOK",;

"+A1_COD", .T., {"A1_NOME"}, , .F., 200, "U_FIELDOK", "U_SUPERDEL",,;
"U_DELOK", oDlg)
oDlg:Activate()
Return
Return .T.
Return .T.
ApMsgStop("DELOK")
Return .T.
Return .T.
Return .T.
37.2.3.
MsNewGetDados()
A classe de objetos visuais MsNewGetDados() permite a criao de um grid digitvel com uma
ou mais colunas, baseado em um array.
Sintaxe: MsNewGetDados():New(nSuperior, nEsquerda ,nInferior, nDireita,

nOpc, cLinOk, cTudoOk, cIniCpos, aAlterGDa, nFreeze, nMax,
cFieldOk, cSuperDel, cDelOk, oDLG, aHeader, aCols)
Retorno: oMsGetDados objeto do tipo MsNewGetDados()
Parmetros:
nSuperior
nEsquerda
nInferior
nDireita
nOpc
cLinOk
cTudoOk
cIniCpos
aAlterGDa
nFreeze
Distancia entre a MsNewGetDados e o extremidade superior

Distancia entre a MsNewGetDados e o extremidade esquerda
Distancia entre a MsNewGetDados e o extremidade inferior do
objeto que a contem
Distancia entre a MsNewGetDados e o extremidade direita do
objeto que a contem
Operao em execuo: 2- Visualizar, 3- Incluir, 4- Alterar, 5Excluir
aCols
MsNewGetDados (todo aCols)
automtico.
Campos alterveis da GetDados
Campos estticos na GetDados, partindo sempre da posio
inicial da getdados aonde:
3- Primeiro campo congelado
4- Primeiro e segundo campos congelados...
nMax
cFieldOk
cSuperDel
cDelOk
oDLG
aHeader
aCols
Nmero mximo de linhas permitidas. Valor padro 99

Funo executada na validao do campo
<Ctrl>+<Delete>
aCols
Objeto no qual a MsNewGetDados ser criada
aHeader
aCols
Aparncia:
Variveis private:
aRotina

formato:
6- Pesquisar
7- Visualizar
8- Incluir
9- Alterar
10- Excluir
aHeader

lRefresh

Variveis pblicas:
Funes de validao:
cLinhaOk

cTudoOk
Mtodos adicionais:
ForceRefresh()
Atualiza a MsNewGetDados com a tabela e posiciona na

primeira linha.
Oculta a MsNewGetDados.
Mostra a MsNewGetDados.
Hide()
Show()
Exemplo: Utilizao dos objetos MsNewGetDados() e MsMGet()
/*/
+----------------------------------------------------------------------------| Funo
| MBRWGETD
|
|
|
| MsNewGetDados() e MsMGet() combinados
|
+----------------------------------------------------------------------------| Uso
| Curso ADVPL
|
+----------------------------------------------------------------------------/*/
User Function MrbwGetD()
Private aRotina
:=
{{"Pesquisar"
{"Visualizar"
{"Incluir"
, "axPesqui"
, "U_ModGtd"
, "U_ModGtd"
DbSelectArea("SC5")
DbSetOrder(1)
MBrowse(6,1,22,75,"SC5")
Return
Local
Local
Local
Local
Local
Local
nX
nUsado
aButtons
aCpoEnch
cAliasE
aAlterEnch
:=
:=
:=
:=
:=
:=
0
0
{}
{}
cAlias
{}
, 0, 1},;
, 0, 2},;
, 0, 3}}
Local
Local
Local
Local
Local
Local
Local
Local
Local
Local
Local
Local
Local
Local
Local
Local
Local
Local
Local
Local
Local
Local
Local
Local
Local
aPos
nModelo
lF3
lMemoria
lColumn
caTela
lNoFolder
lProperty
aCpoGDa
cAliasGD
nSuperior
nEsquerda
nInferior
nDireita
cLinOk
cTudoOk
cIniCpos
nFreeze
nMax
cFieldOk
cSuperDel
cDelOk
aHeader
aCols
aAlterGDa
Private
Private
Private
Private
Private
:=
:=
:=
:=
:=
:=
:=
:=
{000,000,080,400}
3
.F.
.T.
:= .F.
:= ""
.F.
.F.
:= {}
"SC6"
:= 081
:= 000
:= 250
:= 400
:= "AllwaysTrue"
:= "AllwaysTrue"
:= "C6_ITEM"
:= 000
:= 999
:= "AllwaysTrue"
:= ""
:= "AllwaysFalse"
:= {}
:= {}
{}
oDlg
oGetD
oEnch
aTELA[0][0]
aGETS[0]
DbSelectArea("SX3")
DbSetOrder(1)
DbSeek(cAliasE)
EndIf
DbSkip()
End
DbSelectArea("SX3")
DbSetOrder(1)
MsSeek(cAliasGD)
If
!(AllTrim(SX3->X3_CAMPO) $ "C6_FILIAL") .And.;
cNivel >= SX3->X3_NIVEL .And. X3Uso(SX3->X3_USADO)
EndIf
DbSkip()
End
nUsado:=0
dbSelectArea("SX3")
dbSeek("SC6")
aHeader:={}
nUsado:=nUsado+1
AADD(aHeader,{ TRIM(x3_titulo), x3_campo, x3_picture,x3_tamanho,;
x3_decimal,"AllwaysTrue()",x3_usado, x3_tipo, x3_arquivo, x3_context } )
Endif
dbSkip()
End
For nX:=1 to nUsado
aCols[1,nX]:= "0001"
ELSE
ENDIF
Next
Else
aCols:={}
dbSelectArea("SC6")
dbSetOrder(1)
For nX:=1 to nUsado
Next
dbSkip()
End
Endif
oDlg
:= MSDIALOG():New(000,000,400,600, cCadastro,,,,,,,,,.T.)
oEnch := MsMGet():New(cAliasE,nReg,nOpc,/*aCRA*/,/*cLetra*/,/*cTexto*/,;
aCpoEnch,aPos,aAlterEnch, nModelo, /*nColMens*/, /*cMensagem*/,;
/*cTudoOk*/, oDlg,lF3, lMemoria,lColumn,caTela,lNoFolder,;
lProperty)
oGetD:= MsNewGetDados():New(nSuperior, nEsquerda, nInferior, nDireita,;
nOpc,cLinOk,cTudoOk, cIniCpos, aAlterGDa, nFreeze, nMax,cFieldOk,;
cSuperDel,cDelOk, oDLG, aHeader, aCols)
oDlg:bInit := {|| EnchoiceBar(oDlg, {||oDlg:End()},{||oDlg:End()},,aButtons)}
oDlg:Activate()
Return
37.2.3.1.
Definindo cores personalizadas para o objeto MsNewGetDados()
Conforme visto no tpico sobre definio das propriedades de cores para os componentes
visuais, cada objeto possui caractersticas que devem ser respeitadas para correta utilizao
deste recurso.
Atributos adicionais:
lUseDefaultColors
Mtodos adicionais:
SetBlkBackColor
Atributo que dever ser definido como .F. para que as

alteraes nas cores sejam permitidas.
Mtodo que define a cor que ser utilizada para cada linha do
grid. No necessrio utilizar o mtodo Refresh() aps a
definio da cor por este mtodo.
Aparncia:
Exemplo: Definindo cores personalizadas para o objeto MsNewGetDados()
/*/
+----------------------------------------------------------------------------| Funo
| MRBWGTCL
|
|
|
| MsNewGetDados() e MsMGet() combinados e tratamento de cores
|
+----------------------------------------------------------------------------| Uso
| Curso ADVPL
|
+----------------------------------------------------------------------------/*/
User Function MrbwGtCl()
Private aRotina
:=
{{"Pesquisar"
{"Visualizar"
{"Incluir"
, "axPesqui"
, "U_ModGtd"
, "U_ModGtd"
DbSelectArea("SC5")
DbSetOrder(1)
MBrowse(6,1,22,75,"SC5")
Return
Local nX
:= 0
Local nUsado
Local
Local
Local
Local
Local
Local
Local
Local
Local
Local
Local
Local
Local
Local
Local
Local
Local
Local
Local
Local
Local
Local
Local
aButtons
aCpoEnch
cAliasE
aAlterEnch
aPos
nModelo
lF3
lMemoria
lColumn
caTela
lNoFolder
lProperty
aCpoGDa
cAliasGD
nSuperior
nEsquerda
nInferior
nDireita
cLinOk
cTudoOk
cIniCpos
nFreeze
nMax
:= 0
:= {}
:= {}
:= cAlias
{}
{000,000,080,400}
3
.F.
.T.
:= .F.
:= ""
:= .F.
:= .F.
:= {}
:= "SC6"
:= 081
:= 000
:= 250
:= 400
:= "AllwaysTrue"
:= "AllwaysTrue"
:= "C6_ITEM"
:= 000
:= 999
:=
:=
:=
:=
:=
, 0, 1},;
, 0, 2},;
, 0, 3}}
Local
Local
Local
Local
Local
Local
cFieldOk
cSuperDel
cDelOk
aHeader
aCols
aAlterGDa
Private
Private
Private
Private
Private
:=
:=
:=
:=
:=
"AllwaysTrue"
""
"AllwaysFalse"
{}
{}
:= {}
oDlg
oGetD
oEnch
aTELA[0][0]
aGETS[0]
DbSelectArea("SX3")
DbSetOrder(1)
DbSeek(cAliasE)
EndIf
DbSkip()
End
DbSelectArea("SX3")
DbSetOrder(1)
MsSeek(cAliasGD)
If
!(AllTrim(SX3->X3_CAMPO) $ "C6_FILIAL") .And. cNivel >= SX3>X3_NIVEL .And. X3Uso(SX3->X3_USADO)
EndIf
DbSkip()
End
nUsado:=0
dbSelectArea("SX3")
dbSeek("SC6")
aHeader:={}
nUsado:=nUsado+1
AADD(aHeader,{ TRIM(x3_titulo), x3_campo, x3_picture,;
Endif
dbSkip()
End
For nX:=1 to nUsado
aCols[1,nX]:= "0001"
ELSE
ENDIF
Next
Else
aCols:={}
dbSelectArea("SC6")
dbSetOrder(1)
For nX:=1 to nUsado
Next
dbSkip()
End
Endif
oDlg := MSDIALOG():New(000,000,400,600, cCadastro,,,,,,,,,.T.)
oEnch := MsMGet():New(cAliasE,nReg,nOpc,/*aCRA*/,/*cLetra*/, /*cTexto*/,;
aCpoEnch,aPos, aAlterEnch, nModelo, /*nColMens*/, /*cMensagem*/,;
cTudoOk,oDlg,lF3, lMemoria,lColumn,caTela,lNoFolder,lProperty)
oGetD:= MsNewGetDados():New(nSuperior,nEsquerda,nInferior,nDireita, nOpc,;
cLinOk,cTudoOk,cIniCpos,aAlterGDa,nFreeze,nMax,cFieldOk, cSuperDel,;
cDelOk, oDLG, aHeader, aCols)
// Tratamento para definio de cores especficas,
// logo aps a declarao da MsNewGetDados
oGetD:oBrowse:lUseDefaultColors := .F.
oGetD:oBrowse:SetBlkBackColor({|| GETDCLR(oGetD:aCols,oGetD:nAt,aHeader)})
oDlg:bInit := {|| EnchoiceBar(oDlg, {||oDlg:End()}, {||oDlg:End()},,aButtons)}
oDlg:Activate()
Return
// Funo para tratamento das regras de cores para a grid da MsNewGetDados
Static Function GETDCLR(aLinha,nLinha,aHeader)
Local
Local
Local
Local
Local
nCor2
nCor3
nPosProd
nUsado
nRet
:=
:=
:=
:=
:=
16776960 // Ciano - RGB(0,255,255)

16777215 // Branco - RGB(255,255,255)
aScan(aHeader,{|x| Alltrim(x[2]) == "C6_PRODUTO"})
Len(aHeader)+1
nCor3
If !Empty(aLinha[nLinha][nPosProd]) .AND. aLinha[nLinha][nUsado]

nRet := nCor2
ElseIf !Empty(aLinha[nLinha][nPosProd]) .AND. !aLinha[nLinha][nUsado]
nRet := nCor3
Endif
Return nRet
37.3. Barras de botes

A linguagem ADVPL permite a implementao de barras de botes utilizando funes prdefinidas desenvolvidas com o objetivo de facilitar sua utilizao, ou atravs da utilizao
direta dos componentes visuais disponveis. Dentre os recursos da linguagem que podem ser
utilizados com esta finalidade sero abordados:
Funo EnchoiceBar: Sintaxe tradicionalmente utilizada em ADVPL, a qual no
retorna um objeto para a aplicao chamadora;
Classe TBar: Classe do objeto TBar(), a qual permite a instanciao direta de um
objeto do tipo barra de botes superior, tornando-o disponvel na aplicao chamadora.
Classe ButtonBar: Classe do objeto ButtonBar(), a qual permite a instanciao direta
de um objeto barra de botes genrico, o qual pode ser utilizado em qualquer posio
da tela, tornando-o disponvel na aplicao chamadora.
37.3.1.
EnchoiceBar()
Funo que cria uma barra de botes no formato padro utilizado pelas interfaces de cadastro
da aplicao Protheus.
Esta barra possui os botes padres para confirmar ou cancelar a interface e ainda permite a
adio de botes adicionais com a utilizao do parmetro aButtons.
Sintaxe:
EnchoiceBar( oDlg, bOk, bCancel, lMsgDel, aButtons, nRecno, cAlias)
Parmetros:
oDlg
bOk
bCancel
lMsgDel
aButtons
nRecno
cAlias
Dialog onde ir criar a barra de botes

Bloco de cdigo a ser executado no boto Ok
Bloco de cdigo a ser executado no boto Cancelar
Exibe dialog para confirmar a excluso
Array contendo botes adicionais.
aArray[n][1] -> Imagem do boto
aArray[n][2] -> bloco de cdigo contendo a ao do boto
aArray[n][3] -> ttulo do boto
Registro a ser posicionado aps a execuo do boto Ok.
Alias do registro a ser posicionado aps a execuo do boto
Ok. Se o parmetro nRecno for informado, o cAlias passa ser
obrigatrio.
Aparncia:
/*/
+----------------------------------------------------------------------------| Funo
| DENCHBAR
|
+----------------------------------------------------------------------------| Descrio | Programa que demonstra a utilizao da funo
|
|
| EnchoiceBar()
|
+----------------------------------------------------------------------------| Uso
| Curso ADVPL
|
+----------------------------------------------------------------------------/*/
User Function DEnchBar()
Local oDlg, oBtn
Local aButtons := {}
DEFINE MSDIALOG oDlg TITLE "Teste EnchoiceBar" FROM 000,000 TO 400,600 PIXEL OF;
oMainWnd
AADD( aButtons, {"HISTORIC", {|| TestHist()}, "Histrico...",;
"Histrico",{|| .T.}} )
@ -15,-15 BUTTON oBtn PROMPT "..." SIZE 1,1 PIXEL OF oDlg
ACTIVATE MSDIALOG oDlg ;
ON INIT (EnchoiceBar(oDlg,{||lOk:=.T.,oDlg:End()},{||oDlg:End()},,@aButtons))
Return
37.3.2.
TBar()
Classe de objetos visuais que permite a implementao de um componente do tipo barra de

botes para a parte superior de uma janela previamente definida.
Sintaxe: New(oWnd, nBtnWidth, nBtnHeight, l3D, cMode, oCursor, cResource,

lNoAutoAdjust)
Retorno: oTBar objeto do tipo TBar()
Parmetros:
oWnd

criado.
nBtnWidth
nBtnHeight
l3D
cMode
No utilizado.
oCursor
cResource
lNoAutoAdjust

barra.
fundo da barra.
Lgico.
Aparncia:
/*/
+----------------------------------------------------------------------------| Funo
| TSTBAR
| Autor | MICROSIGA
|Data |
|
+----------------------------------------------------------------------------| Descrio | Programa que demonstra a utilizao do objeto TBar()
|
+----------------------------------------------------------------------------| Uso
| Curso ADVPL
|
+----------------------------------------------------------------------------/*/
Local oDlg
oDlg
,,,,;

{||},oTBar,'PCO',,.F.,.F. )
,,,,;

{||},oTBar,'Preo' ,,.F.,.F. )
,,,,;
oDlg:Activate()
Return
37.3.3.
ButtonBar
A sintaxe ButtonBar a forma clssica utilizada na linguagem ADVPL para implementar um

objeto da classe TBar(), o qual possui as caractersticas mencionadas no tpico anterior.
Sintaxe:
DEFINE BUTTONBAR oBar SIZE nWidth, nHeight 3D MODE OF oDlg
CURSOR
Retorno: ().
Parmetros:
oBar
nWidth
nHeight
3D
oDlg
MODE
Objeto do tipo TBar() que ser criado com a utilizao da

sintaxe ButtonBar().
Numrico, opcional. Largura do boto contido na barra.
Numrico, opcional. Altura do boto contido na barra.
Se definido habilita a visualizao em 3D da barra de botes.
criado.
Define a forma de orientao do objeto ButtonBar utilizando
os seguintes termos pr-definidos:
TOP, BOTTOM, FLOAT
CURSOR
Objeto, opcional. Define Cursor ao posicionar o mouse sobre

a barra.
A sintaxe ButtonBar requer a adio dos botes como recursos adicionais da barra
previamente definida utilizando a sintaxe abaixo:
Botes: BUTTON RESOURCE
Sintaxe adicional:
DEFINE BUTTON RESOURCE cBitMap OF oBar ACTION cAcao TOOLTIP
cTexto
Parmetros:
cBitMap
Nome da imagem disponvel na aplicao.
oBar
Objeto do tipo TBar() no qual o boto ser adicionado.
cAcao
Funo ou lista de expresses que determina a ao que ser

realizada pelo boto.
Texto no estilo tooltip text que ser exibido quando o
cursor do mouse for posicionado sobre o boto na barra de
ferramentas.
cTexto
Aparncia:
Exemplo: Utilizao da sintaxe ButtonBar
/*/
+----------------------------------------------------------------------| Funo
| TstBBar
| Autor | MICROSIGA
|Data |
|
+----------------------------------------------------------------------| Descrio | Programa que demonstra a utilizao do objeto TBar()
|
+----------------------------------------------------------------------| Uso
| Curso ADVPL
|
+----------------------------------------------------------------------/*/
User Function TstBBar()
Local oDlg
Local oBtn1
Local oBtn2
oDlg
:= MSDIALOG():New(000,000,305,505, 'Exemplo - BUTTONBAR',,,,,,,,,.T.)
DEFINE BUTTONBAR oBar SIZE 25,25 3D TOP OF oDlg

DEFINE
DEFINE
DEFINE
DEFINE
ACTION

BUTTON oBtn1 RESOURCE "S4WB008N" OF
Calculadora() TOOLTIP "Calculadora"
oBtn1:cTitle:="Calc"
ACTION HelProg() TOOLTIP "Ajuda"
ACTION NaoDisp() TOOLTIP "Recortar"

ACTION NaoDisp() TOOLTIP "Copiar"
ACTION NaoDisp() TOOLTIP "Colar"
oBar GROUP;
OF oBar ACTION Agenda() TOOLTIP "Agenda"

OF oBar ACTION OurSpool() TOOLTIP "Spool"
OF oBar GROUP;
DEFINE BUTTON oBtn2 RESOURCE "PARAMETROS" OF oBar GROUP;

ACTION Sx1C020() TOOLTIP "Parmetros"
oBtn2:cTitle:="Param."
DEFINE
BUTTON oBtOk RESOURCE "FINAL" OF oBar GROUP;
ACTION oDlg:End()TOOLTIP "Sair"
oBar:bRClicked := {|| AllwaysTrue()}
oDlg:Activate()
Return
37.3.4.
Imagens pr-definidas para as barras de botes
Conforme mencionado nos tpicos anteriores, os botes visuais do tipo barra de botes
permitem a definio de itens com aes e imagens vinculadas.
Dentre os objetos e funes mencionados, foi citada a EnchoiceBar(), a qual permite a adio
de botes adicionais atravs do parmetro aButton, sendo que os itens deste array devem
possuir o seguinte formato:
Sintaxe: AADD(aButtons,{cBitMap, bAcao, cTexto})
Estrutura:
cBitMap
bAcao
cTexto
Nome da imagem pr-definida existente na aplicao ERP que

ser vinculada ao boto.
Bloco de cdigo que define a ao que ser executada com a
utilizao do boto.
Texto no estilo tooltip text que ser exibido quando o cursor
do mouse for posicionado sobre o boto na barra de
ferramentas.
Alguns BitMaps disponveis:

DESTINOS
DISCAGEM
EDIT
EDITABLE
EXCLUIR
FORM
GRAF2D
GRAF3D
LINE
NOTE
OBJETIVO
OK
PENDENTE
PRECO
PRODUTO
S4SB014N
S4WB001N
S4WB005N
S4WB006N
S4WB007N
S4WB008N
S4WB009N
S4WB010N
S4WB011N
S4WB013N
S4WB014A
S4WB016N
SIMULACA
VENDEDOR
USER
Exemplo:
AADD(aButtons,{"USER",{||AllwaysTrue()},"Usurio"})
38.
Outras aplicaes da interface visual do ADVPL
38.1. MaWndBrowse()
Descrio: Browse que permite a visualizao de registros para arquivos / tabelas que
no possuem estrutura definida no Dicionrio de Dados do sistema.
Sintaxe: MaWndBrowse (nLin1, nCol1, nLin2, nCol2, cTitle, cAlias, aCampos, aRotina,
cFunLeg, cTopFun, cBotFun, lCentered, aResource, nMod, aPesqui, cSeek,
lDic, lSavOrd)
Parmetros:
nLin1
nCol1
nLin2
nCol2
cTitle
cAlias
aCampos
aRotina
cFunLeg
cTopFun
cBotFun
lCentered
aResource
nModelo
aPesqui
cSeek
lDic
lSavOrd
Linha inicial do browse

Coluna inicial do browse
Linha final do browse
Coluna final do browse
Ttulo do browse (obrigatrio)
Alias da tabela corrente podendo ser um temporrio
Se lDic=.T. utilizar o SX3, do contrrio o aCampos
informado
Idntico ao aRotina para mBrowse
Funo que dever retornar um valor lgico e com isso ser
atribudo semafro na primeira coluna do browse
Mostrar os registros com a chave de
Mostrar os registros com a chave ate
Valor verdadeiro centraliza
aAdd(aResource,{"IMAGEM","Texto significativo"})
Posio do Menu:
1- Horizontal (superior)
2- Vertical (esquerda)
3- Horizontal (inferior)
aAdd(aPesqui{"Ttulo",nOrdem}), se no passado ser
utilizado o AxPesqui
Chave principal para a busca, exemplo: xFilial("???")
Parmetro em conjunto com aCampos
Estabelecer a ordem aps pesquisas.
Estrutura do array aCampos

aAdd(aCampo,{X3_CAMPO,X3_PICTURE,X3_TITULO,X3_TAMANHO})
Aparncia:
Exemplo: MaWndBrowse para arquivo temporrio
/*/
+----------------------------------------------------------------------| Funo
| WndBrwTRB
| Autor | Arnaldo R. Junior | Data |
|
+----------------------------------------------------------------------| Descrio | Demonstra a utilizao da MaWndBrowse com Temporrio
|
+----------------------------------------------------------------------| Uso
| Curso ADVPL
|
+----------------------------------------------------------------------/*/
User Function WndBrwTRB()
// Variveis para o Arquivo Temporario
Local cChave
:= ""
Local cArqTrb
:= ""
Local aStruTRB := {}
// Variveis para o MaWndBrowse
Local cTitulo
:= "Cadastro Temporario"// Ttulo obrigatrio
Local cAlias
:= "TRB" // Alias da tabela corrente podendo ser TRB
Local cFunLeg
:= "" // Funo que dever retornar um valor lgico e com isso
ser atribudo semafro na primeira coluna do browse
Local cTopFun
:= "" // Mostrar os registros com a chave de
Local cBotFun
:= "" // Mostrar os registros com a chave ate
Local lCentered := .T. // Valor verdadeiro centraliza
Local aResource := {} // aAdd(aResource,{"IMAGEM","Texto significativo"})
Local nModelo
:= 1 // 1- Menu do aRotina
Local aPesqui
:= {} // aAdd(aPesqui{"Ttulo",nOrdem}), se no passado ser
Local cSeek
:= "" // Chave principal para a busca, exemplo: xFilial("???")
Local lDic
:= .F. // Parmetro em conjunto com aCampos
Local lSavOrd
:= .T. // Estabelecer a ordem aps pesquisas.
// Variaveis para a MsAdvSize

Local lEnchBar := .F. // Se a janela de dilogo possuir enchoicebar (.T.)
Local lPadrao
:= .F. // Se a janela deve respeitar as medidas padres do
//Protheus (.T.) ou usar o mximo disponvel (.F.)
Local nMinY
:= 400 // Altura mnima da janela
Local aSize
:= MsAdvSize(lEnchBar, lPadrao, nMinY)
Private cCadastro := " "

Private aCampos
:= {} // Se lDic=.T. utilizar o SX3, do contrrio o aCampos
//informado -> aAdd(aCampo,{X3_CAMPO,X3_PICTURE,X3_TITULO,X3_TAMANHO})
Private aRotina
:= {} // Idntico ao aRotina para mBrowse
aAdd(aRotina,{"Pesquisar" ,"AxPesqui",0,1})
aAdd(aRotina,{"Visualizar","U_TVisual",0,2})
aAdd(aRotina,{"Incluir"
,"U_TInclui",0,3})
aAdd(aRotina,{"Alterar"
,"U_TAltera",0,4})
aAdd(aRotina,{"Excluir"
,"U_TExclui",0,5})
// Estrutura do Arquivo: Nome do campo / tipo, tamanho, decimais (SX3 para
//temporrio)
AADD(aStruTRB,{"TRB_FILIAL"
,"C",02,0}) // Nome_Campo , Tipo_Campo,
//Tamanho, Decimal
AADD(aStruTRB,{"TRB_ID"
,"C",14,0})
AADD(aStruTRB,{"TRB_NOME"
,"C",20,0})
AADD(aStruTRB,{"TRB_IDADE"
,"N",03,0})
AADD(aStruTRB,{"TRB_STATUS"
,"C",01,0})
// aCampos padro para a MaWndBrowse
//AADD(aCampos,{<Nome_Campo>,<Picture>,<Titulo>,<Tamanho>})
// aCampos melhorado para a WndBrwTRB
//AADD(aCampos,{<Nome_Campo>,<Picture>,<Titulo>,<Tamanho>,<Tipo>,<cWhen>,<lObrig
//atorio>})
// Nota: lObrigatorio deve ser sempre a ultima informacao do aCampos
AADD(aCampos,{"TRB_FILIAL"
AADD(aCampos,{"TRB_ID"
AADD(aCampos,{"TRB_NOME"
AADD(aCampos,{"TRB_IDADE"
AADD(aCampos,{"TRB_STATUS"
,"@!" ,"Filial"
,"@!" ,"Matricula"
,"@!" ,"Nome"
,"@E 999","Idade"
,"@!" ,"Status"
,02,"C",".F.",.T.})
,14,"C",".F.",.T.})
,20,"C",".T.",.F.})
,03,"N",".T.",.F.})
,01,"C",".T.",.T.})
If ( Select( "TRB" ) <> 0 )

dbSelectArea ( "TRB" )
dbCloseArea ()
Endif
//
// Crio arq. de trab. p/ gravar as inconsistencias.
//
cArqTrb
:= CriaTrab(aStruTRB,.t.)
dbUseArea(.T.,,cArqTrb,"TRB",.T.,.F.)
cChave
:= "TRB_FILIAL+TRB_ID"
IndRegua("TRB",cArqTrb,cChave,,,"Selecionando Registros...")
dbSelectArea( "TRB" )
MaWndBrowse(aSize[7],aSize[2],aSize[6],aSize[5],cTitulo,cAlias,aCampos,aRotina,,
cTopFun,cBotFun,lCentered,,nModelo,,cSeek,lDic,lSavOrd)
If ( Select( "TRB" ) <> 0 )
dbSelectArea ( "TRB" )
dbCloseArea ()
Endif
Return
38.1.1.
Enchoice para Arquivos Temporrios
Para aproveitar inteiramente o recurso da MaWndBrowse utilizada com arquivos

temporrios, necessrio implementar uma funo do tipo Enchoice para realizar as
operaes de Visualizar, Incluir, Alterar e Excluir os registros deste arquivo / tabela.
Com foco nesta necessidade, foi desenvolvida para o curso de ADVPL a funo
TEnchoice.
Descrio: Funo para manipulao de registros de um arquivo temporrio simular a

Enchoice do ambiente Protheus.
Sintaxe: TEnchoice(oDlg, aCampos, nLeftE, nTopE, nHeightE, nWidthE, lEnchBar)
Parmetros:
oDlg
aCampos
nLeftE
nTopE
nHeightE
nWidthE
lEnchBar
Objeto Dialog no qual a TEnchoice ser vinculada

Estrutura de campos para exibio da tela da TEnchoice
Altura em pixels
Largura em pixels.
Se a enchoice ser montada em conjunto com uma barra de
botes do tipo Enchoicebar()
Pr-requisitos da funo chamadora:

Para correta utilizao da funo TEnchoice so necessrios os seguintes tratamentos /
definies na funo chamadora:
Tratamento 01: Montagem do array aCampos
O array aCampos utilizado pela TEnchoice possui basicamente o mesmo formato do
array utilizado pela funo Modelo2().
"<Variavel>"
{nLinha,nColuna}
"<Titulo>"
"<Picture>"
"<Validacao>"
"<F3>"
Nome da varivel Private que est vinculada ao campo

digitvel.
Posio em pixels do campo na Enchoice.
Ttulo do campo.
Picture de formatao do campo.
Validao do campo digitvel.
Consulta F3 vinculada ao campo.
"<lWhen>"
<Tamanho>
AADD(aCposEnch,
Se o campo est editvel.

Tamanho do campo para visualizao.
{"<Variavel>"
,{nLinha,nColuna} ,"<Titulo>",;
"<Picture>", "<Validacao>", "<F3>", "<lWhen>",;
<Tamanho>})
Tratamento 02: Definio das dimenses da TEnchoice

Os parmetros de dimenso da TEnchoice no precisam se informados, pois ela ir se
ajustar ao tamanho do objeto Dialog ao qual for vinculado, caso o objetivo seja que a
TEnchoice ocupe toda a rea disponvel do objeto.
importante especificar se o Dialog ir conter uma EnchoiceBar() para que a
TEnchoice() seja posicionada adequadamente no objeto.
Aparncia:
Detalhamento da funo TEnchoice:

/*/
+----------------------------------------------------------------------| Funo
| TEnchoice
|
+----------------------------------------------------------------------| Descrio | Enchoice para arquivos temporarios
|
+----------------------------------------------------------------------| Uso
| Curso ADVPL
|
+----------------------------------------------------------------------/*/
Static Function TEnchoice(oDlg, aCampos, nLeftE, nTopE, nHeightE, nWidthE,;
lEnchBar)
Local
Local
Local
Local
Local
Local
Local
Local
Local
Local
Local
Local
Local
Local
aSays
aGets
cCaption
cPict
cValid
cF3
cWhen
cBlKSay
cBlkGet
cBlKVld
cBlKWhen
nLeft
nTop
nI
:=
:=
:=
:=
:=
:=
:=
:=
:=
:=
:=
:=
:=
:=
{}
{}
""
""
""
""
""
""
""
""
""
0
0
0
Default lEnchBar := .F.

Default
nLeftE
:= IIF(lEnchBar,(oDlg:nLeft)+16,2)
Default
nTopE
:= 2
Default
nHeightE
:= (oDlg:nHeight)-135
Default nWidthE
:= (oDlg:nWidth)-102
// Padrao Modelo2(), com lWhen -> cWhen
// AADD(aC,{"<Variavel>"
,{nLinha,nColuna}
//,"<Titulo>","<Picture>","<Validacao>","<F3>","<lWhen>",<Tamanho>})
If Len(aCampos) > 0
oScroll := TScrollBox():New(oDlg, nLeftE, nTopE, nHeightE , nWidthE, .T.,;
.T., .T.)
For nI:=1 to Len(aCampos)
If Len(aCampos[nI])==8
cCampo
:= aCampos[nI,1]
nLeft := aCampos[nI,2,1]-13
nTop := aCampos[nI,2,2]
cCaption:= Iif(Empty(aCampos[nI,3]), " "
cPict := Iif(Empty(aCampos[nI,4]), Nil
cValid
:= Iif(Empty(aCampos[nI,5]),
cF3
cWhen := Iif(Empty(aCampos[nI,7]), ".T."
nWidthG
,aCampos[nI,3])
,aCampos[nI,4])
".t." ,aCampos[nI,5])
NIL
,aCampos[nI,6])
,aCampos[nI,7])
:= Iif(Empty(aCampos[nI,8]), 100,;
IiF(aCampos[nI,8]*3.5 > 100,100,nil))
cBlKSay := "{|| OemToAnsi('"+cCaption+"')}"

cBlkGet := "{ | u | If( PCount() == 0,;
"+cCampo+","+cCampo+":= u ) }"
cBlKVld := "{|| "+cValid+"}"
cBlKWhen := "{|| "+cWhen+"}"
AADD(aSays,Array(1))
aSays[nI] := TSay():New(nLeft+1, nTop, &(cBlkSay), oScroll,,,;
.F., .F., .F., .T.,,, 50, 8, .F., .F., .F., .F.,;
.F. )
AADD(aGets,Array(1))
aGets[nI] := TGet():New( nLeft, nTop+50, &(cBlKGet), oScroll,;
nWidthG, 11, cPict, &(cBlkVld),,,, .F.,, .T.,,;
.F., &(cBlkWhen), .F., .F.,, .F., .F. , cF3,;
(cCampo))
EndIf
Next
Endif
Return
Exemplo: Funo TVisual ( MaWndBrowse com TEnchoice)
/*/
+----------------------------------------------------------------------| Funo
| TVisual
|
|
+----------------------------------------------------------------------| Uso
| Curso ADVPL
|
+----------------------------------------------------------------------/*/
USER FUNCTION TVisual(cAlias,nReg,nOpc)
LOCAL
LOCAL
LOCAL
LOCAL
LOCAL
LOCAL
LOCAL
aCposEnch := {}
nLinha
:= 15
nColuna
:= 10
nOpcE
:= aRotina[nOpc][4] // Opcao de verdade
bOk
:= {||oDlg:End()}
bCancel
:= {||oDlg:End()}
nX

// AADD(aCposEnch,{"<Variavel>"
,{nLinha,nColuna}
// aCampos,{"TRB_FILIAL"
,"@!" ,"Filial"
,02}
For nX := 1 to Len(aCampos)
If nX > 1
nLinha := IIF(nX%2 > 0 ,nLinha := nLinha +015,nLinha) // Impar
nColuna := IIF(nX%2 == 0,nColuna := nColuna+170,10)// Par
Endif
AADD(aCposEnch,{"_"+aCampos[nX][1],{nLinha,nColuna} ,;
aCampos[nX][3],aCampos[nX][2],"AllwaysTrue()",;
"",".F.",aCampos[nX][4]})
SetPrvt("_"+aCampos[nX][1])
&("_"+aCampos[nX][1]) := (cAlias)->&(aCampos[nX][1])
Next nX
oDlg := TDialog():New(000,000,400,650,cCadastro,,,,,,,,,.T.)
TEnchoice(oDlg, aCposEnch,,,,,.T.)
oDlg:bInit := {|| EnchoiceBar(oDlg, bOk, bCancel,.F.,{},nReg,cAlias)}
oDlg:Activate()
RETURN
Exemplo: Funo TInclui ( MaWndBrowse com TEnchoice)
/*/
+----------------------------------------------------------------------| Funo
| TInclui
|
|
+----------------------------------------------------------------------| Uso
| Curso ADVPL
|
+----------------------------------------------------------------------/*/
USER FUNCTION TInclui(cAlias,nReg,nOpc)
LOCAL
LOCAL
LOCAL
LOCAL
LOCAL
LOCAL
LOCAL
LOCAL
aCposEnch := {}
nLinha
:= 15
nColuna
:= 10
nOpcE
bOk
bCancel
:= {||oDlg:End()}
aArea
:= GetArea()
nX

,{nLinha,nColuna}
,"@!" ,"Filial"
,02}
If nX > 1
Endif
"",".T.",aCampos[nX][4]})
Do Case
Case aCampos[nX][5] == "C"
&("_"+aCampos[nX][1])
Case aCampos[nX][5] == "N"
Case aCampos[nX][5] == "D"
Case aCampos[nX][5] == "L"
Case aCampos[nX][5] == "M"
EndCase
:= Space(aCampos[nX][4])
:= 0
:= CTOD("")
:= .F.
Next nX
bOk := {|| IIF( U_TValid(cAlias,nReg,nOpcE,aCampos),;
(U_TGravar(cAlias,nReg,nOpcE,aCampos),oDlg:End()),)}
oDlg:Activate()
RETURN
Exemplo: Funo TAltera ( MaWndBrowse com TEnchoice)
/*/
+----------------------------------------------------------------------| Funo
| TAltera
|
|
+----------------------------------------------------------------------| Uso
| Curso ADVPL
|
+----------------------------------------------------------------------/*/
USER FUNCTION TAltera(cAlias,nReg,nOpc)
LOCAL
LOCAL
LOCAL
LOCAL
LOCAL
LOCAL
LOCAL
LOCAL
aCposEnch := {}
nLinha
:= 15
nColuna
:= 10
nOpcE
bOk
bCancel
:= {||oDlg:End()}
aArea
:= GetArea()
nX

,{nLinha,nColuna}
,"@!" ,"Filial"
,02}
If nX > 1
Endif
"",aCampos[nX][6],aCampos[nX][4]})
Next nX
oDlg:Activate()
RETURN
Exemplo: Funo TExclui ( MaWndBrowse com TEnchoice)
/*/
+----------------------------------------------------------------------| Funo
| TExclui
|
|
+----------------------------------------------------------------------| Uso
| Curso ADVPL
|
+----------------------------------------------------------------------/*/
USER FUNCTION TExclui(cAlias, nReg, nOpc)
LOCAL
LOCAL
LOCAL
LOCAL
LOCAL
LOCAL
LOCAL
aCposEnch := {}
nLinha
:= 15
nColuna
:= 10
nOpcE
bOk
bCancel
:= {||oDlg:End()}
nX

,{nLinha,nColuna}
,"@!" ,"Filial"
,02}
If nX > 1
Endif
Next nX
oDlg:Activate()
RETURN
Exemplo: Funo TValid ( MaWndBrowse com TEnchoice)
/*/
+----------------------------------------------------------------------| Funo
| TValid
|
|
+----------------------------------------------------------------------| Uso
| Curso ADVPL
|
+----------------------------------------------------------------------/*/
USER FUNCTION TValid(cAlias,nReg,nOpc,aCampos)
LOCAL lRet
LOCAL nX
LOCAL nPosObrig := Len(aCampos[1])
IF aCampos[nX,nPosObrig] == .T.
IF !(lRet := !Empty(&("_"+aCampos[nX,1])))
Help("TEnchoice",1,"HELP","OBRIGATORIO","Existem campos
obrigatorios nao preenchidos",1,0)
RETURN lRet // EXIT
ENDIF
ENDIF
Next nX
IF nOpc == 3
IF !(lRet := !((cAlias)->(dbSeek(_TRB_FILIAL+_TRB_ID))))
Help("TEnchoice",1,"HELP","INCLUSAO","Ja existe um registro com esta
chave",1,0)
ENDIF
ELSE
IF !(lRet := (cAlias)->(dbSeek(_TRB_FILIAL+_TRB_ID)))
Help("TEnchoice",1,"HELP","ALTERACAO","Nao existe um registro com
esta chave",1,0)
ENDIF
ENDIF
RETURN lRet
Exemplo: Funo TGravar ( MaWndBrowse com TEnchoice)
/*/
+----------------------------------------------------------------------| Funo
| TGravar
|
|
+----------------------------------------------------------------------| Uso
| Curso ADVPL
|
+----------------------------------------------------------------------/*/
USER FUNCTION TGravar(cAlias,nReg,nOpc,aCampos)
LOCAL nX
RecLock(cAlias,nOpc==3)
IF nOpc == 5
DbDelete()
ELSE
(cAlias)->&(aCampos[nX][1]) := &("_"+aCampos[nX][1])
Next nX
ENDIF
Msunlock()
RETURN
38.2. DbTree()
Descrio: Classe Advpl que permite a criao de um objeto visual do tipo Tree.
Propriedades:
bChange
Armazena o code-block executado quando da mudana de

foco entre elementos do Tree atual.
Mtodos principais:
New
Contrutor da Classe DbTree.

Retorna uma nova instncia do Objeto da Classe DbTree.
Atravs do mtodo AddTree, possvel acrescentar um 'n'
na rvore atual.
AddTree
Uma vez acrescentado o n, as prximas incluses de itens

na parvore sero realizadas neste n, at que o mesmo
seja fechado atravs do mtodo EndTree.
AddTreeItem
Atravs dele, podemos acrescentar itens na rvore atual ou

ltimo n acrescentado em aberto.
EndTree
Deve ser utilizado aps todos os elementos e itens serem

acrescentados a um n da rvore, aberto com o mtodo
AddTree().
Aparncia:
Mtodo: New()
Sintaxe: DbTree():New ( [ nTop ] , [ nLeft ] , [ nBottom ] , [ nRight ] , [oWnd] ,

[ bchange ] , [ bRClick ] , [ lCargo ] , [ lDisable ] )
Parmetros:
nTop
nLeft
nBottom
nRight
oWnd
bchange
bRClick
lCargo
lDisable
Coordenada vertical superior do Objeto.

Coordenada horizontal esquerda do Objeto.
Coordenada vertical inferior do Objeto.
Coordenada horizontal direita do Objeto.
Janela pai do Objeto Tree
Code-Block contendo a ao a ser edxecutada na mudana
de foco enrte os elementos da rvore.
Code-Block a ser executado quando pressionado o boto
direito do Mouse sobre um elemento da rvoew.
Se .T., indica que os elementos do Tree utilizaro a
propriedade CARGO, capaz de armazenar uma string
identificadora, fornecida na montagem para cada elemento
e item da rvore.
Se .T., cria o objeto do Tree desabilitado, no permitindo
foco e navegao no mesmo qneuando ele no seja
habilitado.
Retorno:
Objeto
Retorna uma nova instncia do Objeto da Classe DbTree.
Mtodo: AddTree()
Sintaxe: oObj:AddTree ( < cLabel > , [ lPar02 ] , [ cResOpen ] , [ cResClose ] ,

[ cBMPOpen ] , [ cBMPClose ] , [ cCargo ] )
Parmetros:
cLabel
lPar02
cResOpen
cResClose
cBMPOpen
cBMPClose
Ttulo do "n" da rvore a ser acrescentado.

(reservado)
Resource do RPO a ser utilizado quando o n estiver
aberto.
Resource do RPO (bitmap) a ser utilizado quando o n
estiver fechado.
Path + Imagem bitmap a ser utilizada quando o n[o estiver
aberto.
A especificao de imagens a partir dos parametros
cBMPOpen e cBMPClose apenas ser considerada caso os
parmetros cResOpen e cResClose no forem
especificados.
Path + Imagem bitmap a ser utilizada quando o n estiver
fechado.
A especificao de imagens a partir dos parametros
cBMPOpen e cBMPClose apenas ser considerada caso os
cCargo
parmetros cResOpen e cResClose no forem

especificados.
String com valor nico, fornecido para identificar o n
atual. Pode ser recuperado posteriormente durante a
navegao.
Retorno:
Nenhum
Mtodo: AddTreeItem()
Sintaxe: oObj:AddTreeItem ( <cLabel> , [cResource] , [cBitMap] , [cCargo] )
Parmetros:
cLabel
cResource
cBitMap
cCargo
Ttulo do item da rvore.

Resource (BMP) do repositrio, a ser mostrado esquerda
do ttulo do item.
Arquivo de imagem (bitmap) a ser mostrado esquerda do
ttulo do item.
Este parm,etro apenas ser considerado caso o parmetro
cResource no for informado.
atravs dele, podemos especificar uma string de
identificao para este item na rvore.
Retorno:
Nenhum
Mtodo: EndTree()
Sintaxe: oObj:EndTree ( )
Parmetros:
Nenhum
Retorno:
Nenhum
Exemplo:
#include "Protheus.ch"
/*/
+----------------------------------------------------------------------| Funo
| TDBTree
| Autor | MICROSIGA
| Data |
|
+----------------------------------------------------------------------| Descrio | Exemplo de utilizao da funo DbTree
|
+----------------------------------------------------------------------| Uso
| Curso ADVPL
|
+----------------------------------------------------------------------/*/
User Function TDBTree()
Local cBmp1 := "PMSEDT3"
Local cBmp2 := "PMSDOC"
Private cCadastro := "Meu Computador"
Private oDlg
Private oDBTree
oDBTree := dbTree():New(10,10,95,240,oDlg,{|| U_Proc(oDBTree:GetCargo())},;
,.T.)
oDBTree:AddTree("Pentium 4"+Space(24),.T.,cBmp1,cBmp1,,,"1.0")
oDBTree:AddTreeItem("Gabinete",cBmp2,,"1.1")
oDBTree:AddTreeItem("Monitor" ,cBmp2,,"1.2")
oDBTree:AddTreeItem("Teclado" ,cBmp2,,"1.3")
oDBTree:AddTreeItem("Mouse",cBmp2,,"1.4")
oDBTree:AddTreeItem("Som",cBmp2,,"1.5")
oDBTree:AddTree("Placa Me",.T.,cBmp1,cBmp1,,,"2.0")
oDBTree:AddTreeItem("Processador",cBmp2,,"2.1")
oDBTree:AddTreeItem("Memria" ,cBmp2,,"2.2")
oDBTree:AddTreeItem("Vdeo",cBmp2,,"2.3")
oDBTree:AddTreeItem("Fonte",cBmp2,,"2.4")
oDBTree:EndTree()
oDBTree:EndTree()
Return
User Function Proc(cCargo)

Local cRet := ""
If
cCargo == "1.1"
MsgInfo("Gabinete Torre com 4 baias - Preto, com unidade de leitura e+;
gravao de CD/DVD",cCadastro)
Elseif cCargo == "1.2"
MsgInfo("Monitor LCD 17' - LG",cCadastro)
MsgInfo("Teclado multimdia com funes de internet e e-mail",cCadastro)
MsgInfo("Mouse Optico sem fio",cCadastro)
MsgInfo("2 Caixas de Som - 50W RMS Cada",cCadastro)
MsgInfo("Processador Pentium 4 - 3.8 Ghz",cCadastro)
MsgInfo("1 Pente de Memria de 1Gb - DDR 500",cCadastro)
MsgInfo("Placa de Vdeo GeoForce 5000 com 256Mb",cCadastro)
MsgInfo("Fonte de Alimentao de 500W",cCadastro)
Endif
Return
38.3. MsSelect()
Descrio: A classe MsSelect cria um objeto browse (ou grid), com a primeira coluna
sendo do tipo marcao.
Propriedades:
oWnd
oBrowse
Mtodos principais:
New
Objeto pai da MsSelect (MSDIALOG, MSWINDOW,

MSPANEL)
Objeto browse (ou grid) da MsSelect, herdado da classe
TCBROWSE
Contrutor da Classe MsSelect.

Retorna uma nova instncia do Objeto da Classe MsSelect.
Aparncia:
Mtodo: New()
Sintaxe: MsSelect():NEW ( < cAlias > , [ cCampo ] , [ cCpo ] , [ aCampos ] , [

lInv ] , [ cMar ] , [ aCord ] , [ cTopFun ] , [ cBotFun ] , [ oWnd ] , [
reserved ] , [ aColors ] )
Parmetros:
cAlias
cCampo
cCpo
aCampos
lInv
cMar
aCord
cTopFun
cBotFun
oWnd
reserved
aColors
Tabela que ser utilizada pela MsSelect

Campo que ser utilizado na coluna de marcao
Campo da tabela informada pelo parametro cAlias ou
funo que ser executada na apresentao da coluna que
indica se a linha da MsSelect esta habilitada ou no
Vetor com informaes dos campos para criao das
colunas da MsSelect. Se no for informado, a MsSelect ir
criar as colunas baseado no Dicionrio de Campos (SX3) da
tabela informada no parametro cAlias.
Formato:
1 - campo ou bloc de cdigo com contedo que ser
apresentado na coluna pela MsSelect
2 - no utilizado
3 - cabealho
4 - mcara de apresentao (picture)
Indica se MsSelect ir utilizar marcao invertida
Marca que ser utilizada pela MsSelect para controle do
campo informado pelo parametro cCampo. Para utilizar o
parametro cMar, utilize a funo GetMark para retornar a
prxima marca.
Coordenadas para criao da MsSelect.
Formato:
1 - Linha inicial
2 - Coluna inicial
3 - Linha final
4 - Coluna final
Funo que retornar o contedo inicial que a MsSelect
utilizar para apresentar a primeira linha da tabela, como
um range, junto com o parametro cBotFun.
O contedo retornado ser utilizado para fazer o
posicionamento da tabela informada pelo parametro cAlias,
baseado na chave de ndice posicionada para a mesma.
Funo que retornar o contedo final que a MsSelect
utilizar para apresentar a ltima linha da tabela, como um
range, junto com o parametro cTopFun.
O contedo retornado ser utilizado para o posicionamento
final da tabela informada pelo parametro cAlias, baseado
na chave de ndice posicionada para a mesma
Objeto pai da MsSelect (MSDIALOG, MSWINDOW,
MSPANEL, etc.)
Parametro reservado
Vetor com regras para a apresentao da coluna de
legenda.
Formato:
1 - Expresso ADVPL com retorno lgico que indica se a
cor ser utilizada pela coluna
2 - cor da coluna:
BR_AMARELO
BR_AZUL
BR_BRANCO
BR_CINZA
BR_LARANJA
BR_MARROM
BR_PINK
BR_PRETO
BR_VERDE
BR_VERMELHO
Retorno:
Objeto
Retorna uma nova instncia do Objeto da Classe MsSelect.
Exemplo:
DEFINE MSDIALOG oDlg1 TITLE "Selecao para Transferencia" From 9,0 To 32,80;
OF oMainWnd
@1.4,.8 Say "Valor Total:"
@1.4, 7 Say oValor
VAR nValor Picture "@E 999,999,999,999.99"
@1.9,.8 Say "Quantidade:"
@1.9, 9 Say oQtda
VAR nQtdBem Picture "@E 99999" SIZE 50,10
@1.4,15 Say Iif(MVParBox01==1,;
"Somente grupos de ["+MVParBox02+"] ate ["+MVParBox03+"]","")
If cTipoDet == "D"
@12.4,01 Say "Qtde. a Detalhar"
@158,60 MSGET nQtde Picture "@E 999" SIZE 036, 10 OF oDlg PIXEL;
VALID nQtde > 0
ElseIf cTipoDet == "P"
@12.4,01 Say oLabel Var cLabel := "Tipo de Projeto"
oRad := TRadMenu():New(169,005,{"Industrial","Florestal"},;
bSetGet(nOpcRad),oDlg,,{|| AF250RAD(nOpcRad)},,,,,,100,12,,,,.T.)
@15.5,01 Say oLabel2 Var cLabel2 := "Detalhamento:"
oRad2 := TRadMenu():New(210,005,{"Manter","Alterar"},;
bSetGet(nOpcRad2),oDlg,,{|| AF250RAD2(nOpcRad2)},,,,,,;
100,12,,,,.T.)
@16.4,01 Say oLabel3 Var cLabel3 := "Percentual"
oGet := TGet():New(210,043,bSetGet(nPerc),oDlg,030,010,;
"@E 999.99",,,,,,,.T.)
@18.2,01 Say oLabel4 Var cLabel4 := "Qtde. Det."
oGet2 := TGet():New(235,040,bSetGet(nQtde),oDlg,030,010,;
"@E 999",,,,,,,.T.)
oGet:Hide()
oGet2:Hide()
oLabel3:Hide()
oLabel4:Hide()
EndIf
oMark := MsSelect():New("SN3","N3_OK","!N3_BAIXA",,@lInverte,;
@cMarca,{35,1,143,315})
oMark:bMark := {| | a250Display(cMarca,lInverte,oValor,oQtda)}
ACTIVATE MSDIALOG oDlg1
ON INIT EnchoiceBar(oDlg1,;
{|| nOpct:=1,iif(DeParaEnt(),oDlg1:End(),.f.)},{|| nOpct:=2,oDlg1:End()})
39.
Introduo relatrios grficos
39.1. TReport()
39.1.1.
Introduo
Finalidade
O Protheus oferece o recurso personalizao para alguns relatrios de cadastros e
movimentaes do sistema. Ele tem como principais funcionalidades a definio de cores,
estilos, tamanho, fontes, quebras, mscara das clulas para cada seo, criao de frmulas e
funes (Soma, Mdia, etc.), possibilidade de salvar as configuraes por usurio e criao de
grficos.
Com a funcionalidade de Relatrios Personalizveis, o usurio pode modificar os relatrios
padres, criando seu prprio layout.
Vale lembrar que nem todos os relatrios so personalizveis. Por exemplo, relatrios que
tenham layout pr-definidos por lei e formulrios (boletos, notas-fiscais, etc) no podero ser
alterados.
Os relatrios personalizados so gravados com extenso .PRT, diferenciando-se dos relatrios
padres que recebem a extenso .##R.
Descrio
O TReport uma classe de impresso que substitui as funes SetPrint, SetDefault,
RptStatus e Cabec.
A classe TReport permite que o usurio personalize as informaes que sero apresentadas no
relatrio, alterando fonte (tipo, tamanho, etc), cor, tipo de linhas, cabealho, rodap, etc.
Estrutura do componente TReport:
O relatrio (TReport) contm 1 ou mais sees (TRSection);

Uma seo (TRSection) pode conter 1 ou mais sees;
A seo (TRSection) contm clulas pr-definidas e clulas selecionadas pelo usurio;
A seo (TRSection) tambm contm as quebras (TRBreak) para impresso de
totalizadores (TRFunction);
Os totalizadores so includos pela seo que automaticamente inclui no relatrio
(TReport).
Pr-Requisitos
Para utilizar o TReport, verifique se o seu repositrio est com o Release 4 do Protheus-8, ou
verso superior.
A funo TRepInUse() verifica se a lib do TReport est liberada no repositrio em uso. O
retorno uma varivel lgica.
User Function MyReport()
Local oReport
If TRepInUse()
//verifica se a opo relatrios personalizveis est
disponvel
Pergunte("MTR025",.F.)
oReport := ReportDef()
oReport:PrintDialog()
EndIf
Return
Verifique tambm o parmetro MV_TReport. Para utilizar os relatrios personalizveis, o
parmetro MV_TREPORT (tipo numrico) deve ser alterado no ambiente Configurador,
conforme uma das opes que seguem:
1 = utiliza relatrio no formato tradicional (antigo);
2 = utiliza relatrio personalizvel;
3 = pergunta qual relatrio ser utilizado: tradicional (antigo) ou personalizvel.
39.1.2.
Impresso do relatrio personalizvel
Cada componente da tela de impresso do TReport, deve ser configurado no programa, para
que o usurio tenha acesso s personalizaes:
39.1.2.1.
Parmetros de impresso
A caixa de listagem apresentada deve ser utilizada conforme o meio de sada do relatrio. Veja
a seguir.
Impresso
Arquivo
O relatrio ser gravado em disco com o nome apresentado. Caso seja escolhida a opo
"Servidor" ele ser gravado no diretrio determinado na senha do usurio, atravs do
configurador, sendo este sempre no servidor (padro \SPOOL\). Na escolha da opo "Local"
ser aberta uma janela para que seja escolhido o local onde o relatrio ser gravado na
mquina do usurio.
O relatrio gerado a partir desta opo pode ser impresso ou enviado por e-mail aps ser
apresentado na tela.
Spool
Direciona o relatrio para impresso via configurao do Windows das impressoras
instaladas.
E-mail
Envia o relatrio por e-mail (Internet). Para isto, devem ser configurados os seguintes
parmetros no Ambiente Configurador:
MV_RELACNT
Define a conta de e-mail para identificar
Exemplo: relprotheus@microsiga.com.br
provenincia
dos
relatrios.
do
relatrio.
MV_RELPSW
Define a senha da conta de e-mail para envio dos relatrios.
MV_RELSERV
Define
o
servidor
da
conta
Exemplo: smtp.microsiga.com.br
de
e-mail
para
envio
Quando selecionada esta opo, deve-se informar, no campo em destaque na figura abaixo, o
e-mail para o qual o relatrio deve ser remetido.
Programao TelNet
Papel
Tamanho do papel
Selecione o tamanho do papel em que o relatrio ser impresso.
As especificaes de tamanho do papel so as do padro do mercado,

conforme o formato escolhido, o Protheus ir ajustar a impresso.
Formato da impresso
Selecione o formato de impresso, clicando nos botes de opo Retrato ou Paisagem,
fazendo assim que o relatrio seja impresso na orientao vertical ou horizontal,
respectivamente.
Configuraes
Ttulo
Caso queira alterar a opo sugerida pelo sistema, digite o cabealho do relatrio.
Ordem
Escolha a ordem em que as informaes sero apresentadas no relatrio, clicando em uma das
chaves disponveis.
Layout
Permite selecionar o modelo de relatrio para impresso, medida que novos leiautes forem
gravados para um relatrio, seus nomes sero listados nessa caixa.
Preview
Faz a exibio do relatrio gerado na tela, possibilitando, na seqncia, o seu envio para
impressora ou a cancelamento da impresso.
Executar em segundo plano

Essa opo permite que o relatrio seja gerado e enviado para a fila de impresso, enquanto o
usurio pode executar outras tarefas no sistema.
39.1.3.
Personalizao
possvel configurar-se as colunas do lay-out do relatrio, bem como os acumuladores,

cabealhos e linhas.
Esto disponveis para personalizao tambm a fonte, tamanho, cores, e etc.
39.1.3.1.
Editando o layout do relatrio
O primeiro passo entender a nova estrutura dos relatrios desenvolvidos com a ferramenta
TReport.
O Relatrio possui Sees e Clulas. chamada de Seo, cada um dos grupos de
informaes, e de Clula, cada um dos campos que sero impressos.
Nova estrutura do relatrio TReport:
O relatrio mais simples que se consegue emitir em TReport, uma listagem.
39.1.4.
Definindo a Funo ReportDef()
A funo ReportDef() responsvel pela construo do lay-out do relatrio (oReport). ela

quem define as colunas, os campos e as informaes que sero impressas.
Os comandos que far essa construo so:
1. DEFINE REPORT
2. DEFINE SECTION
3. DEFINE CELL
DEFINE REPORT
A funo DEFINE REPORT responsvel pela criao do objeto Report, ou seja, o relatrio.
Internamente, o DEFINE REPORT ir executar o mtodo TReport():New().
Estrutura do componente TReport:
O relatrio (TReport) contm 1 ou mais sees (TRSection);
Uma seo (TRSection) pode conter 1 ou mais sees;
A seo (TRSection) contm clulas pr-definidas e clulas selecionadas pelo usurio;
A seo (TRSection) tambm contm as quebras (TRBreak) para impresso de
totalizadores (TRFunction);
Os totalizadores so includos pela seo que automaticamente inclui no relatrio
(TReport).
DEFINE SECTION
Ainda no ReportDef(), so definidas as sees (oSection) do relatrio.
As sees do relatrio representam os diferentes grupos de informaes exibidos.
H a seo principal e as especficas.
Internamente, o DEFINE SECTION ir executar o mtodo TRSection():New().
A classe TRSection pode ser entendida como um layout do relatrio, por conter clulas,
quebras e totalizadores que daro um formato para sua impresso.
Com a classe TRSection possvel definir uma query, filtro ou ndice com filtro (IndRegua) que
ser utilizada por ela para processamento do relatrio, atravs do mtodo Print e utilizando as
clulas de posicionamento (TRPosition).
DEFINE CELL
Para cada seo, devem ser definidas as clulas. Clula cada informao que dever ser
impressa. Pode ser um campo do cadastro, ou um resultado de uma operao. uma Clula
de impresso de uma seo (TRSection) de um relatrio que utiliza a classe TReport
Internamente, o DEFINE CELL ir executar o mtodo TRCell():New ().
MDULO 08: Aplicaes ADVPL para o ERP

40.
Protheus e o TOPCONNECT / TOTVS DbAccess
O TOTVSDBAccess uma ferramenta de conectividade a bases de dados, permitindo que

aplicativos acessem uma ampla variedade de servidores de banco de dados sem a necessidade
de gerao de cdigos especficos para cada uma delas.
Os bancos de dados hoje suportados pelo TOTVSDBAccess so:
Microsoft SQL7 ou superior
Oracle 8 ou superior
IBM Universal Database (DB2)
Informix
Sybase Adaptive Server
Postgres 7.1.1 ou superior
MySQL
O TOTVSDBAccess permite gerenciar as informaes pertinentes utilizao do banco de
dados, registrando e apresentado dados, como:
Dados estatsticos de forma grfica com relao :
Quantidade de usurios conectados
Quantidade de tabelas em utilizao
IOs por segundo
Mximo de IOs por segundo
Relao dos usurios conectados
Checagem das querys geradas pelos usurios conectados
Quebra de conexo do usurio
Mensagens de utilizao do TOTVSDBAccess
Configuraes Gerais quanto a:
Banco de dados em utilizao
Relao de usurios e senhas por banco de dados
Logins de usurio
Configurao de "Table Spaces" para determinados bancos de dados
Definio dos parmetros de criao de tabelas para determinados bancos de dados
Validao de conexo, checando os parmetros de conexo com o banco de dados
Monitoramento de ndices gerados
40.1. Caractersticas tcnicas com o uso do TOTVS DbAccess

Comportamento de Queries Colunas Calculadas
Aps enviar ao Banco de Dados uma solicitao de abertura de Query, em caso de sucesso na
operao, o TOPConnect obtm do Banco de Dados a quantidade de colunas que sero
retornadas, e qual o tamanho e tipo e especificaes de cada uma das colunas, para retornar
ao Protheus uma estrutura definida de informaes, e o cursor aberto lido conforme so
solicitados os prximos registros ( DBSkip() no Advpl ), e a cada requisio, uma linha do
cursor retornada, at no haver mais linhas no cursor, atingindo o final do arquivo no Advpl (
EOF() ).
Quando especificamos uma coluna de retorno na Query, que corresponde a informaes lidas
diretamente de uma ou mais coluna(s) da tabela, cada coluna retornada pela Query contm
uma definio de tipo e tamanho correspondente ao campo de origem do dado de retorno.
Deste modo, se considerarmos, por exemplo, a Query : SELECT A1_FILIAL FROM SA1990 ,
onde o campo A1_FILIAL na tabela SA1990 um campo do tipo varchar, com 2 bytes de
tamanho, quando o cursor for aberto no Banco de Dados, o TOPConnect ir obter do banco
que o result-set gerado possui apenas uma coluna, e esta coluna do tipo varchar, com no
mximo 2 bytes de tamanho.
Os Bancos de Dados no apenas permitem recuperar retornos diretamente lidos de uma ou
mais tabelas, mas tambm possvel abrir um cursor onde uma ou mais colunas contenham
um resultado calculado, utilizando-se de expresses e/ou funes nativas do Banco de Dados.
Para estes tipos de retorno, cada banco de dados pode apresentar comportamentos
diferenciados ao descrever o tamanho de retorno da(s) coluna(s).
Este comportamento pode variar de acordo com o Banco de Dados, a expresso e/ou funes
utilizadas para gerar a coluna de retorno, e inclusive podem ter diferenas entre verses e
Builds do mesmo Banco de Dados e/ou parametrizaes especficas do Banco de Dados e/ou
da aplicao Client / ODBC / API utilizada para acesso ao Banco.
Para ilustrar melhor estas diferenas, vejamos abaixo os resultados obtidos com queries, em
bancos distintos, onde foi criada uma tabela com a mesma estrutura, e 10 linhas de dados, e
nela foram executadas algumas querys, onde temos como retorno uma coluna calculada. A
tabela possui os campos CPOC, tipo Caractere, tamanho 10 bytes, numerados de 0000000001
a 0000000010 e um campo numrico CPON, alimentado com valores positivos. Para cada
Query, mostramos o valor retornado ao Advpl, contendo o tipo de dado retornado e o tamanho
(len) da coluna, no formato . ( Tipo ( tamanho ) ).
Query: SELECT MIN(CPOC) CPOTESTE FROM TESTRET
Retorno: Todos os bancos retornaram uma coluna com tamanho de 10 bytes.
Bancos:
Database
MSSQL 2000
INFORMIX
ORACLE
MYSQL
DB2
Tipo
Caracter
Caracter
Caracter
Caracter
Caracter
Tamanho
10
10
10
10
10
Contedo
0000000001
0000000001
0000000001
0000000001
0000000001
Query: SELECT MIN(CPOC) CPOTESTE FROM TESTRET WHERE CPON < 0
Retorno: Todos os bancos retornaram uma coluna vazia.
Bancos:
Database
MSSQL 2000
POSTGRES
INFORMIX
ORACLE
MYSQL
DB2
Tipo
Caracter
Caracter
Caracter
Caracter
Caracter
Caracter
Tamanho
10
0
10
10
10
10
Contedo
Vazio
Vazio
Vazio
Vazio
Vazio
Vazio
Query: SELECT LEFT(CPOC,5) CPOTESTE FROM TESTRET
Retorno: Todos os bancos que suportam a funo LEFT() retornaram uma coluna
de informaes, onde os 5 primeiros bytes eram '00000'.
Observaes: Os bancos retornaram que a coluna tem 5 bytes de tamanho.

Porm, o BAnco DB2 informa que a coluna tm tamanho de 4000 Bytes.
Este mesmo retorno foi obtido no DB2 quando utilizadas funes
RIGHT(), REPLACE() e REPEAT(), no banco DB2, e para o BAnco
Postgres, foi retornado o tamanho de 2000 bytes para estas funes.
Bancos:
Database
MSSQL 2000
MYSQL
DB2
Tipo
Caracter
Caracter
Caracter
Tamanho
5
5
4000
Contedo
00000
00000
00000
Query: SELECT SUBSTRING(CPOC,2,4) CPOTESTE FROM TESTRET
Retorno: Todos os bancos retornaram uma coluna de tamanho 4 bytes, exceto o

POSTGRES, que retornou tamanho de 2000 bytes.
Bancos:
Database
MSSQL 2000
POSTGRES
INFORMIX
ORACLE
MYSQL
DB2
Tipo
Caracter
Caracter
Caracter
Caracter
Caracter
Caracter
Tamanho
4
2000
4
4
4
4
Contedo
0000
0000
0000
0000
0000
0000
Devido a estas diferenas de comportamento, devemos tomar alguns cuidados ao desenvolver

aplicaes que utilizam colunas calculadas em queries. Nestes casos, deve ser utilizada uma
funo do banco de dados, para assegurar que o banco de dados retorne o tamanho de coluna
adequado ao TOPConnect / TotvsDBAccess.
Por exemplo, vejamos a query abaixo :
SELECT REPLACE(CPOC,'0','_') AS CPOTESTE FROM TESTRET
Se j de conhecimento do programador que o campo da base de dados CPOC desta tabela

tem 10 bytes de tamanho, devemos fazer um cast deste retorno, para char ou varchar, com
tamanho de 10 bytes. Dessa forma, o banco retorna o tamanho esperado da coluna para o
TOPConnect quando da abertura da query. Isto evita que espaos desnecessrios trafeguem
pela rede para atender requisio, e que este valor excedente seja usado para alimentar
uma varivel do Advpl. Vejamos como usar este recurso na query acima descrita, utilizando
uma sintaxe aceita pela maioria dos Bancos de Dados homologados :
SELECT CAST( REPLACE(CPOC,'0','_') AS VARCHAR(10)) CPOTESTE FROM TESTRET
Vale a pena salientar que, cada banco de dados possui, com pequenas variaes, uma sintaxe
para permitir o CAST de um retorno. Para maiores detalhes, a documentao do banco deve
ser consultada.
Comportamento diferenciado com Bandos de Dados PostGres
O Banco de Dados Postgres possuem um comportamento diferenciado entre os Builds do
Server do Banco, e possui uma parametrizao na configurao do ODBC que pode interferir
na maneira como os atributos das colunas de retorno de uma query so retornados.
Em verses inferiores o Postgres 8.x, as diferenas de comportamento em relao os demais
Bancos de Dados possuem um diferencial muito significativo, em praticamente todas as
funes de retorno calculado. Para estes casos, em se tratando de Postgres verses inferiores
a 8.x, a preciso de retorno da coluna corresponde ao tamanho mximo de retorno do tipo
VarChar. ( Este tamanho mximo pode ser configurado na conexo ODBC do PostgreSql, e o
valor default 65536 bytes. )
Na funo Substring(), mesmo que esteja especificado no 3. parmetro da funo, a
quantidade final limitada de Bytes, o Banco de Dados descreve esta coluna de retorno como
sendo um VarChar() com a preciso do maior valor VARCHAR() a ser retornado pelo client. Na
funo Max(), quando especificado um campo da base do tipo Char ou Varchar, temos um
comportamento semelhante.
Quando foram homologados os Bancos Postgres para uso com o ERP Microsiga e TOPConnect
4, praticamente no eram utilizadas queries com colunas calculadas nas aplicaes Advpl, e
este comportamento diferenciado no foi percebido. Conforme as rotinas foram evoluindo,
buscando mais performance atravs do uso de Queries, tornou-se perceptvel estas diferenas
operacionais.
Algumas destas diferenas operacionais foram assimiladas pelas funes do ERP, por exemplo
a ChangeQuery, que em verso atualizada (** Protheus 8 e P10, fonte aplib070.prw com data
igual ou superior a 08/03/2008) , aplicam o CAST() automaticamente para SELECT
MAX(CAMPO), quando o banco Postgres, e o campo selecionado for um campo da base de
dados, presente no Dicionrio de Campos ( SX3 ).
Para todos os efeitos, para utilizao com as verses homologadas de Postgres inferiores a
8.x, necessrio alterar a configurao de ODBC do Postgres, para limitar o retorno do tipo
VarChar para 2000 Bytes, pois o retorno do valor default ( 65536 bytes ) no suportado pelo
TOPConnect / TOTVSDBAccess. Alteramos esta configurao no arquivo .odbc.ini no linux, e/ou
no arquivo de configurao do ODBC do Postgres utilizado, inserindo na seo da conexo /
identificao do banco a chave abaixo :
MaxLongVarcharSize=2000
Atualmente est em processo de homologao as verses mais recentes (8.x) do banco

Posgres. Quando homologado, a informao estar disponivel na DEM, em Principal -> Guia de
Referncia -> Guia de Plataformas Homologadas -> Bancos de Dados Relacional X S.O.
Conceito de ndices Permanentes e Diferenas das RDDs
Na RDD TOPCONN, no temos o conceito de criao de ndice temporrio, apenas ndice
permanente. Um ndice permanente criado fisicamente no Banco de Dados relacional
utilizado, atravs do TOPConnect / DbAccess, onde devemos especificar um ou mais campos
para compor a chave / expresso de ndice.
Quando utilizamos CodeBase/DBF, podemos especificar como campos de chave de ndice o
retorno de funes, como por exemplo STR(), DTOS(), SUBSTR(), entre outras suportadas de
modo nativo pela aplicao provedora de acesso, no caso ADS Local e/ou ADS Server.
Quando usamos um Banco Relacional SGDB atravs do TOPConnect / DbAccess, devemos
especificar uma expresso de chave que sempre retorne um valor Caractere, e as nicas
funes permitidas para adequaes de tipo de dado no Advpl para estas expresses de ndice
so : DTOS() e STR().
Funcionamento Interno
A expresso utilizada para a criao de um ndice permanente em Advpl, por exemplo : CPOC
+ DTOS(CPOD) + STR( CPON,10 ), quando utilizamos o RDD TOPCONN, ser ajustada para o
Banco de Dados relacional utilizado para uma expresso contendo apenas a lista de campos
desejada, na sequncia em que foi especificada, e as funes DTOS() e STR() nao so
passadas ao banco de dados, pois no existe a necessidade de converso de dados para o
Banco.
Um campo do tipo 'D' Data tratado pelo TOPConnect e gravado na tabela em questo como
um campo 'C' Caractere, de 10 bytes, no formato AAAAMMDD, e os nmeros so gravados em
um campo DOUBLE*.
Quebra de Compatibilidade com CodeBase/DBF

Os Bancos relacionais, em sua grande maioria, seno todos, suportam apenas a criao de
ndices onde sejam especificados campos fsicos da base de dados. No so suportadas
funes de converso ou transformao de dados na criao de ndices, como por exemplo
substring(), left(), entre outras. Embora alguns bancos permitam a criao de colunas
calculadas, as mesmas so 'virtuais', isto , no existem fisicamente na tabela, e tambm no
permitido o uso de colunas virtuais para a criao de ndices.
Entendemos que o RDD CodeBase / DBF, onde originalmente foi desenvolvido o ERP, nos dava
certa flexibilidade ao permitir operaes como estas, porm a um custo de processamento
mais alto, pois para cada insero ou alterao, o RDD tem que executar funes de conversao
e concatenao de strings para atualizao dos ndices que usam este recurso.
Manter o suporte a todos os indices permanentes, criados a partir de resultados de
expresses, nas verses anteriores do ERP, teramos um custo muito alto de complexidade,
performance e duplicidade de informaes nas tabelas. Seria necessrio criar colunas fsicas
nas tabelas, transparentes ao usuario, para manter copias em duplicidade de partes de colunas
agrupadas, com gatilhos do banco de dados disparados internamente em operaes de insert e
update, um mecanismo relativamente complexo de se manter, instvel para dar manuteno,
e custoso em performance para o Banco de Dados.
Partindo da premissa que, se uma determinada informao deve ser indexada para busca, ela
deve ser uma informao que ocupa exclusivamente um campo fsico da base de dados, so
evitadas as operaes constantes de concatenao e desmembramento de uma informao
agrupada, colocando cada parte da informao em seu devido espao ( campo )
definido, mesmo com o impacto gerado para alterar as aplicaes que usavam estes tipos
de ndices, os ganhos obtidos em organizao e performance foram muito significativos.
Lista dos cdigos de erro do TOPConnect / DbAccess

Quanto utilizado o TOPConnect / DbAccess para conexo e operaes com Bancos de Dados,
as ocorrncias de erro so reportadas ao Protheus informando em conjunto com o erro um
nmero menor que zero, correspondendo a um tipo de erro.
Para a maioria das ocorrncias, relacionadas ao Banco de Dados, deve-se olhar o log de erro
gravado pelo TOPConnect / DbAccess ( arquivo topconn.log ) para obter maiores detalhes
sobre a ocorrncia.
TC_NO_ERROR
NO_ROUTER_INSTALLED
NO_CONNECTION
NO_USER_SECURITY
PASSTHRU_FAILED
NO_MORE_CONNECTIONS
INVALID_TOP_KEY
INVALID_ENVIRONMENT
INVALID_FILE
UNKNOWN_FILE
EXCLUSIVE_REQUIRED
INVALID_OPERATION
INVALID_KEY_NUM
FILE_IN_USE
TOO_MANY_FILES
INVALID_NUMRECS
CALL_FAILED
COMMAND_FAILED
OVERRIDE_FAILED
QUERY_FAILED
CREATION_FAILED
OPEN_FAILED
NOT_OPENED
NO_RECORD_FOUND
END_OF_RECORDS
NO_WRITE_POSIBLE
NO_RECORD_EQUAL
UPDATE_FAILED
DELETE_FAILED
RECORD_LOCKED
FILE_LOCKED
NO_AUTORIZATION
TOO_MANY_USERS
NO_DB_CONNECTION
NO_CONN_ALLOWED
INTEGRITY_FAILURE
BUFFER_OVERFLOW
INVALID_PARAMETERS
NO_AUDIT_CONNECTION
COMM_DOSMEM_ERROR
COMM_PARTNER_ERROR
COMM_SNDSTAT_ERROR
COMM_RCVSTAT_ERROR
0
-1
-2
-4
-5
-6
-8
-9
-10
-11
-11
-13
-14
-15
-16
-17
-18
-19
-20
-21
-22
-23
-24
-25
-26
-27
-28
-29
-30
-31
-32
-33
-34
-35
-36
-37
-40
-41
-50
-58
-67
-76
-76
COMM_INITPGM_ERROR
COMM_PARAM_ERROR
COMM_PROGRAM_ERROR
COMM_INSMEM_ERROR
INVALID_BUILD
INVALID_TOPAPI
-81
-86
-88
-90
-99
-100
40.2. Funes ADVPL para TOPCONNECT / TOTVS DbAccess

Neste tpico sero descritas as funes da linguagem ADVPL que permitem a interao
com a aplicao TopConnect / DbAccess.
Lista das funes de interao com a aplicao TopConnect / DbAccess:
TCCANOPEN
TCCONTYPE
TCDELFILE
TCGENQRY
TCGETDB
TCLINK
TCQUERY
TCQUIT
TCSETCONN
TCSETFIELD
TCSPEXEC
TCSPEXIST
TCSQLERROR
TCSQLEXEC
TCSRVTYPE
TCUNLINK
TCCHKOBJ
TCEXEERROR
TCPGMEXE
TCSYSEXE
Lista das funes acessrias utilizadas nos fontes como facilitadoras:
CHANGEQUERY
RETFULLNAME
RETSQLCOND
RETSQLNAME
RETSQLTABLE
SQLCOPY
SQLORDER
SQLTOTRB
Funes de interao com o TopConnect / DbAccess

TCCANOPEN ()
Verifica a existncia de tabelas e ndices no servidor.
Sintaxe: TCCanOpen(cTable , cIndice)
Parmetros:
cTable
cIndice
Opcional, indica o nome completo do ndice referente a tabela especificada.
Retorno:
Lgico
Nome completo da tabela no banco de dados.
Indica a existncia da tabela e/ou do ndice especificado.
Exemplo:
//Verifica a existncia da tabela customer

IF !TCCanOpen("CUSTOMER")
dbCreate("CUSTOMER", aStru, "TOPCONN")
ENDIF
USE CUSTOMER SHARED NEW VIA "TOPCONN"
//Verifica a existncia do ndice
IF !TCCanOpen("CUSTOMER","CUSTCOD")
INDEX ON CODIGO TO CUSTCOD
ELSE
SET INDEX TO CUSTCOD
ENDIF
TCCONTYPE()
Especifica o protocolo de comunicao a ser utilizado pelo TOPConnect.
Sintaxe: TCConType(cType)
Parmetros:
cType
Tipo de protocolo de comunicao a ser utilizado pelo TopConnect, aonde:

TCPIP: Utiliza o protocolo TCP/IP.
NPIPE: Utiliza o protocolo Named Pipes.
APPC: Utiliza o protocolo APPC.
BRIDGE: Utiliza o utilitrio TOPBrigde para comunicao de estaes DOS
NPIPE com servidor AS/400 utilizando TCP/IP.
Retorno:
Nenhum
Exemplo:
#INCLUDE "TOPCONN.CH"
//Especifica conexo TCP/IP
TCConType("TCPIP")
//Conecta-se ao ambiente SIGAADV no Microsoft SQL-Server
TCLink("MSSQL/SIGAADV")
TCDELFILE()
Exclui uma tabela no servidor.
Sintaxe: TCDelFile(cTable)
Parmetros:
cTable
Retorno:
Nenhum
Nome completo da tabela a ser excluda.
Exemplo:
TCDelFile("CUSTOMER")
TCGENQRY()
Permite a execuo de uma query de seleo no banco de dados e retorna um recordset com o
resultado.
Sintaxe: TCGENQRY(xParam1,xParam2,cQuery)
Parmetros:
xParam1
Parmetro reservado.
xParam2
Parmetro reservado.
cQuery
Query de seleo com sintaxe no padro SQL ANSI a ser executada no banco
de dados.
Retorno:
RecordSet
RecordSet contendo o resultado da execuo da query de seleo.
Para que os dados contidos no RecordSet retornado pela funo TCGenQry()

sejam utilizados pela aplicao ADVPL necessrio disponibiliz-los em uma
WorkArea.
Desta forma a funo TCGenQry() dever ser utilizada em conjunto com a
funo DbUseArea(), para que a mesma disponibilize o RecordSet como uma
rea de trabalho do ADVPL.
Exemplo:
cQuery := "SELECT DISTINCT CV8_PROC FROM "+RETSQLNAME("CV8")

cQuery += " WHERE "
cQuery += "CV8_FILIAL = '"+MV_PAR01+"' AND "
cQuery += "D_E_L_E_T_ = '' "
cQuery += "ORDER BY CV8_PROC"
cQuery := ChangeQuery(cQuery)
dbUseArea(.T., "TOPCONN", TCGenQry(,,cQuery), "CV8QRY", .F., .T.)
TCGETDB()
Retorna o tipo de Banco de Dados corrente.
Sintaxe: TCGETDB()
Parmetros:
Nenhum
Retorno:
Caracter
Descrio referente ao tipo do banco de dados corrente, aonde:

ANYWHERE - Sybase SQL Anywhere
ANYSYBASE - Sybase SQL Anywhere (Emulando Sybase SQL-Server)
DB2 - IBM Universal Database
INFORMIX Informix
MSSQL - Microsoft SQL-Server 6.5
MSSQL7 - Microsoft SQL-Server 7.0 ou superior
ORACLE - Oracle
POSTGRES - PostGres
SYBASE - Sybase SQL-Server
Nota: O retorno da funo pode variar de acordo com a homologao de
novos databases para utilizao com a ferrramenta TopConnect / DbAccess.
Exemplo:
cDataBase := TCGETDB() // MSSQL7
TCLINK()
Abre uma conexo com o Servidor TOPConnect.
Sintaxe: TCLink(cConectString,cServer)
Parmetros:
cConectString
String composta conforme a regra:

Para TOPConnect NT : Nome do Banco de Dados / Nome do Ambiente
Para TOPConnect/400: Nome do Ambiente
cServer
Nome do servidor conforme a regra:

Para conexes NamedPipe, APPC e Brigde : O nome do servidor
TOPConnect.
Para conexes TCP/IP : O endereo IP do servidor TOPConnect
Observaes:
Para o TOPConnect NT acessando Oracle, um ambiente o nome do Alias criado
com o utilitrio SQL-Net.
Para o TOPConnect NT acessando os demais SGDB's um ambiente um System
DSN criado atravs do ODBC Data Source Administrator.
Para o TOPConnect AS/400 um ambiente uma Library criada atravs do comando
CRTTOPENV do TOPConnect.
Para informaes sobre a criao de ambientes consulte o manual de instalao do

TOPConnect.
A lista dos tipos de bancos de dados suportados pela aplicao TopConnect /
DbAccess a mesma das possibilidades de retorno da funo TCGETDB conforme
abaixo:
ANYWHERE
ANYSYBASE
DB2
INFORMIX
MSSQL
MSSQL7
ORACLE
POSTGRES
SYBASE
- Sybase SQL Anywhere

- Sybase SQL Anywhere (Emulando Sybase SQL-Server)
- IBM Universal Database
Informix
- Microsoft SQL-Server 6.5
- Microsoft SQL-Server 7.0 ou superior
- Oracle
- PostGres
- Sybase SQL-Server
Retorno:
Numrico
A funo TCLink retorna ou o nmero da conexo ou um valor negativo

contendo o cdigo do erro.
A relaes dos cdigos de erros ocorridos durante uma tentativa de conexo
est disponvel no tpico 8.1. deste material.
Exemplo:
//Conecta-se ao Microsoft SQL-Server no ambiente SIGAADV

//Protocolo Named Pipes
TCConType("NPIPE")
nCon := TCLink("MSSQL/SIGAADV","TOPSRV")
if nCon < 0 //Conexes com retorno < 0 significam erro
Alert("Falha de conexo com o TOPConnect")
endif
//Protocolo TCP/IP
TCConType("TCPIP")
//Conecta-se ao Oracle no ambiente TESTES
nCon := TCLink("ORACLE/TESTES",172.16.1.2)
//Protocolo APPC
//Conecta-se ao AS/400 no ambiente PRODUCAO
nCon := TCLink("PRODUCAO","TOP400")
TCQUERY()
Executa uma Query no servidor e coloca seu retorno em uma WorkArea.
Durante o processo de compilao, a sintaxe TCQUERY() substituda pelas
expresso:
dbUseArea(.T.,"TOPCONN",TcGenQry(,,cQuery), ALIAS ,.T.,.F.)
Esta substituio realizada conforme as definies do include TOPCONN.CH.
Desta forma recomendvel a utilizao direta da sintaxe DbUseArea() +
TcGeQry().
Sintaxe: TCQUERY cSQLExpr ALIAS cAlias NEW VIA "TOPCONN"
Parmetros:
cSQLExpr
Expresso SQL a ser enviada ao servidor.
ALIAS cAlias
Especifica um nome para a Work Area a ser aberta.
NEW
Abre a tabela <cTable> na prxima Work Area disponvel. Se esta

clausula no for especificada, <cTable> ser na Work Area corrente.
Este parmetro indica ao ADVPL que esta Work Area ser gerenciada
pelo TOPconnect.
VIA "TOPCONN"
Observaes:
A Work Area criada com o comando TCQUERY READ-ONLY, portanto no
permitido o uso de APPEND's ou REPLACE's.
O TOPConnect tem apenas um cursor para a Query executada portando apenas os
seguintes comandos so suportados em uma Work Area criada com TCQUERY:
o
o
o
o
o
GO TOP - DbGoTop()
GO BOTTOM - DbGoBottom()
SKIP - DbSkip()
Eof()
Bof()
Ao executar uma Query que retorne um ou mais valores calculados, o nome dos
campos da WorkArea sero COLUMN1, COLUMN2... COLUMNn.
Retorno:
Nenhum
Exemplo:
//Abre a tabela de Clientes em uma nova WorkArea

cQuery := "SELECT a.codigo, b.nome FROM CLIENTES a, CLIDATA b "
cQuery += "WHERE a.CODIGO = b.CODIGO ORDER BY CODIGO,NOME "
TCQUERY cQuery ALIAS CLIENTES NEW VIA "TOPCONN"
dbGoTop()
While !Eof()
ALERT(CODIGO+"|"+NOME)
dbSkip()
end
cQuery := 'SELECT SUM(VALOR),SUM(SALDO) FROM CUSTOMER'
TCQUERY cQuery NEW VIA "TOPCONN"
ALERT(CValToChar(COLUMN1)+"|"+CValToChar(COLUMN2))
// COLUMN1 - Somatoria dos valores
// COLUMN2 - Somatoria dos saldos
TCQUIT()
Encerra todas as conexes com o TOPConnect.
Sintaxe: TCQuit()
Parmetros:
Nenhum
Retorno:
Nenhum
TCSETCONN()
Seleciona a conexo ativa.
Sintaxe: TCSETCONN(nConn)
Parmetros:
nConn
Nmero da conexo
Retorno:
Nenhum
Exemplo:
// Abre conexo com o ambiente de Produo

nCon1 := TCLink("MSSQL/PRODUCAO")
if nCon1 < 0
Alert("Falha conectando ambiente de Produo")
QUIT
endif
// Abre conexo com o ambiente de Testes
nCon2 := TCLink("MSSQL/TESTES")
if nCon2 < 0 then
Alert("falha conectando ambiente de Testes")
QUIT
endif
TCSetConn(nCon1)
//Abre tabela de Clientes no ambiente de produo
USE CUSTOMER ALIAS PROD SHARED NEW VIA "TOPCONN"
TCSetConn(nCon2)
//Abre tabela de Clientes no ambiente de testes
USE CUSTOMER ALIAS TEST SHARED NEW VIA "TOPCONN"
...
TCSETFIELD()
Esta funo serve como apoio ao comando TCQUERY, na recuperao de campos tipo
NUMERIC, DATE e LOGICAL, pois os mesmos so gravados fisicamente no Banco de Dados
como caracteres, e no caso dos numricos como float.
Sintaxe: TCSetField(cAlias, cField ,cType, nTam, nDec )
Parmetros:
cAlias
Alias da WorkArea gerada pela execuo da query.
cField
Nome do campo a ser tratado
cType
Tipo desejado para o campo
nTam
Tamanho total desejado para o campo
nDec
Nmero de decimais desejado para o campo
Retorno:
Nenhum
Exemplo 01:
TCQUERY "SELECT NOME, DATA, MARRIED, VALOR FROM CUSTOMER" ALIAS QUERY VIA
"TOPCONN"
TCSetField("QUERY","DATA","D")
TCSetField("QUERY","VALOR","N",12,2)
Dentro de um programa ADVPL j podemos considerar como um campo data

no mais um campo caracter como o seu armazenamento.
O campo Data s retornado como um campo caracter por que estamos
utilizando a funo TCQUERY, se no o tratamento automtico.
A estrutura dos parmetros da funo TCSETFIELD() a mesma retornada

pela funo DbStruct() e que utilizada em diversas funes que manipulam
arquivos de dados.
Desta forma muito comum a montagem de queries em tabelas do sistema
partindo da estrutura de campos retornada pela funo DbStruct() sendo que
aps a execuo dos campos Tcquery() ou DbUseArea() normalmente
utilizado o campo TcSetField com base no contedo deste mesmo array de
estrutura.
Exemplo 02:
Local
Local
Local
Local
Local
cQuery
cCampos
aStruSA1
nX
nMax
:=
:=
:=
:=
:=
""
""
SA1->(DbStruct())
0
Len(aStruSA1)
// Monta a String cCampos de acordo com o contedo de aStruSA1

aEval(aStruSA1,{|aCampo| nX++, cCampos += aCampo[1] +;
IIF(nX == nMax,' ',', ')})
// Monta a query utilizando a String cCampos
cQuery := "SELECT "+cCampos+" FROM "+RetSqlName("SA1")
If Select("SA1SQL") <> 0
DbSelectArea("SA1SQL")
DbCloseArea()
Endif
dbUseArea(.T.,"TOPCONN",TcGenQry(,,cQuery),"SA1SQL",.T.,.F.)
Continuao:
For nX := 1 to Len(aStruSA1)
IF !( aStrutSA1[nX][2] $ "C/M")
TCSetField( cAlias,aStruSA1[nX][1],aStruSA1[nX][2],;
aStruSA1[nX][3],aStruSA1[nX][4])
ENDIF
Next nX
TCSPEXEC()
Executa uma Stored Procedure no Banco de Dados.
Devido a uma limitao em alguns dos Bancos de Dados suportados na
obteno dos tipos de parmetros (se so de INPUT e/ou OUTPUT) todos as
Stored Procedures a serem executadas atravs do TOPConnect devero
obedecer o seguinte padro de nomenclatura de seus parmetros :
Parmetros de INPUT devem comear com IN_... Ex. IN_VALOR.
Parmetros de OUTPUT devem comear com OUT_... Ex. OUT_CODIGO
Aps a execuo de uma Stored Procedure o TOPConnect retornar ao ADVPL
um array com 'n' elementos, onde n o nmero de parmetros de OUTPUT da
Stored Procedure.
Sintaxe: TCSPExec(cSPName,xParam1,xParam2...xParamN)
Parmetros:
cSPName
Nome completo da Stored Procedure no banco de dados.
xParamN
Parmetros de input da Stored Procedure.

As procedur es padres da aplicao ERP Protheus possuem concatenadas em
seus nomes o cdigo da empresa para a qual foram aplicadas.
Desta forma ao executar uma procedure padro do ERP atravs do comando
TCSPEXEC necessrio utilizar a funo xProcedures(), pois a mesma ir
concatenar ao nome da procedure que ser executada o cdigo da empresa.
Por exemplo: Procedure MAT001
Se for executada com a sintaxe: TCSPExec(MAT001,...) ocorrer
um erro na aplicao pois esta procedure no existe.
Utilizando a funo xProcedures() temos:
TCSPExec( xProcedures(MAT001), ...), onde caso a empresa em uso
seja a 01, ser executada a MAT001_01, a qual vlida.
Retorno:
Array
Array com os parmetros de retorno da Stored Procedure e <cSPName> o

nome da Stored Procedure a ser executada e os demais parmetros variam
conforme a definio da Stored Procedure.
Exemplo:
//Verifica se a Stored Procedure Teste existe no Servidor

If TCSPExist("TESTE")
//Executa a Stored Procedure Teste
aRet := TCSPExec("TESTE","JOSE",1000)
if aRet <> nil
cRetorno := ""
For i:= 1 to Len(aRet)
cRetorno += "|"+ IIF(ValType(aRet[i]) == "C", aRet[i],;
IIF(ValType(aRet[i]) == "N", CValToChar(aRet[i]), "U"))
Next
//Mostra os valores de retorno
ALERT(cRetorno)
Else
ALERT("Erro executando Stored Procedure"+CRLF+"Mensagem: "+TCSQLError())
Endif
EndIf
A funo TCSPExist() deve ser utilizada apenas para verificao da existncia

de Stored Procedures padres da aplicao ERP, ou que possuam concate
nadas no nome a informao da empresa para qual esto habilitadas.
Para verificao de procedures sem esta caracterstica deve ser utilizada a
funo ExistProc().
TCSPEXIST()
Verifica a existncia de uma determinada Stored Procedure no servidor.
Sintaxe: TCSPExist(cSPName)
Parmetros:
CSPName
Nome da procedure a ser verificada no banco de dados.
Retorno:
Lgico
Indica se a Stored Procedure existe ou no e <cSPName> o nome da

Stored Procedure procurada.
Exemplo:
If TCSPExist("MAT001_01")
TCSPExec("MAT001_01",...)
Endif
A funo TCSPExist() deve ser utilizada apenas para verificao da existncia

de Stored Procedures padres da aplicao ERP, ou que possuam concate
nadas no nome a informao da empresa para qual esto habilitadas.
Para verificao de procedures sem esta caracterstica deve ser utilizada a
funo ExistProc().
TCSQLERROR()
Retorna o ltimo erro registrado pelo TOPConnect durante a execuo de uma Query.
Sintaxe: TCSQLError()
Parmetros:
Nenhum
Retorno:
String
Mensagem de erro registrada no TopConnect para a ocorrncia.
Exemplo:
If
TCSQLExec("UPDATE CUSTOMER SET VALUE=0") < 0 then

ALERT(TCSQLError())
Endif
Esta a mesma mensagem que esta registrada no log de eventos do

TopConnect / TOTVS DbAccess Manager.
TCSQLEXEC()
Permite a execuo de comandos de atualizao no servidor de banco de dados.
Sintaxe: TCSQLExec(cCommand)
Parmetros:
cCommand
Retorno:
Numrico
Comando SQL a ser executado.
Retorna um valor negativo em caso de erros.
Exemplo:
nRet := TCSQLExec("UPDATE CUSTOMER SET VALUE=0)

TCSRVTYPE()
Retorna o tipo do servidor no qual TOPConnect / TOTVS DbAccess est em execuo.
Sintaxe: TCSrvType()
Parmetros:
Nenhum
Retorno:
String
Tipo do servidor, como por exemplo: "WinNT" ou "AS/400".
Exemplo:
TCLink("MSSQL/TESTE","TOPSRV")
ALERT(TCSrvtype())
Devido aos tratamentos especficos necessrios nas queries que sero

executadas em bancos de dados DB2 com sistemas operacionais AS/400
normal a seguinte verificao:
#IFDEF TOP
If TcSrvType() != "AS/400"
<Tratamento SQL convencional>
Else
#ENDIF
<Tratamento padro CODBASE>
#IFDEF TOP
Endif
#ENDIF
TCUNLINK()
Encerra uma conexo com o TOPConnect.
Sintaxe: TCUnlink(nConn)
Parmetros:
nConn
Retorno:
Nenhum
Nmero da conexo previamente retornado pela funo TCLink()
Exemplo:
TCConType("NPIPE")
nConn := TCLink("MSSQL/TOPCONN","TOPSRV")
TCUnLink(nConn)
TCCHKOBJ()
Verifica a existncia de um objeto no servidor AS/400
Sintaxe: TCChkObj(cObj,cLibrary,cType)
Parmetros:
cObj
Nome do objeto a ser verificado.
cLibrary
Nome da biblioteca que deve conter o objeto
cType
Tipo do de objeto AS/400, como por exemplo: *FILE ou *PGM.
Retorno:
Numrico
0 quando o objeto existe ou o nmero do erro no AS/400.
Exemplo:
nError := TCChkObj("CALCCUST","PRODUCAO","*PGM")
Funo para uso apenas com o TOPConnect em servidores AS/400.
TCEXEERROR()
Retorna uma string com a mensagem de erro retornada pela execuo das funes
TCPGMEXE() e TCSYSEXE().
Sintaxe: TCExeError()
Parmetros:
Nenhum
Retorno:
String
Mensagem de erro.
Exemplo:
If TCPGMEXE("CALCCUST") != 0
ALERT(TCExeError())
Endif
TCPGMEXE()
Executa um programa no servidor AS/400.
Sintaxe: TCPGMEXE(cProgram)
Parmetros:
cProgram
Nome do programa a ser executado.
Retorno:
Numrico
Exemplo:
If TCPGMEXE("CALCCUST") != 0
ALERT(TCExeError())
Endif
TCSYSEXE()
Permite a execuo de um comando utilizando a sintaxe e recursos nativos do DB2/400,
diretamente no servidor do banco de dados.
Sintaxe: TCSysExe(cCommand)
Parmetros:
cCommand
Comando a ser executado no servidor de banco de dados utilizando sintaxe

DB2/400.
Retorno:
Numrico
Exemplo:
cCommand
cCommand
cCommand
cCommand
:=
+=
+=
+=
"CRTCBLMOD MODULE("+cTDataBase+"/"+cName+"F"+cCrrEmp+") "

"SRCFILE("+cTDataBase+"/QSPSRC) "
"SRCMBR("+cName+"F"+cCrrEmp+") "
"REPLACE(*YES)"
If TCSysExe( cCommand )!= 0

ALERT(TCExeError())
Endif
Funes acessrias para uso em fontes com interao com o TOTVS DbAccess
CHANGEQUERY()
Funo que efetua as adequaes necessrias a query para que a mesma possa ser executada
adequadamente no banco de dados em uso pela aplicao ERP atravs do TopConnect.
Esta funo necessria pois a aplicao ERP Protheus pode ser utilizada com diversos bancos
de dados, e cada banco possui particularidades em sua sintaxe, de forma que mesmo uma
query escrita respeitando o padro SQL ANSI pode necessitar de adequaes.
Sintaxe: ChangeQuery(cQuery)
Parmetros:
cQuery
Retorno:
String
String contendo a query escrita em sintaxe SQL ANSI.
Query adequada em funo do banco em uso pela conexo ativa com a

aplicao TopConnect.
Exemplo:

cQuery += " WHERE "
cQuery += "CV8_FILIAL = '"+MV_PAR01+"' AND "
cQuery += "D_E_L_E_T_ = '' "
A funo ChangeQuery() deve obrigatoriamente ser utilizada pelos fontes da

aplicao ERP, pois a mesma pode ser instalada em diversos ambientes,
utilizando os vrios bancos de dados homologados, mas para
desenvolvimentos especficos de clientes, o analista pode optar por no
utilizar a funo ChangeQuery().
A razo disto permitir ao analista, que tenha conhecimentos mais apurados
do banco de dados em uso pelo cliente, utilizar uma sintaxe focada em utilizar
melhor os recursos do banco, otimizando a performance da aplicao.
RETFULLNAME()
Retorna o nome real da tabela no banco de dados para utilizao desta na seleo da query.
A funo RetFullName() no exclusiva para uso em queries, sendo utilizada
pela aplicao ERP para verificar o nome da tabela para o alias, especificado
no SX2 da empresa indicada.
Sintaxe: RetFullName(cAlias, cEmp)
Parmetros:
cAlias
cEmp
Retorno:
String
Nome da rea de trabalho da aplicao para identificao da tabela no banco

de dados.
Cdigo da empresa a ser avaliada.
Nome completo / real da tabela no banco de dados.
Exemplo:
SA1->(DbSetOrder(1)) // A1_FILIAL+A1_COD+A1_LOJA
cOrder := SqlOrder(IndexKey())
cQuery := "SELECT * FROM "+RETSQLNAME("SA1")+ " WHERE "
cQuery += RetSqlCond("SA1")
cQuery += " ORDER BY "+cOrder
dbUseArea(.T.,"TOPCONN", TcGenQry(,,cQuery), "TRBSQL", .T., .F.)
cRealName := RetFullName("TRBSQL")
RETSQLCOND()
Retorna uma string com as condies padres de uso em uma query.
Sintaxe: RetSqlCond(cAlias)
Parmetros:
cAlias
Retorno:
String
Nome do alias para composio a string de condies.
Condies de seleo padres para o alias indicado.

As condies padres so:
ALIAS_FILIAL = xFilial(ALIAS) .AND.
ALIAS.D_E_L_E_T_ = .
Exemplo:

cQuery += " WHERE "
cQuery += RetSqlCond("CV8")
RETSQLNAME()
Retorna o nome padro da tabela para seleo no banco de dados atravs da query.
Sintaxe: RetSqlName(cAlias)
Parmetros:
cAlias
Retorno:
String
Alias para ser avaliado o nome padro da tabela.
Nome completo da tabela para seleo atravs da query.
Exemplo:

cQuery += " WHERE "
RETSQLTABLE()
Retorna o nome real da tabela para seleo no banco de dados atravs da query.
Sintaxe: RetSqlTable(cAlias)
Parmetros:
cAlias
Retorno:
String
Alias para ser avaliado o nome real da tabela.
Nome real da tabela no banco de dados.
Exemplo:
cQuery := "SELECT DISTINCT CV8_PROC FROM "+RETSQLTABLE("CV8")

cQuery += " WHERE "
SQLCOPY()
Cria um arquivo no formato especificado pela configurao LOCALFILES do ambiente com o
retorno da query.
Sintaxe: SqlCopy(cFile, cWhere, aStru, cAlias, aDates, lRecno)
Parmetros:
cFile
Nome do arquivo temporario destino a ser gerado
cWhere
Condicao "Where" da query
aStru
Array com os Campos a serem selecionados pela query
cAlias
Alias origem dos dados
aDates
Array com os nomes dos campos que devero ter o tratamento da funo
TCSetField() para o formato de data.
Se copia o contedo da coluna R_E_C_N_O_ para o arquivo gerado.
lRecno
Retorno:
Nenhum
SQLORDER()
Converte a sintaxe de um indce em formato ISAM (CODEBASE) para o formato SQL ANSI
Sintaxe: SqlOrdem(cOrder)
Parmetros:
cOrder
Retorno:
String
Sintaxe de ndice em formato ISAM.
ndice convertido para sintaxe SQL ANSI
Exemplo:
SA1->(DbSetOrder(1)) // A1_FILIAL+A1_COD+A1_LOJA
cOrder := SqlOrder(IndexKey())
cQuery := "SELECT * FROM "+RETSQLNAME("SA1")+ " WHERE "
cQuery += RetSqlCond("SA1")
cQuery += " ORDER BY "+cOrder
dbUseArea(.T.,"TOPCONN", TcGenQry(,,cQuery), "TRBSQL", .T., .F.)
cRealName := RetFullName("TRBSQL")
SQLTOTRB()
Preenche um arquivo temporrio com o contedo do retorno da query.
Sintaxe: SqlToTrb(cQuery, aStru, cAlias)
Parmetros:
cQuery
Query para seleo dos registros no banco de dados.
aStru
Array contendo a estrutura do arquivo temporrio a ser preenchido com os

dados de retorno da query.
Alias do arquivo temporrio a ser preenchido com os dados de retorno da
query.
cAlias
Para correta utilizao da funo SQLTOTRB() o arquivo temporrio deve estar

criado e com a rea de trabalho (ALIAS) definido.
Retorno:
Nenhum
Exemplo:
// Arquivo de trabalho que ser utilizado pela MaWndBrowse

cCampos:= ""
nX
:= 0
nMax
:= Len(aStruSQL)
aEval( aStruSQL,{|aCampo| nX++, cCampos += aCampo[1] +;
IIF(nX == nMax,' ',', ')})
cArqTrb := CriaTrab(aStruSQL,.T.)
dbUseArea(.T.,__LOCALDRIVER,cArqTrb,cAlias,.T.,.F.)
cQuery := "SELECT "+cCampos+" FROM "+RetSqlName("SA1")+" (NOLOCK) "
SqlToTrb(cQuery,aStruSQL,cAlias)
cArqInd := CriaTrab(Nil,.F.)
cChave
:= "A1_FILIAL+A1_COD+A1_LOJA"
IndRegua(cAlias,cArqInd,cChave,,,"Indexando Registros...")
dbGotop()
40.3. Aplicaes com controle de comunio com o Banco de Dados

Utilizando as funo de interao com a aplicao TopConnect / TOTVS DbAccess tm-se um
grande nmero de aplicaes que podem ser desenvolvidas, combinando-se recursos
previamente estudados nos mdulos Bsico, Intermedirio e utilizando os conceitos de
orientao objetos e as classes de objetos disponveis na linguagem ADVPL, tais como:
Rotinas de processamento utilizando queries para seleo dos registros;
Relatrios para seleo dos registros;
Rotinas de atualizao para execuo dos comando de atualizao diretamente
no banco de dados.
Em resumo, qualquer aplicao do ambiente ERP pode ser escrita utilizando os recursos de
interao com a aplicao TopConnect / TOTVS DbAccess, para obter, manipular e atualizar os
dados do banco do banco de dados.
Neste tpico sero detalhadas duas aplicaes utilizando estas funes, cujo grau de
complexidade ilustra bem o potencial desta ferramenta.
MaWndBrowse com Alias Temporrio gerado por Query
Banco de dados de interface
40.3.1.
MaWndBrowse com Alias Temporrio gerado por Query
Conforme descrito no tpico 6.1. MaWndBrowse, esta funo permite a montagem de

um browse cuja estrutura do arquivo no necessita estar definida no dicionrio de dados
da aplicao ERP.
Utilizando esta particularidade da MaWndBrowse possvel ento compor um alias
temporrio contendo o retorno de uma query e exibi-lo em um browse.
A vantagem deste BrowseSQL em relao ao browse de uma tabela normal a
possibilidade de combinar informaes de vrias tabelas atravs de uma query e exibilas em tela.
Algumas aplicaes interessantes para este recurso seriam:
Consulta Kardex em tela, pois este relatrio combina dados das tabelas de
itens dos documentos de entrada (SD1), itens dos documentos de sada
(SD2) e movimentaes internas (SD3).
Conciliao de contabilizaes, pois uma contabilizao composta por
uma origem, a qual pode ser praticamente de qualquer tabela de
movimentos da aplicao ERP, e de um ou mais lanamentos contbeis
(CT2) gerados por esta origem.
Demonstrao em tela das depreciaes dos bens do imobilizado por
perodo, compondo dinamicamente as colunas de depreciao de acordo
com o intervalo de meses selecionados. Este recurso interessante pois
elimina a limitao de espao da impresso e pode ser combinado com a
funcionalidade de exportao de grids de dados para o Microsoft Excel.
Exemplo: MaWndBrowse com Alias Temporrio gerado por Query

Este exemplo de uso da MaWndBrowse com alias de temporrio utilizando
queries derivado do exemplo de utilizao da MaWndBrowse com arquivo
temporrio descrito no item 6.1. MaWndBrowse.
/*/
+----------------------------------------------------------------------| Funo
| WndSQLTRB
|
+----------------------------------------------------------------------| Descrio | Demonstra a utilizao da MaWndBrowse com SQL
|
+----------------------------------------------------------------------| Uso
| Curso ADVPL
|
+----------------------------------------------------------------------/*/
User Function WndSQLTRB()

// Variveis para o Arquivo Temporario
Local cChave
:= ""
Local cArqTrb
:= ""
Local aStruTRB := {}
Local aStruSQL := SA1->(DbStruct())
// Variveis para o MaWndBrowse
Local cTitulo
:= "Cadastro Temporario"// Ttulo obrigatrio
Local cAlias
:= "SA1" // Alias da tabela corrente podendo ser TRB
Local cFunLeg
:= "" // Funo que dever retornar um valor lgico e com isso
ser atribudo semafro na primeira coluna do browse
Local cTopFun
:= "" // Mostrar os registros com a chave de
Local cBotFun
:= "" // Mostrar os registros com a chave ate
Local lCentered := .T. // Valor verdadeiro centraliza
Local aResource := {} // aAdd(aResource,{"IMAGEM","Texto significativo"})
Local nModelo
:= 1 // 1- Menu do aRotina
Local aPesqui
:= {} // aAdd(aPesqui{"Ttulo",nOrdem}), se no passado ser
Local cSeek
:= "" // Chave principal para a busca, exemplo: xFilial("???")
Local lDic
:= .T. // Parmetro em conjunto com aCampos
Local lSavOrd
:= .T. // Estabelecer a ordem aps pesquisas.
// Variaveis para a MsAdvSize
Local lEnchBar := .F. // Se a janela de dilogo possuir enchoicebar (.T.)
Local lPadrao
:= .F. // Se a janela deve respeitar as medidas padres do
Protheus (.T.) ou usar o mximo disponvel (.F.)
Local nMinY
:= 400 // Altura mnima da janela
Local aSize
:= MsAdvSize(lEnchBar, lPadrao, nMinY)
Private cCadastro := " "

Private aCampos
:= {} // Se lDic=.T. utilizar o SX3, do contrrio o aCampos
informado -> aAdd(aCampo,{X3_CAMPO,X3_PICTURE,X3_TITULO,X3_TAMANHO})
Private aRotina
:= {} // Idntico ao aRotina para mBrowse
Continuao:
aAdd(aRotina,{"Visualizar","U_TcVisual",0,2}) // Desenvolver Enchoice para
campos de arquivo temporrio
aAdd(aRotina,{"Incluir"
,"U_TcInclui",0,3}) // Desenvolver Enchoice para
aAdd(aRotina,{"Alterar"
,"U_TcAltera",0,4}) // Desenvolver Enchoice para
aAdd(aRotina,{"Excluir"
,"U_TcExclui",0,5}) // Desenvolver Enchoice para
// Estrutura do Arquivo: Nome do campo / tipo, tamanho, decimais (SX3 para
temporrio)
/*
AADD(aStruTRB,{"TRB_FILIAL"
,"C",02,0})
// Nome_Campo , Tipo_Campo, Tamanho, Decimal
AADD(aStruTRB,{"TRB_ID"
,"C",14,0})
AADD(aStruTRB,{"TRB_NOME"
,"C",20,0})
AADD(aStruTRB,{"TRB_IDADE"
,"N",03,0})
AADD(aStruTRB,{"TRB_STATUS"
,"C",01,0})
*/
// aCampos padro para a MaWndBrowse
//AADD(aCampos,{<Nome_Campo>,<Picture>,<Titulo>,<Tamanho>})
// aCampos melhorado para a WndBrwTRB
//AADD(aCampos,{<Nome_Campo>,<Picture>,<Titulo>,<Tamanho>,<Tipo>,<cWhen>,;
//<lObrigatorio>})
// Nota: lObrigatorio deve ser sempre a ultima informacao do aCampos
/*
AADD(aCampos,{"TRB_FILIAL"
,"@!" ,"Filial"
,02,"C",".F.",.T.})
AADD(aCampos,{"TRB_ID"
,"@!" ,"Matricula"
,14,"C",".F.",.T.})
AADD(aCampos,{"TRB_NOME"
,"@!" ,"Nome"
,20,"C",".T.",.F.})
AADD(aCampos,{"TRB_IDADE"
,"@E 999","Idade"
,03,"N",".T.",.F.})
AADD(aCampos,{"TRB_STATUS"
,"@!" ,"Status"
,01,"C",".T.",.T.})
*/
If ( Select( cAlias ) <> 0 )
dbSelectArea ( cAlias )
dbCloseArea ()
Endif
// Arquivo de trabalho que ser utilizado pela MaWndBrowse
cCampos:= ""
nX
:= 0
nMax
:= Len(aStruSQL)
aEval( aStruSQL,{|aCampo| nX++, cCampos += aCampo[1] +;
IIF(nX == nMax,' ',', ')})
cArqTrb := CriaTrab(aStruSQL,.T.)
dbUseArea(.T.,__LOCALDRIVER,cArqTrb,cAlias,.T.,.F.)
cQuery := "SELECT "+cCampos+" FROM "+RetSqlName("SA1")+" (NOLOCK) "
SqlToTrb(cQuery,aStruSQL,cAlias)
Continuao:
cArqInd := CriaTrab(Nil,.F.)
cChave
:= "A1_FILIAL+A1_COD+A1_LOJA"
IndRegua(cAlias,cArqInd,cChave,,,"Indexando Registros...")
dbGotop()
MaWndBrowse(aSize[7],aSize[2],aSize[6],aSize[5],cTitulo,cAlias,/*aCampos*/,;
aRotina,,cTopFun,cBotFun,lCentered,,nModelo,,cSeek,lDic,lSavOrd)
If ( Select( cAlias ) <> 0 )

dbSelectArea ( cAlias )
dbCloseArea ()
Endif
If File(cArqInd+OrdBagExt())
FErase(cArqInd+OrdBagExt())
ENDIF
DbSelectArea("SA1")
DbSetOrder(1)
Return
/*/
+----------------------------------------------------------------------| Funo
| TcVisual
|
|
+----------------------------------------------------------------------| Uso
| Curso ADVPL
|
+----------------------------------------------------------------------/*/
USER FUNCTION TcVisual(cAlias,nReg,nOpc)

LOCAL
LOCAL
LOCAL
LOCAL
LOCAL
LOCAL
LOCAL
//
//
//
//
aCposEnch := {}
nLinha
:= 15
nColuna
:= 10
nOpcE
bOk
:= {||oDlg:End()}
bCancel
:= {||oDlg:End()}
nX
Padrao Modelo2(), com lWhen -> cWhen

AADD(aCposEnch,{"<Variavel>"
,{nLinha,nColuna}
,"<Titulo>","<Picture>","<Validacao>","<F3>","<lWhen>",<Tamanho>})
aCampos,{"TRB_FILIAL"
,"@!" ,"Filial"
,02}
Continuao:
If nX > 1
Endif
Next nX
oDlg:Activate()
RETURN
/*/
+----------------------------------------------------------------------| Funo
| TcInclui
|
|
+----------------------------------------------------------------------| Uso
| Curso ADVPL
|
+----------------------------------------------------------------------/*/
USER FUNCTION TcInclui(cAlias,nReg,nOpc)
LOCAL
LOCAL
LOCAL
LOCAL
LOCAL
LOCAL
LOCAL
LOCAL
aCposEnch := {}
nLinha
:= 15
nColuna
:= 10
nOpcE
bOk
bCancel
:= {||oDlg:End()}
aArea
:= GetArea()
nX

,{nLinha,nColuna}
,"@!" ,"Filial"
,02}
Continuao:
If nX > 1
Endif
"",".T.",aCampos[nX][4]})
Do Case
Case aCampos[nX][5] == "C"
Case aCampos[nX][5] == "N"
Case aCampos[nX][5] == "D"
Case aCampos[nX][5] == "L"
Case aCampos[nX][5] == "M"
EndCase
:= 0
:= CTOD("")
:= .F.
Next nX
( U_TGravar(cAlias,nReg,nOpcE,aCampos),oDlg:End()),)}
oDlg:Activate()
RETURN
Continuao:
/*/
+----------------------------------------------------------------------| Funo
| TcAltera
|
|
+----------------------------------------------------------------------| Uso
| Curso ADVPL
|
+----------------------------------------------------------------------/*/
USER FUNCTION TcAltera(cAlias,nReg,nOpc)
LOCAL
LOCAL
LOCAL
LOCAL
LOCAL
LOCAL
LOCAL
LOCAL
aCposEnch := {}
nLinha
:= 15
nColuna
:= 10
nOpcE
bOk
bCancel
:= {||oDlg:End()}
aArea
:= GetArea()
nX

,{nLinha,nColuna}
,"@!" ,"Filial"
,02}
If nX > 1
Endif
"",aCampos[nX][6],aCampos[nX][4]})
Next nX
( U_TGravar(cAlias,nReg,nOpcE,aCampos),oDlg:End()),)}
oDlg:Activate()
RETURN
Continuao:
/*/
+----------------------------------------------------------------------| Funo
| TcExclui
|
|
+----------------------------------------------------------------------| Uso
| Curso ADVPL
|
+----------------------------------------------------------------------/*/
USER FUNCTION TcExclui(cAlias, nReg, nOpc)
LOCAL
LOCAL
LOCAL
LOCAL
LOCAL
LOCAL
LOCAL
//
//
//
//
aCposEnch := {}
nLinha
:= 15
nColuna
:= 10
nOpcE
bOk
bCancel
:= {||oDlg:End()}
nX
Padrao Modelo2(), com lWhen -> cWhen

AADD(aCposEnch,{"<Variavel>"
,{nLinha,nColuna}
,"<Titulo>","<Picture>","<Validacao>","<F3>","<lWhen>",<Tamanho>})
aCampos,{"TRB_FILIAL"
,"@!" ,"Filial"
,02}
If nX > 1
Endif
Next nX
oDlg:Activate()
RETURN
Continuao:
/*/
+----------------------------------------------------------------------| Funo
| TcValid
|
|
+----------------------------------------------------------------------| Uso
| Curso ADVPL
|
+----------------------------------------------------------------------/*/
USER FUNCTION TcValid(cAlias,nReg,nOpc,aCampos)
LOCAL lRet
LOCAL nX
LOCAL nPosObrig := Len(aCampos[1])
IF aCampos[nX,nPosObrig] == .T.
IF !(lRet := !Empty(&("_"+aCampos[nX,1])))
Help("TEnchoice",1,"HELP","OBRIGATORIO","Existem campos
obrigatorios nao preenchidos",1,0)
RETURN lRet // EXIT
ENDIF
ENDIF
Next nX
IF nOpc == 3
IF !(lRet := !((cAlias)->(dbSeek(_TRB_FILIAL+_TRB_ID))))
Help("TEnchoice",1,"HELP","INCLUSAO","Ja existe um registro com esta
chave",1,0)
ENDIF
ELSE
IF !(lRet := (cAlias)->(dbSeek(_TRB_FILIAL+_TRB_ID)))
Help("TEnchoice",1,"HELP","ALTERACAO","Nao existe um registro com
esta chave",1,0)
ENDIF
ENDIF
RETURN lRet
Continuao:
/*/
+----------------------------------------------------------------------| Funo
| TcGravar
|
|
+----------------------------------------------------------------------| Uso
| Curso ADVPL
|
+----------------------------------------------------------------------/*/
USER FUNCTION TcGravar(cAlias,nReg,nOpc,aCampos)

LOCAL nX
RecLock(cAlias,nOpc==3)
IF nOpc == 5
DbDelete()
ELSE
(cAlias)->&(aCampos[nX][1]) := &("_"+aCampos[nX][1])
Next nX
ENDIF
Msunlock()
RETURN
Continuao:
/*/
+----------------------------------------------------------------------| Funo
| TEnchoice
|
|
+----------------------------------------------------------------------| Uso
| Curso ADVPL
|
+----------------------------------------------------------------------/*/
Static Function TEnchoice(oDlg, aCampos, nLeftE, nTopE, nHeightE, nWidthE,;
lEnchBar)
Local
Local
Local
Local
Local
Local
Local
Local
Local
Local
Local
Local
Local
Local
aSays
aGets
cCaption
cPict
cValid
cF3
cWhen
cBlKSay
cBlkGet
cBlKVld
cBlKWhen
nLeft
nTop
nI
:=
:=
:=
:=
:=
:=
:=
:=
:=
:=
:=
:=
:=
:=
{}
{}
""
""
""
""
""
""
""
""
""
0
0
0
Default lEnchBar := .F.

Default
nLeftE
:= IIF(lEnchBar,(oDlg:nLeft)+16,2)
Default
nTopE
:= 2
Default
nHeightE
:= (oDlg:nHeight)-135
Default nWidthE
:= (oDlg:nWidth)-102
// AADD(aC,{"<Variavel>"
,{nLinha,nColuna}
If Len(aCampos) > 0
oScroll := TScrollBox():New(oDlg, nLeftE, nTopE, nHeightE , nWidthE, .T.,;
.T., .T.)
For nI:=1 to Len(aCampos)
If Len(aCampos[nI])==8
cCampo
:= aCampos[nI,1]
nLeft := aCampos[nI,2,1]-13
nTop := aCampos[nI,2,2]
cCaption:= Iif(Empty(aCampos[nI,3]), " "
cPict := Iif(Empty(aCampos[nI,4]), Nil
cValid
cF3
,aCampos[nI,3])
,aCampos[nI,4])
".t." ,aCampos[nI,5])
NIL
,aCampos[nI,6])
cWhen := Iif(Empty(aCampos[nI,7]), ".T." ,aCampos[nI,7])
Continuao:
nWidthG
:= Iif(Empty(aCampos[nI,8]), 100,;
IiF(aCampos[nI,8]*3.5 > 100,100,nil))
cBlKSay := "{|| OemToAnsi('"+cCaption+"')}"

cBlkGet := "{ | u | If( PCount() == 0,;
"+cCampo+","+cCampo+":= u ) }"
cBlKVld := "{|| "+cValid+"}"
cBlKWhen := "{|| "+cWhen+"}"
AADD(aSays,Array(1))
aSays[nI] := TSay():New(nLeft+1, nTop, &(cBlkSay), oScroll,,,;
.F., .F., .F., .T.,,, 50, 8, .F., .F., .F., .F.,;
.F. )
AADD(aGets,Array(1))
aGets[nI] := TGet():New( nLeft, nTop+50, &(cBlKGet), oScroll,;
nWidthG, 11, cPict, &(cBlkVld),,,, .F.,, .T.,,;
.F., &(cBlkWhen), .F., .F.,, .F., .F. , cF3,;
(cCampo))
EndIf
Next
Endif
Return
40.3.2.
Banco de dados de interface
O termo Banco de dados de interface utilizado para classificar uma aplicao ADVPL escrita
com funes de interao com a aplicao TopConnect / TOTVS DbAccess para realizar a
integrao entre a aplicao ERP Protheus e outro sistema, utilizando como meio de
comunicao um banco de dados e no mais importao de arquivos em N formatos, tais
como .TXT, .DBF e similares.
Este tipo de integrao no visa substituir formatos de integraes padres j
existentes como o padro CNAB e o padro Web XML.
Sua aplicao integrao direta entre sistemas atravs de um banco de
dados com formato e padres comuns entre elas.
As vantagens da utilizao do conceito de Banco de Dados de Interface em comparao da
integrao por importao / exportao de arquivos so:
Maior controle da integrao das informaes entre os sistemas, permitindo um
tratamento adequado de eventos de erros;
Transparncia e rastreabilidade das informaes integradas, implementando
confiabilidade no processo;
Possibilidade de utilizao de um tipo de banco de dados pela aplicao ERP
Protheus e de outro tipo de banco de dados para integrao entre os sistemas.
Possibilidade de desenvolvimento de ferramentas para monitorar e gerenciar a
integrao entre os sistemas atravs do controle da rea de interface no banco
de dados, inclusive com a utilizao de Stored Procedures para aumentar a
performance da aplicao de interface.
Consideraes relevantes sobre as funes TCLink() e TCSetConn()
A funo TCLink() permite a abertura de uma conexo com um banco de dados,
desde que haja o OBDC configurado no ambiente da aplicao e na aplicao
TOPConnect / TOTVS DBAccess;
Cada abertura de conexo atravs da funo TcLink() consome uma licensa de
usurio do TOPConnect / TOTVS DBAccess. Aps a abertura de uma conexo a
mesma deve ser selecionada pela funo TcSetConn() para se tornar a conexo
ativa;
Podem ser utilizadas diversas conexes em uma mesma aplicao ADVPL, e
podem ser utilizadas as informaes das tabelas j abertas e vinculadas a uma
rea de trabalho independente da conexo que est ativa. Somente deve ser
verificado que para abertura de uma tabela e vnculo desta com uma rea de
trabalho obrigatoriamente deve estar ativa a conexo com o banco de dados que
contm esta tabela.
A conexo aberta entre o ERP Protheus e o TopConnect / DbAccess possu o
nmero de referncia 0. Desta forma, aps finalizar uma conexo aberta com o
comando TCLink() deve ser efetuado um TCSetConn(0) para restaurar como
conexo ativa a conexo padro do Protheus com o TopConnec.
A figura abaixo ilustra a estrutura tpica de uma aplicao utilizando o conceito de Banco de
Dados de Interface, com foco na aplicao ERP Protheus e seus recursos pr-disponveis:
Tarefa
Descrio
01
Exportao Protheus -> DbInterface
02
Importao DbInterface -> ERP X
03
Extrao ERP X -> DbInterface
04
Importao DbInterface -> Protheus
05
Efetivao Protheus -> Protheus
Detalhamento
Utilizao de queries ou stored
procedures para atualizao das
tabelas do banco DBInterface no
formato
necessrio
ao
ERP
X,
executadas a partir do ERP Protheus.
Ferramentas proprietrias do ERP X
para
leitura
do
DBInterface
e
tratamento das informaes para
atualizao do banco de dados desta
aplicao.
Pode ser uma ferramenta proprietria
da aplicao ERP X, ou pode ser um
conjunto
de
queries
e
stored
procedures
desenvolvidas
em
conjunto com a equipe do ERP X e a
equipe TOTVS, permitindo o controle
de execuo da extrao pelo ERP
Protheus.
Utilizao de queries ou stored
procedures
para
leitura
das
informaes
do
DBInterface
e
atualizao de tabelas intermedirias
no banco de dados do ERP Protheus,
executadas a partir do ERP Protheus.
Utilizao de funes prprias para
esta finalidade no ERP Protheus para
efetivao
das
informaes
importadas em informaes vlidas no
ERP. Estas funes normalmente so
compatveis com a execuo atravs
do recurso de MsExecAuto().
Consideraes complementares sobre o conceito de Banco de Dados de Interface

A utilizao de tabelas intermedirias no banco de dados Protheus apesar de no

ser obrigatria recomendada para permitir um tratamento adequado das
ocorrncias de efetivao das informaes, principalmente quando utilizada a
funo MsExecAuto() para executao das rotinas de efetivao dos dados;
Para extrao das informaes tanto do banco de dados Protheus para
exportao, quanto do banco de dados do sistema ERP X recomendvel o uso
de Stored Procedures para aumentar a performance do processo como um todo.
importante lembrar que se o sistema ERP X possuir procedures de exportao
as mesmas podero ser executadas diretamente pelo Protheus atravs da funo
TCSpExec();
recomendvel que as funcionalidades de Exportao, Extrao, Importao e
Efetivao sejam tratadas tanto com interfaces de execuo direta quanto
atravs de execuo via Job.
40.4. Embedded SQL Facilitador de Querys

O objetivo do Embedded SQL facilitar a escrita e leitura de query's. Foi definida uma sintaxe
para que se possa escrever a query diretamente no cdigo ADVPL, sem a necessidade de ficar
concatenando pedaos de string para compor a string final.
Disponibilidade do Recurso
Este recurso est disponvel apenas no Protheus 8. A utilizao do Embedded SQL divide-se
em : compilao do fonte, e execuo do fonte. Para ser possvel compilar um fonte com o
cdigo escrito no formato Embedded, deve ser utilizado um Protheus, com Build igual ou
superior a 7.00.050721p, em um ambiente com repositrio para TopConnect ( RPODB=TOP ).
A utiliao deste recurso tambm depende da atualizao da LIB 811, superior a 'Lib
20050902 - 811'.
Exemplo bsico - Fonte atual
cQuery : 'SELECT SE2.E2_PREFIXO,SE2.E2_NUM '

cQuery += 'FROM '+RetSqlTable('SE2')+' SE2,'+RetSqlTable('QEK')+' QEK '
cQuery += 'WHERE SE2.E2_FILIAL= '+xfilial('SE2')+' AND '
cQuery += 'SE2.E2_PREFIXO<> ''+cPrefixo+'' AND '
cQuery += 'SE2.D_E_L_E_T_ = ' ' '
cQuery += 'ORDER BY '+RetSqlOrder('SE2')
dbUseArea(.T.,'TOPCONN',TcGenQry(,,cQuery),'E2TEMP',.T.,.T.)
TCSetField('E2TEMP','E2_EMISSAO','D',8,0)
Exemplo bsico - Utilizando Embedded SQL
BeginSql alias 'E2TEMP'

column E2_EMISSAO as Date
%noparser%
SELECT SE2.E2_PREFIXO,SE2.E2_NUM
FROM %table:SE2% SE2,%table:QEK% QEK
WHERE SE2.E2_FILIAL= %xfilial:SE2% AND
SE2.E2_PREFIXO<> %exp:cPrefixo% AND
SE2.%notDel%
ORDER BY %Order:SE2%
EndSql
Caractersticas operacionais - Sintaxe

O bloco onde ser escrito o Select deve sempre ser iniciado com 'BeginSql alias' e finalizado
com 'EndSql'.
Partes do cdigo que devem ser substitudas aparecem entre os sinais de %. Estas expresses
possuem tratamento especial em momento de execuo.
Qualquer instruo colocada entre BEGINSQL... ENDSQL, que no seja uma expresso %...% ,
ser inserida na query a ser enviada para o banco, de forma literal.
Variveis, expresses, funes aparecem iniciando com %exp: %.
Em column, especificar campos da query que so do tipo data, lgico ou numrico (DATE,
LOGIC, NUMBER). Esta linha trocada por chamadas funo TCSetField.
%noparser% indica que a query no deve passar pela funo 'ChangeQuery' antes de ser
enviada ao banco de dados. Caso no especificado, o default a string da query ser passada
automaticamente pela funo ChangeQuery.
%table:<alias>% substituda por RetSqlName(<alias>)
%notDel% substituda por D_E_L_E_T_= ' '
%Order:<alias>% substituda por SqlOrder(<alias>->(IndexKey()))
H 3 opes para o %Order:
1. %Order: <cAlias> %
traduzido para
SqlOrder(<cAlias>->(IndexKey()))
2. %Order: <cAlias>, <nIndice>% traduzido para
SqlOrder(<cAlias>->(IndexKey(<nIndice>)))
3. %Order: <cAlias>, <cNick>% traduzido para
SqlOrder(<alias>->(DBNickIndexKey(<cNick>)))
Limitao:
No permitido incluir funes no meio do cdigo 'embedded'. Se precisar, o valor deve ser
guardado em uma varivel antes do incio do BeginSql.
tam_cp := GetE2ValorSize()
column E2_EMISSAO as Date, E2_VALOR as Numeric(tam_cp,2)
. . .
EndSql
Erros de Compilao
Caso seja utilizado algum argumento invlido para especificar as colunas, ou erros de sintaxe
nas expresses a serem transformadas para a montagem da query, a compilao do fonte
interrompida com a ocorrncia 'Syntax Error', informando a linha onde a primeira ocorrncia
foi encontrada.
ENDSQL (Error C2001
Syntax error:)
Caso a ocorrncia de compilao aponte diretamente para a linha do cdigo-fonte, onde est
escrita a instruo EndSql, verifique se existe algum espao em branco ou tabulao, a partir
do incio da linha, antes da instruo EndSql. A verso atual desde ambiente no suporta esta
declarao, exigindo que a instruo EndSql seja alinhada esquerda do fonte, sem espaos
ou tabulaes.
Erros de Execuo
'Query Argument Error : Alias [XXX] already in use.'
Caso a instruo BeginSQL especifique um alias que j esteja aberto (em uso), a aplicao
abortada com a ocorrncia de erro fatal acima, informando em XXX o alias utilizado.
'Query Argument Error : Invalid Value Type [X]'
Caso alguma expresso informada na Query, atravs da tag %exp: ... %, retorne um valor de
tipo diferente de 'C' Catacter, 'D' Data, 'N' Numrico, ou 'L' Lgico, a aplicao abortada com
a ocorrncia de erro acima, onde o tipo do argumento inesperado mostrado em [X].
'Type Mismach on +'
Esta ocorrncia, se reproduzida, informar na pilha de chamadas o nmero da linha do cdigofonte correspondente instruo EndSQL. Ocorre caso alguma funo intermediria do engine
do Embedded SQL, excluindo-se as funes especificadas na query com a sintaxe %exp: ... %
, retornar um contedo no-caractere a ser acrescentado na Query. Esta ocorrncia de mais
difcil localizao, sendo til nestes casos a anlise do arquivo temporrio gerado pelo Protheus
IDE, no momento da compilao.
Help NOFUNCW - Funo __EXECSQL
Caso um fonte com o Embedded SQL seja executado em um repositrio que no tenha sido
atualizado, OU que no seja um Repositrio para o ambiente TOPConnect ( RPODB=TOP), a
aplicao exibir a ocorrncia acima, indicando que a funo interna de execuo da Query
no est presente no ambiente. Verifique se a lib est atualizada, e se o RPO em uso de um
ambiente TOPConnect.
Caractersticas operacionais - depurao

Dada a montagem da Query, no possvel depurar o bloco do cdigo-fonte compreendido
entre as instrues BeginSql e EndSql, no sendo considerados pontos de parada de depurao
( BreakPoints ), caso colocados neste intervalo do cdigo. A colocao de pontos de parada
deve ser realizada antes ou depois deste bloco.
Funo auxiliar - GETLastQuery()
Aps a abertura do cursor, no alias especificado, a funo GetLastQuery() retorna um array,
com 5 elementos, onde esto disponveis as seguintes informaes sobre a Query executada :
[1]
[2]
[3]
[4]
[5]
cAlias - Alias usado para abrir o Cursor.

cQuery - Query executada.
aCampos - Array de campos com critrio de converso especificados.
lNoParser - Caso .T., no foi utilizada ChangeQuery() na String original.
nTimeSpend - Tempo, em segundos, utilizado para a abertura do Cursor.
Exemplo mais completo: Cdigo ADVPL

column E2_EMISSAO as Date, E2_VALOR as Numeric(tam_cp,2)
column QEK_SKLDOC As Logical
%noparser%
SELECT SE2.E2_PREFIXO,SE2.E2_NUM, SE2.E2_FORNECE, SE2.E2_LOJA,SE2.E2_VALOR,
SE2.D_E_L_E_T_ DEL1, QEK.D_E_L_E_T_ DEL2 , QEK.QEK_SKLDOC, SE2.R_E_C_N_O_
SE2RECNO
FROM %table:SE2% SE2,%table:qeK% QEK
WHERE SE2.E2_FILIAL= %xfilial:SE2% AND
qek.%notDel% and
SE2.E2_PREFIXO<> %exp:cPrefixo% AND
SE2.E2_NUM<> %exp:(cAlias)->M0_CODIGO% AND
SE2.E2_NUM<>45
AND
SE2.E2_FORNECE=%exp:Space(Len(SE2->E2_FORNECE))% AND
SE2.E2_EMISSAO<>%exp:MV_PAR06% AND
SE2.E2_LOJA<>%exp:MV_PAR05% AND
SE2.E2_VALOR<>%exp:MV_PAR04% AND
qek.QEK_SKLDOC<>%exp:MV_PAR03%
And
SE2.%notDel%
ORDER BY %Order:SE2,1%
EndSql
Exemplo mais completo: Fonte gerado pelo pr-compilador (PPO)
__execSql(
'E2TEMP',
' SELECT SE2.E2_PREFIXO,SE2.E2_NUM, SE2.E2_FORNECE, SE2.E2_LOJA,SE2.E2_VALOR,
SE2.D_E_L_E_T_ DEL1, QEK.D_E_L_E_T_ DEL2 , QEK.QEK_SKLDOC, SE2.R_E_C_N_O_
SE2RECNO FROM
'+RetSqlName('SE2')+' SE2, '+RetSqlName('QEK')+' QEK WHERE
SE2.E2_FILIAL=
SE2.E2_PREFIXO<>
'' +xFilial('SE2')+''
AND qek.D_E_L_E_T_= ' ' AND
'+___SQLGetValue(CPREFIXO)+' AND SE2.E2_NUM <> '+
___SQLGetValue((CALIAS)->M0_CODIGO)+' AND SE2.E2_NUM<>45 AND SE2.E2_FORNECE= '+

___SQLGetValue(SPACE(LEN(SE2->E2_FORNECE)))+' AND SE2.E2_EMISSAO<> '+
___SQLGetValue(MV_PAR06)+' AND SE2.E2_LOJA<> '+___SQLGetValue(MV_PAR05) +' AND
SE2.E2_VALOR<> '+___SQLGetValue(MV_PAR04)+' AND qek.QEK_SKLDOC<> '+
___SQLGetValue(MV_PAR03)+' And SE2.D_E_L_E_T_= ' ' ORDER BY
'+
SqlOrder(SE2->(IndexKey(1))), {{'E2_EMISSAO','D',8,0}, {'E2_VALOR','N',tam_cp,2},

{'QEK_SKLDOC','L',1,0}},.T.)
)
41.
Funcionalidade MsExecAuto
Sobre a MsExecAuto e Rotinas Automticas

A funcionalidade MsExecAuto, ou tambm conhecida como Rotina Automtica, permite a
execuo de rotinas do ambiente ERP Protheus por funes especficas, o que confere ao
desenvolvedor a possibilidade de efetuar tratamentos especficos antes da execuo da rotina
padro, e mais importante, no perder nenhuma funcionalidade que a rotina padro oferece.
Avaliando esta funcionalidade apenas pelo pargrafo acima, tem-se a impresso de ser um
recurso simples e at mesmo desnecessrio, pois um desenvolvedor experiente poderia
reproduzir todas as validaes e tratamentos existentes em sua rotina, ento porque ter de
tratar a rotina padro?
Para responder a esta pergunta devemos fazer as seguintes consideraes:
A aplicao ERP est em constante evoluo:
No momento de desenvolvimento da rotina especfica era necessrio apenas o
tratamento de um conjunto isolado de informaes, mas com o aprimoramento do
ERP como um todo, agora so necessrios outros conjuntos de dados, os quais no
foram tratados pelo desenvolvedor naquele momento, mas que esto contemplados
na rotina padro do sistema.
Como o desenvolvedor optou por realizar todo o tratamento de forma especfica, em
uma atualizao do ERP este desenvolvimento precisar ser revisto ou at mesmo
refeito, o que implacar em custo para o cliente ou para o desenvolvedor.
Se o desenvolvedor tivesse optado por utilizar a rotina padro encapsulada em seu
desenvolvimento ele no teria problemas em adaptar sua rotina as novas
necessidades do sistema, pois a rotina padro j se preocupada com a
compatibilidade entre as verses, possibilitando que uma simples manuteno
atualize toda a rotina especfica, isto se esta manuteno for necessria, pois a
rotina padro poder tratar a novas informaes com contedos padres
dependendo da situao em que estas no forem informadas.
A aplicao ERP pode ser personalidada atravs de pontos de entrada e
do dicionrio de dados:
A partir do momento que uma aplicao padro desenvolvida e disponibilizada a
mesma pode sofrer diversas personalizaes em campo, as quais podem ser
implementadas em paralelo ou aps o desenvolvimento da rotina especfica
disponibilizada pelo desenvolvedor.
Se esta situao no for prevista, a incluso de informaes utilizando a rotina
padro do sistema poder sofrer diversas validaes ou at mesmo efetuar a
gravao de informaes adicionais, as quais no esto visveis na rotina especfica,
gerando graves inconistncias na base de dados.
Avaliando estas consideraes percebesse o fator de sucesso que um desenvolvimento
especfico pode ter ao optar por refazer todos os tratamentos do sistema em detrimento de
utilizar a funcionalidade MsExecAuto, ou seja, qualquer modificao no ambiente,
independente do quo simples pode tornar a rotina especfica inadequada.
Quando utilizar a funcionalidade MsExecAuto ?

Tendo em vista este cenrio fica a pergunta: Quando utilizar a funcionalidade MsExecAuto ?
A resposta pode ser bvia e at conservadora, mas Sempre que a funcionalidade estiver
disponvel naquele processo.
Em resumo, qualquer funcionalidade de interface, seja ela de carga ou contnua, qualquer
funcionalidade de atualizao, ou seja, qualquer manuteno na base de dados do sistema,
sempre que possvel, deve utilizar a funcionalidade MsExecAuto.
Processos da aplicao ERP com tratamentos para execuo por MsExecAuto
Pode-se dizer que as principais rotinas de atualizao do ERP Protheus atualmente possuem o
tratamento necessrio para sua execuo por MsExecAuto, e com base nas necessidades de
desenvolvimento internas da TOTVS e nas melhorias solicitadas por clientes e analistas de
implantao as demais rotinas necessrias so atualizadas para contemplar este tratamento.
O quadro abaixo ilustra um dos ltimos cenrios de tratamento de MsExecAuto pelas rotinas
da aplicao ERP Protheus.
Rotina
ATFA010
ATFA030
ATFA035
CFGX016
CTBA015
CTBA016
CTBA020
CTBA102
CTBA270
FATA140
FATA220
FATA300
FATA310
FATA320
FINA010
FINA040
FINA050
FINA070
FINA080
FINA390
MATA040
MATA080
MATA103
MATA105
MATA110
MATA116A
MATA120
MATA125
MATA140
MATA145
MATA150
Parmetros
(xAutoCab, xAutoItens, nOpcAuto)
(xAutoCab, nOpc)
(xAutoCab, nOpc)
(xAutoCab, xAutoItens)
(nOpcAuto, aAuto)
(nOpcAuto, aAuto)
(aRotAuto, nOpcAuto, aRotItem)
(nOpcAuto, aAuto)
(nOpcAuto, aAutoCab)
(nOpcAuto, xAutoCab, xAutoAD2, xAutoAD3, xAutoAD4, xAutoAD9)
(xAutoVend, xAutoTask, xAutoCalend)
(aRotAuto, nOpcAuto)
(aRotAuto, nOpcAuto)
(aRotAuto, nOpcion, nOpcAuto)
(xAutoCab, nOpc)
(xAutoCab, nOpc)
(nPosArotina, xAutoCab, nOpcAuto)
(aAuto, nOpcAuto)
(aRotauto, nOpcAuto)
(xAutoCab, xAutoItens, nOpcAuto, lWhenGet, xAutoImp)
(xReservCab, xReservItens, nOpcAuto)
(xAutoCab, xAutoItens, lInclui)
(nFuncao, xAutoCab, xAutoItens, nOpcAuto, )
(xAutoCab, xAutoIt, xAutoIt2, nOpcAuto)
Rotina
MATA175
MATA185
MATA200
MATA230
MATA241
MATA242
MATA261
MATA265
MATA266
MATA267
MATA360
MATA410
MATA415
MATA416
MATA490
MATA685
MATA700
MATA920
TMKA061
TMKA062
TMKA271
TMSA040
TMSA050
TMSA170
TMSA360
TMSA430
TMSA440
Parmetros
(xRotAuto, xOpcAuto)
(xAutoSCP, xAutoSD3, nOpcAuto, xPerg)
(aAuto, nOpcAuto)
(xAutoCab, xAutoItens, nCallOpcx)
(aAutoItens, nOpcAuto)
(aAutoItens)
(aAutoItens)
(xAutoCab, xAutoItens)
(xAuto, nOpcAuto)
(xAuto, nOpcAuto)
(xAutoCab, xAutoItens, xItensPesM3, xItensEnder, nOpcAuto)
(xAutoCab, nOpcAuto)
(xAutoCab, xAutoItens, xAutoNFAva, nOpcAuto)
(cAlias, xAutoCab, xAutoVei, xAutoMot, nOpcAuto)
Quando no utilizar a funcionalidade MsExecAuto

Apesar de todas as orientaes dos tpicos anteriores existem situaes nas quais no
recomendado utilizar a funcionalidade MsExecAuto, no caso, em situaes para as quais
existem rotinas padres da aplicao ERP para processamentos de integraes e atualizaes
que possuem tratamento para execuo direta ou execuo via Job.
Para estes casos a rotina j est pr-disposta a execuo direta, no havendo a necessidade
de tratamento via MsExecAuto, ou o tratamento realizado pela rotina o mais adequado para
aquele volume de dados.
O exemplo clssico desta situao para importao de lanamentos ou saldos contbeis. A
aplicao ERP possui uma rotina de integrao denominada Contabilizao TXT (CTBA500)
mas a rotina de lanamentos contbeis (CTBA102)
pode ser executada atravs da
MsExecAuto.
Para importaes de saldos e lanamentos deve-se optar pela utilizao da rotina de
Contabilizao TXT, devido aos tratamentos que a mesma permite atravs das configuraes
da prpria rotina em conjunto com as parametrizaes do mdulo. O uso da CTBA102
Laamentos Contbeis via MsExecAuto recomendado para rotinas de manuteno ou
funcionalidades especficas / melhorias, com por exemplo o estorno de lanamentos contbeis
sem a necessidade de avaliar regras de contabilizao.
41.1. Desenvolvendo aplicaes com MsExecAuto

Estrutura de uma rotina com execuo de MsExecAuto
Definio das variveis de controle da MsExecAuto
Montagem dos arrays de parmetros
Definio dos parmetros especficos da rotina que ser executada
Controle de transao
Tratamento do sucesso ou no da operao
Variveis de controle
Private lMsErroAuto
Indica de se houve erro no fatal durante a execuo.
Private lMsHelpAuto
Habilita a captura das mensagens de erro.
Private lAutoErrNoFile
Desabilita a gerao do arquivo de log padro do sistema.
Montagem dos arrays de parmetros
Tipos de arrays de parmetros:
Basicamente uma MsExecAuto possui dois tipos de arrays de parmetros: Array de
Dados de Cabealho e Array de Dados de Itens.
Os exemplos a seguir visam ilustrar a utilizao de cada uma dos tipos de arrays:
Cadastro de clientes (MATA030): Esta rotina atualiza apenas os dados da tabela
SA1 Cadastro de Clientes, portanto ser necessrio apenas um array de dados
contendo as informaes que devero ser gravadas na tabela SA1.
Documentos de entrada (MATA103): Esta rotina atualiza basicamente os dados
das tabelas SF1 Cabealho do Documento de Entrada e SD1 Itens do
Documento de entrada, portanto sero necessrios dois arrays de dados
contendo as informaes do cabealho do documento de entrada e dos itens do
documento de entrada, sendo que este ltimo ter sua estrutura de contedo
repetida para cada item do documento.
Aviso de Recebimento de Carga (MATA145): Esta rotina atualiza basicamente os
dados das tabelas DB1 Aviso de Recebimento de Carga, DB2 Cabealho do
documento recebido e DB3 Itens do documento recebido, portanto so
necessrios trs array de dados contendo as respectivas informaes para as
tabelas DB1, DB2 e DB3, sendo que as duas ltimas tero suas estruturas de
contedo repetidas para cada documento recebido.
Estrutura dos arrays de parmetros:

Array de dados do cabealho (xAutoCab):
O array contendo os dados do cabealho composto por: Campo, Contedo e
Validao.
Cada item deste array um dos campos da tabela de cabealho das informaes
que sero processadas pela MsExecAuto. Com base nos exemplos anteriores, a
MsExecAuto da MATA030 possui apenas um array de parmetros no formato
xAutoCab, sendo que a MATA103 utilizar o xAutoCab para a tabela SF1 e a
MATA145 para a tabela DB1.
Sintaxe:
AADD(xAutoCab,{Campo, xContedo, Validao})
Exemplo:
AADD(xAutoCab,{A1_FILIAL
AADD(xAutoCab,{A1_COD
AADD(xAutoCab,{A1_LOJA
AADD(xAutoCab,{A1_NOME
,
,
,
,
xFilial(SA1)
000001
01
TESTE-000001
,
,
,
,
Nil})
Nil})
Nil})
Nil})
MsExecAuto({|x,y| MATA030(x,y)}, xAutoCab, 3)
Array de dados dos itens (xAutoItens):

O array contendo os dados dos itens tambm composto por: Campo, Contedo
e Validao; sendo que a diferena est no fato de que para cada item a ser
tratado pela MsExecAuto dever ser repetida e preenchida a estrutura do array
com as informaes do mesmo.
Com base nos exemplos anteriores, a MsExecAuto da MATA030 no possui um
array de parmetros no formato xAutoItens, j a MATA103 utilizar o xAutoItens
para a tabela SD1 e a MATA145 utilizar dois xAutoItens, sendo o primeiro para
a tabela DB2 e o segundo para a tabela DB3.
Sintaxe:
<Estrutura de controle e repetio>

xAutoItem := {}
AADD(xAutoItem,{Campo, xContedo, Validao})
AADD(xAutoItens, xAutoItem)
</Estrutura>
Exemplo:
AADD(xAutoCab,{F1_FILIAL
AADD(xAutoCab,{F1_DOC
AADD(xAutoCab,{F1_SERIE
AADD(xAutoCab,{F1_FORNECE
AADD(xAutoCab,{F1_LOJA
,
,
,
,
,
xFilial(SF1)
000001
1
000001
01
,
,
,
,
,
Nil})
Nil})
Nil})
Nil})
Nil})
For nX := 1 to 2
xAutoItem := {}
AADD(xAutoItem,{D1_FILIAL
AADD(xAutoItem,{D1_DOC
AADD(xAutoItem,{D1_SERIE
AADD(xAutoItem,{D1_FORNECE
AADD(xAutoItem,{D1_LOJA
AADD(xAutoItem,{D1_ITEM
AADD(xAutoItem,{D1_COD
AADD(xAutoItem,{D1_QUANT
AADD(xAutoItem,{D1_VUNIT
AADD(xAutoItem,{D1_TOTAL
AADD(xAutoItem,{D1_TES
,
,
,
,
,
,
,
,
,
,
,
xFilial(SD1)
000001
1
000001
01
STRZERO(nx,04)
STRZERO(nx,15)
100*nX
5*nX
(100*nX)*(5*nX)
001
,
,
,
,
,
,
,
,
,
,
,
Nil})
Nil})
Nil})
Nil})
Nil})
Nil})
Nil})
Nil})
Nil})
Nil})
Nil})
AADD(xAutoItens, xAutoItem)
Next nX
MsExecAuto({|x,y,z| MATA103(x,y,z)}, xAutoCab, xAutoItens, 3)
Mtodo de atribuio de contedo Direto:

O mtodo direto consiste em atribuir diretamente na montagem do array de parmetros
o contedo de cada campo que ser tratado pela MsExecAuto.
Este mtodo o mais comum de ser utilizado dado sua praticidade, e pela possibilidade
do desenvolvedor especificar somente os campos obrigatrios para a tabela e aqueles
que contero as informaes geradas por sua aplicao.
Exemplo:
,
,
,
,
xFilial(SA1)
000001
01
TESTE-000001
,
,
,
,
Nil})
Nil})
Nil})
Nil})
Mtodo de atribuio de contedo pela estrutura:

O mtodo de atribuio pela estrutura recomendvel em rotinas que efetuam a
importao das informaes atravs da leitura de arquivos de dados, sejam eles
CODEBASE ou via banco de dados.
Este mtodo consiste em comparar a estrutura do arquivo de origem (a ser importado)
contra a do arquivo de destino (tratado pela MsExecAuto). Desta forma os campos que
forem coincidentes entre o arquivo de origem e o arquivo de destino sero preenchidos
com as informaes do arquivo importado, caso contrrio os mesmos podero ser
desconsiderados ou serem preenchidos com um contedo padro.
Exemplo:
// Captura a estrutura da tabela padro do sistema

DbSelectArea("SN1")
DbSetOrder(1)
aStruSN1 := SN1->(DbStruct())
// Efetua a abertura do arquivo SN1 que ser importado
cArqSN1:= cDirArq+"SN1IMP"
IF File(cArqSN1+cFileExt)
dbUseArea(.T.,,cArqSN1+cFileExt,"SN1IMP",.F.,.F.)
IndRegua("SN1IMP",cArqSN1+OrdBagExt(),"N1_FILIAL+N1_CBASE+N1_ITEM",;
,,"Selecionando Registros...")
ELSE
HELP("IATF001",1,"HELP","NO_FILE","ARQUIVO SN1IMP no existe."+;
CRLF+"Verifique caminho informado.",1,0)
RETURN
ENDIF
// Efetua a leitura do arquivo a ser importado
DbSelectArea("SN1IMP")
DbGotop()
WHILE SN1IMP->(!Eof())
// Efetua a montagem do xAutoCab com base nas estruturas dos
// arquivos
FOR nX := 1 TO LEN(aStruSN1)
IF SN1IMP->(FieldPos(aStruSN1[nX][1]))>0
DO CASE
CASE EMPTY(SN1IMP->&(aStruSN1[nX][1]))
AADD(xAutoCab,{aStruSN1[nX][1],;
CRIAVAR(aStruSN1[nX][1]), NIL})
CASE aStruSN1[nX][2] == "C"
SN1IMP->&(aStruSN1[nX][1]),;
"",aStruSN1[nX][3]), NIL})
CASE aStruSN1[nX][2] == "N"
ABS(SN1IMP->&(aStruSN1[nX][1])), NIL})
OTHERWISE
SN1IMP->&(aStruSN1[nX][1]), NIL})
ENDCASE
ELSE
ENDIF
NEXT nX
...
MsExecAuto({|x,y,z| ATFA010(x,y,z)}, xAutoCab, xAutoItens, 3)
END
Definio dos parmetros especficos da rotina que ser executada

Este ponto no qual o desenvolvedor inclui os tratamentos necessrios a correta execuo da
rotina, alm de seus tratamentos especficos, os quais justificaram o desenvolvimento.
Utilizando o mesmo exemplo anterior da ATFA010 Cadastro de Ativos podemos citar dois
tratamentos especficos necessrios para a correta execuo da MsExecAuto:
Chamada das perguntas da ATFA010:
A execuo da funo Pergunte(ATFA010,.F.) permite que seja definidos os
contedos desejados para os parmetros da rotina de cadastro conforme a
necessidade da aplicao, como por exemplo permitir a incluso de uma chapa de
bem em branco ou no efetuar a contabilizao da incluso.
Atualizao das variavis de memria do ALIAS M-> para o SN1:
A execuo da funo RegToMemory(SN1,.T.) necessria para a utilizao da
funo CRIAVAR() no mtodo de atribuio pela estrutura.
Muitas vezes uma estrutura que funciona para um MsExecAuto pode no
funcionar para outro do mesmo tipo, devido as caractersticas individuais de
cada rotina. Podemos citar os seguintes exemplos:
MATA103 (Documento de Entrada): Para tratamento do ttulo
financeiro a ser gerado pela nota fiscal quando o parmetro de
atualizao de financeiro da TES est ativado, deve ser includo
o seguinte item no array xAutoCab:
{" E2_NATUREZ "
,"NAT01"
,NIL})
MATA650 (Abertura de ordem de produo): Para que sejam

geradas as ordens de produo intermedirias na abertura de
uma ordem de produo principal deve ser includo o seguinte
item no array xAutoCab:
{"AUTEXPLODE"
,"S"
,NIL})
Controle de transao
A utilizao do controle de transao permite garantir a integridade das informaes gravadas
pelo processamento.
Para utilizao do controle de transao na aplicao podem ser utilizados os seguintes blocos
de controle:
Begin Transaction ... DisarmTransaction() ... End Transaction
Um bloco de cdigo determinado pelos comandos Begin Transaction ... End Transaction
ter suas informaes atualizadas somente se antes do execuo do comando End
Transaction no for executada a funo DisarmTransaction().
Desta forma pode-se implementar um controle de transao por item processado, sendo
executado o DisarmTransaction() para aquele elemento em que houve algum problema
de processamento.
Seguindo este mesmo raciocnio, caso ocorra um erro fatal na aplicao, somente o item
que est em processamento ser desconsiderado, pois a aplicao ERP efetua um
DisarTransaction() automaticamente, fechamento as transaes pendentes e
restaurando as situaes anteriores, mas apenas para aqueles processamento protegidos
pelo bloco de controle de transao.
O comando END TRANSACTION no pode ter sua interpretao vinculada a

uma condio. Nestes casos ocorrer um erro de compilao indicando que o
bloco aberto pelo comando BEGIN TRANSACTION no foi corretamente
fechado.
Exemplo:
,
,
,
,
xFilial(SA1)
000001
01
TESTE-000001
BEGIN TRANSACTION
lMsErroAuto := .F.
IF lMsErroAuto
DisarmTransaction()
ENDIF
END TRANSACTION
,
,
,
,
Nil})
Nil})
Nil})
Nil})
BeginTran() ... DisarmTransaction() ... EndTran()

As funes BeginTran() e EndTran() visam permitir que o trmino da transao seja
condicional, eliminando a limitao da estrutura BEGIN TRANSACTION ... END
TRANSACTION.
Exemplo:
,
,
,
,
xFilial(SA1)
000001
01
TESTE-000001
,
,
,
,
Nil})
Nil})
Nil})
Nil})
BeginTran()
lMsErroAuto := .F.
IF lMsErroAuto
DisarmTransaction()
ELSE
EndTran()
ENDIF
MsUnlockAll()
Neste modelo de controle de transao recomendvel a utilizao da funo

MsUnlockAll() para destravar todos os registros que estejam eventualmente
travados.
Tratamento de mensagens de erro

Com a utilizao da funcionalidade MsExecAuto a aplicao ERP disponibiliza diversos mtodos
para visualizao e tratamento das mensagens de erro ocorridas durante a execuo da rotina,
sendo estes:
Visualizao do evento de erro;
Gravao do evento de erro em arquivo texto;
Personalizao da gravao do evento de erro.
Visualizao do evento de erro

Para visualizao em tela do evento de erro ocorrido durante o processamento da
rotina via MsExecAuto deve-se utilizar a funo MostraErro(), conforme o exemplo:
Private lMsHelpAuto
:= .T.
Private lAutoErrNoFile := .F.
,
,
,
,
xFilial(SA1)
000001
01
TESTE-000001
,
,
,
,
Nil})
Nil})
Nil})
Nil})
BEGIN TRANSACTION
lMsErroAuto := .F.
IF lMsErroAuto
MostraErro()
DisarmTransaction()
ENDIF
END TRANSACTION
O contedo das variveis PRIVATE de controle da MsExecAuto deve ser

configurado conforme abaixo:
Private lMsHelpAuto
Private lAutoErrNoFile
:= .T.
:= .F.
Gravao do evento de erro em arquivo texto

Para gravao em arquivo no formato texto do evento de erro ocorrido durante o
processamento da rotina via MsExecAuto deve-se utilizar a funo MostraErro(),
conforme o exemplo:
Private lMsHelpAuto
:= .T.
Private lAutoErrNoFile := .F.
,
,
,
,
xFilial(SA1)
000001
01
TESTE-000001
,
,
,
,
Nil})
Nil})
Nil})
Nil})
BEGIN TRANSACTION
lMsErroAuto := .F.
IF lMsErroAuto
MostraErro(\system\)
DisarmTransaction()
ENDIF
END TRANSACTION
A funo MostraErro() possui o parmetro cPath o qual pode ser informado

de duas formas:
Apenas o diretrio: Se for informado apenas o diretrio ser
gerado um arquivo com denominao no formato SCxxxxxx.log,
aonde xxxxxx ser um nmero sequencial gerado internamente
pelo sistema.
Informando o diretrio e o nome do arquivo: A funo ir
respeitar o nome do arquivo informado, sobrescrendo o
contedo anterior.
Caso seja necessrio gerar um nico arquivo texto contendo todos os

eventos de erro gerados pelos sucessivos processamentos da MsExecAuto,
a funo MostraErro(cPath) dever ser chamada apenas uma vez, ao
trmino do processamento da rotina.
Isto ocorre pois a funo MostraErro() limpa o cache de eventos de erros
controlado pela MsExecAuto.
Personalizao da gravao do evento de erro

Para processamentos mais volumosos, a gerao de diversos arquivos de textos ou
at mesmo a gerao de um nico arquivo texto contendo todos os eventos de erro
pode dificultar a anlise e correo dos problemas encontrados durante o
processamento.
Desta forma possvel personalizar a gravao do evento de erro, de forma que o
mesmo seja gerado em um arquivo no formato .DBF, permitindo o vnculo do registro
processado com a mensagem de erro gerada.
Private lMSHelpAuto
:= .F.
Private lAutoErrNoFile := .T.
, 000001
, 01
, TESTE-000001
, Nil})
, Nil})
, Nil})
// Funo especfica que cria o arquivo no formato DBF que conter as

// mensagens de erro.
XDBFLOG()
BEGIN TRANSACTION
lMsErroAuto := .F.
IF lMsErroAuto
// Funo que retorna o evento de erro na forma de um array
aAutoErro := GETAUTOGRLOG()
// Funo especifica que converte o array aAutoErro em texto
// contnuo, com a quantidade de caracteres desejada por linha
// Funo especfica que efetua a gravao do evento de erro no
// arquivo previamente crado.
XGRVLOG(XCONVERRLOG(aAutoErro))
DisarmTransaction()
ENDIF
END TRANSACTION
As funes especficas XDBFLOG(), XCONVERRLOG() e XGRVLOG() sero

detalhadas no exemplo completo de utilzao da funo MsExecAuto().
Aplicao completa de importao utilizando MsExecAuto: Carga de imobilizado

#INCLUDE "PROTHEUS.CH"
/*/
+----------------------------------------------------------------------| Funo
| IATF001
|
+----------------------------------------------------------------------| Descrio | IMPORTACAO DO CADASTRO DE ATIVO IMOBILIZADO
|
+----------------------------------------------------------------------| Uso
| Curso ADVPL
|
+----------------------------------------------------------------------/*/
USER FUNCTION IATF001()
LOCAL oProcess
PRIVATE oMainWnd
//Perguntas para parametrizacao da rotina (PARAMBOX)
//MVParBox01 - Tipo de informao (.DBF/.TXT)
//MVParBox02 - LayOut do arquivo (Padro / Especifico)
//MVParBox03 - Arquivo de dados
(Consulta)
//MVParBox04 - Arquivo de layout (Consulta)
//MVParBox05 - Operacao
(Incluir, Alterar, Excluir)
//MVParBox06 - Diretorio de Log
(Consulta)
//MVParBox07 - Importa CIAP
(SIM/NAO)
PRIVATE
PRIVATE
PRIVATE
PRIVATE
PRIVATE
PRIVATE
PRIVATE
PRIVATE
aTiposFile
MvParBox01
MvParBox02
MvParBox03
MvParBox04
MvParBox05
MvParBox06
MVParBox07
PRIVATE _cDirectory
:=
:=
:=
:=
:=
:=
:=
:=
{".DBF",".DTC",".TXT"}
0
0
""
""
0
""
0
:= ""
RpcSetType(3)
RpcSetEnv("99", "01",,,,,
{"CT1","SF9","SN1","SN2","SN3","SN4","SN5","SNG","SM2"})
SET DATE FORMAT "dd/mm/yyyy"
oMainWnd := TWindow():New( 000, 000, 001, 001, "Importao: Fichas do
imobilizado",,,,,,,,,,,,,,,,.T.)
oMainWnd:bInit := {|| IIF(IC001PARBX(),(oProcess:= MsNewProcess():New({|lEnd|
PROCATIVO(.F.,oProcess)}),oProcess:Activate(),oMainWnd:End()),oMainWnd:End())}
oMainWnd:Activate("ICONIZED")
RpcClearEnv()
RETURN
Continuao:
/*/
+----------------------------------------------------------------------| Funo
| PROCATIVO
|
+----------------------------------------------------------------------| Descrio | PROCESSAMENTO DA IMPORTACAO DO CADASTRO DE IMOBILIZADO
|
+----------------------------------------------------------------------| Uso
| Curso ADVPL
|
+----------------------------------------------------------------------/*/
STATIC FUNCTION PROCATIVO(lEnd,oProcess)
Local
Local
Local
Local
Local
Local
Local
Local
Local
Local
Local
Local
Local
Local
Local
Local
Local
Local
Local
Local
Local
Local
Local
Local
Local
Local
Local
Local
Local
Local
Local
Local
aArea
aDadosSN1
aDadosSN3
aDadosSF9
aDadosTN1
aDadosTN2
aDadosTN3
aItemSN3
cArqSN1
cArqSN2
cArqSN3
cArqSA2
aStruSN1
aStruSN2
aStruSN3
aStruSF9
nX
nTotRegs
nProcRegs
nPosDados
cCodFor
cLojaFor
cDescFor
cFilAtu
cDirArq
cHistorico
nX
cFileExt
lImpSF9
lImpSNG
cKeyImp
aAutoErro
:=
:=
:=
:=
:=
:=
:=
:=
:=
:=
:=
:=
:=
:=
:=
:=
:=
:=
:=
:=
:=
:=
:=
:=
:=
:=
:=
:=
:=
:=
:=
:=
GetArea()
{}
{}
{}
{}
{}
{}
{}
""
""
""
""
{}
{}
{}
{}
0
0
0
0
""
""
""
cFilAnt
Alltrim(MVParBox03)
""
0
aTiposFile[MvParBox01]
MvParBox07==1
.F. // Ainda nao implementado
""
{}
// Tratamentos adicionais - arquivos especificos do cliente

Local cArqCTA
:= ""
Local cArqSM2
:= ""
Local cIndSNG
Local nIndex
:= 0
Local cGrupo
:= ""
Local cContab
:= ""
Local aEntSNG
:= {}
Local cChapa
:= "000000"
Private lMsErroAuto
Private lMSHelpAuto
:= .F.
:= .F.
Continuao:
Private lAutoErrNoFile := .T.
// Garante a abertura dos arquivos padres do sistema
DbSelectArea("CT1")
DbSetOrder(2) // FILIAL + COD.REDUZIDO
DbSelectArea("SM2")
DbSetOrder(1)
DbSelectArea("SN1")
DbSetOrder(1)
DbSelectArea("SN2")
DbSetOrder(1)
DbSelectArea("SN3")
DbSetOrder(1)
DbSelectArea("SF9")
DbSetOrder(1)
aStruSF9 := SF9->(DbStruct())
// Prepara o arquivo no formato .DBF para gravao dos eventos de erro
XDBFLOG()
DbSelectArea("SNG")
cIndSNG := CRIATRAB(Nil,.F.)
IndRegua("SNG",cIndSNG,"NG_FILIAL+NG_CCONTAB",,,"Selecionando Registros...")
nIndex := RetIndex()
#IFNDEF TOP
DbSetIndex(cIndSNG+OrdBagExt())
#ENDIF
DbSetOrder(nIndex)
PERGUNTE("ATF010",.F.)
MV_PAR02 := 1 // Permite repetir chapa definido como sim
IF Select("SN1IMP") > 0
DbCloseArea()
ENDIF
DbCloseArea()
ENDIF
DbCloseArea()
ENDIF
IF Select("SF9IMP") > 0
DbSelectArea("SF9IMP")
DbCloseArea()
ENDIF
Continuao:
IF Select("CTAIMP") > 0
DbSelectArea("CTAIMP")
DbCloseArea()
ENDIF
IndRegua("SN1IMP",cArqSN1+OrdBagExt(),"N1_FILIAL+N1_CBASE+N1_ITEM",,,;
"Selecionando Registros...")
ELSE
HELP("IATF001",1,"HELP","NO_FILE","ARQUIVO SN1IMP no existe."+CRLF+;
"Verifique caminho informado.",1,0)
RETURN
ENDIF
IF File(cArqSN2+cFileExt )
IndRegua("SN2IMP",cArqSN2+OrdBagExt(),;
"N2_FILIAL+N2_CBASE+N2_ITEM+N2_TIPO+N2_SEQ",,,"Selecionando Registros...")
ELSE
RETURN
ENDIF
IndRegua("SN3IMP",cArqSN3+OrdBagExt(),"N3_FILIAL+N3_CBASE+N3_ITEM",,,;
ELSE
RETURN
ENDIF
IF lImpSF9
cArqSF9:= cDirArq+"SF9IMP"
IF File(cArqSF9+cFileExt )
dbUseArea(.T.,,cArqSF9+cFileExt,"SF9IMP",.F.,.F.)
IndRegua("SF9IMP",cArqSF9+OrdBagExt(),"F9_FILIAL+F9_CODIGO",,,;
ELSE
HELP("IATF001",1,"HELP","NO_FILE","ARQUIVO SF9IMP no existe."+;
CRLF+"Verifique caminho informado.",1,0)
RETURN
ENDIF
ENDIF
Continuao:
cArqCTA:= cDirArq+"CTAIMP"
IF File(cArqCTA+cFileExt)
dbUseArea(.T.,,cArqCTA+cFileExt,"CTAIMP",.F.,.F.)
IndRegua("CTAIMP",cArqCTA+OrdBagExt(),"CODIGO_CON",,,;
ELSE
HELP("IATF001",1,"HELP","NO_FILE","ARQUIVO CTAIMP no existe."+CRLF+;
RETURN
ENDIF
cArqSM2:= cDirArq+"SM2IMP"
IF File(cArqSM2+cFileExt)
dbUseArea(.T.,,cArqSM2+cFileExt,"SM2IMP",.F.,.F.)
IndRegua("SM2IMP",cArqSM2+OrdBagExt(),"DTOS(BTN_DATA)",,,"Selecionando
Registros...")
ELSE
HELP("IATF001",1,"HELP","NO_FILE","ARQUIVO SM2IMP no existe."+CRLF+;
RETURN
ENDIF
lMSHelpAuto := .T.
DbGotop()
//
// Preparao para inicio do processamento
//
cKeyImp := DTOS(dDatabase)+StrZero(HoraToInt(Time()),6)
// Identidficador dos registros do log de erros
ConOut("Processando importao:")
ConOut("Inicio: "+Time())
ConOut("Registros SN1IMP: "+CValToChar(SN1IMP->(RecCount())))
dbEval( {|x| nTotRegs++ },,{||SN1IMP->(!EOF())})
oProcess:SetRegua1(nTotRegs+2)
oProcess:IncRegua1("Iniciando processamento...")
oProcess:SetRegua2(nTotRegs+1)
oProcess:IncRegua2("Ficha de Ativo:")
DbGotop()
Continuao:
While SN1IMP->(!Eof())
nProcRegs++
oProcess:IncRegua1("Processando item: "+CValToChar(nProcRegs)+" / "+;
CValToChar(nTotRegs))
oProcess:IncRegua2("Ficha de Ativo: ")
aDadosSN1 := {}
aDadosSN3 := {}
// Compatibilizao para utilizao do CRIAVAR()
REGTOMEMORY("SN1",.T.)
//Monstagem do array com dados sem tratamento e com as informao da IMP
DO CASE
AADD(aDadosSN1,{aStruSN1[nX][1],;
"",aStruSN1[nX][3]), NIL})
ABS(SN1IMP->&(aStruSN1[nX][1])), NIL})
OTHERWISE
ENDCASE
ELSE
AADD(aDadosSN1,{aStruSN1[nX][1], CRIAVAR(aStruSN1[nX][1]),;
NIL})
ENDIF
NEXT nX
// Alterao das informaes do array de acordo com a necessidade
// AADD(aDadosTN1,{"CAMPO",CONTEUDO,"VALIDACAO"})
aDadosTN1
:= {}
// ALTERACAO DO ARRAY ADADOSSN1 COM AS INFORMACOES TRABALHADAS E
// ARMAZENADAS EM ADADOSTN1
// AADD(aDadosTN1,{"N1_XXXXXX"
,xConteudo
,Nil})
For nX := 1 TO LEN(aDadosTN1)
IF (nPosField := aScan(aDadosSN1,{|aDadoSN1| aDadosSN1[1] ==;
aDadosTN1[nX][1]})) > 0
aDadosSN1[nPosField][2] := aDadosTN1[nX][2]
aDadosSN1[nPosField][3] := aDadosTN1[nX][3]
ENDIF
Next nX
Continuao:
IF SN1->(DbSeek(aDadosSN1[1][2]+aDadosSN1[2][2]+aDadosSN1[3][2]))
ConOut("Registro j importado: "+;
aDadosSN1[1][2]+"/"+aDadosSN1[2][2]+"/"+aDadosSN1[3][2])
ConOut("Registros importados com sucesso: "+CValToChar(nProcRegs))
SN1IMP->(dbSkip())
Loop
ENDIF
SN3IMP->(DbSeek(SN1IMP->(N1_FILIAL+N1_CBASE+N1_ITEM)))
While SN3IMP->(!Eof()) .AND. SN3IMP->(N3_FILIAL+N3_CBASE+N3_ITEM) ==;
SN1IMP->(N1_FILIAL+N1_CBASE+N1_ITEM)
aItensSN3 := {}
// Monstagem do array com dados sem tratamento e com as informaes
DO CASE
AADD(aItensSN3,{aStruSN3[nX][1],;
aStruSN3[nX][3]), NIL})
ABS(SN3IMP->&(aStruSN3[nX][1])),;
".T."})
OTHERWISE
ENDCASE
ELSEIF aStruSN3[nX][2] == "N"
CRIAVAR(aStruSN3[nX][1]), ".T."})
ELSE
ENDIF
NEXT nX
// Alterao das informaes do array de acordo com a necessidade
// AADD(aDadosTN3,{"CAMPO"
,CONTEUDO,"VALIDACAO"})
aDadosTN3 := {}
// ALTERACAO DO ARRAY aItenSN3
// ARMAZENADAS EM aDadosTN3
COM AS INFORMACOES TRABALHADAS E
For nX := 1 TO LEN(aDadosTN3)
IF (nPosField := aScan(aItensSN3,{|aItenSN3| aItenSN3[1] ==;
aDadosTN3[nX][1]})) > 0
aItensSN3[nPosField][2] := aDadosTN3[nX][2]
aItensSN3[nPosField][3] := aDadosTN3[nX][3]
Continuao:
ENDIF
Next nX
AADD(aDadosSN3,aItensSN3)
SN3IMP->(DbSkip())
Enddo
IF
Len(aDadosSN1) > 0 .AND. Len(aDadosSN3) > 0

ConOut("Iniciando MsExecAuto - ATFA010: "+Time())
Begin Transaction
cFilAnt := SN1IMP->N1_FILIAL
lMsErroAuto := .F.
MSExecAuto({|x,y,z| Atfa010(x,y,z)},aDadosSN1,aDadosSN3,3)
// Cabealho, Itens e Opo
ConOut("Finalizada MsExecAuto - ATFA010: "+Time())
IF lMsErroAuto
aAutoErro := GETAUTOGRLOG()
XGRVLOG(cKeyImp,;
SN1IMP->(N1_FILIAL+N1_CBASE+N1_ITEM),;
SN1IMP->N1_DESCRIC, XCONVERRLOG(aAutoErro))
DisarmTransaction()
MostraErro(Alltrim(MVParBox06))
ELSE
// TRATAMENTO DA DESCRIO ESTENDIDA (SN2)
SN2IMP->(DbSeek(SN1IMP->(N1_FILIAL+N1_CBASE+N1_ITEM)))
cHistorico := ALLTRIM(SN2IMP->N2_HISTOR1) +;
ALLTRIM(SN2IMP->N2_HISTOR2)
For nX := 1 to Len(cHistorico) STEP 40
RECLOCK("SN2",.T.)
SN2->N2_FILIAL
:=
SN2->N2_CBASE
:=
SN2->N2_ITEM
:=
SN2->N2_TIPO
:=
SN2->N2_SEQ
:=
SN2->N2_SEQUENC
:=
SN2->N2_HISTOR
:=
MSUNLOCK()
SN1->N1_FILIAL
SN1->N1_CBASE
SN1->N1_ITEM
"01"
"001"
STRZERO(nX,2)
SUBSTR(cHistorico,nX,40)
NEXT nX
// TRATAMENTO DA CARGA DO CIAP
IF lImpSF9
IATFCIAP(aStruSF9,aDadosSF9)
ENDIF
ConOut("Registros importados com sucesso: "+;
CValToChar(nProcRegs))
ENDIF
End Transaction
Continuao:
ENDIF
SN1IMP->(DbSkip())
Enddo
oProcess:IncRegua1("Processamento finalizado")
DbCloseArea()
IF File(cArqSN1+OrdBagExt())
FErase(cArqSN1+OrdBagExt())
ENDIF
DbCloseArea()
ENDIF
DbCloseArea()
ENDIF
IF lImpSF9
DbSelectArea("SF9IMP")
DbCloseArea()
IF File(cArqSF9+OrdBagExt())
FErase(cArqSF9+OrdBagExt())
ENDIF
ENDIF
IF lImpSNG
DbSelectArea("SNGIMP")
DbCloseArea()
IF File(cIndSNG+OrdBagExt())
FErase(cIndSNG+OrdBagExt())
ENDIF
ENDIF
DbSelectArea("CTAIMP")
DbCloseArea()
IF File(cArqCTA+OrdBagExt())
FErase(cArqCTA+OrdBagExt())
ENDIF
DbSelectArea("SM2IMP")
DbCloseArea()
IF File(cArqSM2+OrdBagExt())
FErase(cArqSM2+OrdBagExt())
ENDIF
Continuao:
DbSelectArea("LOGIMP")
DbCloseArea()
ConOut("Total de registros importados: "+CValToChar(nProcRegs))
ConOut("Trmino da importao: "+Time())
cFilAnt := cFilAtu
RestArea(aArea)
RETURN
/*/
+----------------------------------------------------------------------| Funo
| CT001PARBX
|
+----------------------------------------------------------------------| Descrio | TELA DE PARAMETROS ESPECIFICOS DA ROTINA CUSTOMIZADA
|
+----------------------------------------------------------------------| Uso
| Curso ADVPL
|
+----------------------------------------------------------------------/*/
STATIC FUNCTION IC001PARBX()
LOCAL
LOCAL
LOCAL
LOCAL
LOCAL
LOCAL
LOCAL
LOCAL
LOCAL
LOCAL
LOCAL
LOCAL
LOCAL
aParamBox
cTitulo
aRet
bOk
aButtons
lCentered
nPosx
nPosy
cLoad
lCanSave
lUserSave
nX
lRet
:=
:=
:=
:=
:=
:=
{}
"Importacao de cadastros"
{}
{|| .T.}
{}
.T.
:=
:=
:=
:=
:=
""
.T.
.T.
0
.F.
AADD(aParamBox,{2,"Tipo de informao"
,1 ,aTiposFile ,060,;
"AllwaysTrue()", .T.})
AADD(aParamBox,{2,"LayOut do arquivo "
,1 ,;
{"Padro","Especifico"},060, "AllwaysTrue()", .T.})
AADD(aParamBox,{1,"Diretorio de dados"
,Space(60)
,;
"@!","AllwaysTrue()","HSSDIR" ,".T.",120,.T.})
AADD(aParamBox,{1,"Arquivo de layout "
,Space(60)
,;
"@!","AllwaysTrue()","" ,".T.",120,.F.})
AADD(aParamBox,{2,"Operacao
"
,1 ,;
{"Incluir","Alterar","Excluir"},060, "AllwaysTrue()", .T.})
AADD(aParamBox,{1,"Diretorio de Log "
,Space(60)
,;
"@!","AllwaysTrue()","HSSDIR" ,".T.",120,.F.})
AADD(aParamBox,{2,"Importa CIAP
"
,1 ,;
{"Sim","No"} ,060, "AllwaysTrue()", .T.})
lRet := ParamBox(aParamBox, cTitulo, aRet, bOk, aButtons, lCentered, nPosx,;
nPosy, /*oMainDlg*/ , cLoad, lCanSave, lUserSave)
Continuao:
IF ValType(aRet) == "A" .AND. Len(aRet) == Len(aParamBox)
For nX := 1 to Len(aParamBox)
If aParamBox[nX][1] == 1
ElseIf aParamBox[nX][1] == 2 .AND. ValType(aRet[nX]) == "C"
&("MvParBox"+StrZero(nX,2)) := aScan(aParamBox[nX][4],;
{|x| Alltrim(x) == aRet[nX]})
ElseIf aParamBox[nX][1] == 2 .AND. ValType(aRet[nX]) == "N"
Endif
Next nX
ENDIF
RETURN lRet
/*/
+----------------------------------------------------------------------| Funo
| IATFCIAP
|
+----------------------------------------------------------------------| Descrio | IMPORTACAO DO LIVRO FISCAL CIAP
|
+----------------------------------------------------------------------| Uso
| Curso ADVPL
|
+----------------------------------------------------------------------/*/
STATIC FUNCTION IATFCIAP(aStruSF9,aDadosSF9)
Local aDadosCIAP := {}
Local nX
:= 0
Local nPosSF9
:= 0
// Monta array com dados padres do SF9 de acordo com o SX3
FOR nX := 1 to Len(aStruSF9)
AADD(aDadosCIAP,{aStruSF9[nX][1],CRIAVAR(aStruSF9[nX][1]),NIL})
NEXT nX
// Atualiza dados do array com as informaes presentes no SN1
FOR nX := 1 to Len(aDadosSF9)
IF (nPosSF9 := aScan(aDadosCIAP,{|aLinhaCIAP| aLinhaCIAP[1] ==
aDadosSF9[nX][1]})) > 0
aDadosCIAP[nPosSF9][2] := aDadosSF9[nX][2]
ENDIF
NEXT nX
ConOut("Iniciando MsExecAuto - ATFCIAP: "+Time())
lMsErroAuto := .F.
MSExecAuto({|x,y| U_ATFCIAP(x,y)},aDadosCIAP,3) // Dados e Opo
ConOut("Finalizada MsExecAuto - ATFCIAP: "+Time())
RETURN lMsErroAuto
Continuao:
/*/
+----------------------------------------------------------------------| Funo
| XDBFLOG
|
+----------------------------------------------------------------------| Descrio | CRIACAO DO ARQUIVO DBF PARA TRATAMENTO DOS EVENTOS DE ERR|
+----------------------------------------------------------------------| Uso
| Curso ADVPL
|
+----------------------------------------------------------------------/*/
STATIC FUNCTION XDBFLOG()
LOCAL aCampos
:= {}
LOCAL cArqLog
:= MVParBox06+"LOGIMP"+GetDbExtension()
IF !File(cArqLog)
AADD(aCampos,{"CKEYIMP" ,"C",014,0})
AADD(aCampos,{"CKEYREG" ,"C",020,0})
AADD(aCampos,{"CDESCR" ,"C",040,0})
AADD(aCampos,{"CSEQMSG" ,"C",003,0})
AADD(aCampos,{"CMSGERR" ,"C",254,0})
dbCreate(cArqLog,aCampos,__LocalDriver)
ENDIF
dbUseArea(.T., __LocalDriver, cArqLog, "LOGIMP", .T., .F.)
RETURN
/*/
+----------------------------------------------------------------------| Funo
| XGRVLOG
|
+----------------------------------------------------------------------| Descrio | GRAVACAO DA MENSAGEM DE ERRO NO ARQUIVO DBF DE CONTROLE |
+----------------------------------------------------------------------| Uso
| Curso ADVPL
|
+----------------------------------------------------------------------/*/
STATIC FUNCTION XGRVLOG(cKeyImp, cKeyReg, cDescReg, cMsgErr)
LOCAL cSeqLog := "000"
FOR nX := 1 TO Len(cMsgErr) STEP 254
cSeqLog := SOMA1(cSeqLog)
RECLOCK("LOGIMP",.T.)
LOGIMP->CKEYIMP
:= cKeyImp
LOGIMP->CKEYREG
:= cKeyReg
LOGIMP->CDESCR
:= cDescReg
LOGIMP->CSEQMSG
:= cSeqLog
LOGIMP->CMSGERR
:= SUBSTR(cMsgErr,nX,254)
MSUNLOCK()
NEXT nX
RETURN
Continuao:
/*/
+----------------------------------------------------------------------| Funo
| XCONVERRLOG
|
+----------------------------------------------------------------------| Descrio | CONVERTE O ARRAY AAUTOERRO EM TEXTO CONTINUO.
|
+----------------------------------------------------------------------| Uso
| Curso ADVPL
|
+----------------------------------------------------------------------/*/
STATIC FUNCTION XCONVERRLOG(aAutoErro)
LOCAL cRet := ""
LOCAL nX := 1
FOR nX := 1 to Len(aAutoErro)
cRet += aAutoErro[nX]+CHR(13)+CHR(10)
NEXT nX
RETURN cRet
42.
Recursos de envio de e-mail
Neste tpico sero descritas as funes da linguagem ADVPL que permitem o envio e o
recebimento de mensagens atravs de e-mails.
Funes para manipulao de e-mails
CALLPROC
MAILSMTPON
MAILPOPON
MAILSMTPOFF
MAILPOPOFF
MAILRECEIVE
MAILAUTH
POPMSGCOUNT
MAILSEND
MAILGETERR
Detalhamento das funes de manipulao de e-mails

CALLPROC()
Mtodo do objeto oRpcSrv que permite a utilizao de todas as funes de envio e
recebimento de e-mail descritas neste tpico.
Sintaxe: CallProc(cFuncao, xParam1, ..., xParamN)
Parmetros:
cFuncao
Nome da funo ou mtodo do objeto oRpcSrv que ser executado.
xParamN
Parmetros da funo ou mtodo que ser executado.
Retorno:
Nenhum
MAILSMTPON()
Ativa uma conexo com o servio de SMTP para a thread ativa.
Sintaxe: MailSmtpOn( cServer, cUser, cPass, nTimeOut)
Sintaxe clssica:
CONNECT SMTP SERVER cServer ACCOUNT cUser PASSWORD cPass TIMEOUT nTimeOut IN
SERVER oRpcSrv RESULT lResult
Parmetros:
Cserver
Endereo do servidor para conexo
Cuser
Nome do usurio para autenticao no servidor.
CPass
Senha do usurio para autenticao no servidor.
NTimeOut
Tempo de espera para operao de autenticao.
Retorno:
Lgico
Indica se foi realizada com sucesso a conexo com o servidor indicado.
MAILPOPON()
Ativa uma conexo com o servio de POP para a thread ativa. -> lReturn
Sintaxe: MailPopOn( cServer, cUser, cPass, nTimeOut)
Sintaxe clssica:
CONNECT POP SERVER cServer ACCOUNT cUser PASSWORD cPass

SERVER oRpcSrv
RESULT lResult
TIMEOUT nTimeOut
Parmetros:
Cserver
Endereo do servidor para conexo
Cuser
Nome do usurio para autenticao no servidor.
CPass
Senha do usurio para autenticao no servidor.
NTimeOut
Tempo de espera para operao de autenticao.
Retorno:
Lgico
Indica se foi realizada com sucesso a conexo com o servidor indicado.
IN
MAILSMTPOFF()
Encerra a conexo com o servio de SMTP.
Sintaxe: MailSmtpOff()
Sintaxe clssica:
RESULT lResult
Parmetros:
Nenhum
IN SERVER oRpcSrv
Retorno:
Lgico
Indica se a operao foi realizada com sucesso.
MAILPOPOFF()
Encerra a conexo com o servio de POP
Sintaxe: MailPopOff()
Sintaxe clssica:
DISCONNECT POP SERVER
RESULT lResult
Parmetros:
Nenhum
IN SERVER oRpcSrv
Retorno:
Lgico
Indica se a operao foi realizada com sucesso.
MAILRECEIVE()
Efetua o recebimento de um e-mail, salvando-o no local definido.
Sintaxe: MailReceive(nNumber, @cFrom, @cTo, @cCc, @cBcc, @cSubject,

@cBody, @aFiles, cPath, lDelete)
Sintaxe clssica:
RECEIVE MAIL MESSAGE nNumber FROM cFrom TO

cTo CC cCc BCC cBcc SUBJECT
cSubject BODY cBody ATTACHMENT aFiles SAVE IN cPath DELETE IN SERVER oRpcSrv
RESULT lResult
Parmetros:
nNumber
cFrom
Nmero da mensagem que dever ser recebida. Este nmero em funo da

quantidade de mensagens na caixa de e-mails.
Varivel local do fonte que ser atualizada com o remetente da mensagem.
cTo
Varivel local do fonte que ser atualizada com o destinatrio da mensagem.
cCc
cSubject
Varivel local do fonte que ser atualizada com a conta copiada na

mensagem.
Varivel local do fonte que ser atualizada com a conta copiada em cpia
oculta na mensagem.
Varivel local do fonte que ser atualizada com o assunto da mensagem.
cBody
Varivel local do fonte que ser atualizada com corpo da mensagem.
aFiles
Varivel local do fonte que ser atualizada os nomes dos anexos da

mensagem.
Diretrio no qual sero salvos os anexos da mensagem.
cBcc
cPath
lDelete
Indica se a mensagem dever ser apagada do servidor de e-mails aps sua

recepo pela aplicao.
Retorno:
Lgico
Indica se a operao de recebimento de mensagens foi realizada com

sucesso.
MAILAUTH()
Funo que executa a autenticao do usurio no servio ativo.
Sintaxe: MailAuth(cUser, cPassword)
Parmetros:
cUser
Nome do usurio para validao da conexo com o servidor.
cPassword
Senha do usurio para validao da conexo com o servidor.
Retorno:
Lgico
Indica se foi realizada a autenticao do usurio com sucesso.
A funo MailAuth() dever ser utilizada obrigatoriamente aps a abertura da

conexo com o servidor, seja ele de envio ou recebimento de mensagens.
Para validao da conexo sempre efetue a verificao com o usurio contendo

o endereo completo do e-mail, e caso necessrio somente com o usurio,
eliminando o restante do endereo aps o caractere @.
lResult := MailAuth(Alltrim(cEmail), Alltrim(cPass))
// Se nao conseguiu fazer a Autenticacao usando o E-mail completo, tenta
// fazer a autenticacao usando apenas o nome de usuario do E-mail.
If !lResult
nA := At("@",cEmail)
cUser := If(nA>0,Subs(cEmail,1,nA-1),cEmail)
lResult := MailAuth(Alltrim(cUser), Alltrim(cPass))
Endif
POPMSGCOUNT()
Verifica quantas mensagens existem na caixa de entrada do servio POP ativo.
Sintaxe: PopMsgCount(@nMsgCount)
Sintaxe clssica:
POP MESSAGE COUNT nMsgCount
Parmetros:
nMsgCount
IN SERVER oRpcSrv RESULT lResult
Varivel local do fonte que ser atualizada com a quantidade de mensagens

disponveis para recebimento na caixa de e-mails.
Retorno:
Lgico
Indica se foi realizado o acesso a caixa de mensagens.
MAILSEND()
Envia um e-mail utilizando a servio de SMTP ativo.
Sintaxe: MailSend(cFrom, aTo, aCc, aBcc, cSubject, cBody, aFiles, lText)
Sintaxe clssica:
SEND MAIL FROM cFrom TO aTo,... CC aCc,... BCC aBcc,... SUBJECT cSubject BODY
cBody FORMAT TEXT ATTACHMENT aFiles,... IN SERVER oRpcSrv RESULT lResult
Parmetros:
cFrom
Endereo de e-mail do remente da mensagem.
aTo
Array contendo os endereos de e-mails dos destinatrios da mensagem.
aCc
Array contendo os endereos de e-mails dos copiados na mensagem.
aBcc
cSubject
Array contendo os endereos de e-mails dos copiados de forma oculta na

mensagem.
Texto de assunto do e-mail.
cBody
Texto da mensagem do e-mail.
aFiles
Array contendo os nomes dos arquivos que sero anexados a mensagem.
lText
Indica se o corpo do e-mail est em formato texto.
Retorno:
Lgico
Indica se a operao de envio de mensagens foi realizada com sucesso.
MAILGETERR()
Retorna o erro que ocorreu no envio do e-mail.
Sintaxe: MailGetErr()
Sintaxe clssica:
GET MAIL ERROR cErrorMsg IN SERVER oRpcSrv
Parmetros:
Nenhum
Retorno:
Caracter
Mensagem de erro ocorrida no processamento do envio ou recebimento dos

e-mails.
Exemplos de utilizao das funcionalidades de envio e recebimento de e-mail

Envio de mensagens utilizando sintaxe clssica
#include "tbiconn.ch"
#include "AP5MAIL.CH"
/*/
+----------------------------------------------------------------------| Funo
| SENDMAIL
|
+----------------------------------------------------------------------| Descrio | ENVIO DE E-MAIL GENERICO
|
+----------------------------------------------------------------------| Uso
| Curso ADVPL
|
+----------------------------------------------------------------------/*/
USER FUNCTION SendMail(_lJob)
Local lResulConn := .T.
Local lResulSend := .T.
Local cError := ""
Local
Local
Local
Local
cServer
cEmail
cPass
lRelauth
Local cDe
Local cPara
:=
:=
:=
:=
AllTrim(GetMV("MV_RELSERV"))
AllTrim(GetMV("MV_RELACNT"))
AllTrim(GetMV("MV_RELPSW"))
GetMv("MV_RELAUTH")
:= cEmail
:= "arnaldojr@microsiga.com.br"
Continuao:
Local
Local
Local
Local
cCc
cAssunto
cAnexo
cMsg
Default _lJob
cMsg
cMsg
cMsg
cMsg
:=
+=
+=
+=
:=
:=
:=
:=
""
"Teste de envio de e-mail: Curso ADVPL"
"\SYSTEM\lgrl99.bmp"
Space(200)
:= .T.
"--------------------------------------------------"
"CURSO DE ADVPL
"
"--------------------------------------------------"
"Voc est recebendo um e-mail do curso de ADVPL avanado"
CONNECT SMTP SERVER cServer ACCOUNT cEmail PASSWORD cPass RESULT lResulConn
If !lResulConn
GET MAIL ERROR cError
If _lJob
ConOut(Padc("Falha na conexao "+cError,80))
Else
MsgAlert("Falha na conexao "+cError)
Endif
Return(.F.)
Endif
// Sintaxe: SEND MAIL FROM cDe TO cPara CC cCc SUBJECT cAssunto BODY cMsg
ATTACHMENT cAnexo RESULT lResulSend
// Todos os e-mail tero: De, Para, Assunto e Mensagem, porm precisa analisar
se tem: Com Cpia e/ou Anexo
If lRelauth
//Se nao conseguiu fazer a Autenticacao usando o E-mail completo, tenta fazer
a autenticacao usando apenas o nome de usuario do E-mail
If !lResult
Endif
Endif
If lResult
If Empty(cCc) .And. Empty(cAnexo)
SEND MAIL FROM cDe TO cPara SUBJECT cAssunto BODY cMsg RESULT
lResulSend
Else
If Empty(cCc) .And. !Empty(cAnexo)
SEND MAIL FROM cDe TO cPara SUBJECT cAssunto BODY cMsg
ElseIf !Empty(cCc) .And. !Empty(cAnexo)
SEND MAIL FROM cDe TO cPara CC cCc SUBJECT cAssunto BODY cMsg
ElseIf Empty(cCc) .And. Empty(cAnexo)
RESULT lResulSend
Endif
Endif
Continuao:
If !lResulSend
GET MAIL ERROR cError
If _lJob
ConOut(Padc("Falha no Envio do e-mail "+cError,80))
Else
MsgAlert("Falha no Envio do e-mail " + cError)
Endif
Endif
Else
If _lJob
ConOut(Padc("Falha na autenticao do e-mail: "+cError,80))
Else
MsgAlert("Falha na autenticao do e-mail:" + cError)
Endif
Endif
IF lResulSend
If _lJob
ConOut(Padc("E-mail enviado com sucesso",80))
Else
MsgInfo("E-mail enviado com sucesso" + cError)
Endif
ENDIF
RETURN lResulSend
Envio de mensagens utilizando funes
#include 'tbiconn.ch'
/*/
+----------------------------------------------------------------------| Funo
| SENDMAIL
|
+----------------------------------------------------------------------| Descrio | ENVIO DE E-MAIL GENERICO
|
+----------------------------------------------------------------------| Uso
| Curso ADVPL
|
+----------------------------------------------------------------------/*/
USER FUNCTION FSendMail(_lJob)
Local
Local
Local
Local
lResulConn := .T.
lResulSend := .T.
lResult
:= .T.
cError := ""
Local
Local
Local
Local
cServer
cEmail
cPass
lRelauth
:=
:=
:=
:=
GetMv("MV_RELAUTH")
Local
Local
Local
Local
Local
Local
Local
cDe
cPara
cCc
cBcc
cAssunto
cAnexo
cMsg
:=
:=
:=
:=
:=
:=
:=
cEmail
"arnaldojr@microsiga.com.br"
""
""
"Teste de envio de e-mail: Curso ADVPL"
"\SYSTEM\lgrl99.bmp"
Space(200)
Default _lJob
cMsg
cMsg
cMsg
cMsg
:=
+=
+=
+=
:= .F.
"--------------------------------------------------"
"CURSO DE ADVPL
"
"--------------------------------------------------"
"Voc est recebendo um e-mail do curso de ADVPL avanado"
//CONNECT SMTP SERVER cServer ACCOUNT cEmail PASSWORD cPass RESULT lResulConn
lResulConn := MailSmtpOn( cServer, cEmail, cPass)
If !lResulConn
//GET MAIL ERROR cError
cError := MailGetErr()
If _lJob
Else
Endif
Return(.F.)
Endif
Continuao:
// Sintaxe: SEND MAIL FROM cDe TO cPara CC cCc SUBJECT cAssunto BODY cMsg
// Todos os e-mail tero: De, Para, Assunto e Mensagem, porm precisa analisar
se tem: Com Cpia e/ou Anexo
If lRelauth
//Se nao conseguiu fazer a Autenticacao usando o E-mail completo, tenta fazer
a autenticacao usando apenas o nome de usuario do E-mail
If !lResult
Endif
Endif
If lResult
/*
If Empty(cCc) .And. Empty(cAnexo)
SEND MAIL FROM cDe TO cPara SUBJECT cAssunto BODY cMsg RESULT
lResulSend
Else
If Empty(cCc) .And. !Empty(cAnexo)
SEND MAIL FROM cDe TO cPara SUBJECT cAssunto BODY cMsg
ElseIf !Empty(cCc) .And. !Empty(cAnexo)
ElseIf Empty(cCc) .And. Empty(cAnexo)
RESULT lResulSend
Endif
Endif
*/
lResulSend := MailSend(cDe,{cPara},{cCc},{cBcc},cAssunto,cMsg,{cAnexo},.T.)
If !lResulSend
//GET MAIL ERROR cError
If _lJob
ConOut(Padc("Falha no Envio do e-mail "+cError,80))
Else
MsgAlert("Falha no Envio do e-mail " + cError)
Endif
Endif
Else
If _lJob
Else
Endif
Endif
Continuao:
//DISCONNECT SMTP SERVER

MailSmtpOff()
IF lResulSend
If _lJob
ConOut(Padc("E-mail enviado com sucesso",80))
Else
MsgInfo("E-mail enviado com sucesso" + cError)
Endif
ENDIF
RETURN lResulSend
Recebimento de mensagens utilizando funes
#include "tbiconn.ch"
/*/
+----------------------------------------------------------------------| Funo
| POPMAIL
|
+----------------------------------------------------------------------| Descrio | RECEBIMENTO DE E-MAIL GENERICO
|
+----------------------------------------------------------------------| Uso
| Curso ADVPL
|
+----------------------------------------------------------------------/*/
USER FUNCTION FPopMail(_lJob)
Local
Local
Local
Local
lResulConn := .T.
lResulPop := .T.
lResult
:= .T.
cError := ""
Local
Local
Local
Local
cServer
cEmail
cPass
lRelauth
Local
Local
Local
Local
Local
Local
Local
Local
Local
Local
cDe
:=
cPara
:=
cCc
:=
cBcc
:=
cAssunto :=
aAnexo
:=
cMsg
:=
cPath
:=
nMsgCount:=
nNumber :=
Default _lJob
:=
:=
:=
:=
GetMv("MV_RELAUTH")
""
""
""
""
""
{}
""
"\MailBox"
0
0
:= .F.
lResulConn := MailPopOn( cServer, cEmail, cPass,1000)

If !lResulConn
If _lJob
Else
Endif
Return(.F.)
Endif
Continuao:
/*If lRelauth
// Se nao conseguiu fazer a Autenticacao usando o E-mail completo, tenta
// fazer a autenticacao usando apenas o nome de usuario do E-mail
If !lResult
Endif
Endif*/
If lResult
PopMsgCount(@nMsgCount)
For nNumber := 1 to nMsgCount
lResulPop := MailReceive(nNumber, @cDe, @cPara, @cCc, @cBcc,;
@cAssunto, @cMsg, @aAnexo , cPath, .F.)
If !lResulPop
If _lJob
ConOut(Padc("Falha no recebimento do e-mail "+cError,80))
Else
MsgAlert("Falha no recebimento do e-mail " + cError)
Endif
Else // Salvar mensagem de e-mail
cMessage
cMessage
cMessage
cMessage
cMessage
cMessage
:=
+=
+=
+=
+=
+=
"DE: "+cDe+CRLF
"PARA: "+cPara+CRLF
"CC: "+cCc+CRLF
"BCC: "+cBcc+CRLF
"ASSUNTO: "+cAssunto+CRLF
"MENSAGEM: "+cMsg+CRLF
MsgInfo(cMessage,"E-mail Recebido")
Endif
End-For // Next nNumber
Else
If _lJob
Else
Endif
Endif
MailPopOff()
Continuao:
IF lResulPop
If _lJob
ConOut(Padc("E-mails recebidos com sucesso",80))
Else
MsgInfo("E-mail recebidos com sucesso" + cError)
Endif
ENDIF
RETURN lResulPop
43.
Integrao bsica com MsOffice
43.1. Exportao para EXCEL

A funcionalidade bsica de exportao de informaes para o Microsoft Excel utiliza a funo
DlgToExcel(), a qual permite que as informaes em formatos de array sejam geradas em uma
planilha.
DLGTOEXCEL()
Realiza a exportao das informaes do ambiente Protheus em formato de arrays para uma
planilha do Microsoft Excel.
Sintaxe: DlgToExcel(cOrigem, cTitulo, aDadosCab, aDadosItens)
Parmetros:
cOrigem
Contedo fixo definido como: GETDADOS
cTitulo
Nome para exibio da planilha
aDadosCab
Array contendo os nomes dos campos que sero exibidos na planilha.
aDadosItens
Array contendo as informaes dos campos, de acordo com a ordem do

array de cabealho.
Retorno:
Nenhum
Na exportao das informaes para o Microsoft Excel deve-se atentar para as

colunas que possurem informaes alfanumricas mas que contm apenas
nmeros. Para que estas colunas sejam exibidas corretamente deve ser
acrescentado um caracter especial no incio da string de forma que o Microsoft
Excel as reconhea como texto e no como numricas.
Exemplo de exportao para o Microsoft Excel utilizando a funo DlgToExcel()
/*/
+----------------------------------------------------------------------| Funo
| GExpExcel
|
+----------------------------------------------------------------------| Descrio | EXPORTACAO PARA EXCEL GENERICO
|
+----------------------------------------------------------------------| Uso
| Curso ADVPL
|
+----------------------------------------------------------------------/*/
User Function GExpExcel()
Local aCabExcel
:={}
Local aItensExcel
:={}
// AADD(aCabExcel, {"TITULO DO CAMPO", "TIPO", NTAMANHO, NDECIMAIS})

AADD(aCabExcel, {"A1_FILIAL"
,"C", 02, 0})
AADD(aCabExcel, {"A1_COD"
,"C", 06, 0})
AADD(aCabExcel, {"A1_LOJA"
,"C", 02, 0})
AADD(aCabExcel, {"A1_NOME"
,"C", 40, 0})
AADD(aCabExcel, {"A1_MCOMPRA"
,"N", 18, 2})
MsgRun("Favor Aguardar.....", "Selecionando os Registros",;
{|| GProcItens(aCabExcel, @aItensExcel)})
MsgRun("Favor Aguardar.....", "Exportando os Registros para o Excel",;
{||DlgToExcel({{"GETDADOS",;
"POSIO DE TTULOS DE VENDOR NO PERODO",;
aCabExcel,aItensExcel}})})
Return
/*/
+----------------------------------------------------------------------| Funo
| GProcItens
|
+----------------------------------------------------------------------| Uso
| Curso ADVPL
|
+----------------------------------------------------------------------/*/
Static Function GProcItens(aHeader, aCols)
Local aItem
Local nX
DbSelectArea("SA1")
DbSetOrder(1)
DbGotop()
Continuao:
While SA1->(!EOF())
aItem := Array(Len(aHeader))
For nX := 1 to Len(aHeader)
IF aHeader[nX][2] == "C"
aItem[nX] := CHR(160)+SA1->&(aHeader[nX][1])
ELSE
aItem[nX] := SA1->&(aHeader[nX][1])
ENDIF
Next nX
AADD(aCols,aItem)
aItem := {}
SA1->(dbSkip())
End
Return
APNDICES
Relao de imagens para aplicaes visuais
AFASTAME
BPMSDOCI
COLTOT
AFASTAMENTO
BPMSEDT1
CONTAINR
ALT_CAD
BPMSEDT2
DBG05
AMARELO
BPMSEDT3
DBG06
ANALITICO
BPMSEDT4
DBG09
ANALITIC
BPMSRELA
DBG3
AGENDA
BPMSTASK1
DESTINOS
ALTERA
BPMSTASK2
DESTINOS2
AREA
BPMSTASK3
DISABLE
ASIENTOS
BPMSTASK4
DISCAGEM
AUTOM
BR_AMARELO
DOWN
BAIXATIT
BR_AZUL
E5
BAR
BR_AZUL_OCEAN
EDITABLE
BMPCALEN
BR_CINZA
EXCLUIR
BMPEMERG
BR_LARANJA
FILTRO
BMPGROUP
BR_MARROM
FINAL
BMPINCLUIR
BR_PRETO
FOLDER10
BMPPERG
BR_VERDE
FOLDER11
BMPPOST
BR_VERDE_OCEAN
FOLDER12
BMPTABLE
BR_VERMELHO
FOLDER14
BMPTRG
BR_VERMELHO_OCEAN
FOLDER5
BMPUSER
BUDGET
FOLDER6
BMPVISUAL
BUDGETY
FOLDER7
BONUS
CADEADO
GEOROTA
BOTTOM
CALCULADORA
GRAF2D
BPMSDOC
CANCEL
GRAF3D
BPMSDOCA
CHAVE2
HISTORIC
BPMSDOCE
CHECKED
INSTRUME
IMPRESSAO
PCO_ITALT
PMSSETATOP
LBNO
PCO_ITEXC
PMSSETAUP
LBOK
PCOCO
PMSTASK1
LBTIK
PCOCUBE
PMSTASK2
LEFT
PCOFXCANCEL
PMSTASK3
LINE
PCOFXOK
PMSTASK4
LIQCHECK
PENDENTE
PMSUSER
LJPRECO
PESQUISA
PMSZOOMIN
LOCALIZA
PGNEXT
PMSZOOMOUT
LUPA
PGPREV
POSCLI
MAQFOTO
PMSCOLOR
PRECO
MATERIAL
PMSEDT3
PREV
METAS_BAIXO_16
PMSEDT4
PRINT03
METAS_BAIXO_LEG
PMSEXCEL
PRODUTO
METAS_CIMA_16
PMSEXPALL
RECALC
METAS_CIMA_LEG
PMSEXPCMP
RECORTAR
MSGHIGH
PMSMAIS
RIGHT
MSVISIO
PMSMATE
RPMNEW
NEXT
PMSMENOS
RPMSAVE
NOTE
PMSPESQ
S4SB014N
NOVACELULA
PMSPRINT
S4WB001N
OBJETIVO
PMSRELA
S4WB005N
OK
PMSRRFSH
S4WB006N
ORDEM
PMSSETABOT
S4WB007N
PARAMETROS
PMSSETADIR
S4WB008N
PCO_COINC
PMSSETADOWN
S4WB009N
PCO_CONOR
PMSSETAESQ
S4WB010N
S4WB011N
WEB
CARAGANEW
S4WB014B
WFCHK
CARGASEQ
S4WB016N
WFUNCHK
CCTCALC
SALVAR
ADDCONTAINER
CHAT
SDUIMPORT
ADICIONAR_001
CHAT1
SDUPACK
ARMAZEM
CHAT2
SDUPROPR
ATALHO
CHAT3
SDUSETDEL
AVGARMAZEM
CHECK
SDUSOFTSEEK
AVGBOX1
CHECKOK
SHORTCUTDEL
AVGLBPAR1
CLOCK01
SHORTCUTEDIT
AVGOIC1
CLOCK02
SHORTCUTMINUS
AVIAO
CLOCK03
SHORTCUTNEW
AZUL
CLOCK04
SHORTCUTPLUS
BALANCA
DEVOLNF
SIMULACA
BGCOLOR
COBROWSR
SIMULACAO
BMPPARAM
COLFORM
SUGESTAO
BMPCONS
COMPTITL
SUMARIO
BMPCPO
COMSOM
SVM
BMPDEL
CRITICA
TK_VERTIT
BR_BRANCO
COPYUSER
UNCHECKED
BRANCO
CTBLANC
UP
BR_CANCEL
CTBREPLA
USER
BR_MARROM
DBG07
VCDOWN
BR_PINK
DELWEB
VCUP
BTCALC
COLOR
VENDEDOR
BTPESQ
DBG12
VERNOTA
CARGA
DBG10
DEPENDENTES
F7_VERM
F14_PINK
GEO
F8_NULL
F14_PRET
EDITWEB
F10_AMAR
F14_VERD
EMPILHADEIRA
F10_AZUL
F14_VERM
ENABLE
F10_CINZ
FRIAS
ESCALA
F10_LARA
FILTRO1
ESTOMOVI
F10_MARR
FOLDER8
F5_AZUL
F10_NULL
FOLDER13
F5_NULL
F10_PINK
FOLDER15
F5_VERD
F10_PRET
FORM
F5_VERM
F10_VERD
FRCOLOR
F6_NULL
F10_VERM
FRTOFFLINE
F5_AMAR
F11_NULL
FRTONLINE
F5_CINZ
F12_AMAR
GEO
F5_LARA
F12_AZUL
GEOEMAIL
F5_MARR
F12_CINZ
GEOTRECHO
F5_PINK
F12_LARA
GERPROJ
F5_PRET
F12_MARR
GLOBO
F7_AMAR
F12_PINK
IC_17
F7_AZUL
F12_PRET
INSTRUME
F7_CINZ
F12_VERD
LANDSCAPE
F7_LARA
F12_VERM
LIGHTBLU
F7_MARR
F14_AMAR
MDIHELP
F7_NULL
F14_AZUL
MDILOGOFF
F7_PINK
F14_CINZ
MDIRUN
F7_PRET
F14_LARA
MDISPOOL
F7_VERD
F14_MARR
MEDEXT
MENURUN
RPMCABEC
SDUFIELDS
MPWIZARD
RPMCPO
SDUFIND
NCO
RPMDES
SDUGOTO
NEWWEB
RPMFORM
SDUNEW
NOCONNECT
RPMFUNC
SDUOPEN
NOCHECKED
RPMGROUP
SDUOPENIDX
NOMEDICA
RPMIMP
SDUORDER
NORMAS
RPMIMPORT
SDURECALL
OPEN
RPMNEW2
SDUREPL
OPERACAO
RPMOPEN
SDUSEEK
OUTLOOK
RPMPERG
SDUSTRUCT
PAPEL_ESCRITO
RPMTABLE
SDUSUM
PEDIDO
S4WB004N
SDUZAP
PIN
S4WB013N
SEMSOM
PMSINFO
S4WB014A
SOLICITA
PREDIO
SALARIOS
SSFONTES
PRINT02
SAVECLOCK
TAB1
PROCESSA
SDUADDTBL
TABPRICE
PRODUT2
SDUAPPEND
TEXTBOLD
PROJETPMS
SDUCLOSE
TEXTCENTER
PRTETQ
SDUCLOSEIDX
XCLOSE
QMT_COND
SDUCOPYTO
TEXTITALIC
QMT_NO
SDUCOUNT
TEXTJUSTIFY
QMT_OK
SDUCREATEIDX
TEXTLEFT
RESPADEX
SDUDELETE
TEXTRIGHT
RESPONSA
SDUDRPTBL
TEXTUNDERLINE
ROSA
SDUERASE
TK_ALTFIN
TK_CLIFIN
BPMSEDT3A
GCT_NEW
TK_FIND
BPMSEDT3E
INVOICE1
TK_FONE
BPMSEDT3I
MSGGROUP
TK_HISTORY
BPMSEDT4A
MSGHIGH
TK_NOVO
BPMSEDT4E
PCO_COALT
TK_REFRESH
BPMSEDT4I
PCO_COEXC
TPOPAGTO1
BPMSREC
PCO_ITINC
UPDWARNING
BPMSRECA
PCOCOLA
UPDERROR
BPMSRECE
PCOCOPY
UPDINFORMATION
BPMSRECI
PCOEDIT
VERDE
BPMSRELAA
PCOFX
VERMELHO
BPMSRELAE
PCOLOCK
VERMESCURO
BPMSRELAI
PEDIDO2
WATCH
BPMSTSK1A
PEDIDO2_MDI
CLIENTE
BPMSTSK1E
PGRSAVE
ACAO
BPMSTSK1I
PMSAPONT
BOXBOM1
BPMSTSK2A
PMSCANC
BOXBOM2
BPMSTSK2E
PMSCOLUM
BOXBOM3
BPMSTSK2I
PMSCONS
BOXBOM4
BPMSTSK3A
PMSCUSTO
BOXBOM5
BPMSTSK3E
PMSDATE
BPMSEDT1A
BPMSTSK3I
PMSESTRU
BPMSEDT1E
BPMSTSK4A
PMSEXCEL
BPMSEDT1I
BPMSTSK4E
PMSEXEC
BPMSEDT2A
BPMSTSK4I
PMSEXPEXC
BPMSEDT2E
ENGRENAGEM2
PMSFILTER
BPMSEDT2I
GCT_EDIT
PMSGRAPH
PMSNEXT
MSGFORWD
UNSELECTALL
PMSOPCAO
MSGREPLY
BSTART
PMSPESQ
OMSDIVIDE
BTURNSHARPLEFT
PMSPREV
PMSUPDOWN
BTURNSHARPRIGHT
PMSPREVIO
SHAPE01
ENGRENAGEM
PMSPRINT
SHAPE02
PAGEDOWN
PMSPROG
SHAPE03
PAGEUP
PMSSUPALOC
SHAPE04
SELECT
PMSTOOLS
SHAPE05
SELECTALL
PMSUSERP
TRIDOWN
BBEARRIGHT
REFRESH
WORD
BEND
SHAPE06
ROTEIRO
BKEEPLEFT
TRILEFT
CLIPS_PQ
BKEEPRIGHT
TRIRIGHT
NEXT_PQ
BLEFT
VINCULA1
RELACIONAMENTO_DIREIRA_PQ
BRIGHT
BAHEAD
PREV_PQ
CANCEL
BBEARLEFT
UP.GIF
CONFIRM
DOWN
GOTOP
GOBOTTOM
INVERTSELECTION
LISTAS DE EXERCCIOS
01
02
03
Implementar a classe Aluno com os mtodos New(), Inscrever() e Avaliar().
Desenvolver um dilogo para interagir com a classe Aluno desenvolvida no

exerccio anterior.
Implementar uma Enchoice para o cadastro de produtos (SB1).
04
Converter o cadastro desenvolvido no exerccio anterior para que o mesmo

utilize o objeto MsMGet().
05
Desenvolver uma interface de cadastro que combine os objetos MsMGet e

MsNewGetDados causando o efeito de uma Modelo3().
06
Adicionar na interface de cadastro desenvolvida no exerccio anterior uma

EnchoiceBar() com um boto definido pelo usurio que exiba o AxCadastro de
um item utilizado na interface.
07
Converter o fonte DIALOG_OBJETOS.PRW para sintaxe orientada objetos.
08
Desenvolver uma MaWndBrowse utilizando um arquivo temporrio.
09
Implementar uma funcionalidade com mltiplos TwBrowses que permita

pesquisar clientes e visualizar os ttulos a receber dos mesmos.
10
Implementar um objeto TFolder para montar um rodap para uma interface

que contenha MsMGet() e MsNewGetDados().
11
Implementar a MsAdvSize() e MsObjSize() no fonte desenvolvido no exerccio

anterior.
12
Desenvolver uma MaWndBrowse utilizando um Alias gerado pela funo

TcGenQry().
13
Desenvolver uma MaWndBrowse utilizando um Alias gerado pela funo

TcGenQry() para um banco de dados externo a aplicao ERP.
14
Desenvolver uma aplicao que execute a Stored Procedure padro de

reprocessamento de saldos contbeis.
15
Implementar no fonte WndSqlConn desenvolvido anteriormente as funes

TcInclui(), TcAltera(), TcExclui() com o uso das funes TEnchoice() e
TcSqlExec().
16
Implementar uma funo que realize o envio de um texto simples para uma
conta de e-mail @totvs, que permita sua fcil identificao.
17
Implementar uma rotina que realize o recebimento do e-mail enviado

anteriormente para a conta de e-mail @totvs.
18
Implementar uma rotina automtica para gravar as informaes no cadastro

de clientes (MATA030).
Projeto: Avaliao prtica do treinamento de ADVPL Avanado

Objetivos do projeto
Contemplar o contedo do curso e estimular a prtica da programao utilizando a linguagem
ADVPL;
Acrescentar um grau de desafio ao treinamento;
Regras para entrega e apresentao
Dever ser entregue na data estabelecida pelo instrutor, contendo os fontes e demais arquivos
necessrios. A avaliao do projeto ser realizada aps a entrega, no prazo estabelecido pelo
instrutor;
Pode ser realizado em grupos de at 03 pessoas. Caso existam alunos sem grupos, estes podero
integrar equipes j formadas com o total de membros estabelecido, mediante aprovao do
instrutor;
Avaliao do projeto
Mesmo peso da prova terica, podendo substitu-la integralmente.
Sero considerados os quesitos:
Funcionalidades
Clareza da programao
Apresentao
Otimizao de tcnicas e recursos apresentados no treinamento
Funcionalidades que compe o projeto
Desenvolver uma aplicao utilizando a linguagem ADVPL que contemple as seguintes funcionalidades:
Projeto 01
Desenvolver uma aplicao de cadastro utilizando a classe Aluno e os mtodos

disponveis para a mesma.
Projeto 02
Converter os fontes do pacote de oficina de programao para orientao a

objetos.
Projeto 03
Implementar uma aplicao ADVPL que consulte e atualize dados em um

banco de interface externo ao Protheus.
REFERNCIAS BIBLIOGRFICAS
Referncias bibliogrficas
Gesto empresarial com ERP
Ernesto Haberkorn, 2006
Programao Orientada a Objetos com C ++
Ivan Luiz Marques Ricarte, 1996
Modelagem e Projetos baseados em objetos
James Rumbaugh, 1994 11. Edio
Programao orientada objetos no FiveWin
Gilmer FiveWin Brasil
Oficina de Programao
Robson Luiz Estefani Gonalves
Apostila de Treinamento - TReport
Tnia Bronzeri
Apostila de Treinamento - ADVPL
Educao corporativa
Apostila de Treinamento Boas Prticas de Programao
Inteligncia Protheus e Fbrica de Software
DEM Documentao Eletrnica Microsiga
Microsiga Software S.A.
Materiais diversos de colaboradores Microsiga
Colaboradores Microsiga
Colaboradores
Reviso 01
Arnaldo Raymundo Junior
Luis Akira Tamura
Mrcia Satiko Sasaki Tokura
Patricia Lopes Legas
Robson Luiz Estefani Gonalves
Srgio Sueo Fuzinaka
Data: 04.2008
CSA
Educao Corporativa
ACR-N1_FRAMEW1
Educao Corporativa
Fbrica de Software
Inteligncia Protheus

ADVPL Completo

Enviado por

Dados do documento

Direitos autorais

Formatos disponíveis

Compartilhar este documento

Compartilhar ou incorporar documento

Opções de compartilhamento

Você considera este documento útil?

Este conteúdo é inapropriado?

Direitos autorais:

Formatos disponíveis

ADVPL Completo

Enviado por

Direitos autorais:

Formatos disponíveis

Educao Corporativa

Matriz Av. Braz Leme, 1.717 02511-000 So Paulo SP Brasil.

Lgica de Programao e Algoritmos .................................................................................................................... 11

Lgica de Programao ................................................................................................................ 11

Desenvolvendo algoritmos ............................................................................................................ 12

Estudando algoritmos ................................................................................................................................ 13

Estruturas de programao .................................................................................................................................... 16

Diagrama de bloco ........................................................................................................................ 16

Estruturas de deciso e repetio ................................................................................................ 19

Estruturas de deciso ................................................................................................................................. 19

MDULO 02: A linguagem ADVPL ............................................................................................................................... 24

Estrutura de um Programa ADVPL ...................................................................................................................... 26

Declarao e Atribuio de Variveis .................................................................................................................... 31

Tipo de Dados ................................................................................................................................ 31

Declarao de variveis ................................................................................................................ 32

Escopo de variveis ....................................................................................................................... 33

Entendendo a influncia do escopo das variveis ...................................................................... 37

Operaes com Variveis ............................................................................................................. 38

Estruturas de repetio ................................................................................................................ 51

Estruturas de deciso .................................................................................................................... 56

Arrays e Blocos de Cdigo...................................................................................................................................... 60

Estruturas bsicas de programao ....................................................................................................................... 51

reas de um Programa ADVPL .................................................................................................. 28

Listas de Expresses e Blocos de Cdigo .................................................................................... 67

Tipos e escopos de funes ........................................................................................................... 74

Passagem de parmetros entre funes ...................................................................................... 77

MDULO 03: Desenvolvendo pequenas customizaes ................................................................................................ 88

ADVPL e o ERP Microsiga Protheus .................................................................................................................... 88

O Ambiente Protheus ................................................................................................................... 88

Organizao e configurao inicial do ambiente Protheus ....................................................... 92

O Configurador do Protheus ....................................................................................................... 98

Funcionalidades Abordadas ...................................................................................................................... 98

Funcionalidades do Configurador ............................................................................................. 104

Dicionrio de Dados da aplicao ERP ................................................................................................... 105

TOTVS Development Studio ................................................................................................................................ 121

Desenvolvimento de pequenas customizaes ....................................................................................... 124

Acesso e manipulao de bases de dados em ADVPL ......................................................................................... 124

Diferenas e compatibilizaes entre bases de dados............................................................... 125

Funes de acesso e manipulao de dados .............................................................................. 126

Diferenciao entre variveis e nomes de campos ................................................................... 131

Controle de numerao seqencial............................................................................................ 132

Customizaes para a aplicao ERP .................................................................................................................. 133

Customizao de campos Dicionrio de Dados ..................................................................... 134

Validaes de campos e perguntas ..................................................................................................... 134

Customizao de gatilhos Configurador ................................................................................ 138

Customizao de parmetros Configurador ......................................................................... 139

Funes para manipulao de parmetros .......................................................................................... 139

Pontos de Entrada Conceitos, Premissas e Regras ............................................................... 141

Interfaces visuais .................................................................................................................................................. 142

Sintaxe e componentes das interfaces visuais ........................................................................... 142

Interfaces padres para atualizaes de dados ........................................................................ 145

AxCadastro() ...................................................................................................................................... 145

APNDICES .................................................................................................................................................................. 152

Utilizao de Identao ........................................................................................................................................ 152

Capitulao de Palavras-Chave ........................................................................................................................... 153

Palavras em maisculo ............................................................................................................... 154

Utilizao da Notao Hngara ........................................................................................................................... 154

Palavras reservadas .............................................................................................................................................. 155

LISTAS DE EXERCCIOS ........................................................................................................................................... 156

Mdulo 01: Introduo programao ................................................................................................. 156

A linguagem ADVPL ............................................................................................................................................ 162

Estrutura de um Programa ADVPL .................................................................................................................... 164

reas de um Programa ADVPL ................................................................................................ 166

Declarao e Atribuio de Variveis .................................................................................................................. 169