Matriz Av. Braz Leme, 1.717 02511-000 So Paulo SP Brasil. Tel.: 55 (11) 3981-7001 www.totvs.com.br
- 2 -
ADVPL Avanado
ESTRUTURA DO TREINAMENTO
OBJETIVOS DO CURSO............................................................................................................................... 11 MDULO 05: Introduo orientao objetos ........................................................................................ 12 1. Conceitos de orientao objetos..................................................................................................... 12 1.1. Definies ................................................................................................................................. 12 1.2. Conceitos Bsicos ..................................................................................................................... 15 1.3. O Modelo de Objetos (OMT) ...................................................................................................... 16 1.3.1. Objetos e Classes .....................................................................................................................16 1.3.2. Atributos .................................................................................................................................17 1.3.3. Operaes e Mtodos ................................................................................................................18 1.3.4. Sugestes de desenvolvimento...................................................................................................19 2. Orientao a objetos em ADVPL ........................................................................................................ 20 2.1. Sintaxe e operadores para orientao a objetos ....................................................................... 20 2.2. Estrutura de uma classe de objetos em ADVPL ......................................................................... 23 2.3. Implementao dos mtodos de uma classe em ADVPL............................................................ 24 3. Regras adicionais da linguagem ADVPL............................................................................................. 28 3.1. Palavras reservadas.................................................................................................................. 28 3.2. Pictures de formatao disponveis........................................................................................... 29 MDULO 07: ADVPL Orientado objetos II ............................................................................................... 30 4. Componentes da interface visual do ADVPL ...................................................................................... 30 TSRVOBJECT() .............................................................................................................................32 TFONT() ......................................................................................................................................35 MSDIALOG() ................................................................................................................................36 TDIALOG() ...................................................................................................................................37 TWINDOW() .................................................................................................................................40 TCONTROL() ................................................................................................................................43 BRGETDDB() ................................................................................................................................44 MSCALEND() ................................................................................................................................47 MSCALENDGRID().........................................................................................................................49 MSSELBR() ..................................................................................................................................51 MSWORKTIME()............................................................................................................................54 SBUTTON() ..................................................................................................................................57 TBAR() ........................................................................................................................................59 TBITMAP() ...................................................................................................................................61 TBROWSEBUTTON() ......................................................................................................................63 TBTNBMP() ..................................................................................................................................65 TBTNBMP2().................................................................................................................................67 TBUTTON() ..................................................................................................................................69 TCBROWSE()................................................................................................................................71 TCHECKBOX() ..............................................................................................................................75 TCOLORTRIANGLE() ......................................................................................................................77 TCOMBOBOX() .............................................................................................................................79 TFOLDER()...................................................................................................................................82 TGET() ........................................................................................................................................84 TGROUP() ....................................................................................................................................86 THBUTTON() ................................................................................................................................88 TIBROWSER() ..............................................................................................................................89 TLISTBOX()..................................................................................................................................91 TMENU()......................................................................................................................................95 TMENUBAR() ................................................................................................................................96 TMETER() ....................................................................................................................................97 TMSGRAPHIC() ........................................................................................................................... 100 TMSGBAR()................................................................................................................................ 106 TMSGITEM()............................................................................................................................... 108 TMULTIBTN() ............................................................................................................................. 109 TMULTIGET().............................................................................................................................. 112 TOLECONTAINER()...................................................................................................................... 114
- 3 -
ADVPL Avanado
TPAGEVIEW() ............................................................................................................................. 116 TPANEL() ................................................................................................................................... 118 TRADMENU().............................................................................................................................. 119 TSBROWSE().............................................................................................................................. 123 TSAY() ...................................................................................................................................... 127 TSCROLLBOX() ........................................................................................................................... 129 TSIMPLEEDITOR()....................................................................................................................... 130 TSLIDER().................................................................................................................................. 135 TSPLITTER()............................................................................................................................... 138 TTABS()..................................................................................................................................... 142 TTOOLBOX() .............................................................................................................................. 144 TWBROWSE()............................................................................................................................. 147 VCBROWSE() ............................................................................................................................. 151 4.1. Particularidades dos componentes visuais.............................................................................. 157 4.1.1. Configurando as cores para os componentes .............................................................................. 157 5. Aplicaes com a interface visual do ADVPL.................................................................................... 159 5.1. Captura de informaes simples (Multi-Gets) ......................................................................... 159 5.1.1. Enchoice() ............................................................................................................................. 160 5.1.2. MsMGet() .............................................................................................................................. 162 5.2. Captura de mltiplas informaes (Multi-Lines) ..................................................................... 164 5.2.1. MsGetDB()............................................................................................................................. 165 5.2.2. MsGetDados() ........................................................................................................................ 169 5.2.3. MsNewGetDados() .................................................................................................................. 173 5.2.3.1. Definindo cores personalizadas para o objeto MsNewGetDados() .......................................... 178 5.3. Barras de botes..................................................................................................................... 183 5.3.1. EnchoiceBar()......................................................................................................................... 183 5.3.2. TBar() ................................................................................................................................... 185 5.3.3. ButtonBar .............................................................................................................................. 186 5.3.4. Imagens pr-definidas para as barras de botes......................................................................... 189 6. Outras aplicaes da interface visual do ADVPL .............................................................................. 190 6.1. MaWndBrowse() ..................................................................................................................... 190 6.1.1. Enchoice para Arquivos Temporrios ......................................................................................... 193 6.2. DbTree() ................................................................................................................................. 203 6.3. MsSelect() .............................................................................................................................. 208 7. Introduo relatrios grficos...................................................................................................... 211 7.1. TReport()................................................................................................................................ 211 7.1.1. Introduo............................................................................................................................. 211 Finalidade .................................................................................................................................. 211 Descrio................................................................................................................................... 212 Pr-Requisitos ............................................................................................................................ 212 7.1.2. Impresso do relatrio personalizvel ....................................................................................... 213 7.1.2.1. Parmetros de impresso ................................................................................................ 213 Impresso.................................................................................................................................. 213 Arquivo...................................................................................................................................... 213 Spool ........................................................................................................................................ 214 E-mail ....................................................................................................................................... 214 Papel......................................................................................................................................... 215 Tamanho do papel ...................................................................................................................... 215 Formato da impresso................................................................................................................. 215 Configuraes............................................................................................................................. 215 Ttulo ........................................................................................................................................ 215 Ordem....................................................................................................................................... 215 Layout....................................................................................................................................... 215 Preview ..................................................................................................................................... 215 Executar em segundo plano ......................................................................................................... 216 7.1.3. Personalizao........................................................................................................................ 216 7.1.3.1. Editando o layout do relatrio .......................................................................................... 216 Nova estrutura do relatrio TReport: ............................................................................................. 217 7.1.4. Definindo a Funo ReportDef()................................................................................................ 217 DEFINE REPORT.......................................................................................................................... 218 DEFINE SECTION........................................................................................................................ 218 DEFINE CELL .............................................................................................................................. 218
- 4 -
ADVPL Avanado
MDULO 08: Aplicaes ADVPL para o ERP ............................................................................................. 219 8. Protheus e o TOPCONNECT / TOTVS DbAccess................................................................................ 219 8.1. Caractersticas tcnicas com o uso do TOTVS DbAccess......................................................... 220 Comportamento de Queries Colunas Calculadas ........................................................................... 220 Comportamento diferenciado com Bandos de Dados PostGres .......................................................... 222 Conceito de ndices Permanentes e Diferenas das RDDs................................................................. 223 Funcionamento Interno................................................................................................................ 223 Quebra de Compatibilidade com CodeBase/DBF.............................................................................. 224 Lista dos cdigos de erro do TOPConnect / DbAccess....................................................................... 225 8.2. Funes ADVPL para TOPCONNECT / TOTVS DbAccess ........................................................... 226 Lista das funes de interao com a aplicao TopConnect / DbAccess: ........................................... 226 Lista das funes acessrias utilizadas nos fontes como facilitadoras:................................................ 226 Funes de interao com o TopConnect / DbAccess ....................................................................... 227 TCCANOPEN () ........................................................................................................................... 227 TCCONTYPE() ............................................................................................................................. 227 TCDELFILE()............................................................................................................................... 228 TCGENQRY() .............................................................................................................................. 229 TCGETDB() ................................................................................................................................ 229 TCLINK() ................................................................................................................................... 230 TCQUERY() ................................................................................................................................ 232 TCQUIT() ................................................................................................................................... 233 TCSETCONN() ............................................................................................................................ 233 TCSETFIELD() ............................................................................................................................ 234 TCSPEXEC() ............................................................................................................................... 236 TCSPEXIST() .............................................................................................................................. 238 TCSQLERROR()........................................................................................................................... 238 TCSQLEXEC() ............................................................................................................................. 239 TCSRVTYPE() ............................................................................................................................. 239 TCUNLINK() ............................................................................................................................... 240 TCCHKOBJ()............................................................................................................................... 241 TCEXEERROR() ........................................................................................................................... 241 TCPGMEXE() .............................................................................................................................. 242 TCSYSEXE() ............................................................................................................................... 242 Funes acessrias para uso em fontes com interao com o TOTVS DbAccess................................... 243 CHANGEQUERY() ........................................................................................................................ 243 RETFULLNAME().......................................................................................................................... 244 RETSQLCOND() .......................................................................................................................... 245 RETSQLNAME()........................................................................................................................... 245 RETSQLTABLE().......................................................................................................................... 246 SQLCOPY()................................................................................................................................. 246 SQLORDER() .............................................................................................................................. 247 SQLTOTRB()............................................................................................................................... 248 8.3. Aplicaes com controle de comunio com o Banco de Dados............................................... 249 8.3.1. MaWndBrowse com Alias Temporrio gerado por Query............................................................... 249 Exemplo: MaWndBrowse com Alias Temporrio gerado por Query..................................................... 250 8.3.2. Banco de dados de interface .................................................................................................... 261 Consideraes relevantes sobre as funes TCLink() e TCSetConn().................................................. 261 Consideraes complementares sobre o conceito de Banco de Dados de Interface .............................. 263 8.4. Embedded SQL Facilitador de Querys.................................................................................. 264 Disponibilidade do Recurso........................................................................................................... 264 Caractersticas operacionais - Sintaxe............................................................................................ 265 Limitao:.................................................................................................................................. 265 Erros de Compilao.................................................................................................................... 266 Erros de Execuo....................................................................................................................... 266 Caractersticas operacionais - depurao........................................................................................ 267 Funo auxiliar - GETLastQuery().................................................................................................. 267 9. Funcionalidade MsExecAuto ............................................................................................................ 269 Sobre a MsExecAuto e Rotinas Automticas.................................................................................... 269 Quando utilizar a funcionalidade MsExecAuto ? ............................................................................... 270 Processos da aplicao ERP com tratamentos para execuo por MsExecAuto..................................... 270 Quando no utilizar a funcionalidade MsExecAuto ........................................................................... 271 9.1. Desenvolvendo aplicaes com MsExecAuto ........................................................................... 272 Estrutura de uma rotina com execuo de MsExecAuto.................................................................... 272 Variveis de controle................................................................................................................... 272 Montagem dos arrays de parmetros............................................................................................. 272 Definio dos parmetros especficos da rotina que ser executada................................................... 276
- 5 -
ADVPL Avanado
Controle de transao ................................................................................................................. 277 Tratamento de mensagens de erro................................................................................................ 279 Aplicao completa de importao utilizando MsExecAuto: Carga de imobilizado................................. 282 10. Recursos de envio de e-mail ....................................................................................................... 295 Funes para manipulao de e-mails ........................................................................................... 295 Detalhamento das funes de manipulao de e-mails .................................................................... 295 CALLPROC() ............................................................................................................................... 295 MAILSMTPON()........................................................................................................................... 296 MAILPOPON() ............................................................................................................................. 296 MAILSMTPOFF().......................................................................................................................... 297 MAILPOPOFF()............................................................................................................................ 297 MAILRECEIVE()........................................................................................................................... 298 MAILAUTH() ............................................................................................................................... 299 POPMSGCOUNT()........................................................................................................................ 300 MAILSEND()............................................................................................................................... 300 MAILGETERR()............................................................................................................................ 301 Exemplos de utilizao das funcionalidades de envio e recebimento de e-mail .................................... 301 Envio de mensagens utilizando sintaxe clssica .............................................................................. 301 Envio de mensagens utilizando funes ......................................................................................... 304 Recebimento de mensagens utilizando funes............................................................................... 307 11. Integrao bsica com MsOffice.................................................................................................. 309 11.1. Exportao para EXCEL ........................................................................................................... 309 DLGTOEXCEL() ........................................................................................................................... 309 Exemplo de exportao para o Microsoft Excel utilizando a funo DlgToExcel().................................. 310 APNDICES.............................................................................................................................................. 312 Relao de imagens para aplicaes visuais........................................................................................ 312 LISTAS DE EXERCCIOS........................................................................................................................... 320 Projeto: Avaliao prtica do treinamento de ADVPL Avanado .......................................................... 325 REFERNCIAS BIBLIOGRFICAS.............................................................................................................. 326 GUIA DE REFERNCIA RPIDA: Funes e Comandos ADVPL .................................................................. 328 Converso entre tipos de dados .......................................................................................................... 328 CTOD()...................................................................................................................................... 328 CVALTOCHAR()........................................................................................................................... 328 DTOC()...................................................................................................................................... 329 DTOS()...................................................................................................................................... 329 STOD()...................................................................................................................................... 329 STR() ........................................................................................................................................ 330 STRZERO() ................................................................................................................................ 330 VAL() ........................................................................................................................................ 331 Matemticas........................................................................................................................................ 332 ACOS()...................................................................................................................................... 332 CEILING() .................................................................................................................................. 332 COS()........................................................................................................................................ 332 LOG10() .................................................................................................................................... 333 SIN()......................................................................................................................................... 333 SQRT() ...................................................................................................................................... 334 TAN() ........................................................................................................................................ 334 Anlise de variveis............................................................................................................................. 335 TYPE()....................................................................................................................................... 335 VALTYPE().................................................................................................................................. 335 Manipulao de arrays......................................................................................................................... 336 AADD()...................................................................................................................................... 336 ACLONE() .................................................................................................................................. 337 ACOPY() .................................................................................................................................... 337 ADEL() ...................................................................................................................................... 338 ADIR()....................................................................................................................................... 339 AFILL() ...................................................................................................................................... 340 AINS()....................................................................................................................................... 340 ARRAY() .................................................................................................................................... 341 ASCAN() .................................................................................................................................... 341 ASCANX() .................................................................................................................................. 342 ASIZE() ..................................................................................................................................... 343
Ao final do curso o treinando dever ter desenvolvido os seguintes conceitos, habilidades e atitudes:
a) Conceitos a serem aprendidos
estruturas para implementao aplicaes orientadas a objetos introduo as tcnicas de programao de desenvolvimento de relatrios grficos introduo aos conceitos de ADVPL ASP e WebServices
b) Habilidades e tcnicas a serem aprendidas
desenvolvimento de aplicaes voltadas ao ERP Protheus anlise de fontes de mdia complexidade desenvolvimento de com orientao a objetos
c) Atitudes a serem desenvolvidas
adquirir conhecimentos atravs da anlise dos funcionalidades disponveis no ERP Protheus; estudar a implementao de fontes com estruturas orientadas a objetos em ADVPL; embasar a realizao de outros cursos relativos a linguagem ADVPL
- 12 -
ADVPL Avanado
MDULO 05: Introduo orientao objetos
1. 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.
E Objetos E Herana E Atributos E Mtodos E Classes E Abstrao E Generalizao E Encapsulamento E Polimorfismo
1.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
- 13 -
ADVPL Avanado
- 14 -
ADVPL Avanado
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.
- 15 -
ADVPL Avanado
1.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.
- 16 -
ADVPL Avanado
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.
1.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.
1.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.
1.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.
- 17 -
ADVPL Avanado
1.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
- 18 -
ADVPL Avanado
- 19 -
ADVPL Avanado
1.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:
E 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. E Tente manter seu modelo simples. Evite complicaes desnecessrias. E 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. E 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. E 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. E No transfira os atributos de ligao para dentro de uma das classes. E Tente evitar hierarquias de generalizao muito profundas. E No se surpreenda se o seu modelo necessitar vrias revises; isto o normal. E 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. E Nem sempre todas as construes OMT so necessrias para descrever uma aplicao. Use apenas aquelas que forem adequadas para o problema analisado.
- 20 -
ADVPL Avanado
2. 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.
2.1. Sintaxe e operadores para orientao a objetos
Palavras reservadas
CLASS CLASSDATA CONSTRUCTOR DATA ENDCLASS EXPORT FROM HIDDEN METHOD PROTECTED SELF
CLASS
Descrio Utilizada na declarao de uma classe de objetos 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>
CLASSDATA
Descrio Utilizada na declarao de um atributo da classe de objetos com a finalidade de definir um tipo e um contedo padro para este atributo. Sintaxe 1 CLASSDATA <nome_da_varivel> AS <tipo> <atributo> INIT <contedo>
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
- 21 -
ADVPL Avanado
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
EXPORT
Descrio Operador utilizado para definir o modo de acesso de um atributo especificado na classe de objetos. O uso deste operador indica que o atributo ser visvel e altervel sem a necessidade de utilizao dos mtodos do prprio objeto. Seu uso na linguagem ADVPL opcional. Simular EXPORT ou [PUBLIC] Sintaxe 1 DATA cNome Sintaxe 2 EXPORT DATA cNome
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>
HIDDEN
Descrio Operador utilizado para definir o modo de acesso de um atributo especificado na classe de objetos. O uso deste operador indica que o atributo no ser visvel para chamadas diretas do objeto, sendo necessria a utilizao de mtodos para sua manipulao. Simular HIDDEN ou [LOCAL] Sintaxe HIDDEN DATA cNome
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>
- 22 -
ADVPL Avanado
PROTECTED
Descrio Operador utilizado para definir o modo de acesso de um atributo especificado na classe de objetos. O uso deste operador indica que o atributo ser visvel mas no ser editvel para chamadas diretas do objeto, sendo necessria a utilizao de mtodos para sua manipulao. Simular PROTECTED ou [READONLY] Sintaxe PROTECTED DATA cNome
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. Exemplo
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:
#include protheus.ch 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:
#include protheus.ch 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.
2.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.
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.
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)
#include protheus.ch
USER FUNCTION CadPessoa()
Local oPessoa Local cNome := Local dNascimento:= CTOD() Local aDados := {}
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.
// 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
3. Regras adicionais da linguagem ADVPL
3.1. Palavras reservadas
AADD DTOS INKEY REPLICATE VAL ABS ELSE INT RLOCK VALTYPE ASC ELSEIF LASTREC ROUND WHILE AT EMPTY LEN ROW WORD BOF ENDCASE LOCK RTRIM YEAR BREAK ENDDO LOG SECONDS CDOW ENDIF LOWER SELECT CHR EOF LTRIM SETPOS CMONTH EXP MAX SPACE COL FCOUNT MIN SQRT CTOD FIELDNAME MONTH STR DATE FILE PCOL SUBSTR DAY FLOCK PCOUNT TIME DELETED FOUND PROCEDURE TRANSFORM DEVPOS FUNCTION PROW TRIM DOW IF RECCOUNT TYPE DTOC IIF RECNO UPPER TRY AS CATCH THROW
E Palavras reservadas no podem ser utilizadas para variveis, procedimentos ou funes;
E Funes reservadas so pertencentes ao compilador e no podem ser redefinidas por uma aplicao;
E Todos os identificadores que comearem com dois ou mais caracteres _ so utilizados como identificadores internos e so reservados.
E Identificadores de escopo PRIVATE ou PUBLIC utilizados em aplicaes especficas desenvolvida por ou para clientes devem ter sua identificao iniciada por um caractere _.
- 28 -
ADVPL Avanado
- 29 -
ADVPL Avanado
3.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 Funcionalidade A Permite apenas caracteres alfabticos. C Exibe CR depois de nmeros positivos. E Exibe numrico com o ponto e vrgula invertidos (formato Europeu). R Insere caracteres diferentes dos caracteres de template na exibio, mas no os insere na varivel do GET. S<n> Permite rolamento horizontal do texto dentro do GET, <n> um nmero inteiro que identifica o tamanho da regio. X Exibe DB depois de nmeros negativos. Z 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. ! Converte caracteres alfabticos para maisculo. * Exibe um asterisco no lugar dos espaos em branco iniciais em nmeros. . Exibe o ponto decimal. , Exibe a posio do milhar.
Exemplo 02 Picture campo texto, com digitao apenas em caixa alta
A1_NOME Caracter - 40 Picture: @!
- 30 -
ADVPL Avanado
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.
4. 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 de Componentes Visuais Tsplitter Ttabs Ttoolbox Twbrowse Vcbrowse
Atributos comuns as classes de componentes visuais
cCaption Ttulo ou contedo do objeto. cF3 Consulta F3 ao qual o objeto est vinculado, quando o mesmo do tipo get. cMsg Mensagem exibida na barra de status da janela principal quando o objeto ganha foco. cName Nome do objeto cTooltip Mensagem exibida quando objeto exibe seu tooltip. cVariable Varivel que receber o contedo selecionado ou digitado no objeto, quando o mesmo for to tipo get ou similar. lPassword Indica se o texto digitado no objeto ser exibido no formato de password, quando o mesmo do tipo get. lReadOnly Flag que indica se o objeto pode ou no ser editado. lShowHint Flag que ativa .T. ou desativa .F. a exibio do tooltip do objeto. lVisibleControl Se .T. o objeto visvel, se .F. o objeto invisvel. nHeight Altura em pixels. nLeft Coordenada horizontal em pixels. nTop Coordenada vertical em pixels. nWidth Largura em pixels. Picture Picture de digitao do objeto, quando o mesmo do tipo get.
Eventos comuns as classes de componentes visuais
bAction Bloco de cdigo executado quando o objeto utilizado, quando o mesmo do tipo boto ou similar. bChange Bloco de cdigo executado quando ocorre uma mundana na seleo de itens que compe o objeto, como por exemplo em listas ou grids. bF3 Bloco de cdigo executado quando utilizado o recurso de consulta F3 vinculado ao objeto. bGotFocus Executado quando objeto ganha foco. blClicked Executado quando acionado click do boto esquerdo do mouse sobre o objeto. blDblClick Executado quando acionado duplo click do boto esquerdo do mouse sobre o objeto. bLostFocus Executado quando objeto perde foco. brClicked Executado quando acionado click do boto direito do mouse sobre o objeto. bValid Executado quando o contedo do objeto modificado e dever ser validado. Deve retornar .T. se o contedo vlido e .F. se contedo invlido. bWhen Executado quando h movimentao de foco na janela.Se retornar .T. o objeto continua habilitado, se retornar .F. o
- 32 -
ADVPL Avanado
objeto ser desabilitado.
Classes da interface visual
TSRVOBJECT()
E Descrio: Classe abstrata inicial de todas as classes de interface do ADVPL. No deve ser instanciada diretamente.
E Propriedades:
nLeft Coordenada horizontal em pixels. nTop Coordenada vertical em pixels. nWidth Largura em pixels. nHeight Altura em pixels. cCaption Ttulo ou contedo do objeto. cTooltip Mensagem exibida quando objeto exibe seu tooltip. lShowHint Flag que ativa .T. ou desativa .F. a exibio do tooltip do objeto. cMsg Mensagem exibida na barra de status da janela principal quando o objeto ganha foco. nClrText Cor do texto do objeto. nClrPane Cor do fundo do objeto. bWhen Executado quando h movimentao de foco na janela.Se retornar .T. o objeto continua habilitado, se retornar .F. o objeto ser desabilitado. bValid Executado quando o contedo do objeto modificado e dever ser validado. Deve retornar .T. se o contedo vlido e .F. se contedo invlido. blClicked Executado quando acionado click do boto esquerdo do mouse sobre o objeto. brClicked Executado quando acionado click do boto direito do mouse sobre o objeto. blDblClick Executado quando acionado duplo click do boto esquerdo do mouse sobre o objeto. oWnd Janela onde o objeto foi criado. lVisible Se .T. o objeto visvel, se .F. o objeto invisvel. Cargo Contedo associado ao objeto. bLostFocus Executado quando objeto perde foco. bGotFocus Executado quando objeto ganha foco.
E Construtor: No pode ser instanciada.
E Parmetros:
Nenhum -
- 33 -
ADVPL Avanado
E Mtodos auxiliares:
SetFocus
O Descrio: Fora mudana do foco de entrada de dados para o controle. O Sintaxe: SetFocus( ) O Parmetros:
Nenhum -
O Retorno:
Nil
Hide
O Descrio: Torna objeto invisvel. O Sintaxe: Hide( ) O Parmetros:
Nenhum -
O Retorno:
Nil
Show
O Descrio: Torna objeto visvel. O Sintaxe: Show( ) O Parmetros:
Nenhum -
O Retorno:
Nil
Enable
O Descrio: Habilita o objeto. O Sintaxe: Enable( ) O Parmetros:
Nenhum -
O Retorno:
Nil
- 34 -
ADVPL Avanado
Disable
O Descrio: Desabilita o objeto. O Sintaxe: Disable( ) O Parmetros:
Nenhum -
O Retorno:
Nil
Refresh
O Descrio: Fora atualizao (sincronia) de propriedades entre o programa e o Protheus Remote. O Sintaxe: Refresh( ) O Parmetros:
Nenhum -
O Retorno:
Nil
Exemplo:
CLASS TCONTROL FROM TSRVOBJECT
Classes auxiliares
TFONT()
E Descrio: Classe de objetos que define a fonte do texto utilizado nos controles visuais.
acName Caractere, opcional. Nome da fonte, o padro Arial. nPar2 Reservado. anHeight Numrico, opcional. Tamanho da fonte. O padro -11. lPar4 Reservado. alBold Lgico, opcional. Se .T. o estilo da fonte ser negrito. nPar6 Reservado. lPar7 Reservado. nPar8 Reservado. alItalic Lgico, opcional. Se .T. o estilo da fonte ser itlico. alUnderline Lgico, opcional. Se .T. o estilo da fonte ser sublinhado.
E Aparncia:
Exemplo:
#include 'protheus.ch' 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. ACTIVATE MSDIALOG oDlg CENTERED Return
- 35 -
ADVPL Avanado
- 36 -
ADVPL Avanado
Classes de janelas
MSDIALOG()
E 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.
anTop Numrico, opcional. Coordenada vertical superior em pixels ou caracteres. anLeft Numrico, opcional. Coordenada horizontal esquerda em pixels ou caracteres. anBotom Numrico, opcional. Coordenada vertical inferior em pixels ou caracteres. anRight Numrico, opcional. Coordenada horizontal direita em pixels ou caracteres. acCaption Caractere, opcional. Ttulo da janela. cPar6 Reservado. nPar7 Reservado. lPar8 Reservado. nPar9 Reservado. anClrText Numrico,opcional. Cor do texto. anClrBack Numrico,opcional. Cor de fundo. oPar12 Reservado. aoWnd Objeto, opcional. Janela me da janela a ser criada, padro a janela principal do programa. alPixel Lgico, opcional. Se .T. considera as coordenadas passadas em pixels, se .F. considera caracteres. oPar15 Reservado. oPar16 Reservado. nPar17 Reservado.
E Aparncia:
Exemplo:
#include 'protheus.ch' User Function Teste() // cria dilogo Local oDlg := MSDialog():New(10,10,300,300,'Meu dialogo',,,,,CLR_BLACK,CLR_WHITE,,,.T.)
E 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.
anTop Numrico, opcional. Coordenada vertical superior em pixels ou caracteres. anLeft Numrico, opcional. Coordenada horizontal esquerda em pixels ou caracteres. anBotom Numrico, opcional. Coordenada vertical inferior em pixels ou caracteres. anRight Numrico, opcional. Coordenada horizontal direita em pixels
- 37 -
ADVPL Avanado
- 38 -
ADVPL Avanado
ou caracteres. acCaption Caractere, opcional. Ttulo da janela. cPar6 Reservado. nPar7 Reservado. lPar8 Reservado. nPar9 Reservado. anClrText Numrico,opcional. Cor do texto. anClrBack Numrico,opcional. Cor de fundo. oPar12 Reservado. aoWnd Objeto, opcional. Janela me da janela a ser criada, padro a janela principal do programa. alPixel Lgico, opcional. Se .T. considera as coordenadas passadas em pixels, se .F. considera caracteres. oPar15 Reservado. oPar16 Reservado. nPar17 Reservado. anWidth Numrico, opcional. Largura da janela em pixels. anHeight Numrico, opcional. Altura da janela em pixels.
E Mtodos auxiliares:
Activate
O Descrio: Ativa (exibe) o dilogo. Chamar somente uma vez este mtodo. O Sintaxe: Activate([bPar1], [bPar2], [bPar3], [alCentered], [abValid], [lPar6], [abInit], [bPar8], [bPar9] ) O Parmetros:
bPar1 Reservado. bPar2 Reservado. bPar3 Reservado. alCentered Lgico, opcional. Se .T. exibe a janela centralizada, .F. padro. abValid Bloco de cdigo, opcional. Deve retornar .T. se contedo do dilogo vlido, se retornar .F. o dilogo no fechar quando solicitada de encerrar. lPar6 Reservado. abInit Bloco de cdigo, opcional. Executado quando o dilogo inicia exibio. bPar8 Reservado. bPar9 Reservado.
O Retorno:
Nenhum -
End
O Descrio: Encerra (fecha) o dilogo. O Sintaxe: End( ) O Parmetros:
Nenhum -
O Retorno: Lgico .T. se o dilogo foi encerrado.
Lgico Indica se o dilogo foi encerrado.
E Aparncia:
Exemplo:
#include 'protheus.ch' User Function Teste() Local oDlg // cria dilogo 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.. .')} )
/* 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 // ativa dilogo centralizado ACTIVATE DIALOG oDlg CENTER ON INIT (msgstop('iniciando...')) VALID (msgstop('validou!'),.T.) */ Return Nil
- 39 -
ADVPL Avanado
- 40 -
ADVPL Avanado
TWINDOW()
E Descrio: Classe de objetos do tipo dilogo principal de programa. Dever existir apenas uma instncia deste objeto na execuo do programa.
nTop Numrico, opcional. Coordenada vertical superior em pixels ou caracteres. nLeft Numrico, opcional. Coordenada horizontal esquerda em pixels ou caracteres. nBottom Numrico, opcional. Coordenada vertical inferior em pixels ou caracteres. nRight Numrico, opcional. Coordenada horizontal inferior em pixels ou caracteres. cTitle Caractere, opcional. Ttulo da janela. nPar6 Reservado. oPar7 Reservado. oPar8 Reservado. oPar9 Reservado. oParent Objeto, opcional. Janela me da janela corrente. lPar11 Reservado. lPar12 Reservado. nClrFore Numrico, opcional. Cor de fundo da janela. nClrText Numrico, opcional. Cor do texto da janela. oPar15 Reservado. cPar16 Reservado. lPar17 Reservado. lPar18 Reservado. lPar19 Reservado. lPar20 Reservado. lPixel Lgico, opcional. Se .T. (padro) considera coordenadas passadas em pixels, se .F. considera caracteres.
- 41 -
ADVPL Avanado
E Mtodos auxiliares:
Activate
O Descrio: Ativa (exibe) a janela. Chamar esse mtodo apenas uma vez. O Sintaxe: Activate([acShow], [bPar2], [bPar3], [bPar4], [bPar5], [bPar6], [ abInit ], [bPar8], [bPar9], [bPar10], [bPar11], [bPar12] ,[bPar13], [bPar14], [bPar15], [abValid], [bPar17], [bPar18] ). O Parmetros:
acShow Caracter, opcional. ICONIZED para janela iconizada ou MAXIMIZED para janela maximizada. bPar2 Reservado. bPar3 Reservado. bPar4 Reservado. bPar5 Reservado. bPar6 Reservado. abInit Bloco de cdigo. Executado quando janela est sendo exibida. bPar8 Reservado. bPar9 Reservado. bPar10 Reservado. bPar11 Reservado. bPar12 Reservado. bPar13 Reservado. bPar14 Reservado. bPar15 Reservado. abValid 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. bPar17 Reservado. bPar18 Reservado.
O Retorno:
Nenhum -
End
O Descrio: Solicita encerramento da janela. O Sintaxe: End( ) O Parmetros:
Nenhum -
O Retorno: Lgico .T. se o dilogo foi encerrado.
Lgico Indica se a janela foi encerrada.
Center
O Descrio: Centraliza a janela. O Sintaxe: Center( ) O Parmetros:
Nenhum -
O Retorno: Lgico .T. se o dilogo foi encerrado.
Nenhum -
E Aparncia:
Exemplo:
#include 'protheus.ch' User Function Teste() 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 .
- 42 -
ADVPL Avanado
- 43 -
ADVPL Avanado
Classes de componentes
TCONTROL()
E Descrio: Classe abstrata comum entre todos os componentes visuais editveis. No deve ser instanciada diretamente.
E Propriedades:
Align 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. lModified Lgico. Se .T. indica que o contedo da varivel associada ao controle foi modificado. lReadOnly Lgico. Se .T. o contedo da varivel associada ao controle permanecer apenas para leitura. hParent Numrico. Handle (identificador) do objeto sobre o qual o controle foi criado. bChange Bloco de cdigo. Executado quando o estado ou contedo do controle modificado pela ao sobre o controle.
E Construtor: No pode ser instanciada.
E Parmetros:
Nenhum -
E Mtodos auxiliares:
SetFocus
O Descrio: Fora mudana do foco de entrada de dados para o controle. O Sintaxe: SetFocus( ) O Parmetros:
Nenhum -
O Retorno:
Nil
Exemplo:
CLASS TSay FROM Tcontrol
- 44 -
ADVPL Avanado
Classes de componentes visuais
BRGETDDB()
E Descrio: Classe de objetos visuais do tipo Grid.
E Propriedades:
+ Herdadas da classe superior nAt Linha atualmente selecionada / posicionada no objeto nLen Nmero total de linhas do objeto
nRow Numrico, opcional. Coordenada vertical nCol Numrico, opcional. Coordenada horizontal nWidth Numrico, opcional. Largura do objeto nHeight Numrico, opcional. Altura do objeto bFields Bloco de cdigo, Lista de Campos aHeaders Vetor, Descrio dos campos para no cabealho aColSizes Vetor, Largura das colunas oDlg Objeto, opcional. Janela ou controle onde o divisor dever ser criado. cField Caracter, opcional. Campos necessrios ao filtro uValue1 Indefinido, opcional. Inicio do intervalo para o filtro uValue2 Indefinido, opcional. Fim do intervalo para o filtro bChange Bloco de cdigo, opcional. Executado quando o item selecionado alterado. bLDblClick Bloco de cdigo, opcional. Executado quando acionado duplo click do boto esquerdo do mouse sobre o controle. bRClick No utilizado oFont Objeto, opcional. Fonte oCursor Objeto, opcional. Tipo do Cursor nClrFore Numrico, opcional. Cor do texto da janela. nClrBack Numrico, opcional. Cor de fundo da janela. cMsg Caracter, opcional. Mesamge ao posicionar o mouse sobre o objeto lUpdate No utilizado cAlias Caracter, opcional se objeto utilizado com Vetor, obrigatorio se utilizado com Tabela lPixel Lgico, opcional. Se .T. as coordenadas informadas so em pixels, se .F. so em caracteres. bWhen 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. lDesign No Utilizado
- 45 -
ADVPL Avanado
bValid 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. aAlter No Utilizado oMother No Utilizado
E Mtodos auxiliares:
GoUp
O Descrio: Salta uma linha para cima. O Sintaxe: GoUp( ) O Parmetros:
Nenhum -
O Retorno:
Nil
GoDown
O Descrio: Salta uma linha para baixo. O Sintaxe: GoDown( ) O Parmetros:
Nenhum -
O Retorno:
Nil
GoTop
O Descrio: Salta para primeira linha. O Sintaxe: GoTop( ) O Parmetros:
Nenhum -
O Retorno:
Nil
GoBottom
O Descrio: Salta para ultima linha. O Sintaxe: GoBottom( ) O Parmetros:
Nenhum -
O Retorno:
Nil
RowCount
O Descrio: Retorna numero de linhas visiveis. O Sintaxe: RowCount( ) O Parmetros:
Nenhum -
O Retorno:
Nil
E Aparncia:
- 46 -
ADVPL Avanado
- 47 -
ADVPL Avanado
Exemplo:
#include 'protheus.ch' User Function Teste() Local oDlg DEFINE MSDIALOG oDlg FROM 0,0 TO 302,402 PIXEL TITLE 'Exemplo'
E Descrio: Classe de objetos visuais do tipo Calendrio.
E Propriedades:
+ Herdadas da classe superior bChange Bloco de cdigo executado na mudana de seleo de um dia. bChangeMes Bloco de cdigo executado na mundaa de seleo de um ms. dDiaAtu Dia atualmente selecionado
E Construtor: New([nRow], [nCol], [oDlg], [lCanMultSel])
E Parmetros:
nRow Numrico, opcional. Coordenada vertical nCol Numrico, opcional. Coordenada horizontal oDlg Objeto, opcional. Janela ou controle onde o divisor dever ser criado.
lCanMultSel Logico, opcional. Permite seleo de multiplos dias
E Aparncia:
Exemplo:
#include 'protheus.ch' 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') } ACTIVATE MSDIALOG oDlg CENTERED Return
- 48 -
ADVPL Avanado
- 49 -
ADVPL Avanado
MSCALENDGRID()
E Descrio: Classe de objetos visuais do tipo Grade de Perodos.
E Propriedades:
bAction Bloco de cdigo. Executado quando o boto esquerdo do mouse pressionado. bRClick Bloco de cdigo. Executado quando o boto direito do mouse pressionado.
aoWnd Objeto, opcional. Janela ou controle onde o boto dever ser criado.
anRow Numrico, opcional. Coordenada vertical em pixels ou carateres. anCol Numrico, opcional. Coordenada horizontal em pixels ou caracteres. anHeight Numrico, opcional. Altura do boto em pixels. anWidth Numrico, opcional. Largura do boto em pixels.
dDateIni Data, Data inicial do Calendrio nResolution Numrico, Resoluo a ser aplicada na grid do Calendrio abWhen 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.
abAction Bloco de cdigo, opcional. Bloco que dever ser acionado quando o boto for pressionado.
nDefColor Numrico, opcional. Cor do Fundo da Grid. bRClick Bloco de cdigo, opcional. Executado quando acionado o boto direito do mouse sobre o controle. lFillAll Lgico, opcional. Preenche todo o periodo
E Mtodos auxiliares:
Add
O Descrio: Adiciona periodo na Grid. O Sintaxe: Add(cCaption, nLin, nInitial, nFinal, nColor, cDescri ) O Parmetros:
cCaption Caracter. Descrio a ser inserida a esquerda da Grid nLin Numerico. Numero da linha a ser inserido o item nInitial Numerico. Dia inicial nFinal Numerico. Dia Final nColor Numerico. Cor que destacara o item cDescri Caracter, Opicional. Descrio do tipo tooltip(hint) do item
nRow Numrico, opcional. Coordenada vertical nCol Numrico, opcional. Coordenada horizontal nWidth Numrico, opcional. Largura do objeto nHeight Numrico, opcional. Altura do objeto bFields Bloco de cdigo, Lista de Campos aHeaders Vetor, Descrio dos campos para no cabealho aColSizes Vetor, Largura das colunas oDlg Objeto, opcional. Janela ou controle onde o divisor dever ser criado. cField Caracter, opcional. Campos necessrios ao filtro uValue1 Indefinido, opcional. Inicio do intervalo para o filtro uValue2 Indefinido, opcional. Fim do intervalo para o filtro bChange Bloco de cdigo, opcional. Executado quando o item selecionado alterado. bLDblClick Bloco de cdigo, opcional. Executado quando acionado duplo click do boto esquerdo do mouse sobre o controle. bRClick No utilizado oFont Objeto, opcional. Fonte oCursor Objeto, opcional. Tipo do Cursor nClrFore Numrico, opcional. Cor do texto da janela. nClrBack Numrico, opcional. Cor de fundo da janela. cMsg Caracter, opcional. Mesamge ao posicionar o mouse sobre o objeto lUpdate No utilizado cAlias Caracter, opcional se objeto utilizado com Vetor, obrigatorio se utilizado com Tabela lPixel Lgico, opcional. Se .T. as coordenadas informadas so em pixels, se .F. so em caracteres. bWhen 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. lDesign No Utilizado bValid 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.
- 52 -
ADVPL Avanado
E Mtodos auxiliares:
GoUp
O Descrio: Salta uma linha para cima. O Sintaxe: GoUp( ) O Parmetros:
Nenhum -
O Retorno:
Nil
GoDown
O Descrio: Salta uma linha para baixo. O Sintaxe: GoDown( ) O Parmetros:
Nenhum -
O Retorno:
Nil
GoTop
O Descrio: Salta para primeira linha. O Sintaxe: GoTop( ) O Parmetros:
Nenhum -
O Retorno:
Nil
GoBottom
O Descrio: Salta para ultima linha. O Sintaxe: GoBottom( ) O Parmetros:
Nenhum -
O Retorno:
Nil
RowCount
O Descrio: Retorna numero de linhas visiveis. O Sintaxe: RowCount( ) O Parmetros:
Nenhum -
O Retorno:
Nil
E Aparncia:
- 53 -
ADVPL Avanado
- 54 -
ADVPL Avanado
Exemplo:
#include 'protheus.ch' User Function Teste() Local oDlg DEFINE MSDIALOG oDlg FROM 0,0 TO 302,402 PIXEL TITLE 'Exemplo'
aoWnd Objeto, opcional. Janela ou controle onde o boto dever ser criado. anRow Numrico, opcional. Coordenada vertical em pixels ou carateres.
- 55 -
ADVPL Avanado
anCol Numrico, opcional. Coordenada horizontal em pixels ou caracteres. anHeight Numrico, opcional. Altura do boto em pixels. anWidth Numrico, opcional. Largura do boto em pixels. nResolution Numrico, Resoluo a ser aplicada na grid do Calendrio cValue Caracter, opcional. Descritivo abWhen 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. abChange Bloco de cdigo, opcional. Bloco que dever ser acionado quando o boto for pressionado.
E Mtodos auxiliares:
GetValue
O Descrio: Retorna os item selecionados no formato XX X XX. O Sintaxe: GetValue() O Parmetros:
Nenhum -
O Retorno:
Caracter Retorna os item selecionados no formato XX X XX.
GetInterTime
O Descrio: Retorna periodo selecionado. O Sintaxe: GetInterTime() O Parmetros:
Nenhum -
O Retorno:
Caracter Retorna o perodo selecionada no formato HH:MM:SS
SetResol
O Descrio: Define a resoluo da demonstrao da barra de perodos. O Sintaxe: SetResol (nResolution) O Parmetros:
nResolution Resoluo
O Retorno:
Nil
SetValue
O Descrio: Atribui um determindo contedo para um objeto ou atributo de um objeto. O Sintaxe: SetValue(xValue, cPicture) O Parmetros:
xValue Valor que ser atribudo ao objeto ou atributo do objeto. cPicture Picture de formao opcional para o contedo atribudo.
O Retorno:
Nenhum
E Aparncia:
Exemplo:
#include 'protheus.ch' User Function Teste() Local oDlg DEFINE MSDIALOG oDlg FROM 0,0 TO 304,504 PIXEL TITLE 'Exemplo' 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') ACTIVATE MSDIALOG oDlg CENTERED Return NIL
- 56 -
ADVPL Avanado
- 57 -
ADVPL Avanado
SBUTTON()
E 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.
E Propriedades:
bAction Bloco de cdigo. Executado ao precionar o boto esquerdo do mouse.
E Construtor: New([nTop], [nLeft], [nType], [bAction], [oWnd], [lEnable], [cMsg], [bWhen])
E Parmetros:
Parmetro Tipo / Descrio nTop Numrico, opcional. Coordenada vertical em pixels ou carateres. nLeft Numrico, opcional. Coordenada horizontal em pixels ou caracteres. nType Numrico. Tipo do Boto bAction Bloco de cdigo, opcional. Bloco que dever ser acionado quando o boto for pressionado. oWnd Objeto, opcional. Janela ou controle onde o boto dever ser criado. lEnable Logico, opcional. Habilita/Desabilita boto cMsg Caracter, Opicional. Descrio do tipo tooltip(hint) do item abWhen 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.
E Mtodos auxiliares:
Create
O Descrio: Retorna Mtodo construtor opcional da classe. O Sintaxe: Create() O Parmetros:
Nenhum -
O Retorno:
Objeto Objeto da classe Sbutton com todos os atributos com contedos padres.
E Aparncia:
- 58 -
ADVPL Avanado
Exemplo:
#include 'protheus.ch' User Function Teste() Local oDlg DEFINE MSDIALOG oDlg FROM 0,0 TO 304,504 PIXEL TITLE 'Exemplo' oSButton1 := SButton():New( 01,01,1,{||Alert('SButton 01')},oDlg,.T.,,) oSButton2 := SButton():New( 21,01,2,{||Alert('SButton 02')},oDlg,.T.,,) oSButton3 := SButton():New( 41,01,3,{||Alert('SButton 03')},oDlg,.T.,,) oSButton4 := SButton():New( 61,01,4,{||Alert('SButton 04')},oDlg,.T.,,) ACTIVATE MSDIALOG oDlg CENTERED Return NIL
TBAR()
E 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.
E Propriedades:
- Herdados das classes superiores.
E Construtor:
E 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 Objeto, opcional. Define Cursor ao posicionar o mouse sobre a barra. cResource Caracter, opcional. Imagem do recurso a ser inserido como fundo da barra. lNoAutoAdjust Lgico.
E Aparncia:
- 59 -
ADVPL Avanado
Exemplo:
#include 'protheus.ch'
/*/ +------------------------------------------------------------------------ | Funo | TSTBAR | Autor | MICROSIGA |Data | | +------------------------------------------------------------------------ | Descrio | Programa que demonstra a utilizao do objeto TBar() | +------------------------------------------------------------------------ | Uso | Curso ADVPL | +------------------------------------------------------------------------ /*/
E Descrio: Classe de objetos visuais que permite a exibio de uma imagem.
E Propriedades:
cResName Caractere, Nome do resource cBmpFile Caractere, Nome do arquivo lStretch Lgico, opcional. Strech da imagem lAutoSize Lgico, opcional. Tamanho automtico lTransparent Lgico, opcional. Transparente
anTop Numrico, opcional. Coordenada vertical em pixels ou carateres. anLeft Numrico, opcional. Coordenada horizontal em pixels ou caracteres. anWidth Numrico, opcional. Largura em pixels. anHeight Numrico, opcional. Altura em pixels. acResName Caractere, Nome do resource. acBmpFile Caractere, Nome do arquivo. alNoBorder Lgico, opcional. Exibe borda aoWnd Objeto, opcional. Janela ou controle onde a imagem dever ser criada. abLClicked Bloco de cdigo, opcional. Bloco que dever ser acionado boto esquerdo do mouse for pressionado. abRClicked Bloco de cdigo, opcional. Bloco que dever ser acionado boto direito do mouse for pressionado. alScroll Lgico, opcional. Ativa o scroll alStretch Lgico, opcional. Strech da imagem aoCursor Objeto, opcional. Cursor a ser exibido acMsg No utilizado alUpdate No utilizado abWhen 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. alPixel Lgico, opcional. Utiliza coordenadas em pixel abValid Bloco de cdigo, opcional. Bloco que dever ser acionado na validao. alDesign No utilizado alIsIcon Lgico, opcional. cone. No utilizado a partir da verso Protheus 8 alIsJpeg Lgico, opcional. Jpeg. No utilizado a partir da verso Protheus 8
E Mtodos auxiliares:
Create
O Descrio: Retorna Mtodo construtor opcional da classe. O Sintaxe: Create() O Parmetros:
Nenhum -
O Retorno:
Objeto Objeto da classe TBar com todos os atributos com contedos padres.
SetBmp
O Descrio: Mtodo para carregar uma imagem do repositrio. O Sintaxe: SetBmp( acResName ) O Parmetros:
acResName Caractere, Nome do resource
O Retorno:
Nenhum -
Load
O Descrio: Mtodo para carregar uma imagem do repositrio ou local. O Sintaxe: Load( acResName, acBmpFile ) O Parmetros:
acResName Caractere, Nome do resource. acBmpFile Caractere, Nome do arquivo.
O Retorno:
Nenhum -
E Aparncia:
- 62 -
ADVPL Avanado
- 63 -
ADVPL Avanado
Exemplo:
#include protheus.ch
User Function tBitmapTst() Local oDlg Local oBmp
DEFINE MSDIALOG oDlg TITLE '' FROM 0,0 TO 280,330 PIXEL
nRow Numrico, opcional. Coordenada vertical em pixels ou carateres. nCol Numrico, opcional. Coordenada horizontal em pixels ou caracteres. cCaption Caractere, opcional. Titulo do boto. oWnd Objeto, opcional. Janela ou controle onde o boto dever ser criado. bAction Bloco de cdigo, opcional. Bloco que dever ser acionado quando o boto for pressionado. nWidth Numrico, opcional. Largura do boto em pixels nHeight Numrico, opcional. Altura do boto em pixels.
nHelpId Reservado oFont Objeto, opcional. Objeto tipo tFont com propriedades da fonte utilizada para o ttulo do boto. lDefault Reservado lPixel Lgico, opcional. Se .T. considera as coordenadas passadas em pixels, se .F. (padro) considera em caracteres. lDesign Reservado cMsg Reservado lUpdate Reservado bWhen 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. bValid Reservado lCancel Reservado
E Aparncia:
Exemplo:
#include 'protheus.ch' User Function Teste() Local oDlg DEFINE MSDIALOG oDlg FROM 0,0 TO 304,504 PIXEL TITLE 'Exemplo' oTBrowseButton := TBrowseButton():New( 01,01,'TBrowseButton',oDlg,;
cResName1 Caractere, Nome do resource cResName2 Caractere, Nome do resource cBmpFile1 Caractere, NO UTILIZADO cBmpFile2 Caractere, NO UTILIZADO cMsg Caractere, Mensagem de Hint bAction Bloco de cdigo. Ao executada lGroup Lgico. Define grupo oWnd Objeto, opcional. Janela ou controle onde a boto dever ser criado lAdjust Lgico, NO UTILIZADO bWhen 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. cToolTip Mensagem exibida quando objeto exibe seu tooltip. lPressed No utilizado bDrop No utilizado cAction No utilizado nPos No utilizado cPrompt Caracter, opcional. Caption do boto. oFont Objeto, opcional. Objeto tipo tFont utilizado para definir as caractersticas da fonte utilizada para exibir o contedo do controle. cResName3 No utilizado cBmpFile3 No utilizado lBorder No utilizado
E Mtodos auxiliares:
LoadBitmaps
O Descrio: Atribui ao boto os bitmaps ou recursos para exibio. O Sintaxe: LoadBitmaps([cResName1], [cResName2], [cBmpFile1], [cBmpFile2], [cResName3], [cBmpFile3])
O Parmetros:
cResName1 Caractere, Nome do resource cResName2 Caractere, Nome do resource cBmpFile1 Caractere, Nome do arquivo BMP cBmpFile2 Caractere, Nome do arquivo BMP cResName3 Caractere, Nome do resource cBmpFile3 Caractere, Nome do resource
O Retorno:
Nenhum
SetPopUpMenu
O Descrio: Seta o objeto do tipo TMenu referente ao boto. O Sintaxe: SetPopupMenu(oMenu) O Parmetros:
Nenhum -
O Retorno:
Nenhum -
E Aparncia:
- 66 -
ADVPL Avanado
- 67 -
ADVPL Avanado
Exemplo:
#include 'protheus.ch' User Function Teste() Local oDlg DEFINE MSDIALOG oDlg FROM 0,0 TO 304,504 PIXEL TITLE 'Exemplo' 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. )
ACTIVATE MSDIALOG oDlg CENTERED Return NIL
TBTNBMP2()
E Descrio: Classe de objetos visuais do tipo boto, o qual permite a exibio de uma imagem ou de um popup.
anTop Numrico, opcional. Coordenada vertical em pixels ou carateres. anLeft Numrico, opcional. Coordenada horizontal em pixels ou caracteres. anWidth Numrico, opcional. Largura em pixels. anHeight Numrico, opcional. Altura em pixels. acResName1 Caractere, Nome do resource acResName2 Caractere, NO UTILIZADO acBmpFile1 Caractere, NO UTILIZADO acBmpFile2 Caractere, NO UTILIZADO abAction Bloco de cdigo. Ao executada aoWnd Objeto, opcional. Janela ou controle onde a boto dever ser criado acMsg Caractere, Mensagem de Hint abWhen 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. lAdjust Lgico, NO UTILIZADO lUpdate Lgico, NO UTILIZADO
E Mtodos auxiliares:
LoadBitmaps
O Descrio: Atribui ao boto os bitmaps ou recursos para exibio. O Sintaxe: LoadBitmaps([cResName1], [cResName2], [cBmpFile1], [cBmpFile2], [cResName3], [cBmpFile3])
O Parmetros:
cResName1 Caractere, Nome do resource cResName2 Caractere, Nome do resource cBmpFile1 Caractere, Nome do arquivo BMP cBmpFile2 Caractere, Nome do arquivo BMP cResName3 Caractere, Nome do resource cBmpFile3 Caractere, Nome do resource
O Retorno:
Nenhum
SetPopUpMenu
O Descrio: Seta o objeto do tipo TMenu referente ao boto. O Sintaxe: SetPopupMenu(oMenu) O Parmetros:
Nenhum -
O Retorno:
Nenhum -
E Aparncia:
- 68 -
ADVPL Avanado
- 69 -
ADVPL Avanado
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 DEFINE MSDIALOG oDlg TITLE '' FROM 0,0 TO 100,200 PIXEL oBtn := TBtnBmp2():New( 10, 10, 13, 13, 'IBF-MENU.BMP' , 'IBF-MENU.BMP' , , , , oDlg, , , .T.) oBtn:SetPopupmenu(TShowMenu()) ACTIVATE MSDIALOG oDlg CENTERED 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()
E Descrio: Classe de objetos visuais do tipo boto, o qual permite a utilizao de texto para sua identificao.
E Propriedades:
lProcessing Lgico. Se .T. indica o boto est efetuando uma ao. bAction Bloco de cdigo. Executado quando o boto pressionado.
Parmetro Tipo / Descrio anRow Numrico, opcional. Coordenada vertical em pixels ou carateres. anCol Numrico, opcional. Coordenada horizontal em pixels ou caracteres. acCaption Caractere, opcional. Titulo do boto. aoWnd Objeto, opcional. Janela ou controle onde o boto dever ser criado. abAction Bloco de cdigo, opcional. Bloco que dever ser acionado quando o boto for pressionado. anWidth Numrico, opcional. Largura do boto em pixels. anHeight Numrico, opcional. Altura do boto em pixels. nPar8 Reservado. aoFont Objeto, opcional. Objeto tipo tFont com propriedades da fonte utilizada para o ttulo do boto. lPar10 Reservado. alPixel Lgico, opcional. Se .T. considera as coordenadas passadas em pixels, se .F. (padro) considera em caracteres. lPar12 Reservado. cPar13 Reservado. lPar14 Reservado. abWhen 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. bPar16 Reservado. lPar17 Reservado.
E Aparncia:
Exemplo:
#include 'protheus.ch' 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.) ACTIVATE MSDIALOG oDlg CENTERED MsgStop( 'O valor '+cCombo ) Return NIL
- 70 -
ADVPL Avanado
- 71 -
ADVPL Avanado
TCBROWSE()
E Descrio: Classe de objetos visuais do tipo Grid.
E Propriedades:
+ Herdadas da classe superior nAt Linha atualmente selecionada / posicionada no objeto nLen Nmero total de linhas do objeto
nRow Numrico, opcional. Coordenada vertical nCol Numrico, opcional. Coordenada horizontal nWidth Numrico, opcional. Largura do objeto nHeight Numrico, opcional. Altura do objeto bFields Bloco de cdigo, Lista de Campos aHeaders Vetor, Descrio dos campos para no cabealho aColSizes Vetor, Largura das colunas oDlg Objeto, opcional. Janela ou controle onde o divisor dever ser criado. cField Caracter, opcional. Campos necessrios ao filtro uValue1 Indefinido, opcional. Inicio do intervalo para o filtro uValue2 Indefinido, opcional. Fim do intervalo para o filtro bChange Bloco de cdigo, opcional. Executado quando o item selecionado alterado. bLDblClick Bloco de cdigo, opcional. Executado quando acionado duplo click do boto esquerdo do mouse sobre o controle. bRClick No utilizado oFont Objeto, opcional. Fonte oCursor Objeto, opcional. Tipo do Cursor nClrFore Numrico, opcional. Cor do texto da janela. nClrBack Numrico, opcional. Cor de fundo da janela. cMsg Caracter, opcional. Mesamge ao posicionar o mouse sobre o objeto lUpdate No utilizado cAlias Caracter, opcional se objeto utilizado com Vetor, obrigatorio se utilizado com Tabela lPixel Lgico, opcional. Se .T. as coordenadas informadas so em pixels, se .F. so em caracteres. bWhen 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. lDesign No Utilizado bValid Bloco de cdigo, opcional. Executado quando o contedo do
- 72 -
ADVPL Avanado
controle deve ser validado, deve retornar .T. se o contedo for vlido e .F. quando o contedo for invlido. lHScroll Lgico, opcional. Se .T., habilita barra de rolagem horizontal. lVScroll Lgico, opcional. Se .T., habilita barra de rolagem vertical.
E Mtodos auxiliares:
GoUp
O Descrio: Salta uma linha para cima. O Sintaxe: GoUp( ) O Parmetros:
Nenhum -
O Retorno:
Nil
GoDown
O Descrio: Salta uma linha para baixo. O Sintaxe: GoDown( ) O Parmetros:
Nenhum -
O Retorno:
Nil
GoTop
O Descrio: Salta para primeira linha. O Sintaxe: GoTop( ) O Parmetros:
Nenhum -
O Retorno:
Nil
GoBottom
O Descrio: Salta para ultima linha. O Sintaxe: GoBottom( ) O Parmetros:
Nenhum -
O Retorno:
Nil
RowCount
O Descrio: Retorna numero de linhas visiveis. O Sintaxe: RowCount( ) O Parmetros:
Nenhum -
O Retorno:
Nil
E Aparncia:
- 73 -
ADVPL Avanado
- 74 -
ADVPL Avanado
Exemplo:
#include 'protheus.ch' 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() } // Principais commandos 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. )
E Descrio: Classe de objetos visuais do tipo controle - CheckBox.
E Propriedades:
bLClicked Bloco de cdigo disparado ao clique do mouse no objeto bSetGet Bloco de cdigo disparado na mudana de item selecionado, responsavel pela mudana de valor da variavel numerica que indica o item selecionado. bWhen Bloco de cdigo recebe um lgico e de True permite alterao, se False no permite. bValid Bloco de cdigo executado na saida do objeto.
nRow Numrico, opcional. Coordenada vertical nCol Numrico, opcional. Coordenada horizontal cCaption Caracter, Texto descritivo bSetGet Code-block, opcional, Responsvel pela setagem de valor oDlg Objeto, opcional. Janela ou controle onde o divisor dever ser criado. nWidth Numrico, opcional. Largura do objeto nHeight Numrico, opcional. Altura do objeto aHelpIds No utilizado bLClicked Bloco de cdigo, opcional. Executado ao clique do mouse. oFont Objeto, opcional. Fonte bValid 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. nClrText Numrico, opcional. Cor do texto da janela. nClrPane Numrico, opcional. Cor de fundo da janela. lDesign No utilizado lPixel Lgico, opcional. Se .T. as coordenadas informadas so em pixels, se .F. so em caracteres. cMsg Caracter, opcional. Mesamge ao posicionar o mouse sobre o objeto lUpdate No utilizado bWhen 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.
E Aparncia:
Exemplo:
#include 'protheus.ch' 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.,,,) oCheck2 := TCheckBox():New(11,01,'CheckBox 002',,oDlg, 100,210,,,,,,,,.T.,,,) oCheck3 := TCheckBox():New(21,01,'CheckBox 003',,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. ) ACTIVATE MSDIALOG oDlg CENTERED return
- 76 -
ADVPL Avanado
- 77 -
ADVPL Avanado
TCOLORTRIANGLE()
E Descrio: Classe de objetos visuais do tipo Paleta de Cores.
E Propriedades:
- Herdadas das classes superiores.
E Construtor: New([anRow], [anCol], [aoWnd], [anWidth], [anHeight] )
E Parmetros:
anRow Numrico, opcional. Coordenada vertical em pixels ou carateres. anCol Numrico, opcional. Coordenada horizontal em pixels ou caracteres. aoWnd Objeto, opcional. Janela ou controle onde a paleta dever ser criada. anWidth Numrico, opcional. Largura da paleta em pixels. anHeight Numrico, opcional. Altura da paleta em pixels.
E Mtodos auxiliares:
Create
O Descrio: Mtodo construtor opcional da classe. O Sintaxe: Create(aoWnd) O Parmetros:
aoWnd Objeto, opcional. Janela ou controle onde a paleta dever ser criada.
O Retorno:
Objeto Objeto do tipo TColorTriangule com os atributos definidos com contedo padro.
RetColor
O Descrio: Retorna o RGB da cor selecionada O Sintaxe: RetColor ( ) O Parmetros:
Nenhum -
O Retorno:
Numrico Valor que representa do RGB da cor.
SetColorIni
O Descrio: Define a cor inicial selecionada para o controle. O Sintaxe: SetColorIni (nColor ) O Parmetros:
nColor Valor da cor inicial no padro RGB.
O Retorno:
Nenhum -
SetColor
O Descrio: Define a cor corrente. O Sintaxe: SetColor (nColor ) O Parmetros:
nColor Valor da cor inicial no padro RGB.
O Retorno:
Nenhum -
SetSizeTriangule
O Descrio: Define o tamanho do tringulo de configurao das cores. O Sintaxe: SetSizeTriangule (nWidh, nHeight) O Parmetros:
nWidth Numrico. Largura nHeight Numrico.Altura
O Retorno:
Nenhum -
E Aparncia:
- 78 -
ADVPL Avanado
- 79 -
ADVPL Avanado
Exemplo:
#include protheus.ch
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 ) ACTIVATE MSDIALOG oDlg CENTERED Return Nil
TCOMBOBOX()
E 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.
E Propriedades:
aItems 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}. nAt Numrico. Posio do item selecionado.
Parmetro anRow Numrico, opcional. Coordenada vertical em pixels ou caracteres. anCol Numrico, opcional. Coordenada horizontal em pixels ou caracteres. abSetGet 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. anItems 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}. anWidth Numrico, opcional. Largura do controle em pixels.
- 80 -
ADVPL Avanado
anHeight Numrico, opcional. Altura do controle em pixels. aoWnd Objeto, opcional. Janela ou controle onde o controle ser criado. nPar8 Reservado. abChange Bloco de cdigo, opcional. Executado quando o controle modifica o item selecionado. abValid 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. anClrBack Numrico, opcional. Cor de fundo do controle. anClrText Numrico, opcional. Cor do texto do controle. alPixel Lgico, opcional. Se .T. as coordenadas informadas so em pixels, se .F. so em caracteres. aoFont Objeto, opcional. Objeto tipo tFont utilizado para definir as caractersticas da fonte utilizada para exibir o contedo do controle. cPar15 Reservado. lPar16 Reservado. abWhen 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. lPar18 Reservado. aPar19 Reservado. bPar20 Reservado. cPar21 Reservado. acReadVar 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( ).
E Mtodos auxiliares:
Select
O Descrio: Muda o item selecionado no combobox. O Sintaxe: Select( [anItem] ) O Parmetros:
anItem Numrico, opcional. Posio do item a ser selecionado.
O Retorno:
Nenhum -
E Aparncia:
Exemplo:
#include 'protheus.ch' 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.) ACTIVATE MSDIALOG oDlg CENTERED MsgStop( 'O valor '+cCombo ) Return NIL
- 81 -
ADVPL Avanado
- 82 -
ADVPL Avanado
TFOLDER()
E Descrio: Classe de objetos visuais do tipo controle - Folder.
E Propriedades:
aPrompts Array, Titulo dos folders aDialogs Array, Nome dos dilogos nOption Numrico, Folder selecionado bSetOption Bloco de cdigo, Executado na seleo do folder
anTop Numrico, opcional. Coordenada vertical em pixels ou carateres. anLeft Numrico, opcional. Coordenada horizontal em pixels ou caracteres. aPrompts Array, Titulo dos folders aDialogs Array, Nome dos dilogos aoWnd Objeto, opcional. Janela ou controle onde a boto dever ser criado anOption Numrico, opcional. Folder selecionado anClrFore Numrico, opcional. Cor de frente anClrBack Numrico, opcional. Cor de fundo alPixel Lgico, opcional. Utiliza coordenadas em pixel alDesign Lgico, opcional. NO USADO anWidth Numrico, opcional. Largura em pixels. anHeight Numrico, opcional. Altura em pixels. acMsg Caractere, Mensagem de Hint alAllWidth Lgico, opcional. NO USADO
E Mtodos auxiliares:
SetOption
O Descrio: Seleciona folder desejado O Sintaxe: SetOption( nOption ) O Parmetros:
nOption Numrico. Folder a ser selecionado
O Retorno:
Nenhum -
AddItem
O Descrio: Insere um folder O Sintaxe: AddItem ( cItem, lVisible ) O Parmetros:
cItem Caractere. Ttulo do Folder lVisible Lgico. Visvel
O Retorno:
Nenhum -
aEnable
O Descrio: Habilita/Desabilita um folder O Sintaxe: aEnable( nItem, lEnable ) O Parmetros:
nItem Numrico. Folder para habilitar/desabilitar lEnable Lgico. Habilita/Desabilita
O Retorno:
Nenhum -
E Aparncia:
- 83 -
ADVPL Avanado
- 84 -
ADVPL Avanado
Exemplo:
Local oFolder Local aFolder := { 'Folder 1', 'Folder 2', 'Folder 3' }
E 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.
E Propriedades:
lPassword Lgico. Se .T. o controle se comporta como entrada de dados de senha, exibindo asteriscos * para esconder o contedo digitado. Picture Caractere. Mscara de formatao do contedo a ser exibido.
anRow Numrico, opcional. Coordenada vertical em pixels ou caracteres. anCol Numrico, opcional. Coordenada horizontal em pixels ou caracteres. abSetGet 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. aoWnd Objeto, opcional. Janela ou controle onde o controle ser criado. anWidth Numrico, opcional. Largura do controle em pixels. anHeight Numrico, opcional. Altura do controle em pixels. acPict Caractere, opcional. Mscara de formatao do contedo a ser exibido. abValid 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. anClrFore Numrico, opcional. Cor de fundo do controle. anClrBack Numrico, opcional. Cor do texto do controle. aoFont Objeto, opcional. Objeto tipo tFont utilizado para definir as caractersticas da fonte utilizada para exibir o contedo do controle. lPar12 Reservado. oPar13 Reservado. alPixel Lgico, opcional. Se .T. as coordenadas informadas so em pixels, se .F. so em caracteres. cPar15 Reservado. lPar16 Reservado. abWhen 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. lPar18 Reservado. lPar19 Reservado. abChange Bloco de cdigo, opcional. Executado quando o controle modifica o valor da varivel associada. alReadOnly Lgico, opcional. Se .T. o controle no poder ser editado. alPassword Lgico, opcional. Se .T. o controle exibir asteriscos * no lugar dos caracteres exibidos pelo controle para simular entrada de senha. cPar23 Reservado. acReadVar 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( ). cPar25 Reservado. lPar26 Reservado. nPar27 Reservado. lPar28 Reservado.
E Aparncia:
- 85 -
ADVPL Avanado
- 86 -
ADVPL Avanado
Exemplo:
#include 'protheus.ch' User Function TesteGet() 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')
// Boto para fechar a janela oButton:=tButton():New(30,10,'fechar',oDlg,{||oDlg:End()},100,20,,,,.T.) ACTIVATE MSDIALOG oDlg CENTERED MsgStop( 'O valor '+Transform(nGet1,'@E 999,999.00') )
Return NIL
TGROUP()
E 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.
anTop Numrico, opcional. Coordenada vertical superior em pixels ou caracteres. anLeft Numrico, opcional. Coordenada horizontal esquerda em pixels ou caracteres. anBottom Numrico, opcional. Coordenada vertical inferior em pixels ou caracteres. anRight Numrico, opcional. Coordenada horizontal direita em pixels ou caracteres. acCaption Caractere, opcional. Ttulo do grupo. aoWnd Objeto, opcional. Janela ou controle onde o controle ser criado. anClrText Numrico, opcional. Cor do texto. anClrPane Numrico, opcional. Cor do fundo. alPixel Lgico, opcional. Se .T. as coordenadas informadas so em pixels, se .F. so em caracteres. lPar10 Reservado.
E Aparncia:
Exemplo:
#include 'protheus.ch' User Function Teste() 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 ACTIVATE MSDIALOG oDlg CENTERED
- 87 -
ADVPL Avanado
- 88 -
ADVPL Avanado
THBUTTON()
E Descrio: Classe de objetos visuais do tipo boto com hiperlink.
E Propriedades:
bAction Bloco de cdigo. Executado quando o boto pressionado.
Parmetro Tipo / Descrio anRow Numrico, opcional. Coordenada vertical em pixels ou carateres. anCol Numrico, opcional. Coordenada horizontal em pixels ou caracteres. acCaption Caractere, opcional. Titulo do boto. aoWnd Objeto, opcional. Janela ou controle onde o boto dever ser criado. abAction Bloco de cdigo, opcional. Bloco que dever ser acionado quando o boto for pressionado. anWidth Numrico, opcional. Largura do boto em pixels. anHeight Numrico, opcional. Altura do boto em pixels. aoFont Objeto, opcional. Objeto tipo tFont com propriedades da fonte utilizada para o ttulo do boto. abWhen 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.
E Mtodos auxiliares:
Create
O Descrio: Mtodo construtor opcional da classe. O Sintaxe: Create(aoWnd) O Parmetros:
aoWnd Objeto, opcional. Janela ou controle onde a paleta dever ser criada.
O Retorno:
Objeto Objeto do tipo THButton com os atributos definidos com contedo padro.
E Aparncia:
Exemplo:
#include protheus.ch #include hbutton.ch User Function MyhBtn() Local oDlg, ohBtn DEFINE MSDIALOG oDlg FROM 0,0 TO 500,600 PIXEL TITLE Meu hButton // Usando o mtodo create 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' ACTIVATE MSDIALOG oDlg CENTERED Return Nil
TIBROWSER()
E Descrio: Classe de objetos visuais do tipo Pgina de Internet, sendo necessrio incluir a clausula BrowserEnabled=1 no Config do Remote.INI
E Propriedades:
- Herdadas da classe superior
E Construtor: New([nRow], [nCol], [nWidth], [nHeight], [cPager], [oWnd])
E Parmetros:
nRow Numrico, opcional. Coordenada vertical em pixels ou carateres. nCol Numrico, opcional. Coordenada horizontal em pixels ou caracteres nWidth Numrico, opcional. Largura em pixels nHeigth Numrico, opcional. Altura em pixels. cPage Caracter. Enredeo URL da pgina de Internet oWnd Objeto, opcional. Janela ou controle onde a boto dever ser criado
E Aparncia:
- 89 -
ADVPL Avanado
Exemplo:
#include 'protheus.ch' User Function Teste() Local oDlg DEFINE MSDIALOG oDlg FROM 0,0 TO 304,504 PIXEL TITLE 'Exemplo'
// Habilitar no Remote(Config) -> BrowserEnabled=1 oTIBrowser:= TIBrowser():New(0,0,306,134,'http://www.microsiga.com.br',oDlg )
ACTIVATE MSDIALOG oDlg CENTERED Return NIL
- 90 -
ADVPL Avanado
- 91 -
ADVPL Avanado
TLISTBOX()
E 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.
E Propriedades:
nAt Numrico. Posio do item selecionado. aItems Array de items caracteres. Lista do itens selecionveis.
anRow Numrico, opcional. Coordenada vertical em pixels ou caracteres. anCol Numrico, opcional. Coordenada horizontal em pixels ou caracteres. abSetGet 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 ou numrica. aaItems Array de items caracteres, opcional. Lista de items selecionveis. anWidth Numrico, opcional. Largura do controle em pixels. anHeight Numrico, opcional. Altura do controle em pixels. abChange Bloco de cdigo, opcional. Executado quando o item selecionado alterado. aoWnd Objeto, opcional. Janela ou controle onde o controle ser criado. abValid 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. anClrFore Numrico, opcional. Cor de fundo do controle. anClrBack Numrico, opcional. Cor do texto do controle. alPixel Lgico, opcional. Se .T. as coordenadas informadas so em pixels, se .F. so em caracteres. lPar13 Reservado. abLDBLClick Bloco de cdigo, opcional. Executado quando acionado duplo click do boto esquerdo do mouse sobre o controle. aoFont Objeto, opcional. Objeto tipo tFont utilizado para definir as caractersticas da fonte utilizada para exibir o contedo do controle. cPar16 Reservado. lPar17 Reservado. abWhen 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.
- 92 -
ADVPL Avanado
aPar19 Reservado. bPar20 Reservado. lPar21 Reservado. lPar22 Reservado. abRightClick Bloco de cdigo, opcional. Executado quando acionado click do boto direito do mouse sobre o controle.
E Mtodos auxiliares:
Select
O Descrio: Fora a seleo de um item. O Sintaxe: Select( [anItem] ) O Parmetros:
nItem Numrico, opcional. Posio do item a ser selecionado.
O Retorno:
Nenhum -
Add
O Descrio: Adiciona novo item. O Sintaxe: Add( cText, nPos ) O Parmetros:
cText Caractere, obrigatrio. Texto do item. nPos 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.
O Retorno:
Nenhum -
Modify
O Descrio: Modifica o texto de um item. O Sintaxe: Modify( cText, nPos ) O Parmetros:
cText Caractere, obrigatrio. Novo texto do item. nPos Numrico, obrigatrio. Posio a ser modificada deve ser maior que 0 e menor ou igual que o nmero de itens.
O Retorno:
Nenhum -
- 93 -
ADVPL Avanado
Del
O Descrio: Remove um item. O Sintaxe: Del( nPos ) O Parmetros:
nPos Numrico, obrigatrio. Posio a ser excluida, deve ser maior que 0 e menor ou igual que o nmero de itens.
O Retorno:
Nenhum -
Len
O Descrio: Retorna o nmero de itens. O Sintaxe: Len( ) O Parmetros:
Nenhum -
O Retorno:
Numrico Nmero de itens.
Reset
O Descrio: Apaga todos os itens. O Sintaxe: Reset( ) O Parmetros:
Nenhum -
O Retorno:
Nenhum -
E Aparncia:
Exemplo:
#include 'protheus.ch' User Function Teste() Local oDlg, oList, nList:= 1 Local aItems:={} Aadd(aItems,'Item 1') Aadd(aItems,'Item 2') Aadd(aItems,'Item 3') Aadd(aItems,'Item 4') 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.) ACTIVATE MSDIALOG oDlg CENTERED Return NIL
- 94 -
ADVPL Avanado
TMENU()
E Descrio: Classe de objetos visuais do tipo controle - Menu.
E Propriedades:
- Herdadas das classes superiores.
E Construtor: New ([nTop], [nLeft], [nHeight], [nWidth], [lPopUp], [cBmpName], [oWnd], [nClrNoSelect], [nClrSelect], [cArrowUpNoSel], [cArrowUpSel], [cArrowDownNoSel], [cArrowDownSel])
E Parmetros:
nTop Numrico, opcional. Coordenada vertical em pixels. nLeft Numrico, opcional. Coordenada horizontal em pixels. nHeight Numrico, opcional. Altura do controle em pixels. nWidth Numrico, opcional. Largura do controle em pixels. lPopUp Lgico. Define se o objeto ser um PoPup cBmpName Caracter opcional. Figura do Menu oWnd Objeto, opcional. Janela ou controle onde a boto dever ser criado nClrNoSelect Numerico opcional. Cor quando no selecionado nClrSelect Numerico opcional. Cor quando selecionado cArrowUpNoSel Caracter opcional, Define a figura da seta para cima quando no selecionado o item. cArrowUpSel Caracter opcional, Define a figura da seta para cima quando selecionado o item. cArrowDownNoSel Caracter opcional, Define a figura da seta para baixo quando no selecionado o item. cArrowDownSel Caracter opcional, Define a figura da seta para baixo quando selecionado o item.
E Aparncia:
- 95 -
ADVPL Avanado
Exemplo:
#include 'protheus.ch' User Function Teste() Local oDlg DEFINE MSDIALOG oDlg FROM 0,0 TO 304,504 PIXEL TITLE 'Exemplo' 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 )
E Descrio: Classe de objetos visuais do tipo controle - Barra de Menu.
E Propriedades:
- Herdadas das classes superiores.
E Construtor: New([oWnd])
E Parmetros:
oWnd Objeto, opcional. Janela ou controle onde o boto dever ser criado.
E Aparncia:
- 96 -
ADVPL Avanado
- 97 -
ADVPL Avanado
Exemplo:
#include 'protheus.ch' User Function Teste() Local oDlg DEFINE MSDIALOG oDlg FROM 0,0 TO 304,504 PIXEL TITLE 'Exemplo' // 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.)
E 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.
E Propriedades:
nTotal Numrico. Nmero total de passos at o preenchimento da rgua de processo. lPercentage Lgico. Se .T. considera o passo de movimentao em porcentagem. nClrBar Numrico. Cor da barra de andamento.
anRow Numrico, opcional. Coordenada vertical em pixels ou caracteres. anCol Numrico, opcional. Coordenada horizontal em pixels ou caracteres. abSetGet 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 numrico. anTotal Numrico, opcional. Numero total de passos at o preenchimento da rgua de processo. aoWnd Objeto, opcional. Janela ou controle onde o controle sera criado. anWidth Numrico, opcional. Largura do controle em pixels. anHeight Numrico, opcional. Altura do controle em pixels. lPar8 Reservado. alPixel Lgico, opcional. Se .T. as coordenadas informadas so em pixels, se .F. so em caracteres. oPar10 Reservado. cPar11 Reservado. alNoPerc Lgico, opcional. Se .T. (padro) no considera os passos de atualizao em porcentagem. anClrPane Numrico, opcional. Cor de fundo do controle. nPar14 Reservado. anClrBar Numrico, opcional. Cor da barra de andamento. nPar16 Reservado. lPar17 Reservado.
E Mtodos auxiliares:
Set
O Descrio: Atualiza a posio da rgua de processamento. O Sintaxe: Set( [nVal] ) O Parmetros:
nVal Numrico, opcional. Novo valor da posio da rgua de processamento.
O Retorno:
Nenhum -
E Aparncia:
- 98 -
ADVPL Avanado
- 99 -
ADVPL Avanado
Exemplo:
#include 'protheus.ch' STATIC lRunning:=.F., lStop:=.F. User Function Teste() 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. ACTIVATE MSDIALOG oDlg CENTERED 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
- 100 -
ADVPL Avanado
TMSGRAPHIC()
E Descrio: Classe de objetos visuais do tipo controle - Grfico.
E Propriedades:
l3D Lgico, opcional Grfico em 3D lAxisVisib Lgico, opcional Mostra eixos do grfico
E Construtor: New([anRow], [anCol], [aoWnd], [aoFont], [anClrText], [anClrBack], [anWidth], [anHeight])
E Parmetros:
anRow Numrico, opcional. Coordenada vertical em pixels. anCol Numrico, opcional. Coordenada horizontal em pixels. aoWnd Objeto, opcional. Janela ou controle onde a imagem dever ser criada. aoFont Objeto, opcional. Fonte utilizada no grfico. anClrText Caractere, Nome do resource. anClrBack Caractere, Nome do arquivo. anWidth Lgico, opcional. Exibe borda anHeight Objeto, opcional. Janela ou controle onde a imagem dever ser criada.
E Mtodos auxiliares:
CreateSerie
O Descrio: Mtodo para criao de uma serie para o grfico. O Sintaxe: CreateSerie( [nSerieType], [cLegend], [nDecimals], [lShowValues] ) O Parmetros:
nSerieType Numrico. Indica o tipo do grfico GRP_LINE 1 GRP_AREA 2 GRP_POINT 3 GRP_BAR 4 GRP_PIE 10 cLegend Caractere, opcional. Legenda da srie. nDecimals Numrico, opcional. Numero de casas decimais dos valores. lShowValues Lgico, opcional. Mostra valores
O Retorno:
Numrico Numero da srie criada.
- 101 -
ADVPL Avanado
Add
O Descrio: Mtodo para adicionar um item ao grfico. O Sintaxe: Add(nSerie, nVal, cLegend, nColor ) O Parmetros:
nSerie Numrico. Serie a ser inserido o item. nVal Numrico. Valor do item. cLegend Caractere. Legenda do item. nColor Numrico, Cor do item.
O Retorno:
Nenhum -
SetGradiente
O Descrio: Mtodo para setar o fundo do grfico com uma cor gradiente em determinada direo. O Sintaxe: SetGradient(nDirection, StartColor, EndColor ) O Parmetros:
O Descrio: Define o titulo do grfico. O Sintaxe: SetTitle(cTitle, cTitle2, Color, Aligment, lFoot) O Parmetros:
cTitle Caractere. Primeiro titulo. cTitle2 Caractere. Segundo titulo. Color Numrico. Cor do titulo. Aligment Numrico. Alinhamento do titulo. A_LEFTJUST 1 A_RIGHTJUS 2 A_CENTER 3 lFoot Lgico. Indica titulo no rodap do grfico.
O Retorno:
Nenhum -
- 102 -
ADVPL Avanado
SetLegenProp
O Descrio: Mtodo para setar propriedades da legenda. O Sintaxe: SetLegenProp(Align, Color, Style, Visible ) O Parmetros:
Align Numerico. Alinhamento da legenda. GRP_SCRTOP 1 GRP_SCRLEFT 2 GRP_SCRBOTTOM 3 GRP_SCRRIGHT 4 Color Numrico. Cor da legenda. Style Numrico. Estilo da legenda. GRP_AUTO 1 GRP_SERIES 2 GRP_VALUES 3 GRPLASTVAL 4 Visible Lgico. Indica de o titulo ser visvel.
O Retorno:
Nenhum -
SetMargins
O Descrio: Mtodo para setar as margens superior, inferior e laterais do grfico. O Sintaxe: SetMargins(nTop, nLeft, nBottom, nRight ) O Parmetros:
nTop Numrico. Posio em relao ao topo do grfico. nLeft Numrico. Posio em relao a esquerda. nBottom Numrico. Posio em relao ao rodap. nRight Numrico. Posio em relao a direita.
O Retorno:
Nenhum -
SetRangeY
O Descrio: Define a escala dos valores do eixo Y O Sintaxe: SetRangeY (min, max, delta). O Parmetros:
Min valor inicial Max valor final delta intervalo entre os valores [ opcional, calculado automaticamente ]
O Retorno:
Nenhum -
- 103 -
ADVPL Avanado
SaveToBMP
O Descrio: Mtodo para salvar o grfico atual em um bitmap no server(Obsoleto, ver SaveToImage). O Sintaxe: SaveToBMP(BmpName, PathToWrite ) O Parmetros:
BmpName Caractere, Nome do da figura a ser salva. PathToWrite Caractere. Path no Server onde ser salva a figura.
O Retorno:
Lgico Indica se a imagem foi salva corretamente.
SaveToImage
O Descrio: Mtodo para salvar o grfico atual em um formato de pr- determinado no server. O Sintaxe: SaveToImage(BmpName, PathToWrite, TypeImage) O Parmetros:
BmpName Caractere, Nome do da figura a ser salva. PathToWrite Caractere. Path no Server onde ser salva a figura. TypeImage Caractere. Tipo da Figura (Default 'JPEG') Tipos suportados: JPEG, PNG, BMP
O Retorno:
Lgico Indica se a imagem foi salva corretamente.
DelSerie
O Descrio: Mtodo para deletar uma srie do grafico. O Sintaxe: DelSerie ( nSerie ) O Parmetros:
nSerie Numrico. Serie a ser deletada.
O Retorno:
Lgico Indica se a sria foi removida do grfico
ZoomIn
O Descrio: Mtodo para efetuar zoom interno ( + ). O Sintaxe: ZoomIn() O Parmetros:
Nenhum -
O Retorno:
Nenhum -
ZoomOut
O Descrio: Mtodo para efetuar zoom externo ( - ). O Sintaxe: ZoomOut() O Parmetros:
Nenhum -
O Retorno:
Nenhum -
E Aparncia:
- 104 -
ADVPL Avanado
Exemplo:
#include 'MSGRAPHI.CH' User Function tMsGraphicTst()
DEFINE MSDIALOG oDlg TITLE '' FROM 0,0 TO 250,330 PIXEL
@ 001, 001 MSGRAPHIC oGraphic SIZE 120,120 OF oDlg
E Descrio: Classe de objetos visuais do tipo controle - Rodap.
E Propriedades:
- Herdadas das classes superiores.
E Construtor: New ([oWnd], [cPrompt,], [lCentered], [lClock], [lDate], [lKbd], [nClrFore], [nClrBack], [oFont], [lInset], [imageName])
E Parmetros:
oWnd Objeto, opcional. Janela ou controle onde a boto dever ser criado cPrompt Caracter. Descrio na Barra lCentered Logico. Define centralizao do texto lClock Nao utilizado lDate Nao utilizado lKbd Nao utilizado nClrFore Numerico, opcional. Define cor da fonte da barra nClrBack Numerico, opcional. Define cor do fundo da barra oFont Objeto, opcional. Objeto tipo tFont com propriedades da fonte utilizada para o ttulo do boto. lInset Nao utilizado imageName Caracter, opcional. Insere figura lateral esquerda
E Mtodos auxiliares:
AddItem
O Descrio: Mtodo insere um subitem no rodap O Sintaxe: AddItem( oTMsgItem ) O Parmetros:
oTMsgItem Objeto do tipo TMsgItem que ser inserido como subitem do rodap.
O Retorno:
Nenhum -
SetMsg
O Descrio: Define a descrio da barra de rodap O Sintaxe: SetMsg(cTexto ) O Parmetros:
cTexto Texto a ser inserido na barra
O Retorno:
Nenhum -
E Aparncia:
Exemplo:
#include 'protheus.ch' User Function Teste() Local oDlg DEFINE MSDIALOG oDlg FROM 0,0 TO 304,504 PIXEL TITLE 'Exemplo' oTMsgBar := TMsgBar():New(oDlg, 'MP10 | Totvs/Software', .F.,.F.,.F.,.F., RGB(116,116,116),,,.F.) oTMsgItem1 := TMsgItem():New( oTMsgBar,'oTMsgItem1', 204,,,, .T., {||}) oTMsgItem2 := TMsgItem():New( oTMsgBar,'oTMsgItem2', 040,,,, .T., {||Alert('Item da Barra Acionado')} )
ACTIVATE MSDIALOG oDlg CENTERED Return NIL
- 107 -
ADVPL Avanado
TMSGITEM()
E Descrio: Classe de objetos visuais do tipo controle utilizado para adicionar mensagens em outros objetos, como barras e menus.
oMsgBar Objeto do tipo barra ou menu no qual ser adicionado o item de mensagem. cMsg Mensagem que ser exibida pelo objeto nSize Tamanho da fonte do texto oFont Fonte do texto nClrFore Cor da fonte do texto nClrBack Cor do fundo do objeto lEnable Indica se o objeto est habilitado. bAction Bloco de cdigo executado quando o objeto ativado cImagem Imagem a ser vinculada no objeto.
E Aparncia:
- 108 -
ADVPL Avanado
- 109 -
ADVPL Avanado
Exemplo:
#include 'protheus.ch' User Function Teste() Local oDlg DEFINE MSDIALOG oDlg FROM 0,0 TO 304,504 PIXEL TITLE 'Exemplo' oTMsgBar := TMsgBar():New(oDlg, 'MP10 | Totvs/Software', .F.,.F.,.F.,.F., RGB(116,116,116),,,.F.) oTMsgItem1 := TMsgItem():New( oTMsgBar,'oTMsgItem1', 204,,,, .T., {||}) oTMsgItem2 := TMsgItem():New( oTMsgBar,'oTMsgItem2', 040,,,, .T., {||Alert('Item da Barra Acionado')} )
ACTIVATE MSDIALOG oDlg CENTERED Return NIL
.
TMULTIBTN()
E Descrio: Classe de objetos visuais do tipo controle - Mltiplos botes.
E Propriedades:
bAction Bloco de cdigo. Executado ao precionar o boto esquerdo do mouse.
nRow Numrico, opcional. Coordenada vertical em pixels ou carateres. nCol Numrico, opcional. Coordenada horizontal em pixels ou caracteres oWnd Objeto, opcional. Janela ou controle onde a boto dever ser criado bAction Bloco de cdigo, opcional. Bloco que dever ser acionado quando o boto for pressionado. nWidth Numrico, opcional. Largura em pixels nHeigth Numrico, opcional. Altura em pixels. imgName Caracter. Imagem a ser inserida ao lado esquerdo do componente ori Numerico, opcional. Orientao dos botes. cMsg Caracter, Opicional. Descrio do tipo tooltip(hint) do item btnPerLine Numerico, opcional. Quantidade de botes por linha
- 110 -
ADVPL Avanado
E Mtodos auxiliares:
LoadImage O Descrio: Muda a figura a esquerda do componente O Sintaxe: LoadImage(cImagem) O Parmetros:
cImagem Nome da imagem que ser carregada pelo objeto
O Retorno:
Nenhum -
AddButton O Descrio: Insere um boto O Sintaxe: AddButton(cTexto) O Parmetros:
cTexto Texto para exibio no boto inserido.
O Retorno:
Nenhum -
SetTitle O Descrio: Muda o titulo e o numero de botes por linha O Sintaxe: SetTitle(cTexto, nBotoes) O Parmetros:
cTexto Texto que ser atribudo aos botes nBotoes Nmero de botes por linha
O Retorno:
Nenhum -
SetFonts O Descrio: Muda a font do titulo e dos botes O Sintaxe: SetTitle(cFontTit, nSizeTit, nFontBut, nSizeBut) O Parmetros:
cFontTit Nome da fonte que ser atribuda ao ttulo nSizeTit Tamanho da fonte do ttulo nFontBut Nome da fonte que ser atribuda aos botes nSizeBut Tamanho da fonte dos botes
O Retorno:
Nenhum -
E Aparncia:
Exemplo:
#include 'protheus.ch' User Function Teste() Local oDlg DEFINE MSDIALOG oDlg FROM 0,0 TO 304,504 PIXEL TITLE 'Exemplo'
Parmetro anRow Numrico, opcional. Coordenada vertical em pixels ou caracteres. anCol Numrico, opcional. Coordenada horizontal em pixels ou caracteres. abSetGet 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. aoWnd Objeto, opcional. Janela ou controle onde o controle ser criado. anWidth Numrico, opcional. Largura do controle em pixels. anHeight Numrico, opcional. Altura do controle em pixels. aoFont Objeto, opcional. Objeto tipo tFont utilizado para definir as caractersticas da fonte utilizada para exibir o contedo do controle. alHScroll Lgico, opcional. Se .T., habilita barra de rolagem horizontal. anClrFore Numrico, opcional. Cor de fundo do controle. anClrBack Numrico, opcional. Cor do texto do controle. oPar11 Reservado. alPixel Lgico, opcional. Se .T. as coordenadas informadas so em pixels, se .F. so em caracteres. cPar13 Reservado. lPar14 Reservado. abWhen 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. lPar16 Reservado. lPar17 Reservado. alReadOnly Lgico, opcional. Se .T. o controle so permitira leitura. abValid 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. bPar20 Reservado. lPar21 Reservado. alNoBorder Lgico, opcional. Se .T. cria controle sem borda. alNoVScroll Lgico, opcional. Se .T., habilita barra de rolagem vertical.
E Mtodos auxiliares:
EnableVScroll
O Descrio: Habilita a barra de rolagem vertical. O Sintaxe: EnableVScroll( lEnable ) O Parmetros:
lEnable Lgico, obrigatrio. Se .T. habilita se .F. desabilita a barra de rolagem.
O Retorno:
Nenhum -
EnableHScroll
O Descrio: Habilita a barra de rolagem horizontal. O Sintaxe: EnableHScroll( lEnable ) O Parmetros:
lEnable Lgico, obrigatrio. Se .T. habilita se .F. desabilita a barra de rolagem.
O Retorno:
Nenhum -
E Aparncia:
- 113 -
ADVPL Avanado
- 114 -
ADVPL Avanado
Exemplo:
#include protheus.ch User Function Teste()
Local oDlg, oMemo, cMemo:= space(50)
DEFINE MSDIALOG oDlg FROM 0,0 TO 400,400 PIXEL TITLE My test
@ 200,10 BUTTON oBtn PROMPT Fecha OF oDlg PIXEL ACTION oDlg:End()
ACTIVATE MSDIALOG oDlg CENTERED
MsgStop(cMemo)
Return NIL
TOLECONTAINER()
E Descrio: Classe de objetos visuais do tipo controle, a qual permite a criao de um boto vinculado a um objeto OLE.
E Propriedades:
- Herdadas das classes superiores.
E Construtor: New([nRow], [nCol], [nWidth], [nHeight], [oWnd], [lAutoActivate], [cFileName])
E Parmetros:
nRow Numrico, opcional. Coordenada vertical em pixels ou carateres. nCol Numrico, opcional. Coordenada horizontal em pixels ou caracteres. nWidth Numrico, opcional. Largura do boto em pixels nHeight Numrico, opcional. Altura do boto em pixels.
oWnd Objeto, opcional. Janela ou controle onde o boto dever ser criado. lAutoActivate Nao utilizado cFileName Caracter. Endereo do arquivo Ole a ser aberto
E Mtodos auxiliares:
OpenFromFile
O Descrio: Abre arquivo do tipo OLE. O Sintaxe: New([cFileName, [lAsIcon], [allowInPlace]) O Parmetros:
cFileName Caracter. Endereo do arquivo Ole a ser aberto lAsIcon Logico. Define objeto Ole como Icone allowInPlace Logico opcional. Permite abertura de arquivo local
O Retorno:
Nenhum -
E Aparncia:
Exemplo:
#include 'protheus.ch' User Function Teste() Local oDlg DEFINE MSDIALOG oDlg FROM 0,0 TO 304,504 PIXEL TITLE 'Exemplo'
E Descrio: Classe de objetos visuais do tipo controle, que permite a visualizao de arquivos no formato gerado pelo spool de impresso do Protheus.
E Propriedades:
- Herdadas das classes superiores.
E Construtor: New([nCol], [nRow], [nWidth], [nHeight], [oPrinter], [oWnd], [nPageWidth], [nPageHeight])
E Parmetros:
nCol Numrico, opcional. Coordenada vertical em pixels ou carateres. nRow Numrico, opcional. Coordenada horizontal em pixels ou caracteres nWidth Numrico, opcional. Largura em pixels nHeigth Numrico, opcional. Altura em pixels.
oPrinter Objeto do tipo TMsPrinter() oWnd Objeto, opcional. Janela ou controle onde a boto dever ser criado nPageWidth Numrico, opcional. Largura em pixels da pagina nPageHeight Numrico, opcional. Altura em pixels da pagina
E Mtodos auxiliares:
PageSize
O Descrio: Define o tamanho da pagina. O Sintaxe: AddItem(nLargura, nAltura) O Parmetros:
nLargura Lagura da pgina nAltura Altura da pgina
O Retorno:
Nenhum -
PrintPage
O Descrio: Imprime uma determinada pgina. O Sintaxe: PrintPage(nNrPagina) O Parmetros:
nNrPagina Pgina que ser impressa
O Retorno:
Nenhum -
E Aparncia:
Exemplo:
#include 'protheus.ch' User Function Teste() Local oDlg DEFINE MSDIALOG oDlg FROM 0,0 TO 304,504 PIXEL TITLE 'Exemplo'
E 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.
anRow Numrico, opcional. Coordenada vertical em pixels. anCol Numrico, opcional. Coordenada horizontal em pixels. acText Caractere, opcional. Texto a ser exibido ao fundo. aoWnd Objeto, opcional. Janela ou controle onde ser criado o objeto. alCentered Lgico, opcional. Se .T. exibe o texto de ttulo ao centro do controle. lPar6 Reservado. anClrText Numrico, opcional. Cor do texto do controle. anClrBack Numrico, opcional. Cor do fundo do controle. anWidth Numrico, opcional. Largura do controle em pixels. anHeight Numrico, opcional. Altura do controle em pixels. alLowered Lgico, opcional. Se .T. exibe o painel rebaixado em relao ao controle de fundo. alRaised Lgico, opcional. Se .T. exibe a borda do controle rebaixada em relao ao controle de fundo.
E Aparncia:
- 118 -
ADVPL Avanado
- 119 -
ADVPL Avanado
Exemplo:
#include 'protheus.ch' User Function Teste() Local oDlg, oButton, oCombo, cCombo, cGet1:='Teste' DEFINE MSDIALOG oDlg FROM 0,0 TO 300,300 PIXEL TITLE 'Meu test' 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 ACTIVATE MSDIALOG oDlg CENTERED Return
TRADMENU()
E Descrio: Classe de objetos visuais do tipo controle TRadMenu, a qual permite criar um controle visual no formato Radio Button.
E Propriedades:
bChange Bloco de cdigo disparado na mudana de item selecionado bSetGet Bloco de cdigo disparado na mudana de item selecionado, responsavel pela mudana de valor da variavel numerica que indica o item selecionado. bWhen Bloco de cdigo que permite ou no a alterao do objeto bValid Bloco de cdigo executado na saida do objeto.
nRow Numrico, opcional. Coordenada vertical nCol Numrico, opcional. Coordenada horizontal aItems Vetor, elementos do Radio bSetGet Code-block, Responsvel pela setagem de valor oDlg Objeto, opcional. Janela ou controle onde o divisor dever ser criado. aHelpIds No utilizado bChange Bloco de cdigo, opcional. Executado quando o item selecionado alterado. nClrText Numrico, opcional. Cor do texto da janela. nClrPane Numrico, opcional. Cor de fundo da janela. cMsg Caracter, opcional. Mesamge ao posicionar o mouse sobre o objeto lUpdate No utilizado bWhen 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
- 120 -
ADVPL Avanado
controle deve permanecer habilitado ou .F. se no. nWidth Numrico, opcional. Largura do objeto nHeight Numrico, opcional. Altura do objeto bValid 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. lDesign No utilizado l3d No utilizado lPixel Lgico, opcional. Se .T. as coordenadas informadas so em pixels, se .F. so em caracteres.
E Mtodos auxiliares:
SetOption
O Descrio: Seleciona um item. O Sintaxe: SetOption(nItem) O Parmetros:
nItem Item que ser selecionado
O Retorno:
Nenhum -
EnableItem
O Descrio: Habilita/Desabilita um Item O Sintaxe: EnableItem(nItem, lStatus) O Parmetros:
nItem Item que ser modificado lStatus Status que ser atribudo ( .T. Enable , .F. Disable)
O Retorno:
Nenhum -
Enable
O Descrio: Habilita um item. O Sintaxe: Enable(nItem) O Parmetros:
nItem Item que ser habilitado
O Retorno:
Nenhum -
Disable
O Descrio: Desabilita um item O Sintaxe: Disable(nItem) O Parmetros:
nItem Item que ser desabilitado
O Retorno:
Nenhum -
E Aparncia:
- 121 -
ADVPL Avanado
- 122 -
ADVPL Avanado
Exemplo:
#include 'protheus.ch' 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'},;
nRow Numrico, opcional. Coordenada vertical nCol Numrico, opcional. Coordenada horizontal nWidth Numrico, opcional. Largura do objeto nHeight Numrico, opcional. Altura do objeto oWnd Objeto, opcional. Janela ou controle onde o divisor dever ser criado. bChange Bloco de cdigo, na mudana de linha nHWidth No utilizado oFont Objeto, opcional. Fonte nLines Nmerico. Nr de linhas por clula
E Mtodos auxiliares:
GoUp
O Descrio: Salta uma linha para cima. O Sintaxe: GoUp( ) O Parmetros:
Nenhum -
O Retorno:
Nil
GoDown
O Descrio: Salta uma linha para baixo. O Sintaxe: GoDown( ) O Parmetros:
Nenhum -
O Retorno:
Nil
- 124 -
ADVPL Avanado
GoTop
O Descrio: Salta para primeira linha. O Sintaxe: GoTop( ) O Parmetros:
Nenhum -
O Retorno:
Nil
GoBottom
O Descrio: Salta para ultima linha. O Sintaxe: GoBottom( ) O Parmetros:
Nenhum -
O Retorno:
Nil
RowCount
O Descrio: Retorna numero de linhas visiveis. O Sintaxe: RowCount( ) O Parmetros:
Nenhum -
O Retorno:
Nil
LEditCell
O Descrio: Edita o valor de uma coluna. O Sintaxe: lEditCell( aList, oList, cPicture, nCol ) O Parmetros:
aList Vetor da Browse onde esto os valores da mesma oList Objeto, Browse a ser editado cPicture Caracter, picture necessria para edio do campo nCol Numrico, coluna a ser editada.
O Retorno:
Nil
E Aparncia:
- 125 -
ADVPL Avanado
- 126 -
ADVPL Avanado
Exemplo:
#include 'protheus.ch' User Function Teste() Local oDlg DEFINE MSDIALOG oDlg FROM 0,0 TO 302,402 PIXEL TITLE 'Exemplo'
E Descrio: Classe de objetos visuais do tipo controle tSay, a qual exibe o contedo de texto esttico sobre uma janela ou controle previamente definidos.
E Propriedades:
lWordWrap 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. lTransparent 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.
anRow Numrico, opcional. Coordenada vertical em pixels ou caracteres. anCol Numrico, opcional. Coordenada horizontal em pixels ou caracteres. abText Codeblock, opcional. Quando executado deve retornar uma cadeia de caracteres a ser exibida. aoWnd Objeto, opcional. Janela ou dilogo onde o controle ser criado. acPicture Caractere, opcional. Picture de formatao do contedo a ser exibido. aoFont Objeto, opcional. Objeto tipo tFont para configurao do tipo de fonte que ser utilizado para exibir o contedo. lPar7 Reservado. lPar8 Reservado. lPar9 Reservado. alPixels Lgico, opcional. Se .T. considera coordenadas passadas em pixels se .F., padro, considera as coordenadas passadas em caracteres. anClrText Numrico, opcional. Cor do contedo do controle. anClrBack Numrico, opcional. Cor do fundo do controle. anWidth Numrico, opcional. Largura do controle em pixels. anHeight Numrico, opcional. Altura do controle em pixels. lPar15 Reservado. lPar16 Reservado. lPar17 Reservado. lPar18 Reservado. lPar19 Reservado.
E Aparncia:
Exemplo:
#include 'protheus.ch' User Function Teste() Local oDlg, oButton, oCombo, cCombo, cGet1:='Teste' DEFINE MSDIALOG oDlg FROM 0,0 TO 300,300 PIXEL TITLE 'Meu test' oSay:= tSay():New(01,01,{||'para exibir'},oDlg,,,,; ,,.T.,CLR_RED,CLR_WHITE,100,20) ACTIVATE MSDIALOG oDlg CENTERED Return
- 128 -
ADVPL Avanado
TSCROLLBOX()
E 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.
E Propriedades:
- Herdadas das classes superiores
E Construtor: New([aoWnd], [anTop], [anLeft], [anHeight], [anWidth], [alVertical], [alHorizontal], [alBorder])
E Parmetros:
aoWnd Objeto, opcional. Janela ou controle onde o controle ser criado. anTop Numrico, opcional. Coordenada vertical em pixels. anLeft Numrico, opcional. Coordenada horizontal em pixels. anHeight Numrico, opcional. Altura do controle em pixels. anWidth Numrico, opcional. Largura do controle em pixels. alVertical Lgico, opcional. Se .T. exibe a barra de scroll vertical. alHorizontal Lgico, opcional. Se .T. exibe a barra de scroll horizontal. alBorder Lgico, opcional. Se .T. exibe a borda do controle.
E Aparncia:
- 129 -
ADVPL Avanado
- 130 -
ADVPL Avanado
Exemplo:
#include 'protheus.ch' User Function Teste() Local oDlg, oScr, oGet1, oGet2, oGet3 Local cGet1, cGet2, cGet3 cGet1:= Space(10) cGet2:= Space(10) cGet3:= Space(10) DEFINE MSDIALOG oDlg FROM 0,0 TO 220,220 PIXEL TITLE 'Meu test' 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 @ 50,10 MSGET oGet2 VAR cGet2 SIZE 100,10 OF oScr PIXEL @ 150,100 MSGET oGet3 VAR cGet3 SIZE 100,10 OF oScr PIXEL ACTIVATE MSDIALOG oDlg CENTERED Return
TSIMPLEEDITOR()
E 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
E Propriedades:
- Herdadas das classes superiores.
E Construtor: New([anRow], [anCol], [aoWnd], [anWidth], [anHeight],[ acText], [alReadOnly])
E Parmetros:
anRow Numrico, opcional. Coordenada vertical em pixels ou carateres. anCol Numrico, opcional. Coordenada horizontal em pixels ou caracteres. aoWnd Janela ou controle onde o editor dever ser criado. anWidth Numrico, opcional. Largura do editor em pixels. anHeight Numrico, opcional. Altura do editor em pixels. acText Texto, opcional. Inserido na inicializao do objeto. alReadOnly Lgico, opcional. Permite ou no a edio do texto
E Mtodos auxiliares:
Create
O Descrio: Mtodo construtor opcional da classe. O Sintaxe: Create( aoWnd ) O Parmetros:
aoWnd Objeto, opcional. Janela ou controle onde o editor dever ser criado.
- 131 -
ADVPL Avanado
O Retorno:
Objeto Objeto do tipo TsimpleEditor.
Load
O Descrio: Carrega um texto para o editor. O Sintaxe: Load( acTexto ) O Parmetros:
acTexto Texto. Texto que inicializar o editor.
O Retorno:
Nenhum -
TextBold
O Descrio: Texto em Negrito. O Sintaxe: TextBold( alBold ) O Parmetros:
alBold Lgico. Habilita ou Desabilita a sesso do texto como Negrito.
O Retorno:
Nenhum -
TextUnderline
O Descrio: Texto Sublinhado. O Sintaxe: TextUnderline( alUnderline ) O Parmetros:
alUnderline Lgico. Habilita ou Desabilita a sesso do texto Sublinhado.
O Retorno:
Nenhum -
TextItalic
O Descrio: Texto Itlico. O Sintaxe: TextItalic( alItalic ) O Parmetros:
alItalic Lgico. Habilita ou Desabilita a sesso do texto Itlico.
O Retorno:
Nenhum -
- 132 -
ADVPL Avanado
TextFamily
O Descrio: Famlia de fontes. O Sintaxe: TextFamily( acFamily ) O Parmetros:
acFamily Texto. Nome da famlia da fonte a ser usada na sesso do texto.
O Retorno:
Nenhum -
TextSize
O Descrio: Tamanho da fonte. O Sintaxe: TextSize( anSize ) O Parmetros:
anSize Numrico. Tamanho da fonte utilizada na sesso do texto.
O Retorno:
Nenhum -
TextStyle
O Descrio: Estilo do pargrafo. O Sintaxe: TextStyle( anStyle ) O Parmetros:
anStyle Numrico. Estilo do pargrafo a ser utilizada na sesso do texto.
1 Normal 2 Disco (Bullet) 3 Circulo (Bullet) 4 Quadrado (Bullet) 5 Ordem decimal 6 Ordem alfanumrica minsculo 7 Ordem alfanumrica maisculo
O Retorno:
Nenhum -
- 133 -
ADVPL Avanado
TextAlign
O Descrio: Alinhamento do texto. O Sintaxe: TextAlign( anAlign ) O Parmetros:
anAlign Numrico. Tipo do alinhamento do pargrafo. 1 Esquerda 2 Direita 3 Centralizado 4 Justificado
O Retorno:
Nenhum -
TextFormat
O Descrio: Formato do texto. O Sintaxe: TextFormat( anFormat ) O Parmetros:
anFormat Numrico. Formato do texto 1 Html 2 Plain Text
O Retorno:
Nenhum -
RetText
O Descrio: Retorna o texto em formato string. O Sintaxe: RetText( void ) O Parmetros:
void Retorna uma string com o contedo do editor
O Retorno:
Nenhum -
RetTextSel
O Descrio: Retorna o texto selecionado em formato string.. O Sintaxe: RetText() O Parmetros:
Nenhum -
O Retorno:
String Texto selecionado.
TextStatus
O Descrio: Retorna um array com as propriedades do texto posicionado. O Sintaxe: TextStatus() O Parmetros:
Nenhum -
O Retorno:
Array Retorna um array com as seguintes propriedades :
User Function MyEditor() Local oDlg, oEditor DEFINE MSDIALOG oDlg FROM 0,0 TO 500,600 PIXEL TITLE Meu Editor // Usando o mtodo create 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 )
ACTIVATE MSDIALOG oDlg CENTERED Return Nil
TSLIDER()
E Descrio: Classe de objetos visuais do tipo controle tSlider, a qual permite criar um controle visual do tipo boto deslizante.
E Propriedades:
bChange Bloco de cdigo. Executado toda vez que o valor alterado retornando o novo valor.
E Construtor: New([anRow], [anCol], [aoWnd], [abChange], [anWidth], [anHeight], [acMsg], [abWhen])
E Parmetros:
anRow Numrico, opcional. Coordenada vertical em pixels anCol Numrico, opcional. Coordenada horizontal em pixels aoWnd Objeto, opcional. Janela ou controle onde o boto dever ser criado. abChange Bloco de cdigo, opcional. Bloco que dever ser acionado quando o boto for movimentado. anWidth Numrico, opcional. Largura do boto em pixels. anHeight Numrico, opcional. Altura do boto em pixels. acMsg Caracter, opcional. Mensagem de hint do boto abWhen 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.
E Mtodos auxiliares:
- 136 -
ADVPL Avanado
Create
O Descrio: Mtodo construtor da classe. O Sintaxe: Create( aoWnd ) O Parmetros:
aoWnd Objeto, opcional. Janela ou controle onde o boto dever ser criado.
O Retorno:
Objeto Objeto do tipo TSlide criado.
setRange
O Descrio: Especifica a faixa de valores. O Sintaxe: setRange( min, max ) O Parmetros:
Min Nmrico. Valor mnimo do boto. Max Nmrico. Valor mximo do boto.
O Retorno:
Nenhum -
setMarks
O Descrio: Especifica o tipo de marcao do boto. O Sintaxe: setMarks( nTipo ) O Parmetros:
nTipo Nmrico. Tipo de marcao do boto. 1 - Max Nmrico. Valor mximo do boto. 0 Sem marcao 1 Acima (esquerda se vertical) 2 Abaixo (direita se vertical) 3 Ambos os lados
O Retorno:
Nenhum -
- 137 -
ADVPL Avanado
setInterval
O Descrio: Especifica a distncia entre um marcador e outro. O Sintaxe: setInterval( nInterval ) O Parmetros:
nInterval Nmrico. Valor entre os marcadores
O Retorno:
Nenhum -
setValue
O Descrio: Especifica um valor para o boto. O Sintaxe: setValue( nVal ) O Parmetros:
nVal Nmrico. Valor do boto
O Retorno:
Nenhum -
setStep
O Descrio: Especifica o valor dos passos do boto. O Sintaxe: setStep( nStep ) O Parmetros:
nStep Nmrico. Valor do passo do boto
O Retorno:
Nenhum -
setOrient
O Descrio: Especifica a orientao do boto, horizontal ou vertical. O Sintaxe: setOrient( nOrient ) O Parmetros:
nOrient Nmrico. Orientao do boto 0 Horizontal 1 Vertical
O Retorno:
Nenhum -
E Aparncia:
Exemplo:
#include protheus.ch #include hbutton.ch User Function MytSlider() Local oDlg, oSlider DEFINE MSDIALOG oDlg FROM 0,0 TO 500,600 PIXEL TITLE Meu tSlider // Usando o mtodo create oSlider:= tSlider():Create( oDlg ) oSlider:nTop := 100 oSlider:nLeft := 10 oSlider:nWidth := 100 oSlider:nHeight := 30
E Descrio: Classe de objetos visuais do tipo controle tSplitter, a qual permite criar um controle visual do tipo divisor.
E Propriedades:
- Herdadas as classes superiores.
E Construtor: New( [anRow], [anCol], [aoWnd], [anWidth], [anHeight], [anOrientation] )
E Parmetros:
anRow Numrico, opcional. Coordenada vertical anCol Numrico, opcional. Coordenada horizontal aoWnd Objeto, opcional. Janela ou controle onde o divisor dever ser criado. anWidth Numrico, opcional. Largura do objeto anHeight Numrico, opcional. Altura do objeto anOrientation Numrico, opcional. Sentido no qual devero ser criado os divisores. 0 Horizontal 1 Vertical
- 138 -
ADVPL Avanado
- 139 -
ADVPL Avanado
E Mtodos auxiliares:
Create
O Descrio: Mtodo construtor da classe. O Sintaxe: Create( aoWnd ) O Parmetros:
aoWnd Objeto, opcional. Janela ou controle onde o divisor dever ser criado.
O Retorno:
Objeto Objeto do tipo Tsplitter gerado.
setOrient
O Descrio: Especifica a orientao do divisor, horizontal ou vertical. O Sintaxe: setOrient( nOrient ) O Parmetros:
nOrient Nmrico. Orientao do boto 0 Horizontal 1 Vertical
O Retorno:
Nenhum -
setChildCollapse
O Descrio: Especifica se os elementos podem ser collapsibles. O Sintaxe: setChildCollpse( lColl ) O Parmetros:
lColl Lgico. Ativa / Desativa
O Retorno:
Nenhum -
- 140 -
ADVPL Avanado
setCollapse
O Descrio: Especifica o objeto que pode ser collapsible. O Sintaxe: setCollapse( oObj, lColl ) O Parmetros:
oObj Objeto. Controle a ser collapsed lColl Lgico. Ativa / Desativa
O Retorno:
Nenhum -
movToLast
O Descrio: Coloca o objeto como ultimo das divises. O Sintaxe: movToLast( oObj ) O Parmetros:
oObj Objeto. Controle a posicionado
O Retorno:
Nenhum -
movToFirst
O Descrio: Coloca o objeto como primeiro das divises. O Sintaxe: movToFirst( oObj ) O Parmetros:
oObj Objeto. Controle a ser posicionado
O Retorno:
Nenhum -
setOpaqueResize
O Descrio: Especifica se o resize deve ser opaco. O Sintaxe: setOpaqueResize( lOpaq ) O Parmetros:
lOpaq Lgico. Ativa / Desativa
O Retorno:
Nenhum -
setResizeMode
O Descrio: Especifica o mode de resize do objeto.. O Sintaxe: setResizeMode ( oObj, nMode ) O Parmetros:
oObj Objeto. Controle a ser resized nMode Numrico. Modo do resize 0 Stretch 1- KeepSize 2 FollowSizeHint 3 Auto
O Retorno:
Nenhum -
E Aparncia:
- 141 -
ADVPL Avanado
- 142 -
ADVPL Avanado
Exemplo:
#include protheus.ch #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
// Usando o mtodo create oSplitter := tSplitter():Create( oDlg ) @ 1, 1 MSPANEL oPanel1 OF oSplitter @ 1, 2 MSPANEL oPanel2 OF oSplitter @ 1, 3 MSPANEL oPanel3 OF oSplitter
// Usando o command @ 1, 1 SPLITTER oSplitter SIZE 100, 100 OF oDlg @ 1, 1 MSPANEL oPanel1 OF oSplitter @ 1, 2 MSPANEL oPanel2 OF oSplitter @ 1, 3 MSPANEL oPanel3 OF oSplitter
ACTIVATE MSDIALOG oDlg CENTERED
Return Nil
TTABS()
E Descrio: Classe de objetos visuais do tipo controle TTabs, a qual permite criar um controle visual do tipo pasta.
anTop Numrico, opcional. Coordenada vertical em pixels ou carateres. anLeft Numrico, opcional. Coordenada horizontal em pixels ou caracteres aPrompts Array, Titulo dos folders bAction Bloco de codigo, Disparado na troca da aba.
oWnd Objeto, opcional. Janela ou controle onde a boto dever ser criado nOption Numrico, opcional. Folder selecionado nClrFore Numrico, opcional. Cor de frente nClrBack Numrico, opcional. Cor de fundo lPixel Lgico, opcional. Utiliza coordenadas em pixel lDesign Lgico, opcional. NO USADO nWidth Numrico, opcional. Largura em pixels nHeigth Numrico, opcional. Altura em pixels. cMsg Caractere, Mensagem de Hint
E Mtodos auxiliares:
AddItem
O Descrio: Adiciona uma aba na pasta O Sintaxe: AddItem(cTtulo) O Parmetros:
cTtulo Ttulo da aba que ser adicionada
O Retorno:
Nenhum -
SetOption
O Descrio: Seleciona a Aba O Sintaxe: SetOption( nNrAba ) O Parmetros:
nNrAba Nmero que identifica a posio da aba que ser selecionada.
O Retorno:
Nenhum -
E Aparncia:
- 143 -
ADVPL Avanado
- 144 -
ADVPL Avanado
Exemplo:
#include 'protheus.ch' User Function Teste() Local oDlg DEFINE MSDIALOG oDlg FROM 0,0 TO 304,504 PIXEL TITLE 'Exemplo'
E Descrio: Classe de objetos visuais do tipo controle tToolbox, a qual permite criar um controle visual para agrupar diferentes objetos.
E Propriedades:
bChangeGrp Bloco de cdigo. Executado na troca entre os grupos existentes.
E Construtor: New([anRow], [anCol], [aoWnd], [anWidth], [anHeight], [aoFont], [acMsg]], [abWhen])
E Parmetros:
anRow Numrico, opcional. Coordenada vertical em pixels ou carateres. anCol Numrico, opcional. Coordenada horizontal em pixels ou caracteres. aoWnd Objeto, opcional. Janela ou controle onde o boto dever ser criado. anWidth Numrico, opcional. Largura do boto em pixels. anHeight Numrico, opcional. Altura do boto em pixels. aoFont Objeto, opcional. Objeto tipo tFont com propriedades da fonte utilizada para o ttulo do boto. acMsg Mensagem, opcional. Tooltip/Hint do componente. abWhen 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.
- 145 -
ADVPL Avanado
E Mtodos auxiliares:
Create
O Descrio: Mtodo construtor opcional da classe. O Sintaxe: Create( aoWnd ) O Parmetros:
aoWnd Objeto, opcional. Janela ou controle onde o boto dever ser criado.
O Retorno:
Objeto Objeto do tipo TtoolBox gerado.
addGroup
O Descrio: Adiciona um grupo O Sintaxe: addGroup( aoObj, acName, aoIcon ) O Parmetros:
aoObj Objeto. Objeto Pai que vai ser inserido no grupo. acName Caractere. Descrio do grupo aoIcon Objeto, opcional. cone para o grupo
O Retorno:
Nenhum -
removeGroup
O Descrio: Remove um grupo O Sintaxe: removeGroup( aoObj ) O Parmetros:
aoObj Objeto. Objeto Pai que vai ser removido do grupo.
O Retorno:
Nenhum -
setCurrentGroup
O Descrio: Define o grupo corrente O Sintaxe: setCurrentGroup( aoObj ) O Parmetros:
aoObj Objeto. Objeto Pai que ser definido como grupo corrente.
O Retorno:
Nenhum -
E Aparncia:
Exemplo:
#include protheus.ch
User Function MytToolbox() Local oDlg, oTb
DEFINE MSDIALOG oDlg FROM 0,0 TO 500,600 PIXEL TITLE Meu Toolbox
nRow Numrico, opcional. Coordenada vertical nCol Numrico, opcional. Coordenada horizontal nWidth Numrico, opcional. Largura do objeto nHeight Numrico, opcional. Altura do objeto bFields Bloco de cdigo, Lista de Campos aHeaders Vetor, Descrio dos campos para no cabealho aColSizes Vetor, Largura das colunas oDlg Objeto, opcional. Janela ou controle onde o divisor dever ser criado. cField Caracter, opcional. Campos necessrios ao filtro uValue1 Indefinido, opcional. Inicio do intervalo para o filtro uValue2 Indefinido, opcional. Fim do intervalo para o filtro bChange Bloco de cdigo, opcional. Executado quando o item selecionado alterado. bLDblClick Bloco de cdigo, opcional. Executado quando acionado duplo click do boto esquerdo do mouse sobre o controle. bRClick No utilizado oFont Objeto, opcional. Fonte oCursor Objeto, opcional. Tipo do Cursor nClrFore Numrico, opcional. Cor do texto da janela. nClrBack Numrico, opcional. Cor de fundo da janela. cMsg Caracter, opcional. Mesamge ao posicionar o mouse sobre o objeto lUpdate No utilizado cAlias Caracter, opcional se objeto utilizado com Vetor, obrigatorio se utilizado com Tabela lPixel Lgico, opcional. Se .T. as coordenadas informadas so em pixels, se .F. so em caracteres. bWhen 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. lDesign No Utilizado
- 148 -
ADVPL Avanado
bValid 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. lHScroll Lgico, opcional. Se .T., habilita barra de rolagem horizontal. lVScroll Lgico, opcional. Se .T., habilita barra de rolagem vertical.
E Mtodos auxiliares:
GoUp
O Descrio: Salta uma linha para cima. O Sintaxe: GoUp( ) O Parmetros:
Nenhum -
O Retorno:
Nil
GoDown
O Descrio: Salta uma linha para baixo. O Sintaxe: GoDown( ) O Parmetros:
Nenhum -
O Retorno:
Nil
GoTop
O Descrio: Salta para primeira linha. O Sintaxe: GoTop( ) O Parmetros:
Nenhum -
O Retorno:
Nil
GoBottom
O Descrio: Salta para ultima linha. O Sintaxe: GoBottom( ) O Parmetros:
Nenhum -
O Retorno:
Nil
RowCount
O Descrio: Retorna numero de linhas visiveis. O Sintaxe: RowCount( ) O Parmetros:
Nenhum -
O Retorno:
Nil
LEditCell
O Descrio: Edita o valor de uma coluna. O Sintaxe: lEditCell( aList, oList, cPicture, nCol ) O Parmetros:
aList Vetor da Browse onde esto os valores da mesma oList Objeto, Browse a ser editado cPicture Caracter, picture necessria para edio do campo nCol Numrico, coluna a ser editada.
O Retorno:
Nil
E Aparncia:
- 149 -
ADVPL Avanado
- 150 -
ADVPL Avanado
Exemplo:
#include 'protheus.ch' User Function Teste() Local oDlg Local oOK := LoadBitmap(GetResources(),'br_verde') Local oNO := LoadBitmap(GetResources(),'br_vermelho')
DEFINE MSDIALOG oDlg FROM 0,0 TO 402,402 PIXEL TITLE 'Exemplo'
nRow Numrico, opcional. Coordenada vertical nCol Numrico, opcional. Coordenada horizontal nWidth Numrico, opcional. Largura do objeto nHeight Numrico, opcional. Altura do objeto bFields Bloco de cdigo, Lista de Campos aHeaders Vetor, Descrio dos campos para no cabealho aColSizes Vetor, Largura das colunas oDlg Objeto, opcional. Janela ou controle onde o divisor dever ser criado. cField Caracter, opcional. Campos necessrios ao filtro uValue1 Indefinido, opcional. Inicio do intervalo para o filtro uValue2 Indefinido, opcional. Fim do intervalo para o filtro bChange Bloco de cdigo, opcional. Executado quando o item selecionado alterado. bLDblClick Bloco de cdigo, opcional. Executado quando acionado duplo click do boto esquerdo do mouse sobre o controle. bRClick No utilizado oFont Objeto, opcional. Fonte oCursor Objeto, opcional. Tipo do Cursor nClrFore Numrico, opcional. Cor do texto da janela. nClrBack Numrico, opcional. Cor de fundo da janela. cMsg Caracter, opcional. Mesamge ao posicionar o mouse sobre o objeto lUpdate No utilizado cAlias Caracter, opcional se objeto utilizado com Vetor, obrigatorio se utilizado com Tabela lPixel Lgico, opcional. Se .T. as coordenadas informadas so em pixels, se .F. so em caracteres. bWhen 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.
- 152 -
ADVPL Avanado
lDesign No Utilizado bValid 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. lHScroll Lgico, opcional. Se .T., habilita barra de rolagem horizontal. lVScroll Lgico, opcional. Se .T., habilita barra de rolagem vertical.
E Mtodos auxiliares:
GoUp
O Descrio: Salta uma linha para cima. O Sintaxe: GoUp( ) O Parmetros:
Nenhum -
O Retorno:
Nil
GoDown
O Descrio: Salta uma linha para baixo. O Sintaxe: GoDown( ) O Parmetros:
Nenhum -
O Retorno:
Nil
GoTop
O Descrio: Salta para primeira linha. O Sintaxe: GoTop( ) O Parmetros:
Nenhum -
O Retorno:
Nil
- 153 -
ADVPL Avanado
GoBottom
O Descrio: Salta para ultima linha. O Sintaxe: GoBottom( ) O Parmetros:
Nenhum -
O Retorno:
Nil
RowCount
O Descrio: Retorna numero de linhas visiveis. O Sintaxe: RowCount( ) O Parmetros:
Nenhum -
O Retorno:
Nil
LEditCell
O Descrio: Edita o valor de uma coluna. O Sintaxe: lEditCell( aList, oList, cPicture, nCol ) O Parmetros:
aList Vetor da Browse onde esto os valores da mesma oList Objeto, Browse a ser editado cPicture Caracter, picture necessria para edio do campo nCol Numrico, coluna a ser editada.
O Retorno:
Nil
E Aparncia:
- 154 -
ADVPL Avanado
- 155 -
ADVPL Avanado
Exemplo:
#include 'protheus.ch' User Function Teste() Local oDlg Local oOK := LoadBitmap(GetResources(),'br_verde') Local oNO := LoadBitmap(GetResources(),'br_vermelho') DEFINE MSDIALOG oDlg FROM 0,0 TO 402,402 PIXEL TITLE 'Exemplo'
// 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.) TButton():New(190,060, 'lEditCell (Edita a celula)', oDlg,; {|| lEditCell(@aBrowse,oBrowse,'@!',3) },40,10,,,,.T.)
ACTIVATE MSDIALOG oDlg CENTERED 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:
- 156 -
ADVPL Avanado
4.1. Particularidades dos componentes visuais
4.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:
Com base nesta paleta, podemos definir os valores das seguintes cores bsicas:
Cor R G B Valor Preto 0 0 0 0 Azul 0 0 255 16711680 Verde 0 255 0 65280 Ciano 0 255 255 16776960 Vermelho 255 0 0 255 Rosa 255 0 255 16711935 Amarelo 255 255 0 65535 Branco 255 255 255 16777215
- 157 -
ADVPL Avanado
- 158 -
ADVPL Avanado
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 Cor de fundo do painel nClrText Cor da fonte das letras do painel
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
5. 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:
E Captura de informaes simples ou Multi-Gets; E Captura de mltiplas informaes ou Multi-Lines; E Barras de botes
5.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
- 159 -
ADVPL Avanado
- 160 -
ADVPL Avanado
A linguagem ADVPL permite a implementao da Enchoice de duas formas similares:
E Funo Enchoice: Sintaxe tradicionalmente utilizada em ADVPL, a qual no retorna um objeto para a aplicao chamadora;
E 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().
cAlias Tabela cadastrada no Dicionrio de Tabelas (SX2) que ser editada nReg Parmetro no utilizado nOpc Nmero da linha do aRotina que definir o tipo de edio (Incluso, Alterao, Excluso, Visualizao) aCRA Parmetro no utilizado cLetra Parmetro no utilizado cTexto Parmetro no utilizado aAcho 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" aPos Vetor com coordenadas para criao da enchoice no formato {<top>, <left>, <bottom>, <right>} aCpos Vetor com nome dos campos que podero ser editados nModelo Se for diferente de 1 desabilita execuo de gatilhos estrangeiros nColMens Parmetro no utilizado cMensagem Parmetro no utilizado cTudoOk Expresso para validao da Enchoice oWnd Objeto (janela, painel, etc.) onde a enchoice ser criada. lF3 Indica se a enchoice esta sendo criada em uma consulta F3 para utilizar variveis de memria lMemoria Indica se a enchoice utilizar variveis de memria ou os campos da tabela na edio lColumn Indica se a apresentao dos campos ser em forma de coluna caTela Nome da varivel tipo "private" que a enchoice utilizar no lugar da propriedade aTela lNoFolder Indica se a enchoice no ir utilizar as Pastas de Cadastro (SXA) lProperty Indica se a enchoice no utilizar as variveis aTela e aGets, somente suas propriedades com os mesmos nomes
- 161 -
ADVPL Avanado
Exemplo: Utilizao da funo Enchoice()
#include "protheus.ch"
/*/ +----------------------------------------------------------------------------- | Funo | MBRWENCH | Autor | ARNALDO RAYMUNDO JR.|Data | | +----------------------------------------------------------------------------- | Descrio | Programa que demonstra a utilizao da funo Enchoice() | +----------------------------------------------------------------------------- | Uso | Curso ADVPL | +----------------------------------------------------------------------------- /*/
Local cAliasE := cAlias Local aAlterEnch := {} Local aPos := {000,000,400,600} Local nModelo := 3 Local lF3 := .F. Local lMemoria := .T. Local lColumn := .F. Local caTela := "" Local lNoFolder := .F. Local lProperty := .F. Private oDlg Private oGetD Private oEnch Private aTELA[0][0] Private aGETS[0]
DbSelectArea("SX3") DbSetOrder(1) DbSeek(cAliasE)
- 162 -
ADVPL Avanado
Exemplo (continuao):
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.))
E Retorno: oMsMGet objeto do tipo MsMGet() E Parmetros:
cAlias Tabela cadastrada no Dicionrio de Tabelas (SX2) que ser editada nReg Parmetro no utilizado nOpc Nmero da linha do aRotina que definir o tipo de edio (Incluso, Alterao, Excluso, Visualizao) aCRA Parmetro no utilizado cLetra Parmetro no utilizado cTexto Parmetro no utilizado aAcho 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" aPos Vetor com coordenadas para criao da enchoice no formato {<top>, <left>, <bottom>, <right>} aCpos Vetor com nome dos campos que podero ser editados nModelo Se for diferente de 1 desabilita execuo de gatilhos estrangeiros nColMens Parmetro no utilizado cMensagem Parmetro no utilizado cTudoOk Expresso para validao da Enchoice oWnd Objeto (janela, painel, etc.) onde a enchoice ser criada. lF3 Indica se a enchoice esta sendo criada em uma consulta F3 para utilizar variveis de memria
- 163 -
ADVPL Avanado
lMemoria Indica se a enchoice utilizar variveis de memria ou os campos da tabela na edio lColumn Indica se a apresentao dos campos ser em forma de coluna caTela Nome da varivel tipo "private" que a enchoice utilizar no lugar da propriedade aTela lNoFolder Indica se a enchoice no ir utilizar as Pastas de Cadastro (SXA) lProperty Indica se a enchoice no utilizar as variveis aTela e aGets, somente suas propriedades com os mesmos nomes
Exemplo: Utilizao do objeto MsMGet()
#include "protheus.ch"
/*/ +----------------------------------------------------------------------------- | Funo | MBRWMSGET | Autor | ARNALDO RAYMUNDO JR. |Data | | +----------------------------------------------------------------------------- | Descrio | Programa que demonstra a utilizao do objeto MsMget() | +----------------------------------------------------------------------------- | Uso | Curso ADVPL | +----------------------------------------------------------------------------- /*/
User Function ModEnc(cAlias,nReg,nOpc) Local aCpoEnch := {} Local aAlter := {}
Local cAliasE := cAlias Local aAlterEnch := {} Local aPos := {000,000,400,600} Local nModelo := 3 Local lF3 := .F. Local lMemoria := .T. Local lColumn := .F. Local caTela := "" Local lNoFolder := .F. Local lProperty := .F. Private oDlg Private oGetD Private oEnch Private aTELA[0][0] Private aGETS[0]
- 164 -
ADVPL Avanado
Exemplo (continuao):
DbSelectArea("SX3") DbSetOrder(1) DbSeek(cAliasE)
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
nTop Distancia entre a MsGetDB e o extremidade superior do objeto que a contm. nLeft Distancia entre a MsGetDB e o extremidade esquerda do objeto que a contm. nBottom Distancia entre a MsGetDB e o extremidade inferior do objeto que a contm. nRight
Distancia entre a MsGetDB e o extremidade direita do objeto que a contm. nOpc Posio do elemento do vetor aRotina que a MsGetDB usar como referncia. cLinhaOk Funo executada para validar o contexto da linha atual do aCols. cTudoOk Funo executada para validar o contexto geral da MsGetDB (todo aCols). cIniCpos Nome dos campos do tipo caracter que utilizaro incremento automtico. Este parmetro deve ser no formato +<nome do primeiro campo>+<nome do segundo campo>+.... lDelete Habilita a opo de excluir linhas do aCols. Valor padro falso. aAlter Vetor com os campos que podero ser alterados. nFreeze Indica qual coluna no ficara congelada na exibio. lEmpty Habilita validao da primeira coluna do aCols para esta no poder estar vazia. Valor padro falso. uPar1 Parmetro reservado. cFieldOk Funo executada na validao do campo. cTRB Alias da tabela temporria. lCondicional Reservado lAppend Indica se a MsGetDB ira criar uma linha em branco automaticamente quando for incluso. cDelOk Funo executada para validar a excluso de uma linha do aCols. lDisparos Indica se ser utilizado o Dicionrio de Dados para consulta padro, inicializao padro e gatilhos. uPar2 Parmetro reservado. cSuperDel -Funo executada quando pressionada as teclas <Ctrl>+<Delete>. oWnd Objeto no qual a MsGetDB ser criada.
E Aparncia:
E 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: 1- Pesquisar 2- Visualizar 3- Incluir 4- Alterar 5- Excluir aHeader Vetor com informaes das colunas no formato:
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.
- 166 -
ADVPL Avanado
- 167 -
ADVPL Avanado
E Variveis pblicas:
nBrLin Indica qual a linha posicionada do aCols.
E Funes de validao:
cLinhaOk Funo de validao na mudana das linhas da grid. No pode ser definida como Static Function. cTudoOk Funo de validao da confirmao da operao com o grid. No pode ser definida como Static Function.
E Mtodos adicionais:
ForceRefresh() Atualiza a MsGetDB com a tabela e posiciona na primeira linha.
Exemplo: Utilizao do objeto MsGetDB()
#include protheus.ch
/*/ +----------------------------------------------------------------------------- | Funo | GETDBSA1 | Autor | MICROSIGA |Data | | +----------------------------------------------------------------------------- | Descrio | Programa que demonstra a utilizao do objeto MsGetDB() | +----------------------------------------------------------------------------- | Uso | Curso ADVPL | +----------------------------------------------------------------------------- /*/
User Function GetDbSA1()
Local nI Local oDlg Local oGetDB Local nUsado := 0 Local aStruct := {}
E Retorno: oMsGetDados objeto do tipo MsGetDados()
E Parmetros:
nTop Distancia entre a MsGetDados e o extremidade superior do objeto que a contm. nLeft Distancia entre a MsGetDados e o extremidade esquerda do objeto que a contm. nBottom Distancia entre a MsGetDados e o extremidade inferior do objeto que a contm. nRight
Distancia entre a MsGetDados e o extremidade direita do objeto que a contm. nOpc Posio do elemento do vetor aRotina que a MsGetDados usar como referencia. cLinhaOk Funo executada para validar o contexto da linha atual do aCols. cTudoOk Funo executada para validar o contexto geral da MsGetDados (todo aCols). cIniCpos Nome dos campos do tipo caracter que utilizaro incremento automtico. Este parmetro deve ser no formato +<nome do primeiro campo>+<nome do segundo campo>+.... lDelete Habilita excluir linhas do aCols. Valor padro falso. aAlter Vetor com os campos que podero ser alterados. uPar1 Parmetro reservado. lEmpty Habilita validao da primeira coluna do aCols para esta no poder estar vazia. Valor padro falso. nMax Nmero mximo de linhas permitidas. Valor padro 99. cFieldOk Funo executada na validao do campo. cSuperDel Funo executada quando pressionada as teclas <Ctrl>+<Delete>. uPar2 Parmetro reservado. cDelOk Funo executada para validar a excluso de uma linha do aCols. oWnd Objeto no qual a MsGetDados ser criada.
E Aparncia:
E 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: 6- Pesquisar 7- Visualizar 8- Incluir 9- Alterar 10- Excluir aHeader Vetor com informaes das colunas no formato:
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.
- 170 -
ADVPL Avanado
- 171 -
ADVPL Avanado
E Variveis pblicas:
N Indica qual a linha posicionada do aCols.
E Funes de validao:
cLinhaOk Funo de validao na mudana das linhas da grid. No pode ser definida como Static Function. cTudoOk Funo de validao da confirmao da operao com o grid. No pode ser definida como Static Function.
E Mtodos adicionais:
ForceRefresh() Atualiza a MsGetDados com a tabela e posiciona na primeira linha. Hide() Oculta a MsGetDados. Show() Mostra a MsGetDados.
Exemplo: Utilizao do objeto MsGetDados()
#include protheus.ch
/*/ +----------------------------------------------------------------------------- | 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 aHeader := {} Private aCols := {}
E Retorno: oMsGetDados objeto do tipo MsNewGetDados()
E Parmetros:
nSuperior Distancia entre a MsNewGetDados e o extremidade superior do objeto que a contem nEsquerda Distancia entre a MsNewGetDados e o extremidade esquerda do objeto que a contem nInferior Distancia entre a MsNewGetDados e o extremidade inferior do objeto que a contem nDireita Distancia entre a MsNewGetDados e o extremidade direita do objeto que a contem nOpc Operao em execuo: 2- Visualizar, 3- Incluir, 4- Alterar, 5- Excluir cLinOk Funo executada para validar o contexto da linha atual do aCols cTudoOk Funo executada para validar o contexto geral da MsNewGetDados (todo aCols) cIniCpos Nome dos campos do tipo caracter que utilizaro incremento automtico. aAlterGDa Campos alterveis da GetDados nFreeze Campos estticos na GetDados, partindo sempre da posio inicial da getdados aonde: 1- Primeiro campo congelado 2- Primeiro e segundo campos congelados... nMax Nmero mximo de linhas permitidas. Valor padro 99 cFieldOk Funo executada na validao do campo cSuperDel Funo executada quando pressionada as teclas <Ctrl>+<Delete> cDelOk Funo executada para validar a excluso de uma linha do aCols oDLG Objeto no qual a MsNewGetDados ser criada aHeader Array a ser tratado internamente na MsNewGetDados como aHeader aCols Array a ser tratado internamente na MsNewGetDados como aCols
E Aparncia:
E 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: 1- Pesquisar 2- Visualizar 3- Incluir 4- Alterar 5- Excluir aHeader Vetor com informaes das colunas no formato:
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.
- 174 -
ADVPL Avanado
- 175 -
ADVPL Avanado
E Variveis pblicas:
N Indica qual a linha posicionada do aCols.
E Funes de validao:
cLinhaOk Funo de validao na mudana das linhas da grid. No pode ser definida como Static Function. cTudoOk Funo de validao da confirmao da operao com o grid. No pode ser definida como Static Function.
E Mtodos adicionais:
ForceRefresh() Atualiza a MsNewGetDados com a tabela e posiciona na primeira linha. Hide() Oculta a MsNewGetDados. Show() Mostra a MsNewGetDados.
Exemplo: Utilizao dos objetos MsNewGetDados() e MsMGet()
#include "protheus.ch"
/*/ +----------------------------------------------------------------------------- | Funo | MBRWGETD | Autor | ARNALDO RAYMUNDO JR. |Data | | +----------------------------------------------------------------------------- | Descrio | Programa que demonstra a utilizao dos objetos | | | MsNewGetDados() e MsMGet() combinados | +----------------------------------------------------------------------------- | Uso | Curso ADVPL | +----------------------------------------------------------------------------- /*/
Local nX := 0 Local nUsado := 0 Local aButtons := {} Local aCpoEnch := {} Local cAliasE := cAlias Local aAlterEnch := {}
- 176 -
ADVPL Avanado
Exemplo (continuao):
Local aPos := {000,000,080,400} Local nModelo := 3 Local lF3 := .F. Local lMemoria := .T. Local lColumn := .F. Local caTela := "" Local lNoFolder := .F. Local lProperty := .F. Local aCpoGDa := {} Local cAliasGD := "SC6" Local nSuperior := 081 Local nEsquerda := 000 Local nInferior := 250 Local nDireita := 400 Local cLinOk := "AllwaysTrue" Local cTudoOk := "AllwaysTrue" Local cIniCpos := "C6_ITEM" Local nFreeze := 000 Local nMax := 999 Local cFieldOk := "AllwaysTrue" Local cSuperDel := "" Local cDelOk := "AllwaysFalse" Local aHeader := {} Local aCols := {} Local aAlterGDa := {}
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
- 177 -
ADVPL Avanado
Exemplo (continuao):
aAlterGDa := aClone(aCpoGDa)
nUsado:=0 dbSelectArea("SX3") dbSeek("SC6") aHeader:={} While !Eof().And.(x3_arquivo=="SC6") 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 nOpc==3 // Incluir aCols:={Array(nUsado+1)} aCols[1,nUsado+1]:=.F. For nX:=1 to nUsado IF aHeader[nX,2] == "C6_ITEM" aCols[1,nX]:= "0001" ELSE aCols[1,nX]:=CriaVar(aHeader[nX,2]) ENDIF 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
5.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.
E Atributos adicionais:
lUseDefaultColors Atributo que dever ser definido como .F. para que as alteraes nas cores sejam permitidas.
E Mtodos adicionais:
SetBlkBackColor 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.
E Aparncia:
- 178 -
ADVPL Avanado
- 179 -
ADVPL Avanado
Exemplo: Definindo cores personalizadas para o objeto MsNewGetDados()
#include "protheus.ch"
/*/ +----------------------------------------------------------------------------- | Funo | MRBWGTCL | Autor | ARNALDO RAYMUNDO JR. |Data | | +----------------------------------------------------------------------------- | Descrio | Programa que demonstra a utilizao dos objetos | | | MsNewGetDados() e MsMGet() combinados e tratamento de cores | +----------------------------------------------------------------------------- | Uso | Curso ADVPL | +----------------------------------------------------------------------------- /*/
Local aButtons := {} Local aCpoEnch := {} Local cAliasE := cAlias Local aAlterEnch := {} Local aPos := {000,000,080,400} Local nModelo := 3 Local lF3 := .F. Local lMemoria := .T. Local lColumn := .F. Local caTela := "" Local lNoFolder := .F. Local lProperty := .F. Local aCpoGDa := {} Local cAliasGD := "SC6" Local nSuperior := 081 Local nEsquerda := 000 Local nInferior := 250 Local nDireita := 400 Local cLinOk := "AllwaysTrue" Local cTudoOk := "AllwaysTrue" Local cIniCpos := "C6_ITEM" Local nFreeze := 000 Local nMax := 999
- 180 -
ADVPL Avanado
Exemplo (continuao):
Local cFieldOk := "AllwaysTrue" Local cSuperDel := "" Local cDelOk := "AllwaysFalse" Local aHeader := {} Local aCols := {} Local aAlterGDa := {}
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:={} While !Eof().And.(x3_arquivo=="SC6") 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
- 181 -
ADVPL Avanado
Exemplo (continuao):
If nOpc==3 // Incluir aCols:={Array(nUsado+1)} aCols[1,nUsado+1]:=.F. For nX:=1 to nUsado
IF aHeader[nX,2] == "C6_ITEM" aCols[1,nX]:= "0001" ELSE aCols[1,nX]:=CriaVar(aHeader[nX,2]) ENDIF
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
A linguagem ADVPL permite a implementao de barras de botes utilizando funes pr- definidas 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:
E Funo EnchoiceBar: Sintaxe tradicionalmente utilizada em ADVPL, a qual no retorna um objeto para a aplicao chamadora;
E 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.
E 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.
5.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.
oDlg Dialog onde ir criar a barra de botes bOk Bloco de cdigo a ser executado no boto Ok bCancel Bloco de cdigo a ser executado no boto Cancelar lMsgDel Exibe dialog para confirmar a excluso aButtons 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 nRecno Registro a ser posicionado aps a execuo do boto Ok. cAlias Alias do registro a ser posicionado aps a execuo do boto Ok. Se o parmetro nRecno for informado, o cAlias passa ser obrigatrio.
E Aparncia:
- 183 -
ADVPL Avanado
Exemplo: Utilizao da funo EnchoiceBar()
#include "protheus.ch"
/*/ +----------------------------------------------------------------------------- | Funo | DENCHBAR | Autor | ARNALDO RAYMUNDO JR. |Data | | +----------------------------------------------------------------------------- | 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
ACTIVATE MSDIALOG oDlg ; ON INIT (EnchoiceBar(oDlg,{||lOk:=.T.,oDlg:End()},{||oDlg:End()},,@aButtons))
Return
- 184 -
ADVPL Avanado
5.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.
E Sintaxe: New(oWnd, nBtnWidth, nBtnHeight, l3D, cMode, oCursor, cResource, lNoAutoAdjust)
E Retorno: oTBar objeto do tipo TBar()
E 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 Objeto, opcional. Define Cursor ao posicionar o mouse sobre a barra. cResource Caracter, opcional. Imagem do recurso a ser inserido como fundo da barra. lNoAutoAdjust Lgico.
E Aparncia:
Exemplo: Utilizao da funo EnchoiceBar()
#include 'protheus.ch'
/*/ +----------------------------------------------------------------------------- | Funo | TSTBAR | Autor | MICROSIGA |Data | | +----------------------------------------------------------------------------- | Descrio | Programa que demonstra a utilizao do objeto TBar() | +----------------------------------------------------------------------------- | Uso | Curso ADVPL | +----------------------------------------------------------------------------- /*/
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.
E Sintaxe:
DEFINE BUTTONBAR oBar SIZE nWidth, nHeight 3D MODE OF oDlg CURSOR
E Retorno: ().
E Parmetros:
oBar Objeto do tipo TBar() que ser criado com a utilizao da sintaxe ButtonBar(). nWidth Numrico, opcional. Largura do boto contido na barra. nHeight Numrico, opcional. Altura do boto contido na barra. 3D Se definido habilita a visualizao em 3D da barra de botes. oDlg Objeto, opcional. Janela ou controle onde o boto dever ser criado. MODE 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:
E Botes: BUTTON RESOURCE
E Sintaxe adicional:
DEFINE BUTTON RESOURCE cBitMap OF oBar ACTION cAcao TOOLTIP cTexto
E 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. cTexto Texto no estilo tooltip text que ser exibido quando o cursor do mouse for posicionado sobre o boto na barra de ferramentas.
E Aparncia:
Exemplo: Utilizao da sintaxe ButtonBar
#include 'protheus.ch'
/*/ +----------------------------------------------------------------------- | Funo | TstBBar | Autor | MICROSIGA |Data | | +----------------------------------------------------------------------- | Descrio | Programa que demonstra a utilizao do objeto TBar() | +----------------------------------------------------------------------- | Uso | Curso ADVPL | +----------------------------------------------------------------------- /*/
5.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:
E Sintaxe: AADD(aButtons,{cBitMap, bAcao, cTexto})
E Estrutura:
cBitMap Nome da imagem pr-definida existente na aplicao ERP que ser vinculada ao boto. bAcao Bloco de cdigo que define a ao que ser executada com a utilizao do boto. cTexto Texto no estilo tooltip text que ser exibido quando o cursor do mouse for posicionado sobre o boto na barra de ferramentas.
nLin1 Linha inicial do browse nCol1 Coluna inicial do browse nLin2 Linha final do browse nCol2 Coluna final do browse cTitle Ttulo do browse (obrigatrio) cAlias Alias da tabela corrente podendo ser um temporrio aCampos Se lDic=.T. utilizar o SX3, do contrrio o aCampos informado aRotina Idntico ao aRotina para mBrowse cFunLeg Funo que dever retornar um valor lgico e com isso ser atribudo semafro na primeira coluna do browse cTopFun Mostrar os registros com a chave de cBotFun Mostrar os registros com a chave ate lCentered Valor verdadeiro centraliza aResource aAdd(aResource,{"IMAGEM","Texto significativo"}) nModelo Posio do Menu: 1- Horizontal (superior) 2- Vertical (esquerda) 3- Horizontal (inferior) aPesqui aAdd(aPesqui{"Ttulo",nOrdem}), se no passado ser utilizado o AxPesqui cSeek Chave principal para a busca, exemplo: xFilial("???") lDic Parmetro em conjunto com aCampos lSavOrd Estabelecer a ordem aps pesquisas.
/*/ +----------------------------------------------------------------------- | 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 utilizado o AxPesqui 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.
- 191 -
ADVPL Avanado
- 192 -
ADVPL Avanado
// 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
// 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
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.
E Descrio: Funo para manipulao de registros de um arquivo temporrio simular a Enchoice do ambiente Protheus.
E Sintaxe: TEnchoice(oDlg, aCampos, nLeftE, nTopE, nHeightE, nWidthE, lEnchBar)
E Parmetros:
oDlg Objeto Dialog no qual a TEnchoice ser vinculada aCampos Estrutura de campos para exibio da tela da TEnchoice nLeftE Coordenada horizontal em pixels. nTopE Coordenada vertical em pixels. nHeightE Altura em pixels nWidthE Largura em pixels. lEnchBar Se a enchoice ser montada em conjunto com uma barra de botes do tipo Enchoicebar()
E Pr-requisitos da funo chamadora:
Para correta utilizao da funo TEnchoice so necessrios os seguintes tratamentos / definies na funo chamadora:
E Tratamento 01: Montagem do array aCampos
O array aCampos utilizado pela TEnchoice possui basicamente o mesmo formato do array utilizado pela funo Modelo2().
"<Variavel>" Nome da varivel Private que est vinculada ao campo digitvel. {nLinha,nColuna} Posio em pixels do campo na Enchoice. "<Titulo>" Ttulo do campo. "<Picture>" Picture de formatao do campo. "<Validacao>" Validao do campo digitvel. "<F3>" Consulta F3 vinculada ao campo. "<lWhen>" Se o campo est editvel. <Tamanho> Tamanho do campo para visualizao.
E 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.
E Aparncia:
E Detalhamento da funo TEnchoice:
- 194 -
ADVPL Avanado
- 195 -
ADVPL Avanado
/*/ +----------------------------------------------------------------------- | Funo | TEnchoice | Autor | Arnaldo R. Junior | Data | | +----------------------------------------------------------------------- | Descrio | Enchoice para arquivos temporarios | +----------------------------------------------------------------------- | Uso | Curso ADVPL | +----------------------------------------------------------------------- /*/
Static Function TEnchoice(oDlg, aCampos, nLeftE, nTopE, nHeightE, nWidthE,; lEnchBar)
Local aSays := {} Local aGets := {} Local cCaption := "" Local cPict := "" Local cValid := "" Local cF3 := "" Local cWhen := "" Local cBlKSay := "" Local cBlkGet := "" Local cBlKVld := "" Local cBlKWhen := "" Local nLeft := 0 Local nTop := 0 Local nI := 0
Exemplo: Funo TVisual ( MaWndBrowse com TEnchoice)
/*/ +----------------------------------------------------------------------- | Funo | TVisual | Autor | Arnaldo R. Junior | Data | | +----------------------------------------------------------------------- | Descrio | Enchoice para arquivos temporarios | +----------------------------------------------------------------------- | Uso | Curso ADVPL | +----------------------------------------------------------------------- /*/
USER FUNCTION TVisual(cAlias,nReg,nOpc)
LOCAL aCposEnch := {} LOCAL nLinha := 15 LOCAL nColuna := 10 LOCAL nOpcE := aRotina[nOpc][4] // Opcao de verdade LOCAL bOk := {||oDlg:End()} LOCAL bCancel := {||oDlg:End()} LOCAL nX
Exemplo: Funo TInclui ( MaWndBrowse com TEnchoice)
/*/ +----------------------------------------------------------------------- | Funo | TInclui | Autor | Arnaldo R. Junior | Data | | +----------------------------------------------------------------------- | Descrio | Enchoice para arquivos temporarios | +----------------------------------------------------------------------- | Uso | Curso ADVPL | +----------------------------------------------------------------------- /*/
USER FUNCTION TInclui(cAlias,nReg,nOpc)
LOCAL aCposEnch := {} LOCAL nLinha := 15 LOCAL nColuna := 10 LOCAL nOpcE := aRotina[nOpc][4] // Opcao de verdade LOCAL bOk LOCAL bCancel := {||oDlg:End()} LOCAL aArea := GetArea() LOCAL nX
Do Case Case aCampos[nX][5] == "C" &("_"+aCampos[nX][1]) := Space(aCampos[nX][4]) Case aCampos[nX][5] == "N" &("_"+aCampos[nX][1]) := 0 Case aCampos[nX][5] == "D" &("_"+aCampos[nX][1]) := CTOD("") Case aCampos[nX][5] == "L" &("_"+aCampos[nX][1]) := .F. Case aCampos[nX][5] == "M" &("_"+aCampos[nX][1]) := Space(aCampos[nX][4]) EndCase
Exemplo: Funo TAltera ( MaWndBrowse com TEnchoice)
/*/ +----------------------------------------------------------------------- | Funo | TAltera | Autor | Arnaldo R. Junior | Data | | +----------------------------------------------------------------------- | Descrio | Enchoice para arquivos temporarios | +----------------------------------------------------------------------- | Uso | Curso ADVPL | +----------------------------------------------------------------------- /*/
USER FUNCTION TAltera(cAlias,nReg,nOpc)
LOCAL aCposEnch := {} LOCAL nLinha := 15 LOCAL nColuna := 10 LOCAL nOpcE := aRotina[nOpc][4] // Opcao de verdade LOCAL bOk LOCAL bCancel := {||oDlg:End()} LOCAL aArea := GetArea() LOCAL nX
Exemplo: Funo TExclui ( MaWndBrowse com TEnchoice)
/*/ +----------------------------------------------------------------------- | Funo | TExclui | Autor | Arnaldo R. Junior | Data | | +----------------------------------------------------------------------- | Descrio | Enchoice para arquivos temporarios | +----------------------------------------------------------------------- | Uso | Curso ADVPL | +----------------------------------------------------------------------- /*/
USER FUNCTION TExclui(cAlias, nReg, nOpc)
LOCAL aCposEnch := {} LOCAL nLinha := 15 LOCAL nColuna := 10 LOCAL nOpcE := aRotina[nOpc][4] // Opcao de verdade LOCAL bOk LOCAL bCancel := {||oDlg:End()} LOCAL nX
/*/ +----------------------------------------------------------------------- | Funo | TValid | Autor | Arnaldo R. Junior | Data | | +----------------------------------------------------------------------- | Descrio | Enchoice para arquivos temporarios | +----------------------------------------------------------------------- | Uso | Curso ADVPL | +----------------------------------------------------------------------- /*/
USER FUNCTION TValid(cAlias,nReg,nOpc,aCampos) LOCAL lRet LOCAL nX LOCAL nPosObrig := Len(aCampos[1])
For nX := 1 to Len(aCampos) 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 | Autor | Arnaldo R. Junior | Data | | +----------------------------------------------------------------------- | Descrio | Enchoice para arquivos temporarios | +----------------------------------------------------------------------- | Uso | Curso ADVPL | +----------------------------------------------------------------------- /*/
USER FUNCTION TGravar(cAlias,nReg,nOpc,aCampos) LOCAL nX
RecLock(cAlias,nOpc==3) IF nOpc == 5 DbDelete() ELSE For nX := 1 to Len(aCampos) (cAlias)->&(aCampos[nX][1]) := &("_"+aCampos[nX][1]) Next nX ENDIF Msunlock()
RETURN
- 202 -
ADVPL Avanado
6.2. DbTree()
E Descrio: Classe Advpl que permite a criao de um objeto visual do tipo Tree.
E Propriedades:
bChange Armazena o code-block executado quando da mudana de foco entre elementos do Tree atual.
E Mtodos principais:
New Contrutor da Classe DbTree. Retorna uma nova instncia do Objeto da Classe DbTree. AddTree Atravs do mtodo AddTree, possvel acrescentar um 'n' na rvore atual. 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().
nTop Coordenada vertical superior do Objeto. nLeft Coordenada horizontal esquerda do Objeto. nBottom Coordenada vertical inferior do Objeto. nRight Coordenada horizontal direita do Objeto. oWnd Janela pai do Objeto Tree bchange Code-Block contendo a ao a ser edxecutada na mudana de foco enrte os elementos da rvore. bRClick Code-Block a ser executado quando pressionado o boto direito do Mouse sobre um elemento da rvoew. lCargo 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. lDisable Se .T., cria o objeto do Tree desabilitado, no permitindo foco e navegao no mesmo qneuando ele no seja habilitado.
E Retorno:
Objeto Retorna uma nova instncia do Objeto da Classe DbTree.
cLabel Ttulo do "n" da rvore a ser acrescentado. lPar02 (reservado) cResOpen Resource do RPO a ser utilizado quando o n estiver aberto. cResClose Resource do RPO (bitmap) a ser utilizado quando o n estiver fechado. cBMPOpen 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. cBMPClose 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
- 205 -
ADVPL Avanado
parmetros cResOpen e cResClose no forem especificados. cCargo String com valor nico, fornecido para identificar o n atual. Pode ser recuperado posteriormente durante a navegao.
cLabel Ttulo do item da rvore. cResource Resource (BMP) do repositrio, a ser mostrado esquerda do ttulo do item. cBitMap 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. cCargo atravs dele, podemos especificar uma string de identificao para este item na rvore.
E Retorno:
Nenhum -
Mtodo: EndTree()
E Sintaxe: oObj:EndTree ( )
E Parmetros:
Nenhum
E Retorno:
Nenhum
- 206 -
ADVPL Avanado
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
DEFINE MSDIALOG oDlg TITLE cCadastro FROM 0,0 TO 240,500 PIXEL
cAlias Tabela que ser utilizada pela MsSelect cCampo Campo que ser utilizado na coluna de marcao cCpo 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 aCampos 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) lInv Indica se MsSelect ir utilizar marcao invertida cMar 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. aCord Coordenadas para criao da MsSelect. Formato: 1 - Linha inicial 2 - Coluna inicial 3 - Linha final 4 - Coluna final cTopFun 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. cBotFun 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 oWnd Objeto pai da MsSelect (MSDIALOG, MSWINDOW, MSPANEL, etc.) reserved Parametro reservado aColors 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:
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()})
7. Introduo relatrios grficos
7.1. TReport()
7.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.
- 211 -
ADVPL Avanado
- 212 -
ADVPL Avanado
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. #include "protheus.ch"
User Function MyReport() Local oReport
If TRepInUse() //verifica se a opo relatrios personalizveis est disponvel Pergunte("MTR025",.F.)
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.
7.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:
7.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 ser impresso ou enviado por e-mail aps ser "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 apresentado na tela.
- 213 -
ADVPL Avanado
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: E MV_RELACNT Define a conta de e-mail para identificar a provenincia dos relatrios. Exemplo: relprotheus@microsiga.com.br E MV_RELPSW Define a senha da conta de e-mail para envio dos relatrios. E MV_RELSERV Define o servidor da conta de e-mail para o envio do relatrio. Exemplo: smtp.microsiga.com.br
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.
- 214 -
ADVPL Avanado
- 215 -
ADVPL Avanado
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.
E 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.
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.
7.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.
7.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.
- 216 -
ADVPL Avanado
Nova estrutura do relatrio TReport:
O relatrio mais simples que se consegue emitir em TReport, uma listagem.
7.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
- 217 -
ADVPL Avanado
- 218 -
ADVPL Avanado
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 ().
- 219 -
ADVPL Avanado
MDULO 08: Aplicaes ADVPL para o ERP
8. 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:
E Microsoft SQL7 ou superior E Oracle 8 ou superior E IBM Universal Database (DB2) E Informix E Sybase Adaptive Server E Postgres 7.1.1 ou superior E MySQL
O TOTVSDBAccess permite gerenciar as informaes pertinentes utilizao do banco de dados, registrando e apresentado dados, como:
E Dados estatsticos de forma grfica com relao : E Quantidade de usurios conectados E Quantidade de tabelas em utilizao E IOs por segundo E Mximo de IOs por segundo E Relao dos usurios conectados E Checagem das querys geradas pelos usurios conectados E Quebra de conexo do usurio E Mensagens de utilizao do TOTVSDBAccess E 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
- 220 -
ADVPL Avanado
8.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
E Retorno: Todos os bancos retornaram uma coluna com tamanho de 10 bytes.
E Retorno: Todos os bancos que suportam a funo LEFT() retornaram uma coluna de informaes, onde os 5 primeiros bytes eram '00000'.
E 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.
E Bancos:
Database Tipo Tamanho Contedo MSSQL 2000 Caracter 5 00000 MYSQL Caracter 5 00000 DB2 Caracter 4000 00000
Query: SELECT SUBSTRING(CPOC,2,4) CPOTESTE FROM TESTRET
E Retorno: Todos os bancos retornaram uma coluna de tamanho 4 bytes, exceto o POSTGRES, que retornou tamanho de 2000 bytes.
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.
- 223 -
ADVPL Avanado
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*.
- 224 -
ADVPL Avanado
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.
- 225 -
ADVPL Avanado
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.
Verifica a existncia de tabelas e ndices no servidor.
E Sintaxe: TCCanOpen(cTable , cIndice)
E Parmetros:
cTable Nome completo da tabela no banco de dados. cIndice Opcional, indica o nome completo do ndice referente a tabela especificada.
E Retorno:
Lgico Indica a existncia da tabela e/ou do ndice especificado.
E 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.
E Sintaxe: TCConType(cType)
E 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.
//Conecta-se ao ambiente SIGAADV no Microsoft SQL-Server TCLink("MSSQL/SIGAADV")
TCDELFILE()
Exclui uma tabela no servidor.
E Sintaxe: TCDelFile(cTable)
E Parmetros:
cTable Nome completo da tabela a ser excluda.
E Retorno:
Nenhum .
E Exemplo:
TCDelFile("CUSTOMER")
- 228 -
ADVPL Avanado
TCGENQRY()
Permite a execuo de uma query de seleo no banco de dados e retorna um recordset com o resultado.
E Sintaxe: TCGENQRY(xParam1,xParam2,cQuery)
E Parmetros:
xParam1 Parmetro reservado. xParam2 Parmetro reservado. cQuery Query de seleo com sintaxe no padro SQL ANSI a ser executada no banco de dados.
E 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.
E 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.
E Sintaxe: TCGETDB()
E Parmetros:
Nenhum .
- 229 -
ADVPL Avanado
- 230 -
ADVPL Avanado
E 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.
E Exemplo:
cDataBase := TCGETDB() // MSSQL7
TCLINK()
Abre uma conexo com o Servidor TOPConnect.
E Sintaxe: TCLink(cConectString,cServer)
E 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
E 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 - 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
E 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.
E 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")
- 231 -
ADVPL Avanado
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().
E Sintaxe: TCQUERY cSQLExpr ALIAS cAlias NEW VIA "TOPCONN"
E 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. VIA "TOPCONN" Este parmetro indica ao ADVPL que esta Work Area ser gerenciada pelo TOPconnect.
E 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 GO TOP - DbGoTop() o GO BOTTOM - DbGoBottom() o SKIP - DbSkip() o Eof() o Bof()
Ao executar uma Query que retorne um ou mais valores calculados, o nome dos campos da WorkArea sero COLUMN1, COLUMN2... COLUMNn.
E Retorno:
Nenhum .
- 232 -
ADVPL Avanado
- 233 -
ADVPL Avanado
E 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.
E Sintaxe: TCQuit()
E Parmetros:
Nenhum .
E Retorno:
Nenhum .
TCSETCONN()
Seleciona a conexo ativa.
E Sintaxe: TCSETCONN(nConn)
E Parmetros:
nConn Nmero da conexo
E Retorno:
Nenhum .
- 234 -
ADVPL Avanado
E 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.
E Sintaxe: TCSetField(cAlias, cField ,cType, nTam, nDec )
E 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
E Retorno:
Nenhum .
E Exemplo 01:
TCQUERY "SELECT NOME, DATA, MARRIED, VALOR FROM CUSTOMER" ALIAS QUERY VIA "TOPCONN"
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.
E Exemplo 02:
Local cQuery := "" Local cCampos := "" Local aStruSA1 := SA1->(DbStruct()) Local nX := 0 Local nMax := Len(aStruSA1)
// Monta a String cCampos de acordo com o contedo de aStruSA1
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.
E Sintaxe: TCSPExec(cSPName,xParam1,xParam2...xParamN)
E 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.
- 236 -
ADVPL Avanado
E 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.
E 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
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().
- 237 -
ADVPL Avanado
TCSPEXIST()
Verifica a existncia de uma determinada Stored Procedure no servidor.
E Sintaxe: TCSPExist(cSPName)
E Parmetros:
CSPName Nome da procedure a ser verificada no banco de dados.
E Retorno:
Lgico Indica se a Stored Procedure existe ou no e <cSPName> o nome da Stored Procedure procurada.
E 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.
E Sintaxe: TCSQLError()
E Parmetros:
Nenhum .
E Retorno:
String Mensagem de erro registrada no TopConnect para a ocorrncia.
E Exemplo:
If TCSQLExec("UPDATE CUSTOMER SET VALUE=0") < 0 then ALERT(TCSQLError()) Endif
- 238 -
ADVPL Avanado
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.
E Sintaxe: TCSQLExec(cCommand)
E Parmetros:
cCommand Comando SQL a ser executado.
E Retorno:
Numrico Retorna um valor negativo em caso de erros.
E Exemplo:
nRet := TCSQLExec("UPDATE CUSTOMER SET VALUE=0)
TCSRVTYPE()
Retorna o tipo do servidor no qual TOPConnect / TOTVS DbAccess est em execuo.
E Sintaxe: TCSrvType()
E Parmetros:
Nenhum .
E Retorno:
String Tipo do servidor, como por exemplo: "WinNT" ou "AS/400".
E Exemplo:
TCLink("MSSQL/TESTE","TOPSRV") ALERT(TCSrvtype())
- 239 -
ADVPL Avanado
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.
E Sintaxe: TCUnlink(nConn)
E Parmetros:
nConn Nmero da conexo previamente retornado pela funo TCLink()
Verifica a existncia de um objeto no servidor AS/400
E Sintaxe: TCChkObj(cObj,cLibrary,cType)
E 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.
E Retorno:
Numrico 0 quando o objeto existe ou o nmero do erro no AS/400.
E 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().
E Sintaxe: TCExeError()
E Parmetros:
Nenhum .
E Retorno:
String Mensagem de erro.
E Exemplo:
If TCPGMEXE("CALCCUST") != 0 ALERT(TCExeError()) Endif
- 241 -
ADVPL Avanado
Funo para uso apenas com o TOPConnect em servidores AS/400.
TCPGMEXE()
Executa um programa no servidor AS/400.
E Sintaxe: TCPGMEXE(cProgram)
E Parmetros:
cProgram Nome do programa a ser executado.
E Retorno:
Numrico 0 quando o objeto existe ou o nmero do erro no AS/400.
E Exemplo:
If TCPGMEXE("CALCCUST") != 0 ALERT(TCExeError()) Endif
Funo para uso apenas com o TOPConnect em servidores AS/400.
TCSYSEXE()
Permite a execuo de um comando utilizando a sintaxe e recursos nativos do DB2/400, diretamente no servidor do banco de dados.
E Sintaxe: TCSysExe(cCommand)
E Parmetros:
cCommand Comando a ser executado no servidor de banco de dados utilizando sintaxe DB2/400.
E Retorno:
Numrico 0 quando o objeto existe ou o nmero do erro no AS/400.
If TCSysExe( cCommand )!= 0 ALERT(TCExeError()) Endif
Funo para uso apenas com o TOPConnect em servidores AS/400.
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.
E Sintaxe: ChangeQuery(cQuery)
E Parmetros:
cQuery String contendo a query escrita em sintaxe SQL ANSI.
E Retorno:
String Query adequada em funo do banco em uso pela conexo ativa com a aplicao TopConnect.
E 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.)
- 243 -
ADVPL Avanado
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.
E Sintaxe: RetFullName(cAlias, cEmp)
E Parmetros:
cAlias Nome da rea de trabalho da aplicao para identificao da tabela no banco de dados. cEmp Cdigo da empresa a ser avaliada.
E Retorno:
String Nome completo / real da tabela no banco de dados.
Retorna uma string com as condies padres de uso em uma query.
E Sintaxe: RetSqlCond(cAlias)
E Parmetros:
cAlias Nome do alias para composio a string de condies.
E Retorno:
String Condies de seleo padres para o alias indicado. As condies padres so: ALIAS_FILIAL = xFilial(ALIAS) .AND. ALIAS.D_E_L_E_T_ = .
E Exemplo:
cQuery := "SELECT DISTINCT CV8_PROC FROM "+RETSQLNAME("CV8") cQuery += " WHERE " cQuery += RetSqlCond("CV8") cQuery += "ORDER BY CV8_PROC" cQuery := ChangeQuery(cQuery) dbUseArea(.T., "TOPCONN", TCGenQry(,,cQuery), "CV8QRY", .F., .T.)
RETSQLNAME()
Retorna o nome padro da tabela para seleo no banco de dados atravs da query.
E Sintaxe: RetSqlName(cAlias)
E Parmetros:
cAlias Alias para ser avaliado o nome padro da tabela.
E Retorno:
String Nome completo da tabela para seleo atravs da query.
E Exemplo:
cQuery := "SELECT DISTINCT CV8_PROC FROM "+RETSQLNAME("CV8") cQuery += " WHERE " cQuery += RetSqlCond("CV8") cQuery += "ORDER BY CV8_PROC" cQuery := ChangeQuery(cQuery) dbUseArea(.T., "TOPCONN", TCGenQry(,,cQuery), "CV8QRY", .F., .T.)
- 246 -
ADVPL Avanado
RETSQLTABLE()
Retorna o nome real da tabela para seleo no banco de dados atravs da query.
E Sintaxe: RetSqlTable(cAlias)
E Parmetros:
cAlias Alias para ser avaliado o nome real da tabela.
E Retorno:
String Nome real da tabela no banco de dados.
E Exemplo:
cQuery := "SELECT DISTINCT CV8_PROC FROM "+RETSQLTABLE("CV8") cQuery += " WHERE " cQuery += RetSqlCond("CV8") cQuery += "ORDER BY CV8_PROC" cQuery := ChangeQuery(cQuery) dbUseArea(.T., "TOPCONN", TCGenQry(,,cQuery), "CV8QRY", .F., .T.)
SQLCOPY()
Cria um arquivo no formato especificado pela configurao LOCALFILES do ambiente com o retorno da query.
E Sintaxe: SqlCopy(cFile, cWhere, aStru, cAlias, aDates, lRecno)
E 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. lRecno Se copia o contedo da coluna R_E_C_N_O_ para o arquivo gerado.
E Retorno:
Nenhum .
SQLORDER()
Converte a sintaxe de um indce em formato ISAM (CODEBASE) para o formato SQL ANSI
Preenche um arquivo temporrio com o contedo do retorno da query.
E Sintaxe: SqlToTrb(cQuery, aStru, cAlias)
E 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. cAlias Alias do arquivo temporrio a ser preenchido com os dados de retorno da query.
Para correta utilizao da funo SQLTOTRB() o arquivo temporrio deve estar criado e com a rea de trabalho (ALIAS) definido.
E Retorno:
Nenhum .
E Exemplo:
// Arquivo de trabalho que ser utilizado pela MaWndBrowse
8.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:
E Rotinas de processamento utilizando queries para seleo dos registros; E Relatrios para seleo dos registros; E 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.
E MaWndBrowse com Alias Temporrio gerado por Query
E Banco de dados de interface
8.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 exibi- las em tela.
Algumas aplicaes interessantes para este recurso seriam:
E 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).
E 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.
E 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.
#include "protheus.ch"
/*/ +----------------------------------------------------------------------- | Funo | WndSQLTRB | Autor | Arnaldo R. Junior | Data | | +----------------------------------------------------------------------- | 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 utilizado o AxPesqui 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
- 250 -
ADVPL Avanado
- 251 -
ADVPL Avanado
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 campos de arquivo temporrio aAdd(aRotina,{"Alterar" ,"U_TcAltera",0,4}) // Desenvolver Enchoice para campos de arquivo temporrio
aAdd(aRotina,{"Excluir" ,"U_TcExclui",0,5}) // Desenvolver Enchoice para campos de arquivo temporrio
// 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 File(cArqInd+OrdBagExt()) FErase(cArqInd+OrdBagExt()) ENDIF
DbSelectArea("SA1") DbSetOrder(1)
Return
/*/ +----------------------------------------------------------------------- | Funo | TcVisual | Autor | Arnaldo R. Junior | Data | | +----------------------------------------------------------------------- | Descrio | Enchoice para arquivos temporarios | +----------------------------------------------------------------------- | Uso | Curso ADVPL | +----------------------------------------------------------------------- /*/
USER FUNCTION TcVisual(cAlias,nReg,nOpc)
LOCAL aCposEnch := {} LOCAL nLinha := 15 LOCAL nColuna := 10 LOCAL nOpcE := aRotina[nOpc][4] // Opcao de verdade LOCAL bOk := {||oDlg:End()} LOCAL bCancel := {||oDlg:End()} LOCAL nX
/*/ +----------------------------------------------------------------------- | Funo | TcInclui | Autor | Arnaldo R. Junior | Data | | +----------------------------------------------------------------------- | Descrio | Enchoice para arquivos temporarios | +----------------------------------------------------------------------- | Uso | Curso ADVPL | +----------------------------------------------------------------------- /*/
USER FUNCTION TcInclui(cAlias,nReg,nOpc)
LOCAL aCposEnch := {} LOCAL nLinha := 15 LOCAL nColuna := 10 LOCAL nOpcE := aRotina[nOpc][4] // Opcao de verdade LOCAL bOk LOCAL bCancel := {||oDlg:End()} LOCAL aArea := GetArea() LOCAL nX
Do Case Case aCampos[nX][5] == "C" &("_"+aCampos[nX][1]) := Space(aCampos[nX][4]) Case aCampos[nX][5] == "N" &("_"+aCampos[nX][1]) := 0 Case aCampos[nX][5] == "D" &("_"+aCampos[nX][1]) := CTOD("") Case aCampos[nX][5] == "L" &("_"+aCampos[nX][1]) := .F. Case aCampos[nX][5] == "M" &("_"+aCampos[nX][1]) := Space(aCampos[nX][4]) EndCase
/*/ +----------------------------------------------------------------------- | Funo | TcAltera | Autor | Arnaldo R. Junior | Data | | +----------------------------------------------------------------------- | Descrio | Enchoice para arquivos temporarios | +----------------------------------------------------------------------- | Uso | Curso ADVPL | +----------------------------------------------------------------------- /*/
USER FUNCTION TcAltera(cAlias,nReg,nOpc)
LOCAL aCposEnch := {} LOCAL nLinha := 15 LOCAL nColuna := 10 LOCAL nOpcE := aRotina[nOpc][4] // Opcao de verdade LOCAL bOk LOCAL bCancel := {||oDlg:End()} LOCAL aArea := GetArea() LOCAL nX
/*/ +----------------------------------------------------------------------- | Funo | TcExclui | Autor | Arnaldo R. Junior | Data | | +----------------------------------------------------------------------- | Descrio | Enchoice para arquivos temporarios | +----------------------------------------------------------------------- | Uso | Curso ADVPL | +----------------------------------------------------------------------- /*/
USER FUNCTION TcExclui(cAlias, nReg, nOpc)
LOCAL aCposEnch := {} LOCAL nLinha := 15 LOCAL nColuna := 10 LOCAL nOpcE := aRotina[nOpc][4] // Opcao de verdade LOCAL bOk LOCAL bCancel := {||oDlg:End()} LOCAL nX
/*/ +----------------------------------------------------------------------- | Funo | TcValid | Autor | Arnaldo R. Junior | Data | | +----------------------------------------------------------------------- | Descrio | Enchoice para arquivos temporarios | +----------------------------------------------------------------------- | Uso | Curso ADVPL | +----------------------------------------------------------------------- /*/
USER FUNCTION TcValid(cAlias,nReg,nOpc,aCampos) LOCAL lRet LOCAL nX LOCAL nPosObrig := Len(aCampos[1])
For nX := 1 to Len(aCampos) 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
- 257 -
ADVPL Avanado
Continuao:
/*/ +----------------------------------------------------------------------- | Funo | TcGravar | Autor | Arnaldo R. Junior | Data | | +----------------------------------------------------------------------- | Descrio | Enchoice para arquivos temporarios | +----------------------------------------------------------------------- | Uso | Curso ADVPL | +----------------------------------------------------------------------- /*/
USER FUNCTION TcGravar(cAlias,nReg,nOpc,aCampos) LOCAL nX
RecLock(cAlias,nOpc==3) IF nOpc == 5 DbDelete() ELSE For nX := 1 to Len(aCampos) (cAlias)->&(aCampos[nX][1]) := &("_"+aCampos[nX][1]) Next nX ENDIF Msunlock()
RETURN
- 258 -
ADVPL Avanado
- 259 -
ADVPL Avanado
Continuao:
/*/ +----------------------------------------------------------------------- | Funo | TEnchoice | Autor | Arnaldo R. Junior | Data | | +----------------------------------------------------------------------- | Descrio | Enchoice para arquivos temporarios | +----------------------------------------------------------------------- | Uso | Curso ADVPL | +----------------------------------------------------------------------- /*/
Static Function TEnchoice(oDlg, aCampos, nLeftE, nTopE, nHeightE, nWidthE,; lEnchBar)
Local aSays := {} Local aGets := {} Local cCaption := "" Local cPict := "" Local cValid := "" Local cF3 := "" Local cWhen := "" Local cBlKSay := "" Local cBlkGet := "" Local cBlKVld := "" Local cBlKWhen := "" Local nLeft := 0 Local nTop := 0 Local nI := 0
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:
E Maior controle da integrao das informaes entre os sistemas, permitindo um tratamento adequado de eventos de erros;
E Transparncia e rastreabilidade das informaes integradas, implementando confiabilidade no processo;
E 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.
E 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()
E 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;
E 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;
E 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.
E 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.
- 261 -
ADVPL Avanado
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 Detalhamento 01 Exportao Protheus -> DbInterface 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. 02 Importao DbInterface -> ERP X Ferramentas proprietrias do ERP X para leitura do DBInterface e tratamento das informaes para atualizao do banco de dados desta aplicao. 03 Extrao ERP X -> DbInterface 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. 04 Importao DbInterface -> 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. 05 Efetivao Protheus -> 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().
- 262 -
ADVPL Avanado
Consideraes complementares sobre o conceito de Banco de Dados de Interface
E 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;
E 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();
E recomendvel que as funcionalidades de Exportao, Extrao, Importao e Efetivao sejam tratadas tanto com interfaces de execuo direta quanto atravs de execuo via Job.
- 263 -
ADVPL Avanado
- 264 -
ADVPL Avanado
8.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'.
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
- 265 -
ADVPL Avanado
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>, <nI ndice>% 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()
BeginSql alias 'E2TEMP' column E2_EMISSAO as Date, E2_VALOR as Numeric(tam_cp,2) . . . EndSql
- 266 -
ADVPL Avanado
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
E '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.
E '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].
E 'Type Mismach on +'
Esta ocorrncia, se reproduzida, informar na pilha de chamadas o nmero da linha do cdigo- fonte 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.
E 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.
- 267 -
ADVPL Avanado
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] cAlias - Alias usado para abrir o Cursor. [2] cQuery - Query executada. [3] aCampos - Array de campos com critrio de converso especificados. [4] lNoParser - Caso .T., no foi utilizada ChangeQuery() na String original. [5] nTimeSpend - Tempo, em segundos, utilizado para a abertura do Cursor.
E Exemplo mais completo: Cdigo ADVPL
BeginSql alias 'E2TEMP' 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
E 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= '' +xFilial('SE2')+'' AND qek.D_E_L_E_T_= ' ' AND SE2.E2_PREFIXO<> '+___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.) )
- 268 -
ADVPL Avanado
- 269 -
ADVPL Avanado
9. 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:
E 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.
E 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.
- 270 -
ADVPL Avanado
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.
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.
- 272 -
ADVPL Avanado
9.1. Desenvolvendo aplicaes com MsExecAuto
Estrutura de uma rotina com execuo de MsExecAuto
E Definio das variveis de controle da MsExecAuto E Montagem dos arrays de parmetros E Definio dos parmetros especficos da rotina que ser executada E Controle de transao E Tratamento do sucesso ou no da operao
Variveis de controle
E Private lMsErroAuto Indica de se houve erro no fatal durante a execuo.
E Private lMsHelpAuto Habilita a captura das mensagens de erro.
E Private lAutoErrNoFile Desabilita a gerao do arquivo de log padro do sistema.
Montagem dos arrays de parmetros
E 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.
- 273 -
ADVPL Avanado
E 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.
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.
E 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.
E 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" AADD(xAutoCab,{aStruSN1[nX][1],; SN1IMP->&(aStruSN1[nX][1]),; "",aStruSN1[nX][3]), NIL})
CASE aStruSN1[nX][2] == "N" AADD(xAutoCab,{aStruSN1[nX][1],; ABS(SN1IMP->&(aStruSN1[nX][1])), NIL})
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})
- 276 -
ADVPL Avanado
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:
E 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.
E 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.
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.
- 278 -
ADVPL Avanado
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.
E 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:
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:
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.
- 280 -
ADVPL Avanado
E 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.
/*/ +----------------------------------------------------------------------- | Funo | PROCATIVO | Autor | Arnaldo R. Junior | Data | | +----------------------------------------------------------------------- | Descrio | PROCESSAMENTO DA IMPORTACAO DO CADASTRO DE IMOBILIZADO | +----------------------------------------------------------------------- | Uso | Curso ADVPL | +----------------------------------------------------------------------- /*/
STATIC FUNCTION PROCATIVO(lEnd,oProcess)
Local aArea := GetArea() Local aDadosSN1 := {} Local aDadosSN3 := {} Local aDadosSF9 := {} Local aDadosTN1 := {} Local aDadosTN2 := {} Local aDadosTN3 := {} Local aItemSN3 := {} Local cArqSN1 := "" Local cArqSN2 := "" Local cArqSN3 := "" Local cArqSA2 := "" Local aStruSN1 := {} Local aStruSN2 := {} Local aStruSN3 := {} Local aStruSF9 := {} Local nX := 0 Local nTotRegs := 0 Local nProcRegs := 0 Local nPosDados := 0 Local cCodFor := "" Local cLojaFor := "" Local cDescFor := "" Local cFilAtu := cFilAnt Local cDirArq := Alltrim(MVParBox03) Local cHistorico := "" Local nX := 0 Local cFileExt := aTiposFile[MvParBox01] Local lImpSF9 := MvParBox07==1 Local lImpSNG := .F. // Ainda nao implementado Local cKeyImp := "" Local aAutoErro := {}
// Tratamentos adicionais - arquivos especificos do cliente Local cArqCTA := "" Local cArqSM2 := "" Local cIndSNG Local nIndex := 0 Local cGrupo := "" Local cContab := "" Local aEntSNG := {} Local cChapa := "000000"
// Compatibilizao para utilizao do CRIAVAR() REGTOMEMORY("SN1",.T.)
//Monstagem do array com dados sem tratamento e com as informao da IMP
FOR nX := 1 TO LEN(aStruSN1) IF SN1IMP->(FieldPos(aStruSN1[nX][1]))>0 DO CASE CASE EMPTY(SN1IMP->&(aStruSN1[nX][1])) AADD(aDadosSN1,{aStruSN1[nX][1],; CRIAVAR(aStruSN1[nX][1]), NIL}) CASE aStruSN1[nX][2] == "C" AADD(aDadosSN1,{aStruSN1[nX][1],; SN1IMP->&(aStruSN1[nX][1]),; "",aStruSN1[nX][3]), NIL}) CASE aStruSN1[nX][2] == "N" AADD(aDadosSN1,{aStruSN1[nX][1],; ABS(SN1IMP->&(aStruSN1[nX][1])), NIL}) OTHERWISE AADD(aDadosSN1,{aStruSN1[nX][1],; SN1IMP->&(aStruSN1[nX][1]), NIL}) 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
- 288 -
ADVPL Avanado
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
FOR nX := 1 TO LEN(aStruSN3) IF SN3IMP->(FieldPos(aStruSN3[nX][1]))>0 DO CASE CASE EMPTY(SN3IMP->&(aStruSN3[nX][1])) AADD(aItensSN3,{aStruSN3[nX][1],; CRIAVAR(aStruSN3[nX][1]), NIL}) CASE aStruSN3[nX][2] == "C" AADD(aItensSN3,{aStruSN3[nX][1],; SN3IMP->&(aStruSN3[nX][1]),; aStruSN3[nX][3]), NIL}) CASE aStruSN3[nX][2] == "N" AADD(aItensSN3,{aStruSN3[nX][1],; ABS(SN3IMP->&(aStruSN3[nX][1])),; ".T."})
// TRATAMENTO DA CARGA DO CIAP IF lImpSF9 IATFCIAP(aStruSF9,aDadosSF9) ENDIF
ConOut("Registros importados com sucesso: "+; CValToChar(nProcRegs))
ENDIF End Transaction
- 290 -
ADVPL Avanado
Continuao:
ENDIF
SN1IMP->(DbSkip()) Enddo
oProcess:IncRegua1("Processamento finalizado")
DbSelectArea("SN1IMP") DbCloseArea() IF File(cArqSN1+OrdBagExt()) FErase(cArqSN1+OrdBagExt()) ENDIF
DbSelectArea("SN2IMP") DbCloseArea() IF File(cArqSN2+OrdBagExt()) FErase(cArqSN2+OrdBagExt()) ENDIF
DbSelectArea("SN3IMP") DbCloseArea() IF File(cArqSN3+OrdBagExt()) FErase(cArqSN3+OrdBagExt()) 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
- 291 -
ADVPL Avanado
Continuao:
DbSelectArea("LOGIMP") DbCloseArea()
ConOut("Total de registros importados: "+CValToChar(nProcRegs)) ConOut("Trmino da importao: "+Time())
cFilAnt := cFilAtu RestArea(aArea) RETURN
/*/ +----------------------------------------------------------------------- | Funo | CT001PARBX | Autor | Arnaldo R. Junior | Data | | +----------------------------------------------------------------------- | Descrio | TELA DE PARAMETROS ESPECIFICOS DA ROTINA CUSTOMIZADA | +----------------------------------------------------------------------- | Uso | Curso ADVPL | +----------------------------------------------------------------------- /*/
STATIC FUNCTION IC001PARBX()
LOCAL aParamBox := {} LOCAL cTitulo := "Importacao de cadastros" LOCAL aRet := {} LOCAL bOk := {|| .T.} LOCAL aButtons := {} LOCAL lCentered := .T. LOCAL nPosx LOCAL nPosy LOCAL cLoad := "" LOCAL lCanSave := .T. LOCAL lUserSave := .T. LOCAL nX := 0 LOCAL lRet := .F.
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" &("MvParBox"+StrZero(nX,2)) := aRet[nX] Endif Next nX ENDIF
RETURN lRet
/*/ +----------------------------------------------------------------------- | Funo | IATFCIAP | Autor | Arnaldo R. Junior | Data | | +----------------------------------------------------------------------- | 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
- 293 -
ADVPL Avanado
Continuao:
/*/ +----------------------------------------------------------------------- | Funo | XDBFLOG | Autor | Arnaldo R. Junior | Data | | +----------------------------------------------------------------------- | Descrio | CRIACAO DO ARQUIVO DBF PARA TRATAMENTO DOS EVENTOS DE ERR| +----------------------------------------------------------------------- | Uso | Curso ADVPL | +----------------------------------------------------------------------- /*/ STATIC FUNCTION XDBFLOG() LOCAL aCampos := {} LOCAL cArqLog := MVParBox06+"LOGIMP"+GetDbExtension()
Mtodo do objeto oRpcSrv que permite a utilizao de todas as funes de envio e recebimento de e-mail descritas neste tpico.
E Sintaxe: CallProc(cFuncao, xParam1, ..., xParamN)
E Parmetros:
cFuncao Nome da funo ou mtodo do objeto oRpcSrv que ser executado. xParamN Parmetros da funo ou mtodo que ser executado.
E Retorno:
Nenhum .
- 295 -
ADVPL Avanado
- 296 -
ADVPL Avanado
MAILSMTPON()
Ativa uma conexo com o servio de SMTP para a thread ativa.
E Sintaxe: MailSmtpOn( cServer, cUser, cPass, nTimeOut)
E Sintaxe clssica:
CONNECT SMTP SERVER cServer ACCOUNT cUser PASSWORD cPass TIMEOUT nTimeOut IN SERVER oRpcSrv RESULT lResult
E 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.
E 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
E Sintaxe: MailPopOn( cServer, cUser, cPass, nTimeOut)
E Sintaxe clssica:
CONNECT POP SERVER cServer ACCOUNT cUser PASSWORD cPass TIMEOUT nTimeOut IN SERVER oRpcSrv RESULT lResult
E 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.
E Retorno:
Lgico Indica se foi realizada com sucesso a conexo com o servidor indicado.
- 297 -
ADVPL Avanado
MAILSMTPOFF()
Encerra a conexo com o servio de SMTP.
E Sintaxe: MailSmtpOff()
E Sintaxe clssica:
DISCONNECT SMTP SERVER IN SERVER oRpcSrv RESULT lResult
E Parmetros:
Nenhum .
E Retorno:
Lgico Indica se a operao foi realizada com sucesso.
MAILPOPOFF()
Encerra a conexo com o servio de POP
E Sintaxe: MailPopOff()
E Sintaxe clssica:
DISCONNECT POP SERVER IN SERVER oRpcSrv RESULT lResult
E Parmetros:
Nenhum .
E Retorno:
Lgico Indica se a operao foi realizada com sucesso.
MAILRECEIVE()
Efetua o recebimento de um e-mail, salvando-o no local definido.
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
E Parmetros:
nNumber Nmero da mensagem que dever ser recebida. Este nmero em funo da quantidade de mensagens na caixa de e-mails. cFrom 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 Varivel local do fonte que ser atualizada com a conta copiada na mensagem. cBcc Varivel local do fonte que ser atualizada com a conta copiada em cpia oculta na mensagem. cSubject 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. cPath Diretrio no qual sero salvos os anexos da mensagem. lDelete Indica se a mensagem dever ser apagada do servidor de e-mails aps sua recepo pela aplicao.
E Retorno:
Lgico Indica se a operao de recebimento de mensagens foi realizada com sucesso.
- 298 -
ADVPL Avanado
MAILAUTH()
Funo que executa a autenticao do usurio no servio ativo.
E Sintaxe: MailAuth(cUser, cPassword)
E Parmetros:
cUser Nome do usurio para validao da conexo com o servidor. cPassword Senha do usurio para validao da conexo com o servidor.
E 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
- 299 -
ADVPL Avanado
- 300 -
ADVPL Avanado
POPMSGCOUNT()
Verifica quantas mensagens existem na caixa de entrada do servio POP ativo.
E Sintaxe: PopMsgCount(@nMsgCount)
E Sintaxe clssica:
POP MESSAGE COUNT nMsgCount IN SERVER oRpcSrv RESULT lResult
E Parmetros:
nMsgCount Varivel local do fonte que ser atualizada com a quantidade de mensagens disponveis para recebimento na caixa de e-mails.
E Retorno:
Lgico Indica se foi realizado o acesso a caixa de mensagens.
MAILSEND()
Envia um e-mail utilizando a servio de SMTP ativo.
E Sintaxe: MailSend(cFrom, aTo, aCc, aBcc, cSubject, cBody, aFiles, lText)
E 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
E 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 Array contendo os endereos de e-mails dos copiados de forma oculta na mensagem. cSubject 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.
E Retorno:
Lgico Indica se a operao de envio de mensagens foi realizada com sucesso.
- 301 -
ADVPL Avanado
MAILGETERR()
Retorna o erro que ocorreu no envio do e-mail.
E Sintaxe: MailGetErr()
E Sintaxe clssica:
GET MAIL ERROR cErrorMsg IN SERVER oRpcSrv
E Parmetros:
Nenhum .
E 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
/*/ +----------------------------------------------------------------------- | Funo | SENDMAIL | Autor | Arnaldo R. Junior | Data | | +----------------------------------------------------------------------- | Descrio | ENVIO DE E-MAIL GENERICO | +----------------------------------------------------------------------- | Uso | Curso ADVPL | +----------------------------------------------------------------------- /*/
USER FUNCTION SendMail(_lJob)
Local lResulConn := .T. Local lResulSend := .T. Local cError := ""
Local cServer := AllTrim(GetMV("MV_RELSERV")) Local cEmail := AllTrim(GetMV("MV_RELACNT")) Local cPass := AllTrim(GetMV("MV_RELPSW")) Local lRelauth := GetMv("MV_RELAUTH")
Local cDe := cEmail Local cPara := "arnaldojr@microsiga.com.br"
- 302 -
ADVPL Avanado
Continuao:
Local cCc := "" Local cAssunto := "Teste de envio de e-mail: Curso ADVPL" Local cAnexo := "\SYSTEM\lgrl99.bmp" Local cMsg := Space(200)
Default _lJob := .T.
cMsg := "--------------------------------------------------" cMsg += "CURSO DE ADVPL " cMsg += "--------------------------------------------------" cMsg += "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 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
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 ATTACHMENT cAnexo RESULT lResulSend ElseIf !Empty(cCc) .And. !Empty(cAnexo) SEND MAIL FROM cDe TO cPara CC cCc SUBJECT cAssunto BODY cMsg ATTACHMENT cAnexo RESULT lResulSend ElseIf Empty(cCc) .And. Empty(cAnexo) SEND MAIL FROM cDe TO cPara CC cCc SUBJECT cAssunto BODY cMsg 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
DISCONNECT SMTP SERVER
IF lResulSend If _lJob ConOut(Padc("E-mail enviado com sucesso",80)) Else MsgInfo("E-mail enviado com sucesso" + cError) Endif ENDIF
/*/ +----------------------------------------------------------------------- | Funo | SENDMAIL | Autor | Arnaldo R. Junior | Data | | +----------------------------------------------------------------------- | Descrio | ENVIO DE E-MAIL GENERICO | +----------------------------------------------------------------------- | Uso | Curso ADVPL | +----------------------------------------------------------------------- /*/
USER FUNCTION FSendMail(_lJob)
Local lResulConn := .T. Local lResulSend := .T. Local lResult := .T. Local cError := ""
Local cServer := AllTrim(GetMV("MV_RELSERV")) Local cEmail := AllTrim(GetMV("MV_RELACNT")) Local cPass := AllTrim(GetMV("MV_RELPSW")) Local lRelauth := GetMv("MV_RELAUTH")
Local cDe := cEmail Local cPara := "arnaldojr@microsiga.com.br" Local cCc := "" Local cBcc := "" Local cAssunto := "Teste de envio de e-mail: Curso ADVPL" Local cAnexo := "\SYSTEM\lgrl99.bmp" Local cMsg := Space(200)
Default _lJob := .F.
cMsg := "--------------------------------------------------" cMsg += "CURSO DE ADVPL " cMsg += "--------------------------------------------------" cMsg += "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 ConOut(Padc("Falha na conexao "+cError,80)) Else MsgAlert("Falha na conexao "+cError) Endif Return(.F.) Endif
- 305 -
ADVPL Avanado
Continuao:
// 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 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
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 ATTACHMENT cAnexo RESULT lResulSend ElseIf !Empty(cCc) .And. !Empty(cAnexo) SEND MAIL FROM cDe TO cPara CC cCc SUBJECT cAssunto BODY cMsg ATTACHMENT cAnexo RESULT lResulSend ElseIf Empty(cCc) .And. Empty(cAnexo) SEND MAIL FROM cDe TO cPara CC cCc SUBJECT cAssunto BODY cMsg RESULT lResulSend Endif Endif */
If !lResulSend //GET MAIL ERROR cError cError := MailGetErr() 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
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
/*/ +----------------------------------------------------------------------- | Funo | POPMAIL | Autor | Arnaldo R. Junior | Data | | +----------------------------------------------------------------------- | Descrio | RECEBIMENTO DE E-MAIL GENERICO | +----------------------------------------------------------------------- | Uso | Curso ADVPL | +----------------------------------------------------------------------- /*/
USER FUNCTION FPopMail(_lJob)
Local lResulConn := .T. Local lResulPop := .T. Local lResult := .T. Local cError := ""
Local cServer := AllTrim(GetMV("MV_RELSERV")) Local cEmail := AllTrim(GetMV("MV_RELACNT")) Local cPass := AllTrim(GetMV("MV_RELPSW")) Local lRelauth := GetMv("MV_RELAUTH")
Local cDe := "" Local cPara := "" Local cCc := "" Local cBcc := "" Local cAssunto := "" Local aAnexo := {} Local cMsg := "" Local cPath := "\MailBox" Local nMsgCount:= 0 Local nNumber := 0
If !lResulConn cError := MailGetErr() If _lJob ConOut(Padc("Falha na conexao "+cError,80)) Else MsgAlert("Falha na conexao "+cError) Endif Return(.F.) Endif
- 308 -
ADVPL Avanado
Continuao:
/*If lRelauth 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
If !lResulPop cError := MailGetErr() If _lJob ConOut(Padc("Falha no recebimento do e-mail "+cError,80)) Else MsgAlert("Falha no recebimento do e-mail " + cError) Endif
If _lJob ConOut(Padc("Falha na autenticao do e-mail: "+cError,80)) Else MsgAlert("Falha na autenticao do e-mail:" + cError) 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
11. Integrao bsica com MsOffice
11.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.
E Sintaxe: DlgToExcel(cOrigem, cTitulo, aDadosCab, aDadosItens)
E 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.
E 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.
- 309 -
ADVPL Avanado
- 310 -
ADVPL Avanado
Exemplo de exportao para o Microsoft Excel utilizando a funo DlgToExcel()
#include "protheus.ch"
/*/ +----------------------------------------------------------------------- | Funo | GExpExcel | Autor | Arnaldo R. Junior | Data | | +----------------------------------------------------------------------- | Descrio | EXPORTACAO PARA EXCEL GENERICO | +----------------------------------------------------------------------- | Uso | Curso ADVPL | +----------------------------------------------------------------------- /*/
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 | Autor | Arnaldo R. Junior | Data | | +----------------------------------------------------------------------- | 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
- 311 -
ADVPL Avanado
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
- 312 -
ADVPL Avanado
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
- 313 -
ADVPL Avanado
OK
PMSRRFSH
S4WB006N
ORDEM
PMSSETABOT
S4WB007N
PARAMETROS
PMSSETADIR
S4WB008N
PCO_COINC
PMSSETADOWN
S4WB009N
- 314 -
ADVPL Avanado
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
- 315 -
ADVPL Avanado
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
- 316 -
ADVPL Avanado
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
- 317 -
ADVPL Avanado
BOXBOM3
BPMSTSK2I
PMSCONS
BOXBOM4
BPMSTSK3A
PMSCUSTO
BOXBOM5
BPMSTSK3E
PMSDATE
BPMSEDT1A
BPMSTSK3I
PMSESTRU
- 318 -
ADVPL Avanado
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
INVERTSELECTION
- 319 -
ADVPL Avanado
GOBOTTOM
LISTAS DE EXERCCIOS
01 Implementar a classe Aluno com os mtodos New(), Inscrever() e Avaliar().
02 Desenvolver um dilogo para interagir com a classe Aluno desenvolvida no exerccio anterior.
03 Implementar uma Enchoice para o cadastro de produtos (SB1).
- 320 -
ADVPL Avanado
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.
- 321 -
ADVPL Avanado
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.
- 322 -
ADVPL Avanado
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().
- 323 -
ADVPL Avanado
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).
- 324 -
ADVPL Avanado
- 325 -
ADVPL Avanado
Projeto: Avaliao prtica do treinamento de ADVPL Avanado
Objetivos do projeto
E Contemplar o contedo do curso e estimular a prtica da programao utilizando a linguagem ADVPL;
E Acrescentar um grau de desafio ao treinamento;
Regras para entrega e apresentao
E 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;
E 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
E Mesmo peso da prova terica, podendo substitu-la integralmente. E Sero considerados os quesitos: O Funcionalidades O Clareza da programao O Apresentao O 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.
- 326 -
ADVPL Avanado
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
Matriz Av. Braz Leme, 1.717 02511-000 So Paulo SP Brasil. Tel.: 55 (11) 3981-7001 www.microsiga.com.br
- 328 -
Guia de Referncia Rpida ADVPL Avanado
GUIA DE REFERNCIA RPIDA: Funes e Comandos ADVPL
Neste guia de referncia rpida sero descritas as funes bsicas da linguagem ADVPL, incluindo as funes herdadas da linguagem Clipper, necessrias ao desenvolvimento no ambiente ERP.
Converso entre tipos de dados
CTOD()
Realiza a converso de uma informao do tipo caracter no formato DD/MM/AAAA para uma varivel do tipo data.
E Sintaxe: CTOD(cData) E Parmetros
cData Caracter no formato DD/MM/AAAA
Exemplo:
cData := 31/12/2006 dData := CTOD(cData)
IF dDataBase >= dData MSGALERT(Data do sistema fora da competncia) ELSE MSGINFO(Data do sistema dentro da competncia) ENDIF
CVALTOCHAR()
Realiza a converso de uma informao do tipo numrico em uma string, sem a adio de espaos a informao.
E Sintaxe: CVALTOCHAR(nValor) E Parmetros
nValor Valor numrico que ser convertido para caractere.
Exemplo:
FOR nPercorridos := 1 to 10 MSGINFO(Passos percorridos: +CvalToChar(nPercorridos)) NEXT nPercorridos
- 329 -
Guia de Referncia Rpida ADVPL Avanado
DTOC()
Realiza a converso de uma informao do tipo data para em caracter, sendo o resultado no formato DD/MM/AAAA.
E Sintaxe: DTOC(dData) E Parmetros
dData Varivel com contedo data
Exemplo:
MSGINFO(Database do sistema: +DTOC(dData)
DTOS()
Realiza a converso de uma informao do tipo data em um caracter, sendo o resultado no formato AAAAMMDD.
E Sintaxe: DTOS(dData) E Parmetros
dData Varivel com contedo data
Exemplo:
cQuery := SELECT A1_COD, A1_LOJA, A1_NREDUZ FROM SA1010 WHERE cQuery += A1_DULTCOM >=+DTOS(dDataIni)+
STOD()
Realiza a converso de uma informao do tipo caracter com contedo no formato AAAAMMDD em data.
E Sintaxe: STOD(sData) E Parmetros
sData String no formato AAAAMMDD
Exemplo:
sData := LERSTR(01,08) // Funo que realiza a leitura de uma string de um txt previamente // aberto dData := STOD(sData)
- 330 -
Guia de Referncia Rpida ADVPL Avanado
STR()
Realiza a converso de uma informao do tipo numrico em uma string, adicionando espaos direita.
E Sintaxe: STR(nValor) E Parmetros
nValor Valor numrico que ser convertido para caractere.
Exemplo:
FOR nPercorridos := 1 to 10 MSGINFO(Passos percorridos: +CvalToChar(nPercorridos)) NEXT nPercorridos
STRZERO()
Realiza a converso de uma informao do tipo numrico em uma string, adicionando zeros esquerda do nmero convertido, de forma que a string gerada tenha o tamanho especificado no parmetro.
E Sintaxe: STRZERO(nValor, nTamanho) E Parmetros
nValor Valor numrico que ser convertido para caractere. nTamanho Tamanho total desejado para a string retornada.
Exemplo:
FOR nPercorridos := 1 to 10 MSGINFO(Passos percorridos: +CvalToChar(nPercorridos)) NEXT nPercorridos
VAL()
Realiza a converso de uma informao do tipo caracter em numrica.
E Sintaxe: VAL(cValor) E Parmetros
cValor String que ser convertida para numrico.
Exemplo:
Static Function Modulo11(cData) LOCAL L, D, P := 0 L := Len(cdata) D := 0 P := 1 While L > 0 P := P + 1 D := D + (Val(SubStr(cData, L, 1)) * P) If P = 9 P := 1 End L := L - 1 End D := 11 - (mod(D,11)) If (D == 0 .Or. D == 1 .Or. D == 10 .Or. D == 11) D := 1 End Return(D)
- 331 -
Guia de Referncia Rpida ADVPL Avanado
- 332 -
Guia de Referncia Rpida ADVPL Avanado
Matemticas
ACOS()
Funo utilizada para calcular o valor do arco co-seno.
E Sintaxe: ACOS(nValor) E Parmetros:
nValor Valor entre -1 e 1 de quem ser calculado o Arco Co-Seno.
E Retorno:
Numrico Range de 0 a radianos.
Se o valor informado no parmetro for menor que 1 ou maior que 1, acos retorna um valor indefinido por default [+ , -]
CEILING()
Funo utilizada para calcular o valor mais prximo possvel de um valor nMax informado como parmetro para a funo.
E Sintaxe: CELLING(nMax) E Parmetros
nMax Valor limite para anlise da funo, no formato floating-point.
E Retorno:
Numrico Valor do tipo double, representando o menor inteiro que maior ou igual ao valor de nX. No h retorno de erro na funo.
COS()
Funo utilizada para calcular o valor do co-seno ou co-seno hiperblico.
Importante: Se x >= 2^63 ou x <= -2^63 ocorre perda significante na chamada da funo COS().
E Sintaxe: COS(nAngulo) E Parmetros:
nAngulo Valor que representa o ngulo em radianos.
E Retorno:
Numrico Valor que representa o co-seno ou co-seno hiperblico do ngulo informado.
- 333 -
Guia de Referncia Rpida ADVPL Avanado
E Situaes invlidas:
Entrada Exceo apresentada Significado da Exceo QNAN,IND None Sem Domnio (cosf, cos) INVALID Sem Domnio x 7.104760e+002 (cosh, coshf) INEXACT+OVERFLOW OVERFLOW
LOG10()
Funo utilizada para calcular o logaritmo natural de um valor numrico, em base 10.
LOG10() uma funo numrica que calcula o logaritmo natural de um nmero. O logaritmo natural tem como base o valor 10. Devido ao arredondamento matemtico, os valores retornados por LOG() podem no coincidir exatamente.
E Sintaxe: LOG10(nNatural) E Parmetros:
nNatural Valor cujo o logaritmo deve ser encontrado.
E Retorno:
Numrico A funo retorna o logaritmo de nNatural se bem sucedidas. Se nNatural for negativo, estas funes retornam um indefinido, pelo defeito. Se nNatural for 0, retornam INF(infinito).
SIN()
Funo utilizada para calcular o valor do seno ou seno hiperblico. Devemos informar como parmetro para a funo um valor que representa o angulo em radianos.
Importante: Se x >= 2^63 ou x <= -2^63 ocorre perda significante na chamada da funo SIN().
E Sintaxe: SIN(nAngulo) E Parmetros:
nAngulo Valor do ngulo em radianos.
E Retorno:
Numrico Retorna o valor do seno do ngulo especificado.
E Situaes invlidas:
Entrada Exceo apresentada Significado da Exceo QNAN,IND None Sem Domnio (senf, sen) INVALID Sem Domnio x 7.104760e+002 (senh, senhf) INEXACT+OVERFLOW OVERFLOW
SQRT()
Funo utilizada para calcular a raiz quadrada de um nmero positivo.
E Sintaxe: SQRT(nValor) E Parmetros:
nValor Um nmero positivo do qual ser calculada a raiz quadrada.
E Retorno:
Numrico Retorna um valor numrico calculado com preciso dupla. A quantidade de casas decimais exibidas determinada apenas por SET DECIMALS, sem importar a configurao de SET FIXED. Um nmero negativo <nValor> retorna zero.
TAN()
Funo utilizada para calcular o valor da tangente ou tangente hiperblica.
Importante: Se x >= 2^63 ou x <= -2^63 ocorre perda significante na chamada da funo cos.
E Sintaxe: TAN(nAngulo) E Parmetros:
nAngulo Valor do ngulo em radianos.
E Retorno:
Numrico Retorna o valor da tangente do ngulo especificado.
E Situaes invlidas:
Entrada Exceo apresentada Significado da Exceo QNAN,IND None Sem Domnio INVALID Sem Domnio
- 334 -
Guia de Referncia Rpida ADVPL Avanado
- 335 -
Guia de Referncia Rpida ADVPL Avanado
Anlise de variveis
TYPE()
Determina o tipo do contedo de uma varivel, a qual no foi definida na funo em execuo.
E Sintaxe: TYPE(cVariavel) E Parmetros
cVariavel Nome da varivel que se deseja avaliar, entre aspas ().
Exemplo: IF TYPE(dDataBase) == D MSGINFO(Database do sistema: +DTOC(dDataBase)) ELSE MSGINFO(Varivel indefinida no momento) ENDIF
VALTYPE()
Determina o tipo do contedo de uma varivel, a qual no foi definida na funo em execuo.
E Sintaxe: VALTYPE(cVariavel) E Parmetros
cVariavel Nome da varivel que se deseja avaliar.
Exemplo: STATIC FUNCTION GETTEXTO(nTamanho, cTitulo, cSay) LOCAL cTexto := LOCAL nColF, nLargGet := 0 PRIVATE oDlg Default cTitulo := "Tela para informar texto" Default cSay := "Informe o texto:" Default nTamanho := 1
nTamanho := IIF(ValType(nTamanho) != N,1,nTamanho) // Se o parmetro foi passado cTexto := Space(nTamanho);nLargGet := Round(nTamanho * 2.5,0); nColf := Round(195 + (nLargGet * 1.75) ,0)
DEFINE MSDIALOG oDlg TITLE cTitulo FROM 000,000 TO 120,nColF PIXEL @ 005,005 TO 060, Round(nColF/2,0) OF oDlg PIXEL @ 010,010 SAY cSay SIZE 55, 7 OF oDlg PIXEL @ 010,065 MSGET cTexto SIZE nLargGet, 11 OF oDlg PIXEL ; Picture "@!" VALID !Empty(cTexto) DEFINE SBUTTON FROM 030, 010 TYPE 1 ; ACTION (nOpca := 1,oDlg:End()) ENABLE OF oDlg DEFINE SBUTTON FROM 030, 040 TYPE 2 ; ACTION (nOpca := 0,oDlg:End()) ENABLE OF oDlg ACTIVATE MSDIALOG oDlg CENTERED cTexto := IIF(nOpca==1,cTexto,"") RETURN cTexto
- 336 -
Guia de Referncia Rpida ADVPL Avanado
Manipulao de arrays
AADD()
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.
E Sintaxe: AADD(aArray, xItem) E Parmetros
aArray Array pr-existente no qual ser adicionado o item definido em xItem xItem Item que ser adicionado ao array.
Exemplo:
aDados := {} // Define que a varivel aDados um array, sem especificar suas dimenses. aItem := {} // Define que a varivel aItem um array, sem especificar suas dimenses.
AADD(aItem, cVariavel1) // Adiciona um elemento no array aItem de acordo com o cVariavel1 AADD(aItem, cVariavel2) // Adiciona um elemento no array aItem de acordo com o cVariavel2 AADD(aItem, cVariavel3) // Adiciona um elemento no array aItem de acordo com o cVariavel3
// Neste ponto o array a Item possui 03 elementos os quais podem ser acessados com: // aItem[1] -> corresponde ao contedo de cVariavel1 // aItem[2] -> corresponde ao contedo de cVariavel2 // aItem[3] -> corresponde ao contedo de cVariavel3
AADD(aDados,aItem) // Adiciona no array aDados o contedo do array aItem
// Neste ponto, o array a aDados possui apenas um elemento, que tambm um array // contendo 03 elementos: // aDados [1][1] -> corresponde ao contedo de cVariavel1 // aDados [1][2] -> corresponde ao contedo de cVariavel2 // aDados [1][3] -> corresponde ao contedo de cVariavel3
AADD(aDados, aItem) AADD(aDados, aItem)
// Neste ponto, o array aDados possui 03 elementos, aonde cada qual um array com outros // 03 elementos, sendo:
// aDados [1][1] -> corresponde ao contedo de cVariavel1 // aDados [1][2] -> corresponde ao contedo de cVariavel2 // aDados [1][3] -> corresponde ao contedo de cVariavel3
// aDados [2][1] -> corresponde ao contedo de cVariavel1 // aDados [2][2] -> corresponde ao contedo de cVariavel2 // aDados [2][3] -> corresponde ao contedo de cVariavel3
// aDados [3][1] -> corresponde ao contedo de cVariavel1 // aDados [3][2] -> corresponde ao contedo de cVariavel2 // aDados [3][3] -> corresponde ao contedo de cVariavel3
Exemplo (continuao):
// Desta forma, o array aDados montando com uma estrutura de 03 linhas e 03 colunas, com // o contedo definido por variveis externas, mas com a mesma forma obtida com o uso do // comando: aDados := ARRAY(3,3).
ACLONE()
A funo ACLONE() realiza a cpia dos elementos de um array para outro array integralmente.
E Sintaxe: AADD(aArray) E Parmetros
aArray Array pr-existente que ter seu contedo copiado para o array especificado.
Exemplo:
// Utilizando o array aDados utilizado no exemplo da funo AADD() aItens := ACLONE(aDados)
// Neste ponto, o array aItens possui exatamente a mesma estrutura e informaes do array // aDados.
Por ser uma estrutura de memria, um array no pode ser simplesmente copiado para outro array atravs de uma atribuio simples (:=).
Para mais informaes sobre a necessidade de utilizar o comando ACLONE() verifique o tpico 6.1.3 Cpia de Arrays.
ACOPY()
Funo de array que copia elementos do array aOrigem para array aDestino. O array destino aDestino j deve ter sido declarado e grande o bastante para conter os elementos que sero copiados. Se o array aOrigem contiver mais elementos, alguns dos elementos no sero copiados. ACOPY() copia os valores de todos os dados, incluindo valores nulos (NIL) e cdigos de bloco.
Se um elemento for um subarray, o elemento correspondente no array aDestino, conter o mesmo subarray. Portanto, ACOPY() no produzir uma cpia completa de array multidimensionais.
E Sintaxe: ACOPY( aOrigem, aDestino , [ nInicio ], [ nQtde ], [ nPosDestino ]) E Parmetros:
aOrigem o array que contm os elementos a serem copiados. aDestino o array que receber a cpia dos elementos. nInicio indica qual o ndice do primeiro elemento de aOrigem que ser copiado. Se no for especificado, o valor assumido ser 01.
- 337 -
Guia de Referncia Rpida ADVPL Avanado
- 338 -
Guia de Referncia Rpida ADVPL Avanado
nQtde indica a quantidade de elementos a serem copiados a partir do array aOrigem. iniciando-se a contagem a partir da posio nInicio. Se nQtde no for especificado, todos os elementos do array aOrigem sero copiados, iniciando-se a partir da posio nInicio. nPosDestino a posio do elemento inicial no array aDestino que receber os elementos de aOrigem. Se no especificado, ser assumido 01.
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.
E Sintaxe: ADEL(aArray, nPosio) E Parmetros
aArray Array do qual deseja-se remover uma determinada posio nPosio Posio do array que ser removida
Exemplo:
// Utilizando o array aItens do exemplo da funo ACLONE() temos:
ADEL(aItens,1) // Ser removido o primeiro elemento do array aItens.
// Neste ponto, o array aItens continua com 03 elementos, aonde: // aItens[1] -> antigo aItens[2], o qual foi reordenado como efeito da excluso do item 1. // aItens[2] -> antigo aItens[3], o qual foi reordenado como efeito da excluso do item 1. // aItens[3] -> contedo nulo, por se tratar do item excludo.
ADIR()
Funo que preenche os arrays passados com os dados dos arquivos encontrados, atravs da mscara informada. Tanto arquivos locais (Remote) como do servidor podem ser informados.
Importante: ADir uma funo obsoleta, utilize sempre Directory().
cArqEspec Caminho dos arquivos a serem includos na busca de informaes. Segue o padro para especificao de arquivos, aceitando arquivos no servidor Protheus e no Cliente. Caracteres como * e ? so aceitos normalmente. Caso seja omitido, sero aceitos todos os arquivos do diretrio default ( *.* ). aNomeArq Array de Caracteres. o array com os nomes dos arquivos encontrados na busca.O contedo anterior do array apagado. aTamanho Array Numrico. So os tamanhos dos arquivos encontrados na busca. aData Array de Datas. So as datas de modificao dos arquivos encontrados na busca. aHora Array de Caracteres. So os horrios de modificao dos arquivos encontrados. Cada elemento contm horrio no formato: hh:mm:ss. aAtributos Array de Caracteres. So os atributos dos arquivos, caso esse array seja passado como parmetros, sero includos os arquivos com atributos de sistema e ocultos.
E Retorno:
nArquivos Quantidade de arquivos encontrados.
Exemplo:
LOCAL aFiles[ADIR("*.TXT")] ADIR("*.TXT", aFiles) AEVAL(aFiles, { |element| QOUT(element) })
- 339 -
Guia de Referncia Rpida ADVPL Avanado
- 340 -
Guia de Referncia Rpida ADVPL Avanado
AFILL()
Funo de manipulao de arrays, que preenche os elementos do array com qualquer tipo de dado. Incluindo code-block. Esta funo no deve ser usada para preencher um array com outro array.
E Sintaxe: AFILL( aDestino , xExpValor, [ nI nicio ], [ nQuantidade ]) E Parmetros
aDestino o onde os dados sero preenchidos. xExpValor o dado que ser preenchido em todas as posies informadas, no permitida a utilizao de arrays. nInicio a posio inicial de onde os dados sero preenchidos, o valor padro 1. nCount Quantidade de elementos a partir de [nInicio] que sero preenchidos com <expValor>, caso no seja informado o valor ser a quantidade de elementos at o final do array.
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.
E Sintaxe: AINS(aArray, nPosicao) E Parmetros
aArray Array pr-existente no qual desejasse inserir um novo elemento. nPosicao Posio na qual o novo elemento ser inserido.
Exemplo:
aAlunos := {Edson, Robson, Renato, Tatiana}
AINS(aAlunos,3) // Neste ponto o array aAlunos ter o seguinte contedo: // {Edson, Robson, nulo, Renato, Tatiana}
Similar ao efeito da funo ADEL(), o elemento inserido no array pela funo AINS() ter um contedo nulo, sendo necessrio trata-lo aps a realizao deste comando.
ARRAY()
A funo Array() utilizada na definio de variveis de tipo array, como uma opo a sintaxe utilizando chaves ({}).
E Sintaxe: Array(nLinhas, nColunas) E Parmetros
nLinhas Determina o nmero de linhas com as quais o array ser criado nColunas Determina o nmero de colunas com as quais o array ser criado
Exemplo:
aDados := Array(3,3) // Cria um array de trs linhas, cada qual com 3 colunas.
O array definido pelo comando Array() apesar de j possuir a estrutura solicitada, no possui contedo em nenhum de seus elementos, ou seja:
aDados[1] -> array de trs posies aDados[1][1] -> posio vlida, mas de contedo nulo.
ASCAN()
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.
E Sintaxe: ASCAN(aArray, bSeek) E Parmetros
aArray Array pr-existente no qual desejasse identificar a posio que contm a informao pesquisada. bSeek Bloco de cdigo que configura os parmetros da busca a ser realizada.
Durante a execuo da funo aScan, a varivel x receber o contedo o item que est posicionado no momento, no caso aAlunos[x]. Como aAlunos[x] uma posio do array que contm o nome do aluno, x poderia ser renomeada para cNome, e a definio do bloco bSeek poderia ser re-escrita como:
bSeek := {|cNome| cNome == Denis}
Na definio dos programas sempre recomendvel utilizar variveis com nomes significativos, desta forma os blocos de cdigo no so exceo.
Sempre opte por analisar como o bloco de cdigo ser utilizado e ao invs de x, y e similares, defina os parmetros com nomes que representem seu contedo. Ser mais simples o seu entendimento e o entendimento de outros que forem analisar o cdigo escrito.
ASCANX() Funo utilizada para varrer um vetor procurando um valor especificado, operando de forma similar a funo ASCAN. A diferena fundamental da funo ASCANX que esta funo recebe um segundo parmetro em seu code-block representando o ndice do array. E Sintaxe: ASCANX ( < xDestino > , < bSeek > , [ nInicio ] , [ nCont ] )
E Parmetros:
xDestino Representa o objeto a ser varrido pela funo, pode ser atribudo ao parmetro um array um Objeto. bSeek Representa o valor que ser pesquisado, podendo ser um bloco de cdigo. nInicio Representa o elemento a partir do qual ter inicio a pesquisa, quando este argumento no for informado o valor default ser 1. nCont Representa a quantidade de elementos que sero pesquisados a partir da posio inicial, quando este argumento no for informado todos elementos do array sero pesquisados.
No cdigo demonstrado acima, note a incluso no code-block do Y, onde a funo ir terminar sua execuo em 3 condies:
1) At encontrar o elemento no ARRAY com a ocorrncia cNome, retornando a posio desse elemento.
2) Essa novidade, ASCANX ir verificar o Array at a posio 100.
3) O elemento cNome no foi encontrado no ARRAY e a condio de Y at 100 no satisfaz, pois o array menor do que 100 posies!
Como ASCAN() que utiliza o operador (=) para comparaes, a funo ASCANX() tambm case sensitive, no caso os elementos procurados devem ser exatamente igual.
ASIZE()
A funo ASIZE permite a redefinio da estrutura de um array pr-existente, adicionando ou removendo itens do mesmo.
E Sintaxe: ASIZE(aArray, nTamanho) E Parmetros
aArray Array pr-existente que ter sua estrutura redimensionada. nTamanho Tamanho com o qual deseja-se redefinir o array. Se o tamanho for menor do que o atual, sero removidos os elementos do final do array, j se o tamanho for maior do que o atual sero inseridos itens nulos ao final do array.
Exemplo:
// Utilizando o array aItens, o qual teve um elemento excludo pelo uso da funo ADEL()
ASIZE(aItens,Len(aItens-1))
// Neste ponto o array aItens possui 02 elementos, ambos com contedos vlidos.
Utilizar a funo ASIZE() aps o uso da funo ADEL() uma prtica recomendada e evita que seja acessada uma posio do array com um contedo invlido para a aplicao em uso.
- 343 -
Guia de Referncia Rpida ADVPL Avanado
ASORT()
A funo ASORT() permite que os itens de um array sejam ordenados a partir de um critrio pr-estabelecido.
E Sintaxe: ASORT(aArray, nInicio, nItens, bOrdem) E Parmetros
aArray Array pr-existente que ter seu contedo ordenado atravs de um critrio estabelecido. nInicio Posio inicial do array para incio da ordenao. Caso no seja informado, o array ser ordenado a partir de seu primeiro elemento. nItens Quantos itens, a partir da posio inicial devero ser ordenados. Caso no seja informado, sero ordenados todos os elementos do array. bOrdem Bloco de cdigo que permite a definio do critrio de ordenao do array. Caso bOrdem no seja informado, ser utilizado o critrio ascendente.
- 344 -
Guia de Referncia Rpida ADVPL Avanado
Um bloco de cdigo basicamente uma funo escrita em linha. Desta forma sua estrutura deve suportar todos os requisitos de uma funo, os quais so atravs da anlise e interpretao de parmetros recebidos, executar um processamento e fornecer um retorno.
Com base nesse requisito, pode-se definir um bloco de cdigo com a estrutura abaixo:
|| -> define o intervalo onde esto compreendidos os parmetros Ao Z-> expresso que ser executadas pelo bloco de cdigo Ao1... AoZ -> intervalo de expresses que sero executadas pelo bloco de cdigo, no formato de lista de expresses.
Retorno -> resultado da ultima ao executada pelo bloco de cdigo, no caso AoZ.
Para maiores detalhes sobre a estrutura e utilizao de blocos de cdigo consulte o tpico 6.2 Listas de Expresses e Blocos de cdigo.
Exemplo 01 Ordenao ascendente
aAlunos := { Mauren, Soraia, Andria}
aSort(aAlunos)
// Neste ponto, os elementos do array aAlunos sero {Andria, Mauren, Soraia}
Exemplo 02 Ordenao descendente
aAlunos := { Mauren, Soraia, Andria} bOrdem := {|x,y| x > y }
// Durante a execuo da funo aSort(), a varivel x receber o contedo do item que est // posicionado. Como o item que est posicionado a posio aAlunos[x] e aAlunos[x] -> // string contendo o nome de um aluno, pode-se substituir x por cNomeAtu. // A varivel y receber o contedo do prximo item a ser avaliado, e usando a mesma // analogia de x, pode-se substituir y por cNomeProx. Desta forma o bloco de cdigo // bOrdem pode ser re-escrito como:
// Neste ponto, os elementos do array aAlunos sero {Soraia , Mauren, Andria}
ATAIL()
ATAIL() uma funo de manipulao de array que retorna o ltimo elemento de um array. Ela deve ser usada em substituio da seguinte construo: aArray [LEN( aArray )]
E Sintaxe: ATAIL( aArray ) E Parmetros:
aArray o array de onde ser retornado o ltimo elemento.
E Retorno:
nUltimo Nmero do ltimo elemento do array.
Exemplo:
aArray := {"a", "b", "c", "d"} ATAIL(aArray) // Resultado: d
- 345 -
Guia de Referncia Rpida ADVPL Avanado
- 346 -
Guia de Referncia Rpida ADVPL Avanado
Manipulao de blocos de cdigo
EVAL()
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.
E Sintaxe: EVAL(bBloco, xParam1, xParam2, xParamZ) E Parmetros
bBloco Bloco de cdigo que ser interpretado. xParamZ Parmetros que sero passados ao bloco de cdigo. A partir da passagem do bloco, todos os demais parmetros da funo sero convertidos em parmetros para a interpretao do cdigo.
Exemplo:
nInt := 10 bBloco := {|N| x:= 10, y:= x*N, z:= y/(x*N)} nValor := EVAL(bBloco, nInt) // O retorno ser dado pela avaliao da ultima ao da lista de expresses, no caso z. // Cada uma das variveis definidas em uma das aes da lista de expresses fica disponvel // para a prxima ao. // Desta forma temos: // N recebe nInt como parmetro (10) // X tem atribudo o valor 10 (10) // Y resultado da multiplicao de X por N (100) // Z resultado a diviso de Y pela multiplicao de X por N ( 100 / 100) 1
DBEVAL()
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.
E Sintaxe: Array(bBloco, bFor, bWhile) E Parmetros
bBloco Bloco de cdigo principal, contendo as expresses que sero avaliadas para cada registro do alias ativo.
bFor Condio para continuao da anlise dos registros, com o efeito de uma estrutura For ... Next.
bWhile Condio para continuao da anlise dos registros, com o efeito de uma estrutura While ... End
Exemplo 01: // Considerando o trecho de cdigo abaixo: dbSelectArea(SX5) dbSetOrder(1) dbGotop()
While !Eof() .And. X5_FILIAL == xFilial("SX5") .And.; X5_TABELA <= mv_par02 nCnt++ dbSkip() End
// O mesmo pode ser re-escrito com o uso da funo DBEVAL(): dbEval( {|x| nCnt++ },,{||X5_FILIAL==xFilial("SX5") .And. X5_TABELA<=mv_par02})
Exemplo 02: // Considerando o trecho de cdigo abaixo: dbSelectArea(SX5) dbSetOrder(1) dbGotop()
While !Eof() .And. X5_TABELA == cTabela AADD(aTabela,{X5_CHAVE, Capital(X5_DESCRI)}) dbSkip() End
// O mesmo pode ser re-escrito com o uso da funo DBEVAL():
Na utilizao da funo DBEVAL() deve ser informado apenas um dos dois parmetros: bFor ou bWhile.
- 347 -
Guia de Referncia Rpida ADVPL Avanado
AEVAL()
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.
E Sintaxe: AEVAL(aArray, bBloco, nInicio, nFim) E Parmetros
aArray Array que ser avaliado na execuo da funo. bBloco Bloco de cdigo principal, contendo as expresses que sero avaliadas para cada elemento do array informado.
nInicio Elemento inicial do array, a partir do qual sero avaliados os blocos de cdigo. nFim Elemento final do array, at o qual sero avaliados os blocos de cdigo.
Exemplo 01:
Considerando o trecho de cdigo abaixo:
AADD(aCampos,A1_FILIAL) AADD(aCampos,A1_COD) SX3->(dbSetOrder(2)) For nX:=1 To Len(aCampos) SX3->(dbSeek(aCampos[nX])) AADD(aTitulos,AllTrim(SX3->X3_TITULO)) Next nX
O mesmo pode ser re-escrito com o uso da funo AEVAL():
Retorna a primeira posio de um caracter ou string dentro de outra string especificada.
E Sintaxe: AT(cCaractere, cString ) E Parmetros
cCaractere Caractere ou string que se deseja verificar cString String na qual ser verificada a existncia do contedo de cCaractere.
Exemplo: STATIC FUNCTION NOMASCARA(cString,cMascara,nTamanho)
LOCAL cNoMascara := "" LOCAL nX := 0
IF !Empty(cMascara) .AND. AT(cMascara,cString) > 0 FOR nX := 1 TO Len(cString) IF !(SUBSTR(cString,nX,1) $ cMascara) cNoMascara += SUBSTR(cString,nX,1) ENDIF NEXT nX cNoMascara := PADR(ALLTRIM(cNoMascara),nTamanho) ELSE cNoMascara := PADR(ALLTRIM(cString),nTamanho) ENDIF
RETURN cNoMascara
- 351 -
Guia de Referncia Rpida ADVPL Avanado
BITON()
Funo utilizada para ligar determinados bits de uma String passada por parmetro para a funo. Alm da string ser alterada, a funo tambm recebe como parmetro um numrico que indica o bit de inicio a ser alterado, um numrico que indica a quantidade de bits a serem alterados(ligados) e o tamanho da string passada.
cValue String no qual desejamos ligar os bits. nBitIni Indica a partir de qual bit, comear a ser ligados os bits na String nBitEnd Indica a quantidade de bits que sero ligados a partir do inicio. nStrLen Representa o tamanho da String passada para a funo.
CAPITAL()
Funo que avalia a string passada como parmetro alterando a primeira letra de cada palavra para maiscula e as demais letras como minsculas.
E Sintaxe: CAPITAL(cFrase)
E Parmetros:
cFrase String a ser avaliada
E Retorno:
String Contedo da string original com as modificaes necessrias para atender a condio da funo.
CHR()
Converte um valor nmero referente a uma informao da tabela ASCII no caractere que esta informao representa.
E Sintaxe: CHR(nASCII) E Parmetros
nASCII Cdigo ASCII do caractere
Exemplo:
#DEFINE CRLF CHR(13)+CHR(10) // FINAL DE LINHA
- 352 -
Guia de Referncia Rpida ADVPL Avanado
DESCEND()
Funo de converso que retorna a forma complementada da expresso string especificada. Esta funo normalmente utilizada para a criao de indexadores em ordem decrescente
E Sintaxe: DESCEND ( < cString > ) E Parmetros:
cString Corresponde seqncia de caracteres a ser analisada.
E Retorno:
Caracter
String complementada da string analisada.
Exemplo:
// Este exemplo utiliza DESCEND() em uma expresso INDEX para criar um ndice de datas de // ordem descendente:
USE Sales NEW INDEX ON DESCEND(DTOS(OrdDate)) TO SalesDate
// Depois, DESCEND() pode ser utilizado para fazer uma pesquisa (SEEK) no ndice // descendente:
DbSEEK(DESCEND(DTOS(dFindDate)))
GETDTOVAL()
Funo utilizada para retornar um numero formatado, de acordo com o valor passado por parmetro, sendo que ir apenas manter os valores numricos contidos na string passada por parmetro, verificando se existe algum caractere '.' retornando um numero fracionrio, na ordem dos nmeros contidos na string.
A funo muito til quando desejamos utilizar o valor numrico de uma data que est contida em uma string.
E Sintaxe: GETDTOVAL ( < cDtoVal > )
E Parmetros:
cDtoVal Representa uma string contendo um valor numrico no qual ser convertido.
E Retorno:
Numrico Retorna um dado numrico de acordo com o valor informado em <cDtoVal>.
Funo utilizada para determinar se o caractere mais esquerda em uma cadeia de caracteres alfabtico, permitindo avaliar se o string especificado comea com um caractere alfabtico. Um caractere alfabtico consiste em qualquer letra maiscula ou minscula de A a Z.
E Sintaxe: ISALPHA ( < cString > )
E Parmetros:
cString Cadeia de caracteres a ser examinada.
E Retorno:
Lgico Retorna verdadeiro (.T.) se o primeiro caractere em <cString> for alfabtico, caso contrrio, retorna falso (.F.).
ISDIGIT()
Funo utilizada para determinar se o caractere mais esquerda em uma cadeia de caracteres um dgito, permitindo avaliar se o primeiro caractere em um string um dgito numrico entre zero e nove.
E Sintaxe: ISDIGIT ( < cString > )
E Parmetros:
cString Cadeia de caracteres a ser examinada.
E Retorno:
Lgico Retorna verdadeiro (.T.) caso o primeiro caractere da cadeia seja um dgito entre zero e nove; caso contrrio, retorna falso (.F.).
- 354 -
Guia de Referncia Rpida ADVPL Avanado
ISLOWER()
Funo utilizada para determinar se o caractere mais esquerda uma letra minscula, permitindo avaliar se o primeiro caractere de um string uma letra minscula. o contrrio de ISUPPER(), a qual determina se a cadeia de caracteres comea com uma letra maiscula. ISLOWER() e ISUPPER() ambas so relacionadas s funes LOWER() e UPPER(), que convertem caracteres minsculos para maisculos, e vice-versa.
E Sintaxe: ISLOWER( < cString > )
E Parmetros:
cString Cadeia de caracteres a ser examinada.
E Retorno:
Lgico Retorna verdadeiro (.T.) caso o primeiro caractere da cadeia seja minsculo , caso contrrio, retorna falso (.F.).
ISUPPER()
Funo utilizada para determinar se o caractere mais esquerda uma letra maiscula, permitindo avaliar se o primeiro caractere de um string uma letra maiscula. o contrrio de ISLOWER (), a qual determina se a cadeia de caracteres comea com uma letra minscula. ISLOWER() e ISUPPER() ambas so relacionadas s funes LOWER() e UPPER(), que convertem caracteres minsculos para maisculos, e vice-versa.
E Sintaxe: ISUPPER( < cString > )
E Parmetros:
cString Cadeia de caracteres a ser examinada.
E Retorno:
Lgico Retorna verdadeiro (.T.) caso o primeiro caractere da cadeia seja maisculo , caso contrrio, retorna falso (.F.).
LEN()
Retorna o tamanho da string especificada no parmetro.
E Sintaxe: LEN(cString) E Parmetros
cString String que ser avaliada
Exemplo: cNome := ALLTRIM(SA1->A1_NOME) MSGINFO(Dados do campo A1_NOME:+CRLF Tamanho: + CVALTOCHAR(LEN(SA1->A1_NOME))+CRLF Texto: + CVALTOCHAR(LEN(cNome)))
- 355 -
Guia de Referncia Rpida ADVPL Avanado
LOWER()
Retorna uma string com todos os caracteres minsculos, tendo como base a string passada como parmetro.
E Sintaxe: LOWER(cString) E Parmetros
cString String que ser convertida para caracteres minsculos.
Exemplo:
cTexto := ADVPL
MSGINFO(Texto:+LOWER(cTexto))
LTRIM()
Funo para tratamento de caracteres utilizada para formatar cadeias de caracteres que possuam espaos em branco esquerda. Pode ser o caso de, por exemplo, nmeros convertidos para cadeias de caracteres atravs da funo STR().
LTRIM() relacionada a RTRIM(), a qual remove espaos em branco direita, e a ALLTRIM(), que remove espaos tanto esquerda quanto direita.
O contrrio de ALLTRIM(), LTRIM(), e RTRIM() so as funes PADC(), PADR(), e PADL(), as quais centralizam, alinham direita, ou alinham esquerda as cadeias de caracteres, atravs da insero de caracteres de preenchimento.
E Sintaxe: LTRIM ( < cString > ) E Parmetros:
cString <cString> a cadeia de caracteres a ser copiada sem os espaos em branco esquerda.
E Retorno:
Caracter LTRIM() retorna uma cpia de <cString>, sendo que os espaos em branco esquerda foram removidos. Caso <cString> seja uma cadeia de caracteres nula ("") ou toda composta de espaos em branco, LTRIM() retorna uma cadeia de caracteres nula ("").
- 356 -
Guia de Referncia Rpida ADVPL Avanado
MATHC()
Funo utilizada para realizar operaes matemticas com strings que contm um valor numrico. MATHC() realiza algumas operaes matemticas como: Soma, Subtrao, Diviso, Multiplicao e Exponenciao.
A funo ir retornar uma string contendo o resultado da operao matemtica, com uma especificao de at 18 casas de preciso no numero.
E Sintaxe: MATHC ( < cNum1 > , < cOperacao > , < cNum2 > ) E Parmetros:
cNum1 String contendo um valor numrico, representando o numero no qual desejamos realizar uma operao. cOperacao Representa a string que indica a operao que desejamos realizar. Olhar na tabela para verificar quais valores devem ser informados aqui. cNum2 String contendo um valor numrico, representando o numero no qual desejamos realizar uma operao.
E Retorno:
Caracter Retorna uma nova string contendo o resultado matemtico da operao.
OEMTOANSI()
Funo que transforma uma string no Formato OEM / MS-DOS Text para uma string ANSI Text ( formato do Windows ).
Quando utilizamos um programa baseado no MS-DOS para alimentar uma base de dados , os acentos e caracteres especiais so gravados como texto OEM . Para tornar possvel a correta visualizao destes dados em uma interface Windows , utilizamos a funo OemToAnsi() para realizar a converso.
Ao utilizarmos um programa baseado no Windows para alimentar uma base de dados , o texto capturado no formato ANSI Text . Caso este texto seja utilizado para alimentar uma base de dados a ser acessada atravs de um programa MS-DOS , devemos converter o dado para OEM antes de grav-lo , atravs da funo AnsiToOem().
E Sintaxe: OemToAnsi ( < cStringOEM > ) E Parmetros:
cStringOEM String em formato OEM - MsDos a ser convertida.
E Retorno:
Caracter String convertida para ser exibida no Windows ( Formato ANSI ).
- 357 -
Guia de Referncia Rpida ADVPL Avanado
PADL() / PADR() / PADC()
Funes de tratamento de strings que inserem caracteres de preenchimento para completar um tamanho previamente especificado em vrios formatos como data ou numricos.
O PADC() centraliza <cExp>, adicionando caracteres de preenchimento direita e esquerda. O PADL() adiciona caracteres de preenchimento esquerda. O PADR() adiciona caracteres de preenchimento direita.
Caso o tamanho de <cExp> exceda o argumento <nTamanho>, todas as funes PAD() truncam string preenchida ao <nTamanho> especificado.
PADC(), PADL(), e PADR() so utilizadas para exibir cadeias de caracteres de tamanho varivel em uma rea de tamanho fixo. Elas podem ser usadas, por exemplo, para assegurar o alinhamento com comandos ?? consecutivos. Outra utilizao exibir textos em uma tela de tamanho fixo, para certificar-se de que o texto anterior foi completamente sobrescrito.
PADC(), PADL(), e PADR() so o contrrio das funes ALLTRIM(), LTRIM(), e LTRIM(), as quais eliminam espaos em branco esquerda e direita de cadeias de caracteres.
cExp Caractere, data, ou numrico no qual sero inseridos caracteres de preenchimento. nTamanho Tamanho da cadeia de caracteres a ser retornada. cCaracPreench Caractere a ser inserido em cExp. Caso no seja especificado, o padro o espao em branco.
E Retorno:
Caracter Retornam o resultado de <cExp> na forma de uma cadeia de caracteres preenchida com <cCaracPreench>, para totalizar o tamanho especificado por <nTamanho>.
RAT()
Retorna a ltima posio de um caracter ou string dentro de outra string especificada.
E Sintaxe: RAT(cCaractere, cString) E Parmetros
cCaractere Caractere ou string que se deseja verificar cString String na qual ser verificada a existncia do contedo de cCaractere.
- 358 -
Guia de Referncia Rpida ADVPL Avanado
REPLICATE()
A funo Replicate() utilizada para gerar uma cadeira de caracteres repetidos a partir de um caracter base informado, podendo a string gerada conter at 64KB. Caso seja especificado no parmetro de itens a repetir o nmero zero, ser retornada uma string vazia.
E Sintaxe: REPLICATE(cString, nCount)
E Parmetros:
cString Caracter que ser repetido nCount Quantidade de ocorrncias do caracter base que sero geradas na string de destino.
E Retorno:
cReplicated String contendo as ocorrncias de repeticao geradas para o caracter informado.
RETASC()
A funo Replicate() utilizada para converter uma string numrica em uma informao composta por letras e nmeros, devido a limitao no tamanho de campos ou variveis de controle, como o caso do campo de sistema X3_ORDEM.
E Sintaxe: RETASC(cString, nTamanho, lVolta)
E Parmetros:
cString String a ser convertida nTamanho Tamanho mximo da string de retorno lVolta Indica se ser gerada uma string composta por letras e nmeros a partir de uma string apenas numrica (.T.) ou se ser gerada uma string numrica a partir de uma string composta por letras e nmeros (.F.)
E Retorno:
Caracter String convertida conforme o parmetro lVolta.
Exemplo1 Converso de numrico para alfanumrico
cOrdem := 100
cX3Ordem := RETASC(cOrdem,2,.T.) <-- Ser retornado A0
Exemplo2 Converso de alfanumrico para numrico
cX3Ordem:= A0
cOrdem:= RETASC(cX3Ordem,3,.F.) <-- Ser retornado 100
- 359 -
Guia de Referncia Rpida ADVPL Avanado
RTRIM()
Funo para tratamento de caracteres utilizada para formatar cadeias de caracteres que contenham espaos em branco direita. Ela til quando voc deseja eliminar espaos em branco direita ao se concatenar cadeias de caracteres. o caso tpico com campos de banco de dados que so armazenados em formato de tamanho fixo. Por exemplo, voc pode usar RTRIM() para concatenar o primeiro e o ltimo campos de nome para formar uma cadeia de caracteres de nome.
LTRIM() relacionada a RTRIM(), que remove espaos em branco direita, e a ALLTRIM(), que remove espaos em branco direita e esquerda.
O contrrio de ALLTRIM(), LTRIM(), e RTRIM() so as funes PADC(), PADR(), e PADL(), as quais centralizam, alinham direita, ou alinham esquerda cadeias de caracteres, inserindo caracteres de preenchimento.
E Sintaxe: RTRIM ( < cString > ) --> cTrimString
E Parmetros:
cString <cString> a cadeia de caracteres a ser copiada sem os espaos em branco direita.
E Retorno:
Caracter
RTRIM() retorna uma cpia de <cString>, sendo que os espaos em branco direita foram removidos. Caso <cString> seja uma cadeia de caracteres nula ("") ou totalmente composta por espaos, RTRIM() retorna uma cadeia de caracteres nula ("").
SPACE()
Funo de tratamento de caracteres utilizada para retornar uma quantidade especificada de espaos. A utilizao desta funo tem o mesmo efeito que REPLICATE(' ', <nCont>), e normalmente utilizada para inicializar uma varivel do tipo caractere, antes que a mesma seja associada a um GET.
Sintaxe: SPACE ( < nCont > )
E Parmetros:
nCont A quantidade de espaos a serem retornados, sendo que o nmero mximo 65.535 (64K).
E Retorno:
Caracter Retorna uma cadeia de caracteres. Se <nCont> for zero, SPACE()retorna uma cadeia de caracteres nula ("").
- 360 -
Guia de Referncia Rpida ADVPL Avanado
STRTOKARR()
Funo utilizada para retornar um array, de acordo com os dados passados como parmetro para a funo. Esta funo recebe uma string <cValue> e um caracter <cToken> que representa um separador, e para toda ocorrncia deste separador em <cValue> adicionado um item no array.
E Sintaxe: STRTOKARR ( < cValue > , < cToken > )
E Parmetros:
cValue Representa a cadeia de caracteres no qual desejamos separar de acordo com <cToken>. cToken Representa o caracter que indica o separador em <cValue>.
E Retorno:
Array Array de caracteres que representa a string passada como parmetro.
cString Seqncia de caracteres ou campo memo a ser pesquisado. cSearch Seqncia de caracteres a ser procurada em cString. cReplace Seqncia de caracteres que deve substituir a string cSearch. Caso no seja especificado, as ocorrncias de cSearch em cString sero substitudas por uma string nula (""). nStart nStart corresponde ao nmero seqencial da primeira ocorrncia de cSEarch em cString a ser substituda por cReplace. Se este argumento for omitido , o default 1 ( um ) . Caso seja passado um numero menor que 1, a funo retornar uma string em branco (""). nCount nCount corresponde ao nmero mximo de trocas que dever ser realizada pela funo . Caso este argumento no seja especificado , o default substituir todas as ocorrncias encontradas.
E Retorno:
Code-Block
A funo STRTRAN retorna uma nova string, com as ocorrncias especificadas de cSearch trocadas para cReplace, conforme parametrizao.
- 361 -
Guia de Referncia Rpida ADVPL Avanado
STUFF()
Funo que 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.
E Sintaxe: STUFF(cString, nPosInicial, nExcluir, cAdicao)
E Parmetros:
cString A cadeia de caracteres destino na qual sero eliminados e inseridos caracteres. nPosInicial A posio inicial na cadeia de caracteres destino onde ocorre a insero/eliminao. nExcluir A quantidade de caracteres a serem eliminados. cAdicao A cadeia de caracteres a ser inserida.
E Retorno:
Caracter Retorna a nova string gerada pela funo com as modificaes.
Exemplo:
cLin := Space(100)+cEOL // Cria a string base cCpo := PADR(SA1->A1_FILIAL,02) // Informao que ser armazenada na string cLin := Stuff(cLin,01,02,cCpo) // Substitui o contedo de cCpo na string base
SUBSTR()
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).
E Sintaxe: SUBSTR(cString, nPosInicial, nCaracteres) E Parmetros
cString String que se deseja verificar nPosInicial Posio inicial da informao que ser extrada da string nCaracteres Quantidade de caracteres que dever ser retornada a partir daquele ponto (inclusive).
Funo de converso que formata valores caractere, data, lgicos e numricos conforme um string de mscara especificado, a qual inclui uma combinao de strings de template e funes de picture. Ela faz o mesmo que a clusula PICTURE do comando @...SAY, sendo normalmente utilizada para formatar dados a serem enviados tela ou impressora.
cExp O valor a ser formatado. Esta expresso pode ser qualquer tipo de dados vlidos, exceto vetor, bloco de cdigo, e NIL. cSayPicture Uma string de caracteres de mscara e template usado para descrever o formato da cadeia de caracteres a ser retornada.
E Retorno:
- Retorna a converso de <cExp> para uma cadeia de caracteres formatada conforme a definio em <cSayPicture>.
UPPER()
Retorna uma string com todos os caracteres maisculos, tendo como base a string passada como parmetro.
E Sintaxe: UPPER(cString) E Parmetros
cString String que ser convertida para caracteres maisculos.
Exemplo:
cTexto := ADVPL
MSGINFO(Texto:+LOWER(cTexto))
- 362 -
Guia de Referncia Rpida ADVPL Avanado
Manipulao de data / hora
CDOW()
Funo que converte uma data para uma cadeia de caracteres.
E Sintaxe: CDOW( dExp ) E Parmetros:
dExp Data que ser convertida.
E Retorno:
cDayWeek Nome do dia da semana como uma cadeia de caracteres. A primeira letra maiscula e as demais minsculas.
Funo de converso de datas usada para converter o valor data em um nmero inteiro que representa o dia do ms. Esta funo pode ser usada em conjunto com CMONTH() e YEAR() para formatar datas. Pode ser usada tambm em diversos clculos envolvendo datas.
E Sintaxe: DAY( dData ) E Parmetros:
dData Data que ser convertida.
E Retorno:
nDias Se o ms do argumento dData for fevereiro, anos bissextos so considerados. Se a data do argumento dData for 29 de fevereiro e o ano no for bissexto, ou se o argumento dData for vazio.
Exemplo: // Estes exemplos mostram a funo DAY() de diversas maneiras: dData := DATE() // Resultado: 09/01/01 nDia := DAY(DATE()) // Resultado: 1 nDia := DAY(DATE()) + 1 // Resultado: 2 nDia := DAY(CTOD("12/01/94")) // Resultado: 1 // Este exemplo mostra a funo DAY() usada em conjunto com CMONTH() e YEAR() para formatar o valor da data: dData := Date() cData := CMONTH(dData) + STR(DAY(dData)) + "," + STR(YEAR(dData)) // Resultado: June 15, 2001
- 365 -
Guia de Referncia Rpida ADVPL Avanado
DOW()
Funo que converte uma data para o valor numrico que representa o dia da semana. til quando se deseja fazer clculos semanais. DOW() similar a CDOW(), que retorna o dia da semana como uma cadeia de caracteres.
E Sintaxe: DOW( dData ) E Parmetros:
dData Data que ser convertida.
E Retorno:
nDia Retorna um nmero entre zero e sete, representando o dia da semana. O primeiro dia da semana 1 (Domingo) e o ltimo 7 (Sbado). Se a data for vazia ou invlida, DOW() retorna zero.
Funo para converso de uma data para uma cadeia de caracteres formatada segundo o padro corrente, definido pelo comando SET DATE. Se for necessria a utilizao de formatao especial, use a funo TRANSFORM().
Em expresses de ndices de arquivo, use DTOS() no lugar de DTOC() para converter datas para cadeia de caracteres.
E Sintaxe: DTOC( dData ) E Parmetros:
dData Data que ser convertida.
E Retorno:
cData uma cadeia de caracteres representando o valor da data. O retorno formatado utilizando-se o formato corrente definido pelo comando SET DATE FORMAT. O formato padro mm/dd/yy. Para uma data nula ou invlida, o retorno ser uma cadeia de caracteres com espaos e tamanho igual ao formato atual.
Funo para converso de uma data que pode ser usada para criar expresses de ndice. O resultado estruturado visando manter a ordem correta do ndice (ano, ms, dia).
E Sintaxe: DTOS( dData ) E Parmetros:
dData Data que ser convertida.
E Retorno:
sData Retorna uma cadeia de caracteres com oito byte de tamanho no formato yyyymmdd. Quando dData nulo ou invalido, DTOS() retorna uma cadeia de caracteres com oito espaos. O valor retornado no afetado pela formato da data corrente.
Funo que retorna uma cadeia de caracteres contendo a diferena de tempo no formato hh:mm:ss, onde hh a hora ( 1 a 24 ), mm os minutos e ss os segundos.
E Sintaxe: ElapTime( cHoraI nicial , cHoraFinal ) E Parmetros:
cHoraInicial Informe a hora inicial no formato hh:mm:ss, onde hh a hora ( 1 a 24 ), mm os minutos e ss os segundos CHoraFinal Informe a hora final no formato hh:mm:ss, onde hh a hora ( 1 a 24 ), mm os minutos e ss os segundos.
E Retorno:
Caracter A diferena de tempo no formato hh:mm:ss, onde hh a hora ( 1 a 24 ), mm os minutos e ss os segundos.
Esta funo retorna o nmero de segundos decorridos desde a meia-noite, segundo a hora do sistema. Est relacionada funo TIME() que retorna a hora do sistema como uma cadeia de caracteres no formato hh:mm:ss.
E Sintaxe: SECONDS() E Parmetros:
Nenhum .
E Retorno:
Numrico >=0 e <=86399 Retorna a hora do sistema em segundos. O valor numrico representa o nmero de segundos decorridos desde a meia-noite, baseado no relgio de 24 horas e varia de 0 a 86399.
//Este exemplo usa a funo SECONDS() para cronometrar o tempo decorrido:
LOCAL nStart, nElapsed nStart:= SECONDS()
- 368 -
Guia de Referncia Rpida ADVPL Avanado
TIME()
Funo que retorna a hora do sistema como uma cadeia de caracteres, e que est relacionada com SECONDS(), que retorna o valor inteiro representando o nmero de segundos desde a meia-noite. SECONDS() geralmente usada no lugar de TIME() para clculos.
E Sintaxe: TIME() E Parmetros:
Nenhum .
E Retorno:
Caracter A hora do sistema como uma cadeia de caracteres no formato hh:mm:ss onde hh a hora ( 1 a 24 ), mm os minutos e ss os segundos.
YEAR() uma funo de converso de data que extrai o valor numrico do ano. YEAR() membro de um grupo de funes que retornam valores numricos de uma data. O grupo inclui DAY() e MONTH() que retornam o dia e o ms como valores numricos.
E Sintaxe: YEAR( dData ) E Parmetros:
dData Data que ser convertida.
E Retorno:
Numrico Valor numrico do ano da data especificada em dData incluindo os dgitos do sculo. O valor retornado no afetado pelos valores especificados pelos comandos SET DATE ou SET CENTURY.
Para uma data invlida ou nula ser retornado o valor 0.
Gera um nmero aleatrio de acordo com a semente passada. Esta funo retorna um nmero aleatrio menor ou igual ao primeiro parmetro informado, usando como semente o segundo parmetro. recomendado que esta semente seja sempre o ltimo nmero aleatrio gerado por esta funo.
E Sintaxe: Aleatorio(nMax,nSeed) E Parmetros
nMax Nmero mximo para a gerao do nmero aleatrio nSeed Semente para a gerao do nmero aleatrio
- 370 -
Guia de Referncia Rpida ADVPL Avanado
Exemplo Funo ALEATORIO()
nSeed := 0 For i := 1 to 100 nSeed := Aleatorio(100,nSeed) ? Str(i,3)+ numero aleatorio gerado: +Str(nSeed,3) Next i inkey(0) Return
INT()
Retorna a parte inteira de um valor especificado no parmetro.
Retorna um valor, truncando a parte decimal do valor especificado no parmetro de acordo com a quantidade de casas decimais solicitadas.
E Sintaxe: NOROUND(nValor, nCasas) E Parmetros
nValor Valor que ser avaliado nCasas Nmero de casas decimais vlidas. A partir da casa decimal especificada os valores sero desconsiderados.
- 371 -
Guia de Referncia Rpida ADVPL Avanado
Exemplo Funo NOROUND()
nBase := 2.985 nValor := NOROUND(nBase,2) 2.98
RANDOMIZE()
Atravs da funo RANDOMIZE() , geramos um numero inteiro aleatrio, compreendido entre a faixa inferior e superior recebida atravs dos parmetros nMinimo e nMaximo, respectivamente.
Observao :
O O limite inferior recebido atravs do parmetro nMinimo "maior ou igual a ", podendo ser sorteado e fazer parte do retorno; porm o limite superior "menor que", de modo a nunca ser atingido ou devolvido no resultado. Por exemplo , a chamada da funo RANDOMIZE(1,2) sempre retornar 1 .
nMinimo Corresponde ao menor numero a ser gerado pela funo. nMaximo Corresponde ao maior nmero ( menos um ) a ser gerado pela funo.
E Retorno:
Numrico Numero randmico , compreendido no intervalo entre (nMinimo) e (nMaximo-1) : O numero gerado pode ser maior ou igual nMinimo e menor ou igual a nMaximo-1 .
ROUND()
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.
E Sintaxe: ROUND(nValor, nCasas) E Parmetros
nValor Valor que ser avaliado nCasas Nmero de casas decimais vlidas. As demais casas decimais sofrero o arredondamento matemtico, aonde:
Se nX <= 4 0, seno +1 para a casa decimal superior.
Exemplo:
nBase := 2.985 nValor := ROUND(nBase,2) 2.99
Manipulao de arquivos
ADIR()
Funo que preenche os arrays passados com os dados dos arquivos encontrados, atravs da mscara informada. Tanto arquivos locais (Remote) como do servidor podem ser informados.
Importante: ADir uma funo obsoleta, utilize sempre Directory().
cArqEspec Caminho dos arquivos a serem includos na busca de informaes. Segue o padro para especificao de arquivos, aceitando arquivos no servidor Protheus e no Cliente. Caracteres como * e ? so aceitos normalmente. Caso seja omitido, sero aceitos todos os arquivos do diretrio default ( *.* ). aNomeArq Array de Caracteres. o array com os nomes dos arquivos encontrados na busca.O contedo anterior do array apagado. aTamanho Array Numrico. So os tamanhos dos arquivos encontrados na busca. aData Array de Datas. So as datas de modificao dos arquivos encontrados na busca. aHora Array de Caracteres. So os horrios de modificao dos arquivos encontrados. Cada elemento contm horrio no formato: hh:mm:ss. aAtributos Array de Caracteres. So os atributos dos arquivos, caso esse array seja passado como parmetros, sero includos os arquivos com atributos de sistema e ocultos.
E Retorno:
nArquivos Quantidade de arquivos encontrados.
Exemplo:
LOCAL aFiles[ADIR("*.TXT")] ADIR("*.TXT", aFiles) AEVAL(aFiles, { |element| QOUT(element) })
- 372 -
Guia de Referncia Rpida ADVPL Avanado
CGETFILE()
Funo utilizada para seleo de um arquivo ou diretrio, disponibilizando uma interface grfica para amigvel para o usurio. Esta funo est normalmente associada ao recurso de abrir ou salvar arquivos, permitindo para esta ltima a digitao opcional do nome do arquivo que ser gravado.
ExpC1 Mascara para filtro (Ex: 'Informes Protheus (*.##R) | *.##R') ExpC2 Titilo da Janela ExpN1 Numero da mascara default ( Ex: 1 p/ *.exe ) ExpC3 Diretrio inicial se necessrio Expl1 .T. para mostrar boto como 'Salvar' e .F. para boto 'Abrir' ExpN2 Mascara de bits para escolher as opes de visualizao do Objeto. ExpL2 .T. para exibir diretrio [Servidor] e .F. para no exibir
E Mscaras de bits para opes:
GETF_OVERWRITEPROMPT Solicita confirmao para sobrescrever GETF_MULTISELECT Permite selecionar mltiplos arquivos GETF_NOCHANGEDIR No permite mudar o diretrio inicial GETF_LOCALFLOPPY Exibe o(s) Drive(s) de disquete da maquina local GETF_LOCALHARD Exibe o(s) HardDisk(s) Local(is) GETF_NETWORKDRIVE Exibe os drives da rede ( Mapeamentos ) GETF_SHAREWARE No implementado GETF_RETDIRECTORY Retorna um diretrio
Para permitir a seleo de diversos arquivos contidos em um diretrio necessrio combinar as funes CGETFILE(), DIRECTORY() e o objeto LISTBOX() conforme abaixo:
CGETFILE: exibe os diretrios disponveis e retorna o nome do item selecionado. DIRECTORY: efetua a leitura dos arquivos contidos no diretrio retornado pela CGETFILE. LISTBOX: Exibe uma tela de seleo de com a opo de marcao, para que sejam selecionados os arquivos que sero processados.
- 374 -
Guia de Referncia Rpida ADVPL Avanado
- 375 -
Guia de Referncia Rpida ADVPL Avanado
Exemplo: Seleo de mltiplos arquivos com CGETFILE, DIRECTORY() e LISTBOX()
Funo Principal: SELFILE()
#include "protheus.ch"
//+--------------------------------------------------------------------+ //| Rotina | SELFILE | Autor | ARNALDO R. JUNIOR | Data | 01.01.2007 | //+--------------------------------------------------------------------+ //| Descr. | Funo exemplo para seleo de mltiplos arquivos. | //+--------------------------------------------------------------------+ //| Uso | CURSO DE ADVPL | //+--------------------------------------------------------------------+
USER FUNCTION SELFILE()
LOCAL cDirectory := "" LOCAL aArquivos := {} LOCAL nArq := 0
PRIVATE aParamFile:= ARRAY(1)
IF !PARBOXFILE() RETURN ENDIF
// Exibe a estrutura de diretrio e permite a seleo dos arquivos que sero processados cDirectory := ALLTRIM(cGetFile("Arquivos de Dados|'"+aParamFile[1]+"'|", 'Importao de lanamentos', 0,'', .T., GETF_OVERWRITEPROMPT + GETF_NETWORKDRIVE + GETF_RETDIRECTORY,.T.)) aArquivos := Directory(cDirectory+"*.*") aArquivos := MARKFILE(aArquivos,cDirectory,aParamFile[1],@lSelecao)
FOR nArq TO Len(aArquivos)
IF !aArquivos[nArq][1] LOOP ENDIF
<...processamento...>
NEXT nArq
RETURN
- 376 -
Guia de Referncia Rpida ADVPL Avanado
Funo auxiliar: PARBOXFILE()
//+--------------------------------------------------------------------+ //| Rotina | PARBOXFILE | Autor | ARNALDO R. JUNIOR Data | 01.01.2007 | //+--------------------------------------------------------------------+ //| Descr. | Funo exemplo de uso da PARAMBOX em conjunto com CGETFILE| //+--------------------------------------------------------------------+ //| Uso | CURSO DE ADVPL | //+--------------------------------------------------------------------+
STATIC FUNCTION PARBOXFILE()
Local aParamBox := {} Local cTitulo := "Filtros Adicionais" Local aRet := {} Local bOk := {|| .T.} Local aButtons := {} Local lCentered := .T. Local nPosx Local nPosy Local cLoad := "" Local lCanSave := .F. Local lUserSave := .F. Local nX := 0 Local lRet := .T.
AADD(aParamBox,{2,"Tipo de arquivo" ,2,{"*.dbf","*.dtc"},100,"AllwaysTrue()",.T.})
IF ValType(aRet) == "A" .AND. Len(aRet) == Len(aParamBox) For nX := 1 to Len(aParamBox) If aParamBox[nX][1] == 1 aParam102[nX] := aRet[nX] ElseIf aParamBox[nX][1] == 2 .AND. ValType(aRet[nX]) == "C" aParam102[nX] := aRet[nX] // Tipo do arquivo ElseIf aParamBox[nX][1] == 2 .AND. ValType(aRet[nX]) == "N" aParam102[nX] := aParamBox[nX][4][aRet[nX]] // Tipo do arquivo Endif Next nX ENDIF
RETURN lRet
- 377 -
Guia de Referncia Rpida ADVPL Avanado
Funo auxiliar: MARKFILE()
//+--------------------------------------------------------------------+ //| Rotina | MARKFILE | Autor | ARNALDO R. JUNIOR | Data | 01.01.2007 | //+--------------------------------------------------------------------+ //| Descr. | Funo exemplo para marcao de mltiplos arquivos. | //+--------------------------------------------------------------------+ //| Uso | CURSO DE ADVPL | //+--------------------------------------------------------------------+
STATIC FUNCTION MARKFILE(aArquivos,cDiretorio,cDriver,lSelecao)
Local aChaveArq := {} Local cTitulo := "Arquivos para importao: " Local bCondicao := {|| .T.} // Variveis utilizadas na seleo de categorias Local oChkQual,lQual,oQual,cVarQ // Carrega bitmaps Local oOk := LoadBitmap( GetResources(), "LBOK") Local oNo := LoadBitmap( GetResources(), "LBNO") // Variveis utilizadas para lista de filiais Local nx := 0 Local nAchou := 0
//+--------------------------------------------------------------------+ //| Carrega os arquivos do diretrio no array da ListBox | //+--------------------------------------------------------------------+ For nX := 1 to Len(aArquivos) //+--------------------------------------------------------------------+ //| aChaveArq - Contem os arquivos que sero exibidos para seleo | //+--------------------------------------------------------------------+ AADD(aChaveArq,{.F.,aArquivos[nX][1],cDiretorio}) Next nX
//+--------------------------------------------------------------------+ //| Monta tela para seleo dos arquivos contidos no diretrio | //+--------------------------------------------------------------------+ DEFINE MSDIALOG oDlg TITLE cTitulo STYLE DS_MODALFRAME From 145,0 To 445,628; OF oMainWnd PIXEL oDlg:lEscClose := .F. @ 05,15 TO 125,300 LABEL UPPER(cDriver) OF oDlg PIXEL @ 15,20 CHECKBOX oChkQual VAR lQual PROMPT "Inverte Seleo" SIZE 50, 10; OF oDlg PIXEL; ON CLICK (AEval(aChaveArq, {|z| z[1] := If(z[1]==.T.,.F.,.T.)}),; oQual:Refresh(.F.)) @ 30,20 LISTBOX oQual VAR cVarQ Fields HEADER "","Cdigo","Descrio" SIZE; 273,090 ON DBLCLICK (aChaveArq:=Troca(oQual:nAt,aChaveArq),oQual:Refresh()); NoScroll OF oDlg PIXEL oQual:SetArray(aChaveArq) oQual:bLine := { || {If(aChaveArq[oQual:nAt,1],oOk,oNo),; aChaveArq[oQual:nAt,2],aChaveArq[oQual:nAt,3]}} DEFINE SBUTTON FROM 134,240 TYPE 1 ACTION IIF(MarcaOk(aChaveArq),; (lSelecao := .T., oDlg:End(),.T.),.F.) ENABLE OF oDlg DEFINE SBUTTON FROM 134,270 TYPE 2 ACTION (lSelecao := .F., oDlg:End()); ENABLE OF oDlg ACTIVATE MSDIALOG oDlg CENTERED
RETURN aChaveArq
Funo auxiliar: TROCA()
//+--------------------------------------------------------------------+ //| Rotina | TROCA | Autor | ARNALDO R. JUNIOR | Data | 01.01.2007 | //+--------------------------------------------------------------------+ //| Uso | CURSO DE ADVPL | //+--------------------------------------------------------------------+
STATIC FUNCTION Troca(nIt,aArray) aArray[nIt,1] := !aArray[nIt,1] Return aArray
Funo auxiliar: MARCAOK()
//+--------------------------------------------------------------------+ //| Rotina | MARCAOK | Autor | ARNALDO R. JUNIOR | Data | 01.01.2007 | //+--------------------------------------------------------------------+ //| Uso | CURSO DE ADVPL | //+--------------------------------------------------------------------+
STATIC FUNCTION MarcaOk(aArray) Local lRet:=.F. Local nx:=0
// Checa marcaes efetuadas For nx:=1 To Len(aArray) If aArray[nx,1] lRet:=.T. EndIf Next nx // Checa se existe algum item marcado na confirmao If !lRet HELP("SELFILE",1,"HELP","SEL. FILE","No existem itens marcados",1,0) EndIf
Return lRet
- 378 -
Guia de Referncia Rpida ADVPL Avanado
- 379 -
Guia de Referncia Rpida ADVPL Avanado
CPYS2T()
Funo utilizada para copiar um arquivo do servidor para o cliente (Remote), sendo que os caracteres * e ? so aceitos normalmente. Caso a compactao seja habilitada (lCompacta), os dados sero transmitidos de maneira compacta e descompactados antes do uso. E Sintaxe: CPYS2T ( < cOrigem > , < cDestino > , [ lCompacta ] ) E Parmetros:
cOrigem Nome(s) dos arquivos a serem copiados, aceita apenas arquivos no servidor, WildCards ( * e ? ) so aceitos normalmente. cDestino Diretrio com o destino dos arquivos no Client ( Remote ). lCompacta Indica se a cpia deve ser feita compactando o arquivo antes do envio.
E Retorno:
Lgico
lSucess retorna .T. caso o arquivo seja copiado com sucesso , ou .F. em caso de falha na cpia.
Exemplo: // Copia arquivos do servidor para o remote local, compactando antes de transmitir CpyS2T( "\BKP\MANUAL.DOC", "C:\TEMP", .T. ) // Copia arquivos do servidor para o remote local, sem compactar antes de transmitir CpyS2T( "\BKP\MANUAL.DOC", "C:\TEMP", .F. )
CPYT2S()
Funo utilizada para copiar um arquivo do cliente (Remote) para o servidor, sendo que os caracteres * e ? so aceitos normalmente. Caso a compactao seja habilitada (lCompacta), os dados sero transmitidos de maneira compacta e descompactados antes do uso. E Sintaxe: CpyT2S( cOrigem, cDestino, [ lCompacta ]) E Parmetros:
cOrigem Nomes dos arquivos a serem copiados, aceita apenas arquivos locais ( Cliente ), WildCards so aceitos normalmente. cDestino Diretrio com o destino dos arquivos no remote ( Cliente ). lCompacta Indica se a cpia deve ser feita compactando o arquivo antes.
E Retorno:
Lgico Indica se o arquivo foi copiado para o cliente com sucesso.
Exemplo: // Copia arquivos do cliente( remote ) para o Servidor compactando antes de transmitir CpyT2S( "C:\TEMP\MANUAL.DOC", "\BKP", .T. ) // Copia arquivos do cliente( remote ) para o Servidor sem compactar. CpyT2S( "C:\TEMP\MANUAL.DOC", "\BKP" )
CURDIR()
Funo que retorna o diretrio corrente do servidor. O caminho retornado sempre relativo ao RootPath definido na configurao do Environment no .INI do Protheus Server. Inicialmente , o diretrio atual da aplicao o constante na chave StartPath , tambm definido na configurao do Environment no .INI do Protheus Server.
Caso seja passado o parmetro cNovoPath , este path assumido como sendo o Path atual. Caso o path recebido como parmetro no exista , seja invlido , ou seja um path absoluto (iniciado com uma letra de drive ou caminho de rede), a funo no ir setar o novo path, mantendo o atual .
E Sintaxe: CURDIR ( [ cNovoPath ] )
E Parmetros:
cNovoPath Caminho relativo , com o novo diretrio que ser ajustado como corrente.
E Retorno:
Caracter Diretrio corrente, sem a primeira barra.
Exemplo:
cOldDir := curdir() cNewDir := '\webadv\xis' curdir(cNewDir) // Troca o path If cNewDir <> '\'+curdir() // E verifica se trocou mesmo conout('Falha ao Trocar de Path de '+cOldDir + ' para '+cNewDir) Else conout('Path de '+cOldDir + ' trocado para '+cNewDir+' com sucesso.') Endif
- 380 -
Guia de Referncia Rpida ADVPL Avanado
- 381 -
Guia de Referncia Rpida ADVPL Avanado
DIRECTORY()
Funo de tratamento de ambiente que retorna informaes a respeito dos arquivos no diretrio corrente ou especificado. semelhante a ADIR(), porm retorna um nico vetor ao invs de adicionar valores a uma srie de vetores existentes passados por referncia.
DIRECTORY() pode ser utilizada para realizar operaes em conjuntos de arquivos. Em combinao com AEVAL(), voc pode definir um bloco que pode ser aplicado a todos os arquivos que atendam a <cDirSpec> especificada.
Para tornar as referncias aos vrios elementos de cada sub-vetor de arquivo mais legveis, fornecido o arquivo header Directry.ch, que contm os #defines para os subarray subscripts.
E TABELA A: Atributos de DIRECTORY()
Atributo Significado H Incluir arquivos ocultos S Incluir arquivos de sistema D Incluir diretrios V Procura pelo volume DOS e exclui outros arquivos
Nota: Arquivos normais so sempre includos na pesquisa, a no ser que V seja especificado. E TABELA B: Estrutura dos Subvetores de DIRECTORY()
<cDirSpec> especifica o drive, diretrio e arquivo para a pesquisa no diretrio. Caracteres do tipo coringa so permitidos na especificao de arquivos. Caso <cDirSpec> seja omitido, o valor padro *.*. O caminho especificado pode estar na estao (remote) , ou no servidor, obedecendo s definies de Path Absoluto / Relativo de acesso. cAtributos> <cAtributos> especifica que arquivos com atributos especiais devem ser includos na informao retornada. <cAtributos> consiste em uma cadeia de caracteres que contm um ou mais dos seguintes caracteres, contidos na tabela adicional A , especificada anteriormente.
- 382 -
Guia de Referncia Rpida ADVPL Avanado
E Retorno:
Array
DIRECTORY() retorna um vetor de sub-vetores, sendo que cada sub-vetor contm informaes sobre cada arquivo que atenda a <cDirSpec>.Veja maiores detalhes na Tabela B, discriminada anteriormente.
Funo que elimina um diretrio especifico. Caso especifiquemos um path sem a unidade de disco , ele ser considerado no ambiente do Servidor , a partir do RootPath do ambiente ( caso o path comece com \ ), ou a partir do diretrio corrente (caso o path no seja iniciado com \ ).
Quando especificado um path absoluto ( com unidade de disco preenchida ), a funo ser executada na estao onde est sendo executado o Protheus Remote. Quando executamos a funo DirRemove() em JOB ( processo isolado no Server , sem interface ), no possvel especificar um Path absoluto de disco. Caso isto seja realizado , a funo retornar .F. e FError() retornar -1 ( Syntax Error ).
Note que necessrio ter direitos suficientes para remover um diretrio, e o diretrio a ser eliminado precisa estar vazio, sem subdiretrios ou arquivos dentro do mesmo.
E Sintaxe: DIRREMOVE ( < cDiretorio > )
E Parmetros:
cDiretorio Nome do diretrio a ser removido.
E Retorno:
Lgico lSucesso ser .T. caso o diretrio tenha sido eliminado , ou .F. caso no seja possvel excluir o diretrio. Quando a funo DirRemove retornar .F. , possvel obter mais detalhes da ocorrncia recuperando o cdigo do Erro atravs da funo FError().
IF !lRemoveOk MsgStop('Falha ao remover a pasta '+cDelPath+' ( File Error '+str(Fewrror(),4)+' ) ') Else MsgStop('Pasta '+cDelPath+' removida com sucesso.') Endif
- 383 -
Guia de Referncia Rpida ADVPL Avanado
DISKSPACE()
Funo de ambiente que determina quantos bytes esto disponveis em uma determinada unidade de disco. Esta funo obtm a informao sempre relativa estao onde est sendo executado o Protheus Remote. Atravs do parmetro nDrive , selecionamos qual a unidade de disco que desejamos obter a informao do espao livre , onde:
0 : Unidade de disco atual da estao (DEFAULT). 1 : Drive A: da estao remota. 2 : Drive B: da estao remota. 3 : Drive C: da estao remota. 4 : Drive D: da estao remota ... e assim por diante.
Caso a funo DiskSpace seja executada atravs de um Job ( processo isolado no Servidor , sem interface Remota ) , ou seja passado um argumento de unidade de disco inexistente ou indisponvel , a funo DISKSPACE() retornar -1
E Sintaxe: DISKSPACE ( [ nDrive ] )
E Parmetros:
nDrive Nmero do drive, onde 0 o espao na unidade de disco corrente, e 1 o drive A: do cliente, 2 o drive B: do cliente, etc.
E Retorno:
Numrico Nmero de bytes disponveis no disco informado como parmetro.
Exemplo:
nBytesLocal := DISKSPACE( ) // Retorna o espao disponvel na unidade de disco local
IF nBytesLocal < 1048576 MsgStop('Unidade de Disco local possui menos de 1 MB livre.') Else MsgStop('Unidade de disco local possui '+str(nBytes_A,12)+' bytes livres.') Endif nBytes_A := DISKSPACE( 1 ) // Retorna o espao disponvel no drive A: local ( remote ).
If nBytes_A == -1 MsgStop('Unidade A: no est disponvel ou no h disco no Drive') ElseIf nBytes_A < 8192 MsgStop('No h espao disponvel no disco. Substitua o disco na Unidade A:') Else MsgStop('Unidade A: Verificada . '+str(nBytes_A,12)+' bytes livres.') Endif
- 384 -
Guia de Referncia Rpida ADVPL Avanado
EXISTDIR()
Funo utilizada para determinar se um path de diretrio existe e valido.
E Sintaxe: EXISTDIR (< cPath >)
E Parmetros:
cPath String contendo o diretrio que ser verificado, caso seja feita uma verificao a partir do server, devemos informar a partir do rootPath do Protheus, caso contrrio devemos passar o path completo do diretrio.
E Retorno:
Lgico Retorna se verdadeiro(.T.) caso o diretrio solicitado exista, falso(.F.) caso contrrio.
Exemplo 01: No server a partir do rootPath
lRet := ExistDir('\teste')
Exemplo 02: No client, passando o FullPath
lRet := ExistDir('c:\APO')
FCLOSE()
Funo de tratamento de arquivos de baixo nvel utilizada para fechar arquivos binrios e forar que os respectivos buffers do DOS sejam escritos no disco. Caso a operao falhe, FCLOSE() retorna falso (.F.). FERROR() pode ento ser usado para determinar a razo exata da falha. Por exemplo, ao tentar-se usar FCLOSE() com um handle (tratamento dado ao arquivo pelo sistema operacional) invlido retorna falso (.F.) e FERROR() retorna erro 6 do DOS, invalid handle. Consulte FERROR() para obter uma lista completa dos cdigos de erro.
Nota: Esta funo permite acesso de baixo nvel aos arquivos e dispositivos do DOS. Ela deve ser utilizada com extremo cuidado e exige que se conhea a fundo o sistema operacional utilizado.
E Sintaxe: FCLOSE ( < nHandle > )
E Parmetros:
nHandle Handle do arquivo obtido previamente atravs de FOPEN() ou FCREATE().
E Retorno:
Lgico Retorna falso (.F.) se ocorre um erro enquanto os buffers esto sendo escritos; do contrrio, retorna verdadeiro (.T.).
- 385 -
Guia de Referncia Rpida ADVPL Avanado
Exemplo:
#include "Fileio.ch"
nHandle := FCREATE("Testfile", FC_NORMAL)
If !FCLOSE(nHandle) conout( "Erro ao fechar arquivo, erro numero: ", FERROR() ) EndIf
FCREATE()
Funo de baixo-nvel que permite a manipulao direta dos arquivos textos como binrios. Ao ser executada FCREATE() cria um arquivo ou elimina o seu contedo, e retorna o handle (manipulador) do arquivo, para ser usado nas demais funes de manuteno de arquivo. Aps ser utilizado , o Arquivo deve ser fechado atravs da funo FCLOSE().
Na tabela abaixo , esto descritos os atributos para criao do arquivo , definidos no arquivo header fileio.ch
E Atributos definidos no include FileIO.ch
Constante Valor Descrio FC_NORMAL 0 Criao normal do Arquivo (default/padro). FC_READONLY 1 Cria o arquivo protegido para gravao. FC_HIDDEN 2 Cria o arquivo como oculto. FC_SYSTEM 4 Cria o arquivo como sistema.
Caso desejemos especificar mais de um atributo , basta som-los . Por exemplo , para criar um arquivo protegido contra gravao e escondido , passamos como atributo FC_READONLY + FC_HIDDEN. .
Nota: Caso o arquivo j exista , o contedo do mesmo ser ELIMINADO , e seu tamanho ser truncado para 0 ( ZERO ) bytes.
cArquivo Nome do arquivo a ser criado , podendo ser especificado um path absoluto ou relativo , para criar arquivos no ambiente local ( Remote ) ou no Servidor, respectivamente . nAtributo Atributos do arquivo a ser criado (Vide Tabela de atributos abaixo). Caso no especificado, o DEFAULT FC_NORMAL.
E Retorno:
Numrico
A funo retornar o Handle do arquivo para ser usado nas demais funes de manuteno de arquivo. O Handle ser maior ou igual a zero. Caso no seja possvel criar o arquivo , a funo retornar o handle -1 , e ser possvel obter maiores detalhes da ocorrncia atravs da funo FERROR() .
- 386 -
Guia de Referncia Rpida ADVPL Avanado
FERASE()
Funo utilizada para apagar um arquivo no disco . O Arquivo pode estar no Servidor ou na estao local (Remote). O arquivo para ser apagado deve estar fechado, no sendo permitido a utilizao de caracteres coringa (wildcards).
E Sintaxe: FERASE ( < cArquivo > )
E Parmetros:
cArquivo Nome do arquivo a ser apagado . Pode ser especificado um path absoluto ou relativo , para apagar arquivos na estao local ( Remote ) ou no Servidor, respectivamente.
E Retorno:
Numrico A funo retornar 0 caso o arquivo seja apagado com sucesso , e -1 caso no seja possvel apagar o arquivo. Caso a funo retorne -1, possvel obter maiores detalhes da ocorrncia atravs da funo FERROR().
// Este exemplo apaga um arquivo no cliente ( Remote ) , informando o status da operao IF FERASE("C:\ListaTXT.tmp") == -1 MsgStop('Falha na deleo do Arquivo ( FError'+str(ferror(),4)+ ')') Else MsgStop('Arquivo deletado com sucesso.') ENDIF
FILE()
Funo que verifica se existe um arquivo ou um padro de arquivos, no diretrio. Podem ser especificados caminhos absolutos ( arquivos na estao - Remote ) ou relativos ( a partir do RootPath do Protheus Server) , sendo os caracteres * e ? ( wildcards) aceitos.
E Sintaxe: FILE ( < cArquivo > )
E Parmetros:
cArquivo Nome do arquivo , podendo ser especificado um path (caminho) . Caminhos locais (Remote) ou caminhos de servidor so aceitos , bem como wildcards (Caracteres * e ? ).
E Retorno:
Lgico O retorno ser .T. caso o arquivo especificado exista. Caso o mesmo no exista no path especificado , a funo retorna .F.
Exemplo:
//Verifica no diretrio corrente do servidor se existe o arquivo teste.dbf FILE("teste.dbf")
// Verifica no diretrio Sigaadv do servidor se existe o arquivo teste.dbf FILE("\SIGAADV\TESTE.dbf")
// Verifica no diretrio Temp do cliente (Remote) se existe o arquivo teste.dbf FILE("C:\TEMP\TESTE.dbf")
Caso a funo FILE() seja executada em Job ( programa sem interface remota ), sendo passado um caminho absoluto de arquivo (exemplo c:\teste.txt) , a funo retornar .F. e FERROR() retornar -1 ).
FILENOEXT()
Funo que retorna o nome de um arquivo contido em uma string, ignorando a extenso.
Funo de tratamento de arquivo de baixo nvel que abre um arquivo binrio existente para que este possa ser lido e escrito, dependendo do argumento <nModo>. Toda vez que houver um erro na abertura do arquivo, FERROR() pode ser usado para retornar o cdigo de erro do Sistema Operacional. Por exemplo, caso o arquivo no exista, FOPEN() retorna -1 e FERROR() retorna 2 para indicar que o arquivo no foi encontrado. Veja FERROR() para uma lista completa dos cdigos de erro.
Caso o arquivo especificado seja aberto, o valor retornado o handle (manipulador) do Sistema Operacional para o arquivo. Este valor semelhante a um alias no sistema de banco de dados, e ele exigido para identificar o arquivo aberto para as outras funes de tratamento de arquivo. Portanto, importante sempre atribuir o valor que foi retornado a uma varivel para uso posterior, como mostra o exemplo desta funo.
Nota: Esta funo permite acesso de baixo nvel a arquivos e dispositivos. Ela deve ser utilizada com extremo cuidado e exige que se conhea a fundo o sistema operacional utilizado.
FOPEN procura o arquivo no diretrio corrente e nos diretrios configurados na varivel de pesquisa do Sistema Operacional, a no ser que um path seja declarado explicitamente como parte do argumento <cArq>.
Por serem executadas em um ambiente cliente-servidor, as funes de tratamento de arquivos podem trabalhar em arquivos localizados no cliente (estao) ou no servidor. O ADVPL identifica o local onde o arquivo ser manipulado atravs da existncia ou no da letra do drive no nome do arquivo passado em <cArq>. Ou seja, se o arquivo for especificado com a letra do drive, ser aberto na estao. Caso contrrio, ser aberto no servidor com o diretrio configurado como rootpath sendo o diretrio raiz para localizao do arquivo.
E Sintaxe: FOPEN ( < cArq > , [ nModo ] )
E Parmetros:
cArq Nome do arquivo a ser aberto que inclui o path caso haja um. nModo Modo de acesso DOS solicitado que indica como o arquivo aberto deve ser acessado. O acesso de uma das categorias relacionadas na tabela A e as restries de compartilhamento relacionada na Tabela B. O modo padro zero, somente para leitura, com compartilhamento por Compatibilidade. Ao definirmos o modo de acesso , devemos somar um elemento da Tabela A com um elemento da Tabela B.
E Retorno:
Numrico FOPEN() retorna o handle de arquivo aberto na faixa de zero a 65.535. Caso ocorra um erro, FOPEN() retorna -1.
- 388 -
Guia de Referncia Rpida ADVPL Avanado
Exemplo:
#include 'fileio.ch' ... nH := fopen('\sigaadv\error.log' , FO_READWRITE + FO_SHARED ) If nH == -1 MsgStop('Erro de abertura : FERROR '+str(ferror(),4)) Else MsgStop('Arquivo aberto com sucesso.') ... fclose(nH) Endif ...
E Tabela A: Modos de acesso a arquivos binrios
Modo Constate(fileio.ch) Operao 0 FO_READ Aberto para leitura (padro assumido) 1 FO_WRITE Aberto para gravao 2 FO_READWRITE Aberto para leitura e gravao
E Tabela B: Modos de acesso de compartilhamento a arquivos binrios
Modo Constate(fileio.ch) Operao 0 FO_COMPAT Modo de Compatibilidade (Default) 16 FO_EXCLUSIVE Acesso total exclusivo 32 FO_DENYWRITE Acesso bloqueando a gravao de outros processos ao arquivo. 48 FO_DENYREAD Acesso bloqueando a leitura de outros processos ao arquivo. 64 FO_DENYNONE Acesso compartilhado. Permite a leitura e gravao por outros.
- 389 -
Guia de Referncia Rpida ADVPL Avanado
- 390 -
Guia de Referncia Rpida ADVPL Avanado
FREAD()
Funo que realiza a leitura dos dados a partir um arquivo aberto, atravs de FOPEN(), FCREATE() e/ou FOPENPORT(), e armazena os dados lidos por referncia no buffer informado. FREAD() ler at o nmero de bytes informado em nQtdBytes; caso acontea algum erro ou o arquivo chegue ao final, FREAD() retornar um nmero menor que o especificado em nQtdBytes. FREAD() l normalmente caracteres de controle (ASC 128, ASC 0, etc.) e l a partir da posio atual do ponteiro atual do arquivo , que pode ser ajustado ou modificado pelas funes FSEEK() , FWRITE() ou FREADSTR().
A varivel String a ser utilizada como buffer de leitura deve ser sempre pr-alocado e passado como referncia. Caso contrrio, os dados no podero ser retornados.
nHandle o manipulador (Handle) retornado pelas funes FOPEN(), FCREATE(), FOPENPORT(), que faz referncia ao arquivo a ser lido. cBuffer o nome de uma varivel do tipo String , a ser utilizada como buffer de leitura , onde os dados lidos devero ser armazenados. O tamanho desta varivel deve ser maior ou igual ao tamanho informado em nQtdBytes. Esta varivel deve ser sempre passada por referncia. ( @ antes do nome da varivel ), caso contrrio os dados lidos no sero retornados. nQtdBytes Define a quantidade de Bytes que devem ser lidas do arquivo a partir posicionamento do ponteiro atual.
E Retorno:
Numrico Quantidades de bytes lidos. Caso a quantidade seja menor que a solicitada, isto indica erro de leitura ou final de arquivo, Verifique a funo FERROR() para maiores detalhes.
FREADSTR ()
Funo que realiza a leitura de caracteres de um arquivo binrio. FREADSTR() l de um arquivo aberto, atravs de FOPEN(), FCREATE(), FOPENPORT(). FREADSTR() ler at o nmero de bytes informado em nQtdBytes ou at encontrar um CHR(0). Caso acontea algum erro ou o arquivo chegue ao final, FREADSTR() retornar uma string menor do que nQdBytes e colocar o erro em FERROR(). FREADSTR() l a partir da posio atual do ponteiro, que pode ser ajustado pelo FSEEK(), FWRITE( ) ou FREAD().
nHandle o manipulador retornado pelas funes FOPEN(), FCREATE(), FOPENPORT(). nQtdBytes Nmero mximo de bytes que devem ser lidos.
E Retorno:
Caracter Retorna uma string contendo os caracteres lidos.
FRENAME()
Atravs da funo FRENAME() possvel renomear um arquivo para outro nome, tanto no servidor como na estao. Ao renomear um arquivo no esquea que esta arquivo dever estar fechado ( isto , no pode estar em uso por nenhum outro processo ou estao). Caso o arquivo esteja aberto por outro processo , a operao de renomear o arquivo no possvel. A funo fRename() no aceita wildcards ( * e/ou ? ).
Vale lembrar que no possvel renomear um arquivo especificando nos parmetros simultaneamente um caminho de servidor e um de estao remota, bem como especificar dois arquivos remotos e executar a funo fRename() atravs de um JOB. Caso isto ocorra, a funo retornar -1 , e fError() retornar tambm -1.
Quando especificamos um path diferente nos arquivos de origem e destino , a funo fRename() realiza a funcionalidade de MOVER o arquivo para o Path especificado.
cOldFile Nome do arquivo ser renomeado, aceita caminhos do servidor e caminhos do cliente. Caso no seja especificado nenhuma unidade de disco e path, considerado o path atual no servidor. cNewFile Novo nome do arquivo, aceita tambm caminho do servidor, e caminho do cliente.
E Retorno:
Numrico Se o status retornado for -1 , ocorreu algum erro na mudana de nome : Verifique se os dois caminhos esto no mesmo ambiente, verifique a existncia do arquivo de origem, se ele no est em uso no momento por outro processo , e verifique se o nome do arquivo de destino j no existe no path de destino especificado.
- 391 -
Guia de Referncia Rpida ADVPL Avanado
- 392 -
Guia de Referncia Rpida ADVPL Avanado
FSEEK()
Funo que posiciona o ponteiro do arquivo para as prximas operaes de leitura ou gravao. As movimentaes de ponteiros so relativas nOrigem que pode ter os seguintes valores, definidos em fileio.ch:
E Tabela A: Origem a ser considerada para a movimentao do ponteiro de posicionamento do Arquivo.
Origem Constate(fileio.ch) Operao 0 FS_SET Ajusta a partir do inicio do arquivo. (Default) 1 FS_RELATIVE Ajuste relativo a posio atual do arquivo. 2 FS_END Ajuste a partir do final do arquivo.
nHandle Manipulador obtido atravs das funes FCREATE,FOPEN. nOffSet nOffSet corresponde ao nmero de bytes no ponteiro de posicionamento do arquivo a ser movido. Pode ser um numero positivo , zero ou negativo, a ser considerado a partir do parmetro passado em nOrigem. nOrigem Indica a partir de qual posio do arquivo, o nOffset ser considerado.
E Retorno:
Numrico FSEEK() retorna a nova posio do ponteiro de arquivo com relao ao incio do arquivo (posio 0) na forma de um valor numrico inteiro. Este valor no leva em conta a posio original do ponteiro de arquivos antes da execuo da funo FSEEK().
FT_FEOF()
Funo que retorna verdadeiro (.t.) se o arquivo texto aberto pela funo FT_FUSE() estiver posicionado no final do arquivo, similar funo EOF() utilizada para arquivos de dados.
E Sintaxe: FT_FEOF( )
E Parmetros:
Nenhum .
E Retorno:
Lgico Retorna true caso o ponteiro do arquivo tenha chegado ao final, false caso contrrio.
FT_FGOTO()
Funo utilizada para mover o ponteiro, que indica a leitura do arquivo texto, para a posio absoluta especificada pelo argumento <nPos>.
E Sintaxe: FT_FGOTO ( < nPos > )
E Parmetros:
nPos Indica a posio que ser colocado o ponteiro para leitura dos dados no arquivo.
E Retorno:
Nenhum .
FT_FGOTOP()
A funo tem como objetivo mover o ponteiro, que indica a leitura do arquivo texto, para a posio absoluta especificada pelo argumento <nPos>.
E Sintaxe: FT_FGOTO ( < nPos > )
E Parmetros:
nPos Indica a posio que ser colocado o ponteiro para leitura dos dados no arquivo.
E Retorno:
Nenhum .
FT_FLASTREC()
Funo que retorna o nmero total de linhas do arquivo texto aberto pela FT_FUse. As linhas so delimitadas pela seqncia de caracteres CRLF o LF.
Verifique maiores informaes sobre formato do arquivo e tamanho mximo da linha de texto na funo FT_FREADLN().
E Sintaxe: FT_FLASTREC( )
E Parmetros:
Nenhum .
E Retorno:
Numrico Retorna a quantidade de linhas existentes no arquivo. Caso o arquivo esteja vazio, ou no exista arquivo aberto, a funo retornar 0 (zero).
- 393 -
Guia de Referncia Rpida ADVPL Avanado
Exemplo:
FT_FUse('teste.txt') // Abre o arquivo CONOUT("Linhas no arquivo ["+str(ft_flastrec(),6)+"]") FT_FGOTOP() While !FT_FEof() conout("Ponteiro ["+str(FT_FRECNO(),6)+"] Linha ["+FT_FReadln()+"]") FT_FSkip() Enddo FT_FUse() // Fecha o arquivo
FT_FREADLN()
Funo que retorna uma linha de texto do arquivo aberto pela FT_FUse. As linhas so delimitadas pela seqncia de caracteres CRLF ( chr(13) + chr(10) ) , ou apenas LF ( chr(10 ), e o tamanho mximo de cada linha 1022 bytes.
- 394 -
Guia de Referncia Rpida ADVPL Avanado
A utilizao desta funo no altera a posio do ponteiro para leitura dos dados, o ponteiro do arquivo no movido. A movimentao do ponteiro realizada atravs da funo FT_FSKIP() O limite de 1022 bytes por linha inclui os caracteres delimitadores de final de linha. Deste modo, quando utilizados os separadores CRLF, isto nos deixa 1020 bytes de texto, e utilizando LF, 1021 bytes. A tentativa de leitura de arquivos com linhas de texto maiores do que os valores especificados acima resultar na leitura dos 1023 primeiros bytes da linha, e incorreta identificao das quebras de linha posteriores. As funes FT_F* foram projetadas para ler arquivos com contedo texto apenas. A utilizao das mesmas em arquivos binrios pode gerar comportamentos inesperados na movimentao do ponteiro de leitura do arquivo, e incorretas identificaes nos separadores de final de linha.
Release: Quando utilizado um Protheus Server, com build superior a 7.00.050713P, a funo FT_FREADLN() tambm capaz de ler arquivos texto / ASCII, que utilizam tambm o caractere LF ( chr(10) ) como separador de linha.
E Sintaxe: FT_FREADLN( )
E Parmetros:
Nenhum .
E Retorno:
Caracter Retorna a linha inteira na qual est posicionado o ponteiro para leitura de dados.
FT_FRECNO()
A funo tem o objetivo de retornar a posio do ponteiro do arquivo texto. A funo FT_FRecno retorna a posio corrente do ponteiro do arquivo texto aberto pela FT_FUse.
E Sintaxe: FT_FRECNO ( ) E Parmetros:
Nenhum .
E Retorno:
Caracter Retorna a posio corrente do ponteiro do arquivo texto.
FT_FSKIP()
Funo que move o ponteiro do arquivo texto aberto pela FT_FUSE() para a prxima linha, similar ao DBSKIP() usado para arquivos de dados.
E Sintaxe: FT_FSKIP ( [ nLinhas ] ) E Parmetros:
nLinhas nLinhas corresponde ao nmero de linhas do arquivo TXT ref. movimentao do ponteiro de leitura do arquivo.
E Retorno
Nenhum .
FT_FUSE()
Funo que abre ou fecha um arquivo texto para uso das funes FT_F*. As funes FT_F* so usadas para ler arquivos texto, onde as linhas so delimitadas pela seqncia de caracteres CRLF ou LF (*) e o tamanho mximo de cada linha 1022 bytes.. O arquivo aberto em uma rea de trabalho, similar usada pelas tabelas de dados.
Verifique maiores informaes sobre formato do arquivo e tamanho mximo da linha de texto na funo FT_FREADLN().
E Sintaxe: FT_FUSE ( [ cTXTFile ] ) E Parmetros:
cTXTFile Corresponde ao nome do arquivo TXT a ser aberto. Caso o nome no seja passado, e j exista um arquivo aberto. o mesmo fechado.
E Retorno:
Numrico A funo retorna o Handle de controle do arquivo. Em caso de falha de abertura, a funo retornar -1
- 395 -
Guia de Referncia Rpida ADVPL Avanado
- 396 -
Guia de Referncia Rpida ADVPL Avanado
FWRITE()
Funo que permite a escrita em todo ou em parte do contedo do buffer , limitando a quantidade de Bytes atravs do parmetro nQtdBytes. A escrita comea a partir da posio corrente do ponteiro de arquivos, e a funo FWRITE retornar a quantidade real de bytes escritos. Atravs das funes FOPEN(), FCREATE(), ou FOPENPORT(), podemos abrir ou criar um arquivo ou abrir uma porta de comunicao , para o qual sero gravados ou enviados os dados do buffer informado. Por tratar-se de uma funo de manipulao de contedo binrio , so suportados na String cBuffer todos os caracteres da tabela ASCII , inclusive caracteres de controle ( ASC 0 , ASC 12 , ASC 128 , etc.).
Caso acontea alguma falha na gravao , a funo retornar um nmero menor que o nQtdBytes. Neste caso , a funo FERROR() pode ser utilizada para determinar o erro especfico ocorrido. A gravao no arquivo realizada a partir da posio atual do ponteiro , que pode ser ajustado atravs das funes FSEEK() , FREAD() ou FREADSTR().
nHandle o manipulador de arquivo ou device retornado pelas funes FOPEN(), FCREATE(), ou FOPENPORT(). cBuffer <cBuffer> a cadeia de caracteres a ser escrita no arquivo especificado. O tamanho desta varivel deve ser maior ou igual ao tamanho informado em nQtdBytes (caso seja informado o tamanho). nQtdBytes <nQtdBytes> indica a quantidade de bytes a serem escritos a partir da posio corrente do ponteiro de arquivos. Caso seja omitido, todo o contedo de <cBuffer> escrito.
E Retorno:
Numrico FWRITE() retorna a quantidade de bytes escritos na forma de um valor numrico inteiro. Caso o valor retornado seja igual a <nQtdBytes>, a operao foi bem sucedida. Caso o valor de retorno seja menor que <nBytes> ou zero, ou o disco est cheio ou ocorreu outro erro. Neste caso , utilize a funo FERROR() para obter maiores detalhes da ocorrncia.
Exemplo:
#INCLUDE "FILEIO.CH" #DEFINE F_BLOCK 1024 // Define o bloco de Bytes a serem lidos / gravados por vez
User Function TestCopy() Local cBuffer := SPACE(F_BLOCK) Local nHOrigem , nHDestino Local nBytesLidos , nBytesFalta , nTamArquivo Local nBytesLer , nBytesSalvo Local lCopiaOk := .T.
// Abre o arquivo de Origem nHOrigem := FOPEN("ORIGEM.TXT", FO_READ)
- 397 -
Guia de Referncia Rpida ADVPL Avanado
Exemplo (continuao):
// Testa a abertura do Arquivo If nHOrigem == -1 MsgStop('Erro ao abrir origem. Ferror = '+str(ferror(),4),'Erro') Return .F. Endif
// Determina o tamanho do arquivo de origem nTamArquivo := Fseek(nHOrigem,0,2)
// Move o ponteiro do arquivo de origem para o inicio do arquivo Fseek(nHOrigem,0)
// Cria o arquivo de destino nHDestino := FCREATE("DESTINO.TXT", FC_NORMAL)
// Testa a criao do arquivo de destino If nHDestino == -1 MsgStop('Erro ao criar destino. Ferror = '+str(ferror(),4),'Erro') FCLOSE(nHOrigem) // Fecha o arquivo de Origem Return .F. Endif
// Define que a quantidade que falta copiar o prprio tamanho do Arquivo nBytesFalta := nTamArquivo
// Enquanto houver dados a serem copiados While nBytesFalta > 0
// Determina quantidade de dados a serem lidos nBytesLer := Min(nBytesFalta , F_BLOCK )
// l os dados do Arquivo nBytesLidos := FREAD(nHOrigem, @cBuffer, nBytesLer )
// Determina se no houve falha na leitura If nBytesLidos < nBytesLer MsgStop( "Erro de Leitura da Origem. "+; Str(nBytesLer,8,2)+" bytes a LER."+; Str(nBytesLidos,8,2)+" bytes Lidos."+; "Ferror = "+str(ferror(),4),'Erro') lCopiaOk := .F. Exit Endif
// Salva os dados lidos no arquivo de destino nBytesSalvo := FWRITE(nHDestino, cBuffer,nBytesLer)
// Determina se no houve falha na gravao If nBytesSalvo < nBytesLer MsgStop("Erro de gravao do Destino. "+; Str(nBytesLer,8,2)+" bytes a SALVAR."+; Str(nBytesSalvo,8,2)+" bytes gravados."+; "Ferror = "+str(ferror(),4),'Erro') lCopiaOk := .F. EXIT Endif
- 398 -
Guia de Referncia Rpida ADVPL Avanado
Exemplo (continuao):
// Elimina do Total do Arquivo a quantidade de bytes copiados nBytesFalta -= nBytesLer
Enddo
// Fecha os arquivos de origem e destino FCLOSE(nHOrigem) FCLOSE(nHDestino)
If lCopiaOk MsgStop('Cpia de Arquivos finalizada com sucesso. '+; str(nTamArquivo,12,0)+' bytes copiados.','Final') Else MsgStop( 'Falha na Cpia. Arquivo de Destino incompleto. '+; 'Do total de '+str(nTamArquivo,12,0)+' bytes, faltaram '+str(nBytesFalta,12,0)+' bytes.','Final') Endif
Return
MSCOPYFILE()
Funo que executa a cpia binria de um arquivo para o destino especificado.
E Sintaxe: MSCOPYFILE( cArqOrig, cArqDest )
E Parmetros:
cArqOrig Nome do arquivo origem e a extenso. cArqDest Nome do arquivo destino e a extenso.
E Retorno:
Lgico Se a copia for realizada com sucesso a funo retornar verdadeiro (.T.).
Exemplo:
Local cArqOrig := 'ARQ00001.DBF' Local cArqDest := 'ARQ00002.XXX'
If MsCopyFile( cArqOrig, cArqDest ) APMsgInfo('Copia realizada com sucesso!') EndIf
MSCOPYTO()
Funo que realiza a cpia dos registros de uma base de dados para outra, criando o arquivo destino de acordo com a estrutura da base de dados origem.
E Sintaxe: MSCOPYTO( [cArqOrig], cArqDest )
E Parmetros:
cArqOrig Nome do arquivo origem e a extenso se o ambiente for Top o parmetro passar a ser obrigatrio. cArqDest Nome do arquivo destino e a extenso.
E Retorno:
Lgico Se a copia for realizada com sucesso a funo retornar verdadeiro (.T.).
Exemplo:
Local cArqDest := 'SX2ZZZ.DBF' DbSelectArea('SX2') If MsCopyTo( , cArqDest ) APMsgInfo('Copia realizada com sucesso!') Else APMsgInfo('Problemas ao copiar o arquivo SX2!') EndIf
MSCREATE()
Funo que cria um arquivo (tabela) de acordo com a estrutura informada no parmetro aStruct. Se o parmetro cDriver no for informado o RDD corrente ser assumido como padro. Para criao de tabelas no TopConnect necessrio estar conectado ao banco e o environment do protheus ser TOP.
aStruct: array contendo a estrutura da tabela aonde: 1 - caracter, nome do campo; 2 - caracter, tipo do campo; 3 - numrico, tamanho do campo; 4 - numrico, decimais.
E Sintaxe: MsCreate( cArquivo, aStru ,[cDriver] )
E Parmetros:
cArquivo Nome do arquivo. aStruct Estrutura do arquivo. cDriver RDD do arquivo.
- 399 -
Guia de Referncia Rpida ADVPL Avanado
E Retorno:
Lgico Indica se a operao foi executada com sucesso.
Exemplo:
Local cTarget := '\sigaadv\' Local aStrut aStrut := { { 'Campo', 'C', 40, 0 } } If MsCreate( cTarget+'ARQ1001', aStrut ) APMsgInfo('Criado com sucesso!') Else APMsgInfo('Problemas ao criar o arquivo!') EndIf
MSERASE()
Funo utilizada para deletar fisicamente o arquivo especificado.
E Sintaxe: MsErase( cArquivo, [cIndice], [cDriver] )
E Parmetros:
cArquivo Nome do arquivo e a extenso. cIndice Nome do arquivo de ndice e a extenso. cDriver RDD do arquivo, se no for informado assumir o RDD corrente.
E Retorno:
Lgico Indica se a operao foi executada com sucesso.
Exemplo:
Local cArquivo := 'SX2ZZZ.DBF' Local cIndice := 'SX2ZZZ'+ OrdBagExt() If MsErase( cArquivo, cIndice ) APMsgInfo( 'Arquivo deletado com sucesso!' ) Else APMsgInfo( 'Problemas ao deletar arquivo!' ) EndIf
- 400 -
Guia de Referncia Rpida ADVPL Avanado
- 401 -
Guia de Referncia Rpida ADVPL Avanado
MSRENAME()
Funo que verifica a existncia do arquivo especificado.
E Sintaxe: MsFile( cArquivo, [cIndice], [cDriver] )
E Parmetros:
cArquivo Nome do arquivo e a extenso. cIndice Nome do arquivo de ndice e a extenso. cDriver RDD do arquivo, se no for informado assumir o RDD corrente.
E Retorno:
Lgico Indica se o arquivo especificado existe.
Exemplo:
Local cArquivo := 'SX2ZZZ.DBF' Local cIndice := 'SX2ZZZ'+ OrdBagExt() If !MsFile ( cArquivo, cIndice ) APMsgInfo( 'Arquivo no encontrado!' ) EndIf
RETFILENAME()
Funo que retorna o nome de um arquivo contido em uma string, ignorando o caminho e a extenso.
E Sintaxe: RetFileName( cArquivo )
E Parmetros:
cArquivo String contendo o nome do arquivo
E Retorno:
Caracter Nome do arquivo contido na string cArquivo sem o caminho e a extenso.
Funo que cria um arquivo de trabalho com uma estrutura especificada, sendo que:
O Caso o parmetro lDbf seja definido como .T., a funo criar um arquivo DBF com este nome e a estrutura definida em aArray. O Caso o parmetro lDbf seja definido como .F., a funo no criar arquivo de nenhum tipo, apenas fornecer um nome vlido.
E Sintaxe: CriaTrab(aArray,lDbf)
E Parmetros:
aArray Array multidimensional contendo a estrutura de campos da tabela que ser criada no formato: {Nome, Tipo, Tamanho, Decimal} lDbf Determina se o arquivo de trabalho deve ser criado ( .T.) ou no (.F. )
E Retorno:
Caracter Nome do Arquivo gerado pela funo.
Exemplo:
// Com lDbf = .F. cArq := CriaTrab(NIL, .F.) cIndice := C9_AGREG++IndexKey() Index on &cIndice To &cArq
// Com lDbf = .T. aStru := {} AADD(aStru,{ MARK , C, 1, 0}) AADD(aStru,{ AGLUT , C, 10, 0}) AADD(aStru,{ NUMOP , C, 10, 0}) AADD(aStru,{ PRODUTO, C, 15, 0}) AADD(aStru,{ QUANT , N, 16, 4}) AADD(aStru,{ ENTREGA, D, 8, 0}) AADD(aStru,{ ENTRAJU, D, 8, 0}) AADD(aStru,{ ORDEM , N, 4, 0}) AADD(aStru,{ GERADO , C, 1, 0}) cArqTrab := CriaTrab(aStru, .T.) USE &cArqTrab ALIAS TRB NEW
Na criao de ndices de trabalho temporrios utilizada a sintaxe:
O CriaTrab(Nil, .F.)
- 402 -
Guia de Referncia Rpida ADVPL Avanado
- 403 -
Guia de Referncia Rpida ADVPL Avanado
Manipulao de bases de dados
ALIAS()
Funo de banco de dados utilizada para determinar o alias da rea de trabalho especificada. Alias o nome atribuido a uma rea de trabalho quando um arquivo de banco de dados est em uso. O nome real atribuido o nome do arquivo de banco de dados, ou um nome que foi explicitamente atribuido atravs da clusula ALIAS do comando USE.
A funo ALIAS() o inverso da funao SELECT() pois retorna o alias atravs do nmero da rea de trabalho, enquanto SELECT() retorna o nmero da rea de trabalho atravs do alias.
E Sintaxe: ALIAS ( [ nAreaTrabalho ] )
E Parmetros:
nAreaTrabalho <nAreaTrabalho> o nmero da rea de trabalho a ser verificada.
E Retorno:
Caracter Retorna o alias da rea de trabalho especificada na forma de uma cadeia de caracteres, em letra maiscula. Caso <nAreaTrabalho> nao seja especificada, retornado o alias da rea de trabalho corrente. Se nao houver nenhum arquivo de banco de dados em USo na rea de trabalho especificada, ALIAS() retorna uma cadeia de caracteres nula ("").
Exemplo:
cAlias := alias() IF empty(cAlias) alert('No h Area em uso') Else alert(Area em uso atual : '+cAlias) Endif
BOF() / EOF()
As funes BOF() e EOF() so utilizadas para determinar se o ponteiro de leitura do arquivo encontra-se no comeo ou no final do mesmo conforme abaixo:
O BOF() uma funo de tratamento de banco de dados utilizada para testar uma condio de limite de inicial do arquivo quando o ponteiro de registros est se movendo para trs em um arquivo de banco de dados. O EOF() uma funo de tratamento de banco de dados utilizada para testar uma condio de limite de final de arquivo quando o ponteiro de registros est se movendo para frente em um arquivo de banco de dados.
Normalmente utilizada a condio EOF() como parte do argumento <lCondicao> de uma construao DO WHILE que processa registros sequencialmente em um arquivo de banco de dados. Neste caso <lCondicao> incluiria um teste para .NOT. EOF(), forando o lao DO WHILE a terminar quando EOF() retornar verdadeiro (.T.)
E Sintaxe: BOF() / EOF()
E Parmetros:
Nenhum .
E Retorno:
Lgico Retorna verdadeiro (.T.) quando feita uma tentativa de mover o ponteiro de registros para alm do primeiro registro lgico em um arquivo de banco de dados, do contrrio, ela retorna falso (.F.). Lgico Retorna verdadeiro (.T.) quando feita uma tentativa de mover o ponteiro de registros para alm do ltimo registro lgico em um arquivo de banco de dados, do contrrio, ela retorna falso (.F.). Caso nao haja nenhum arquivo de banco de dados aberto na rea de trabalho corrente, EOF() retorna falso (.F.). Se o arquivo de banco de dados corrente no possui registros, EOF() retorna verdadeiro (.T.).
COPY()
O comando COPY TO permite a cpia de todos ou parte dos registros da tabela atualmente selecionada como rea de trabalho atual, para um novo arquivo. Os registros considerados para a cpia podem ser limitados pela clusula <escopo>, atravs de expresses FOR/WHILE, e/ou atravs de um filtro.
Se o filtro para registros deletados ( SET DELETED ) estiver desligado (OFF), registros deletados ( marcados para deleo ) so copiados para o arquivo de destino, mantendo este status. Caso contrrio, nenhum registro deletado copiado. Da mesma maneira, caso exista uma condio de filtro na tabela atual ( SET FILTER ), apenas os registros que satisfaam a condio de fintro sero copiados.
Os registros so lidos na tabela atual, respeitando a ordem de ndice setada. Caso no hajam ndices abertos, ou a ordem de navegao nos ndices (SET ORDER ) seja 0 (zero), os registros so lidos em orden natural ( ordem de RECNO ) .
- 404 -
Guia de Referncia Rpida ADVPL Avanado
A tabela de destino dos dados copiados criada, e aberta em modo exclusivo, antes da operao de cpia efetiva ser iniciada.
E Tabela A : Especificao do formato SDF ( System Data Format )
Elemento do Arquivo Formato Campos 'C' Caractere Tamanho fixo, ajustado com espaos em branco Campos 'D' Data Formato aaaammdd ( ano, ms, dia ) Campos 'L' lgicos T ou F Campos 'M' Memo (campo ignorado) Campos 'N' Numricos Ajustados direita, com espaos em branco. Delimitador de Campos Nenhum Separador de Registros CRLF ( ASCII 13 + ASCII 10 ) Marca de final de arquivo (EOF) Nenhum
E Tabela B : Especificao do formato delimitado ( DELIMITED / DELIMITED WITH <cDelimiter> )
Elemento do Arquivo Formato Campos 'C' Caractere Delimitados, ignorando espaos direita Campos 'D' Data Formato aaaammdd ( ano, ms, dia ) Campos 'L' lgicos T ou F Campos 'M' Memo (campo ignorado) Campos 'N' Numricos sem espaos em branco. Delimitador de Campos Vrgula Separador de Registros CRLF ( ASCII 13 + ASCII 10 ) Marca de final de arquivo (EOF) Nenhum
A Linguagem Advpl, antes do Protheus, suportava a gerao de uma tabela delimitada diferenciada, obtida atravs do comando COPY TO (...) DELIMITED WITH BLANK . No Protheus este formato no suportado. Caso utilize-se este comando com a sintaxe acima, o arquivo ASCII gerado ser delimitado, utilizando-se a sequncia de caracteres 'BLANK' como delimitadora de campos Caractere.
E Sintaxe:
COPY [ FIELDS <campo,...> ] TO cFile [cEscopo] [ WHILE <lCondicao> ] [ FOR <lCondicao> ] [ SDF | DELIMITED [WITH <cDelimiter>] ] [ VIA <cDriver> ]
- 405 -
Guia de Referncia Rpida ADVPL Avanado
- 406 -
Guia de Referncia Rpida ADVPL Avanado
E Parmetros:
FIELDS <campo,...> FIELDS <campo,...> especifica um ou mais campos, separados por vrgula, a serem copiados para a tabela de destino. Caso no especificado este parmetro, sero copiados todos os campos da tabela de origem. TO cFile TO <cFile> especifica o nome do arquivo de destino. O nome do arquivo de destimno pode ser especificado de forma literal direta, ou como uma expresso Advpl, entre parnteses.
Caso sejam especificadas as clusulas SDF ou DELIMITED, gerado um arquivo ASCII, com extenso .txt por default. cEscopo <cEscopo> define a poro de dados da tabela atual a ser coipiada. Por default, so copiados todos os registros (ALL). Os escopos possveis de uso so:
ALL - Copia todos os registros. REST - Copia, a partir do registro atualmente posicionado, at o final da tabela. NEXT <n> - Copia apenas <n> registros, iniciando a partir do registro atualmente posicionado.
OBSERVAO : Vale a pena lembrar que o escopo sensvel tambm s demais condies de filtro ( WHILE / FOR ). WHILE <lCondicao> WHILE <lCondicao> permite especificar uma condio para realizao da cpia, a partir do registro atual, executada antes de inserir cada registro na tabela de destino, sendo realizada a operao de cpia enquanto esta condio for verdadeira. FOR <lCondicao> FOR <lCondicao> especifica uma condio para cpia de registros, executada antes de inserir um registro na tabela de destino, sendo a operao realizada apenas se lCondicao ser verdadeira ( .T. ) [SDF|DELIMITED] [ SDF | DELIMITED [WITH <xcDelimiter>] ]
SDF especifica que o tipo de arquivo de destino gerado um arquivo no formato "System Data Format" ASCII, onde registros e campos possuiem tamanho fixo no arquivo de destino.
DELIMITED especifica que o arquivo ASCII de destino ser no formato delimitado, onde os campos do tipo Caractere so delimitados entre aspas duplas ( delimitador Default ). Registros e campos tm tamanho varivel no arquivo ASCII.
DELIMITED WITH <xcDelimiter> permite especificar um novo caractere, ou sequncia de caracteres, a ser utilizada como delimitador, ao invs do default ( aspas duplas ). O caractere delimitador pode ser escrito de forma literal, ou como uma expresso entre parnteses.
Nas Tabelas complementares A e B, na documentao do comando, so detalhadas as especificaes dos formatos SDF e DELIMITED. VIA <cDriver> VIA <xcDriver> permite especificar o driver utilizado para criar a tabela de destino dos dados a serem copiados.
O Driver deve ser especificado como uma expresso caractere. Caso especificado como um valor literal direto, o mesmo deve estar entre aspas.
E Retorno:
Nenhum .
COPY STRUCTURE()
O comando COPY STRUCTURE cria uma nova tabela vazia, com a estrutura da tabela ativa na rea de trabalho atual. Se a tabela a ser criada j exista, a mesma sobrescrita. A tabela de destino criada utiliza o mesmo RDD da tabela de origem ( tabela ativa na rea de trabalho atual ).
A Linguagem Advpl, antes do Protheus, suportava a parametrizao de uma lista de campos da tabela atual, para compor a estrutura da tabela de destino, atravs da clusula FIELDS <campo,...>. Esta opo no suportada no Protheus. Caso seja utilizada, o programa ser abortado com a ocorrncia de erro fatal : 'DBCopyStruct - Parameter <Fields> not supported in Protheus'
E Sintaxe:
COPY STRUCTURE TO <xcDataBase>
E Parmetros:
TO <xcDataBase> Deve ser especificado em xcDatabase o nome da tabela a ser criada.
E Retorno:
Nenhum .
DBAPPEND()
A funo DBAPPEND() acrescenta mais um registro em branco no final da tabela corrente. Se no houver erro da RDD, o registro acrescentado e bloqueado.
E Sintaxe: DBAPPEND ( [ lLiberaBloqueios ] )
E Parmetros:
lLiberaBloqueios Se o valor for .T., libera todos os registros bloqueados anteriormente (locks). Se for .F., todos os bloqueios anteriores so mantidos. Valor default: .T.
E Retorno:
Nenhum .
- 407 -
Guia de Referncia Rpida ADVPL Avanado
Exemplo:
USE Clientes NEW FOR i:=1 to 5 DBAPPEND(.F.) NOME := "XXX" END : ="YYY" NEXT // Os 5 registros includos permanecem bloqueados DBAPPEND() // Todos os bloqueios anteriores so liberados
DBCLEARALLFILTER()
A funo DBCLEARALLFILTER() salva as atualizaes realizadas e pendentes de todas as tabelas e depois limpa as condies de filtro de todas as tabelas.
E Sintaxe: DBCLEARALLFILTER()
E Parmetros:
Nenhum .
E Retorno:
Nenhum .
Exemplo:
USE Clientes NEW DBSETFILTER( {|| Idade < 40}, 'Idade < 40') // Seta a expresso de filtro ... DBCLEARALLFILTER() // Limpa a expresso de filtro de todas as ordens
- 408 -
Guia de Referncia Rpida ADVPL Avanado
- 409 -
Guia de Referncia Rpida ADVPL Avanado
DBCLEARFILTER()
A funo DBCLEARFILTER() salva as atualizaes realizadas e pendentes na tabela corrente e depois limpa todas as condies de filtro da ordem ativa no momento. Seu funcionamento oposto ao comando SET FILTER.
E Sintaxe: DBCLEARFILTER()
E Parmetros:
Nenhum .
E Retorno:
Nenhum .
Exemplo:
USE Clientes NEW DBSETFILTER( {|| Idade < 40}, "Idade < 40" ) // Seta a expresso de filtro ... DBCLEARFILTER() // Limpa a expresso de filtro
DBCLEARINDEX()
A funo DBCLEARINDEX() salva as atualizaes pendentes na tabela corrente e fecha todos os arquivos de ndice da rea de trabalho. Por conseqncia, limpa todas as ordens da lista. Seu funcionamento oposto ao comando SET INDEX.
E Sintaxe: DBCLEARINDEX()
E Parmetros:
Nenhum .
E Retorno:
Nenhum .
Exemplo:
USE Clientes NEW DBSETINDEX("Nome") // Abre o arquivo de ndice "Nome" ... DBCLEARINDEX() // Fecha todos os arquivos de ndices
- 410 -
Guia de Referncia Rpida ADVPL Avanado
DBCLOSEALL()
A funo DBCLOSEALL() salva as atualizaes pendentes, libera todos os registros bloqueados e fecha todas as tabelas abertas (reas de trabalho) como se chamasse DBCLOSEAREA para cada rea de trabalho.
E Sintaxe: DBCLOSEALL()
E Parmetros:
Nenhum .
E Retorno:
Nenhum .
Exemplo:
// Este exemplo demonstra como se pode utilizar o DBCLOSEALL para fechar a rea de trabalho atual. USE Clientes NEW DBSETINDEX("Nome") // Abre o arquivo de ndice "Nome" USE Fornecedores NEW DBSETINDEX("Idade") // Abre o arquivo de ndice "Idade" ... DBCLOSEALL() //Fecha todas as reas de trabalho, todos os indices e ordens
DBCLOSEAREA()
A funo DBCLOSEAREA() 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().
A funo DBCOMMIT() salva em disco todas as atualizaes pendentes na rea de trabalho corrente.
E Sintaxe: DBCOMMIT()
E Parmetros:
Nenhum .
E Retorno:
Nenhum .
Exemplo:
USE Clientes NEW DBGOTO(100) Nome := "Jose" USE Fornecedores NEW DBGOTO(168) Nome := "Joao" DBCOMMIT() // Salva em disco apenas as alteraes realizadas na tabela Fornecedores
DBCOMMITALL()
A funo DBCOMMITALL() salva em disco todas as atualizaes pendentes em todas as reas de trabalho.
E Sintaxe: DBCOMMITALL()
E Parmetros:
Nenhum .
E Retorno:
Nenhum .
Exemplo:
USE Clientes NEW DBGOTO(100) Nome := "Jose" USE Fornecedores NEW DBGOTO(168) Nome := "Joao" DBCOMMITALL() // Salva em disco as alteraes realizadas nas tabelas Clientes e Fornecedores
DBCREATE()
A funo DBCREATE() utilizada para criar um novo arquivo de tabela cujo nome est especificado atravs do primeiro parmetro (cNome) e estrutura atravs do segundo (aEstrutura). A estrutura especificada atravs de um array com todos os campos, onde cada campo expresso atravs de um array contendo {Nome, Tipo, Tamanho, Decimais}.
cNOME Nome do arquivo a ser criado. Se contm pasta, ela se localiza abaixo do "RootPath". Se no, criado por padro no caminho formado por "RootPath"+"StartPath" aESTRUTURA Lista com as informaes dos campos para ser criada a tabela. cDRIVER Nome da RDD a ser utilizado para a criao da tabela. Se for omitido ser criada com a corrente.
E Retorno:
Nenhum .
Exemplo:
// Este exemplo mostra como se pode criar novo arquivo atravs da funo DBCREATE: LOCAL aEstrutura :={{Cod,N,3,0}, {Nome,C,10,0}, {Idade,N,3,0}, {Nasc,D,8,0}, {Pagto,N,7,2}} // Cria a tabela com o RDD corrente DBCREATE('\teste\cliente.dbf', aEstrutura) USE '\teste\cliente.dbf' VIA 'DBFCDX' NEW
Erros mais comuns:
1. DBCreate - Data base files can only be created on the server: O nome do arquivo a ser criado no pode conter 'driver', pois, por conveno, ele seria criado na mquina onde o Remote est rodando. 2. DBCreate - Invalid empty filename: Nome do arquivo no foi especificado 3. DBCreate - Field's name cannot be 'DATA': Algumas RDD's no suportam este nome de campo. uma palavra reservada. 4. DBCreate - The length of Field's name must be at most 10: Nome do campo no pode ter mais que 10 caracteres. 5. DBCreate - Field's name must be defined: Nome do campo no foi definido. 6. DBCreate - Field's type is not defined: Tipo do campo no foi definido. 7. DBCreate - invalid Field's type: Tipo do campo diferente de 'C', 'N', 'D', 'M' ou 'L'.
8. DBCreate - Invalid numeric field format: Considerando 'len' o tamanho
- 412 -
Guia de Referncia Rpida ADVPL Avanado
total do campo numrico e 'dec' o nmero de decimais, ocorre este erro se:
(len = 1) .and. (dec <> 0): Se o tamanho total 1, o campo no pode ter decimais
(len>1) .and. (len< dec + 2): Se o tamanho total maior que 1, ele deve ser maior que o nmero de decimais mais 2, para comportar o separador de decimais e ter pelo menos um algarismo na parte inteira.
Exemplo: O nmero 12.45 poderia ser o valor de um campo com len=5 e dec=2 (no mnimo).
Erros mais comuns:
Podem ocorrer tambm erros decorrentes de permisso e direitos na pasta onde se est tentando criar o arquivo ou por algum problema no banco de dados. Verifique as mensagens do servidor Protheus e do banco de dados.
DBCREATEINDEX()
A funo DBCREATEINDEX() utilizada para criar um novo arquivo de ndice com o nome especificado atravs do primeiro parmetro, sendo que se o mesmo existir deletado e criado o novo. Para tanto so executados os passos a seguir:
O Salva fisicamente as alteraes ocorridas na tabela corrente; O Fecha todos os arquivos de ndice abertos; O Cria o novo ndice; O Seta o novo ndice como a ordem corrente; O Posiciona a tabela corrente no primeiro registro do ndice.
Com exceo do RDD CTREE, a tabela corrente no precisa estar aberta em modo exclusivo para a criao de ndice, pois na criao de ndices no Ctree alterada a estrutura da tabela, precisando para isto a tabela estar aberta em modo exclusivo.
E Sintaxe: DBCREATEINDEX(<cNOME>, <cEXPCHAVE>, [bEXPCHAVE], [lUNICO])
E Parmetros:
cNOME Nome do arquivo de ndice a ser criado. cEXPCHAVE Expresso das chaves do ndice a ser criado na forma de string. bEXPCHAVE Expresso das chaves do ndice a ser criado na forma executvel. lUNICO Cria ndice como nico (o padro .F.).
E Retorno:
Nenhum .
- 413 -
Guia de Referncia Rpida ADVPL Avanado
Exemplo:
// Este exemplo mostra como se pode criar novo arquivo de ndice criando a ordem sobre os // campos Nome e End e no aceitar duplicao:
USE Cliente VIA "DBFCDX" NEW DBCREATEINDEX("\teste\ind2.cdx","Nome+End",{ || Nome+End },.T.)
DBDELETE()
A funo DBDELETE() marca o registro corrente como apagado logicamente(), sendo necessria sua utilizao em conjunto com as funes RecLock() e MsUnLock().
Para filtrar os registro marcados do alias corrente pode-se utilizar o comando SET DELETED e para apag-los fisicamente pode-se utilizar a funo __DBPACK().
IF Found() RecLock(SA1,.F.) // Define que ser realizada uma alterao no registro posicionado DbDelete() // Efetua a excluso lgica do registro posicionado. MsUnLock() // Confirma e finaliza a operao ENDIF
- 414 -
Guia de Referncia Rpida ADVPL Avanado
- 415 -
Guia de Referncia Rpida ADVPL Avanado
DBF()
A funo DBF() verifica qual o Alias da rea de trabalho corrente. O Alias definido quando a tabela aberta atravs do parmetro correspondente (DBUSEAREA()). Esta funo o inverso da funo SELECT(), pois nesta retornado o nmero da rea de trabalho do Alias correspondente.
E Sintaxe: DBF() E Parmetros:
Nenhum .
E Retorno:
Caracter Retorna o Alias corrente. Caso no exista Alias corrente retorna "" (String vazia).
Exemplo:
dbUseArea( .T.,"dbfcdxads", "\dadosadv609\sa1990.dbf","SSS",.T., .F. ) MessageBox("O Alias corrente : "+DBF(),"Alias", 0) //Resultado: "O Alias corrente : SSS"
DBFIELDINFO()
A funo DBFIELDINFO() utilizada para obter informaes sobre determinado campo da tabela corrente. O tipo de informao (primeiro argumento) escolhido de acordo com as constantes abaixo:
E Tabela A : Constantes utilizadas na parametrizao da funo
Constante Descrio Retorno DBS_NAME Nome do campo. Caracter DBS_DEC Nmero de casas decimais. Numrico DBS_LEN Tamanho. Numrico DBS_TYPE Tipo. Caracter
A posio do campo no leva em considerao os campos internos do Protheus (Recno e Deleted).
nINFOTIPO Tipo de informao a ser verificada (DBS_NAME, DBS_DEC, DBS_LEN e DBS_TYPE). nCAMPO Posio do campo a ser verificado.
E Retorno:
Indefinido Retorna NIL se no h tabela corrente ou a posio do campo especificado est invlida. Informao do campo Informao requisitada pelo usurio (pode ser de tipo numrico se for tamanho ou casas decimais, tipo caracter se for nome ou tipo).
Exemplo:
USE Clientes NEW
DBFIELDINFO(DBS_NAME,1) // Retorno: Nome DBFIELDINFO(DBS_TYPE,1) // Retorno: C DBFIELDINFO(DBS_LEN,1) // Retorno: 10 DBFIELDINFO(DBS_DEC,1) // Retorno: 0
DBFILTER()
A funo DBFILTER() utilizada para verificar a expresso de filtro ativo na rea de trabalho corrente.
E Sintaxe: DBFILTER()
E Parmetros:
Nenhum .
E Retorno:
Caracter Retorna a expresso do filtro ativo na rea de trabalho atual. Caso no exista filtro ativo retorna "" (String vazia).
Exemplo:
USE Cliente INDEX Ind1 NEW SET FILTER TO Nome > "Jose" DBFILTER() // retorna: Nome > "Jose" SET FILTER TO Num < 1000 DBFILTER() // retorna: Num < 1000
- 416 -
Guia de Referncia Rpida ADVPL Avanado
- 417 -
Guia de Referncia Rpida ADVPL Avanado
DBGOTO()
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.
E Sintaxe: DbGoto(nRecno) E Parmetros
nRecno Record number do registro a ser posicionado.
Exemplo: DbSelectArea(SA1) DbGoto(100) // Posiciona no registro 100
IF !EOF() // Se a rea de trabalho no estiver em final de arquivo MsgInfo(Voc est no cliente:+A1_NOME) ENDIF
DBGOTOP()
Move o cursor da rea de trabalho ativa para o primeiro registro lgico.
E Sintaxe: DbGoTop() E Parmetros
Nenhum .
Exemplo:
nCount := 0 // Varivel para verificar quantos registros h no intervalo DbSelectArea(SA1) DbSetOrder(1) // A1_FILIAL + A1_COD + A1_LOJA DbGoTop()
While !BOF() // Enquanto no for o incio do arquivo nCount++ // Incrementa a varivel de controle de registros no intervalo DbSkip(-1) End
MsgInfo(Existem :+STRZERO(nCount,6)+ registros no intervalo).
// Retorno esperado :000001, pois o DbGoTop posiciona no primeiro registro.
- 418 -
Guia de Referncia Rpida ADVPL Avanado
DBGOBOTTON()
Move o cursor da rea de trabalho ativa para o ltimo registro lgico.
E Sintaxe: DbGoBotton() E Parmetros
Nenhum .
Exemplo:
nCount := 0 // Varivel para verificar quantos registros h no intervalo DbSelectArea(SA1) DbSetOrder(1) // A1_FILIAL + A1_COD + A1_LOJA DbGoBotton()
While !EOF() // Enquanto no for o incio do arquivo nCount++ // Incrementa a varivel de controle de registros no intervalo DbSkip(1) End
MsgInfo(Existem :+STRZERO(nCount,6)+ registros no intervalo).
// Retorno esperado :000001, pois o DbGoBotton posiciona no ltimo registro.
DBINFO()
DBINFO() utilizada para obter informaes sobre a tabela corrente. O tipo de informao (primeiro argumento) escolhido de acordo com as constantes abaixo:
E Tabela A : Constantes utilizadas na parametrizao da funo
Constante Descrio Retorno DBI_GETRECSIZE Tamanho do registro em nmero de bytes similar a RECSIZE. Numrico DBI_TABLEEXT Extenso do arquivo da tabela corrente. Caracter DBI_FULLPATH Nome da tabela corrente com caminho completo. Caracter DBI_BOF Se est posicionada no incio da tabela similar a BOF Lgico DBI_EOF Se est posicionada no final da tabela similar a EOF Lgico DBI_FOUND Se a tabela est posicionada aps uma pesquisa similar a FOUND Lgico DBI_FCOUNT Nmero de campos na estrutura da tabela corrente similar a FCOUNT Numrico DBI_ALIAS Nome do Alias da rea de trabalho corrente similar a ALIAS Caracter DBI_LASTUPDATE Data da ltima modificao similar a LUPDATE Data
E Sintaxe: DBINFO(<nINFOTIPO>)
E Parmetros:
nINFOTIPO Tipo de informao a ser verificada.
E Retorno:
Indefinido Informao da Tabela Informao requisitada pelo usurio (o tipo depende da informao requisitada). Se no houver tabela corrente retorna NIL.
Funo que retorna o IndexKey,ou seja, a expresso de ndice da ordem especificada pelo NickName. Se no existe ndice com o nickname, retorna uma string vazia.
E Sintaxe: DBNICKINDEXKEY(<cNick>)
E Parmetros:
cNick Indica o "NickName" da ordem de ndice.
E Retorno:
Caracter Expresso do ndice identificado pelo "NickName".
- 419 -
Guia de Referncia Rpida ADVPL Avanado
DBORDERINFO()
A funo DBORDERINFO() utilizada para obter informaes sobre determinada ordem. A especificao da ordem pode ser realizada atravs de seu nome ou sua posio dentro da lista de ordens, mas se ela no for especificada sero obtidas informaes da ordem corrente.O tipo de informao (primeiro argumento) escolhido de acordo com as constantes abaixo:
E Tabela A : Constantes utilizadas na parametrizao da funo
Constante Descrio Retorno DBOI_BAGNAME Nome do arquivo de ndice ao qual a ordem pertence. Caracter DBOI_FULLPATH do arquivo de ndice (com seu diretrio) ao qual a ordem pertence. Caracter DBOI_ORDERCOUNT Nmero de ordens existentes no arquivo de ndice especificado. Caracter
E Sintaxe: DBORDERINFO(<nINFOTIPO>)
E Parmetros:
nINFOTIPO Nome do arquivo de ndice.
E Retorno:
Caracter Retorna a informao da Ordem requisitada pelo usurio (pode ser de tipo numrico se for nmero de ordens no ndice, tipo caracter se for nome do arquivo de ndice). Caso no exista ordem corrente ou a posio da ordem especificada est invlida retorna NIL.
Exemplo:
DBORDERINFO(DBOI_BAGNAME) // retorna: Ind DBORDERINFO(DBOI_FULLPATH) // retorna: C:\AP6\Teste\Ind.cdx
- 420 -
Guia de Referncia Rpida ADVPL Avanado
- 421 -
Guia de Referncia Rpida ADVPL Avanado
DBORDERNICKNAME()
A funo DBORDERNICKNAME() utilizada para selecionar a ordem ativa atravs de seu apelido. Esta ordem a responsvel pela seqncia lgica dos registros da tabela corrente.
E Sintaxe: DBORDERNICKNAME(<cAPELIDO>)
E Parmetros:
cAPELIDO Nome do apelido da ordem a ser setada.
E Retorno:
Lgico Retorna Falso se no conseguiu tornar a ordem ativa. Principais erros: No existe tabela ativa ou no foi encontrada a ordem com o apelido. Retorna Verdadeiro se a ordem foi setada com sucesso.
Exemplo:
USE Cliente NEW SET INDEX TO Nome, Idade
IF !DBORDERNICKNAME("IndNome") Messagebox("Registro no encontrado","Erro", 0) ENDIF
DBPACK()
A funo DBPACK() remove fisicamente todos os registros com marca de excludo da tabela.
E Sintaxe: __DBPACK() E Parmetros:
Nenhum .
E Retorno:
Nenhum .
Exemplo: USE Clientes NEW DBGOTO(100) DBDELETE() DBGOTO(105) DBDELETE() DBGOTO(110) DBDELETE()
// Se a excluso for confirmada: __DBPACK()
- 422 -
Guia de Referncia Rpida ADVPL Avanado
DBRECALL()
A funo DBRECALL() utilizada para retirar a marca de registro deletado do registro atual. Para ser executada o registro atual deve estar bloqueado ou a tabela deve estar aberta em modo exclusivo. Se o registro atual no estiver deletado, esta funo no faz nada. Ela o oposto da funo DBDELETE() que marca o registro atual como deletado.
E Sintaxe: DBRECALL() E Parmetros:
Nenhum .
E Retorno:
Nenhum .
Exemplo 01: Desfazendo a deleo do registro posicionado do alias corrente
Exemplo 02: Desfazendo as delees do alias corrente
USE Cliente DBGOTOP() WHILE !EOF() DBRECALL() DBSKIP() ENDDO
DBRECORDINFO()
A funo DBRECORDINFO() utilizada para obter informaes sobre o registro especificado pelo segundo argumento (recno) da tabela corrente, se esta informao for omitida ser verificado o registro corrente. O tipo de informao (primeiro argumento) escolhido de acordo com as constantes abaixo:
E Tabela A : Constantes utilizadas na parametrizao da funo
Constante Descrio Retorno DBRI_DELETED Estado de deletado similar a DELETED Lgico DBRI_RECSIZE Tamanho do registro similar a RECSIZE Numrico DBRI_UPDATED Verifica se o registro foi alterado e ainda no foi atualizado fisicamente similar a UPDATED Lgico
nINFOTIPO Tipo de informao a ser verificada. nREGISTRO Nmero do registro a ser verificado.
E Retorno:
Indefinido No h tabela corrente ou registro invlido. Informao do Registro. Informao requisitada pelo usurio (o tipo depende da informao requisitada).
Exemplo:
USE Clientes NEW DBGOTO(100) DBRECORDINFO(DBRI_DELETED) // Retorno: .F. DBDELETE() DBRECORDINFO(DBRI_DELETED) // Retorno: .F. DBRECALL() DBRECORDINFO(DBRI_RECSIZE) // Retorno: 230 NOME := "JOAO" DBGOTO(200) DBRECORDINFO(DBRI_UPDATED) // Retorno: .F. DBRECORDINFO(DBRI_UPDATED,100) // Retorno: .T.
DBREINDEX()
A funo DBREINDEX() reconstri todos os ndices da rea de trabalho corrente e posiciona as tabelas no primeiro registro lgico.
E Sintaxe: DBREINDEX()
E Parmetros:
Nenhum .
E Retorno:
Nenhum .
Exemplo:
USE Clientes NEW DBSETINDEX("IndNome") DBREINDEX()
- 424 -
Guia de Referncia Rpida ADVPL Avanado
DBRLOCK()
A funo DBRLOCK() utilizada quando se tem uma tabela aberta e compartilhada e se deseja bloquear um registro para que outros usurios no possam alter-lo. Se a tabela j est aberta em modo exclusivo, a funo no altera seu estado. O usurio pode escolher o registro a ser bloqueado atravs do parmetro (recno), mas se este for omitido ser bloqueado o registro corrente como na funo RLOCK(). Esta funo o oposto DBRUNLOCK, que libera registros bloqueados.
E Sintaxe: DBRLOCK([nREGISTRO])
E Parmetros:
nREGISTRO Nmero do registro a ser bloqueado.
E Retorno:
Lgico Retorna Falso se no conseguiu bloquear o registro. Principal motivo: o registro j foi bloqueado por outro usurio.
Retorna Verdadeiro se o registro foi bloqueado com sucesso.
Exemplo:
DBUSEAREA( .T.,"dbfcdxads", "\dadosadv609\sa1990.dbf","SSS",.T., .F. ) DBGOTO(100) DBRLOCK() // Bloqueia o registro atual (100) DBRLOCK(110) // Bloqueia o registro de nmero 110
DBRLOCKLIST()
A funo DBRLOCKLIST() utilizada para verificar quais registros esto locados na tabela corrente. Para tanto, retornada uma tabela unidimensional com os nmeros dos registros.
E Sintaxe: DBRLOCKLIST()
E Parmetros:
Nenhum .
E Retorno:
Array Retorna NIL se no existe tabela corrente ou no existe nenhum registro locado. Retorna a lista com os recnos dos registros locados na tabela corrente.
- 425 -
Guia de Referncia Rpida ADVPL Avanado
Exemplo:
DBUSEAREA( .T.,"dbfcdxads", "\dadosadv609\sa1990.dbf","SSS",.T., .F. ) DBGOTOP() DBRLOCK() // Bloqueia o primeiro registro DBRLOCK(110) // Bloqueia o registro de nmero 110 DBRLOCK(100) // Bloqueia o registro de nmero 100 DBRLOCKLIST() // Retorna: {1,100,110}
DBRUNLOCK()
A funo DBRUNLOCK() utilizada para liberar determinado registro bloqueado. O usurio pode escolher o registro a ser desbloqueado atravs do parmetro (Recno), mas se este for omitido ser desbloqueado o registro corrente como na funo DBUNLOCK(). Esta funo o oposto DBRLOCK, que bloquea os registros.
E Sintaxe: DBRUNLOCK([nREGISTRO])
E Parmetros:
nREGISTRO Nmero do registro a ser desbloqueado.
E Retorno:
Nenhum .
Exemplo:
DBUSEAREA( .T.,"dbfcdxads", "\dadosadv609\sa1990.dbf","SSS",.T., .F. ) DBGOTO(100) DBRUNLOCK() //Desbloqueia o registro atual (100) DBRUNLOCK(110) // Desbloqueia o registro de nmero 110
DBSETDRIVER()
A funo DBSETDRIVER() pode ser utilizada apenas para verificar qual o RDD que est definido como padro quando for omitido seu parmetro. Ela tambm pode ser utilizada para especificar outro RDD como padro, especificando-o atravs do parmetro.
E Sintaxe: DBSETDRIVER([cNOVORDD]) E Parmetros:
cNOVORDD Novo nome do RDD a ser definido como padro.
Note que ao utilizar a funo DBSETDRIVER para redefinir o driver corrente, o retorno da funo no ser o driver definido nos parmetros, mas o driver que estava em uso antes da atualizao.
DBSETINDEX()
A funo DBSETINDEX() utilizada para acrescentar uma ou mais ordens de determinado ndice na lista de ordens ativas da rea de trabalho. Quando o arquivo de ndice possui apenas uma ordem, a mesma acrescentada lista e torna-se ativa. Quando o ndice possui mais de uma ordem, todas so acrescentadas lista e a primeira torna-se ativa.
Para utilizar os arquivos de extenso padro do RDD este dado deve ser especificado.
E Sintaxe: DBSETINDEX(<@cARQINDICE>) E Parmetros:
cARQINDICE Nome do arquivo de ndice, com ou sem diretrio.
E Retorno:
Nenhum .
Exemplo: USE Cliente NEW DBSETINDEX("Ind1") DBSETINDEX("\teste\Ind2.cdx")
- 426 -
Guia de Referncia Rpida ADVPL Avanado
- 427 -
Guia de Referncia Rpida ADVPL Avanado
DBSETNICKNAME()
A funo DBSETNICKNAME() utilizada para colocar um apelido em determinada ordem especificada pelo primeiro parmetro. Caso seja omitido o nome do apelido a ser dado, a funo apenas verifica o apelido corrente.
E Sintaxe: DBSETNICKNAME(<cINDICE>, [cAPELIDO])
E Parmetros:
cINDICE Nome da ordem que deve receber o apelido. cAPELIDO Nome do apelido da ordem a ser setada.
E Retorno:
Caracter Retorna "" (String vazia) se no conseguiu encontrar a ordem especificada, no conseguiu setar o apelido ou no havia apelido. Retorna o apelido corrente.
Exemplo:
USE Cliente NEW DBSETNICKNAME("IndNome") // retorna: "" DBSETNICKNAME("IndNome","NOME") // retorna: "" DBSETNICKNAME("IndNome") // retorna: "NOME"
DBSELECTAREA()
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.
E Sintaxe: DbSelectArea(nArea | cArea) E Parmetros
nArea Valor numrico que representa a rea desejada, em funo de todas as reas j abertas pela aplicao, que pode ser utilizado ao invs do nome da rea. cArea Nome de referncia da rea de trabalho a ser selecionada.
Exemplo 01: DbselectArea(nArea)
nArea := Select(SA1) // 10 (proposto)
DbSelectArea(nArea) // De acordo com o retorno do comando Select()
ALERT(Nome do cliente: +A1_NOME) // Como o SA1 o alias selecionado, os comandos // a partir da seleo do alias compreendem que ele // est implcito na expresso, o que causa o mesmo // efeito de SA1->A1_NOME
- 428 -
Guia de Referncia Rpida ADVPL Avanado
Exemplo 02: DbselectArea(cArea)
DbSelectArea(SA1) // Especificao direta do alias que deseja-se selecionar
ALERT(Nome do cliente: +A1_NOME) // Como o SA1 o alias selecionado, os comandos // a partir da seleo do alias compreendem que ele // est implcito na expresso, o que causa o mesmo // efeito de SA1->A1_NOME
DBSETORDER()
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.
E Sintaxe: DbSetOrder(nOrdem) E Parmetros
nOrdem Nmero de referncia da ordem que deseja ser definida como ordem ativa para a rea de trabalho.
Exemplo:
DbSelectArea(SA1) DbSetOrder(1) // De acordo com o arquivo SIX -> A1_FILIAL+A1_COD+A1_LOJA
DBORDERNICKNAME()
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.
E Sintaxe: DbOrderNickName(NickName) E Parmetros
NickName NickName atribudo ao ndice criado pelo usurio
Exemplo:
DbSelectArea(SA1) DbOrderNickName(Tipo) // De acordo com o arquivo SIX -> A1_FILIAL+A1_TIPO NickName: Tipo
- 429 -
Guia de Referncia Rpida ADVPL Avanado
DBSEEK() E MSSEEK()
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.
E Sintaxe: DbSeek(cChave, lSoftSeek, lLast) E Parmetros
cChave Dados do registro que deseja-se localizar, de acordo com a ordem de busca previamente especificada pelo comando DbSetOrder(), ou seja, de acordo com o ndice ativo no momento para a rea de trabalho. lSoftSeek Define se o cursor ficar posicionado no prximo registro vlido, em relao a chave de busca especificada, ou em final de arquivo, caso no seja encontrada exatamente a informao da chave. Padro .F. lLast Define se o cursor ser posicionado no primeiro ou no ltimo registro de um intervalo com as mesmas informaes especificadas na chave. Padro .F.
Exemplo 01 Busca exata
DbSelectArea(SA1) DbSetOrder(1) // acordo com o arquivo SIX -> A1_FILIAL+A1_COD+A1_LOJA
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.
Desta forma, a thread mantm em memria os dados necessrios para reposicionar os registros j localizados atravs do comando DbSeek (no caso o Recno()) de forma que a aplicao pode simplesmente efetuar o posicionamento sem executar novamente a busca.
A diferena entre o DbSeek() e o MsSeek() notada em aplicaes com grande volume de posicionamentos, como relatrios, que necessitam referenciar diversas vezes o mesmo registro durante uma execuo.
DBSKIP()
Move o cursor do registro posicionado para o prximo (ou anterior dependendo do parmetro), em funo da ordem ativa para a rea de trabalho.
E Sintaxe: DbSkip(nRegistros) E Parmetros
nRegistros Define em quantos registros o cursor ser deslocado. Padro 1
Exemplo 01 Avanando registros
DbSelectArea(SA1) DbSetOrder(2) // A1_FILIAL + A1_NOME DbGotop() // Posiciona o cursor no incio da rea de trabalho ativa
While !EOF() // Enquanto o cursor da rea de trabalho ativa no indicar fim de arquivo MsgInfo(Voc est no cliente: + A1_NOME) DbSkip() End
Exemplo 02 Retrocedendo registros
DbSelectArea(SA1) DbSetOrder(2) // A1_FILIAL + A1_NOME DbGoBotton() // Posiciona o cursor no final da rea de trabalho ativa
While !BOF() // Enquanto o cursor da rea de trabalho ativa no indicar incio de arquivo MsgInfo(Voc est no cliente: + A1_NOME) DbSkip(-1) End
- 431 -
Guia de Referncia Rpida ADVPL Avanado
DBSETFILTER()
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.
E Sintaxe: DbSetFilter(bCondicao, cCondicao) E Parmetros
bCondicao Bloco de expressa a condio de filtro em forma executvel cCondicao Expresso de filtro simples na forma de string
A funo DBUNCLOK() retira os bloqueios dos registros e do arquivo da tabela corrente.
E Sintaxe: DBUNLOCK()
E Parmetros:
Nenhum .
E Retorno:
Nenhum .
- 433 -
Guia de Referncia Rpida ADVPL Avanado
DBUNLOCKALL()
A funo DBUNLOCKALL() Retira os bloqueios de todos os registros e dos arquivos de todas as tabelas abertas. Esta funo utilizada para liberar todos os registros bloqueados e equivalente a executar DBUNLOCK para todas as tabelas da rea de trabalho.
E Sintaxe: DBUNLOCKALL()
E Parmetros:
Nenhum .
E Retorno:
Nenhum .
DBUSEAREA()
Define um arquivo de base de dados como uma rea de trabalho disponvel na aplicao.
E Sintaxe: DbUseArea(lNovo, cDriver, cArquivo, cAlias, lComparilhado,; lSoLeitura)
E Parmetros
lNovo Parmetro opcional que permite que se caso o cAlias especificado j esteja em uso, ele seja fechado antes da abertura do arquivo da base de dados. cDriver Driver que permita a aplicao manipular o arquivo de base de dados especificado. A aplicao ERP possui a varivel __LOCALDRIVER definida a partir das configuraes do .ini do server da aplicao. Algumas chaves vlidas: DBFCDX, CTREECDX, DBFCDXAX, TOPCONN. cArquivo Nome do arquivo de base de dados que ser aberto com o alias especificado. cAlias Alias para referncia do arquivos de base de dados pela aplicao. lComparilhado Se o arquivo poder ser utilizado por outras conexes. lSoLeitura Se o arquivo poder ser alterado pela conexo ativa.
A funo DELETED() Verifica se o registro est com marca de excludo. Quando o registro excludo, permanece fisicamente na tabela, mas fica marcado como excludo. Esta funo verifica este estado. Se nenhuma rea est selecionada, retorna .F.. Quando executada a funo DBPACK() todos os registros marcados como deletados so apagados fisicamente. A funo DBRECALL() retira todas as marcas.
E Sintaxe: DELETED()
E Parmetros:
Nenhum .
E Retorno:
Nenhum .
Exemplo:
USE "\DADOSADV\AA1990.DBF" SHARED NEW DBGOTO(100) IF DELETED() Messagebox("O registro atual foi deletado","Erro", 0) ENDIF
FCOUNT()
A funo FCOUNT() avalia a quantidade de campos existentes na estrutura do arquivo ativo como rea de trabalho.
E Sintaxe: FCOUNT()
E Parmetros:
Nenhum .
E Retorno:
Numrico Quantidade de campos existentes na estrutura da rea de trabalho ativa.
Exemplo:
DbSelectArea(SA1) nFields := FCOUNT()
IF nFields > 0 MSGINFO(A estrutura da tabela contm :+CvalToChar(nFields)+campos.) ENDIF
- 435 -
Guia de Referncia Rpida ADVPL Avanado
FOUND()
A funo FOUND() recupera o resultado de sucesso referente a ltima operao de busca efetuada pelo processamento corrente.
E Sintaxe: FOUND()
E Parmetros:
Nenhum .
E Retorno:
Lgico Indica se a ltima operao de busca realizada pelo processamento corrente obteve sucesso (.T.) ou no (.F.).
IF Found() MSGINFO(Cliente encontrado) ELSE MSGALERT(Dados no encontrados) ENDIF
INDEXKEY()
A funo INDEXKEY() determina a expresso da chave de um ndice especificado na rea de trabalho corrente, e o retorna na forma de uma cadeia de caracteres, sendo normalmente utilizada na rea de trabalho correntemente selecionada.
E Sintaxe: INDEXKEY()
E Parmetros:
nOrdem Ordem do ndice na lista de ndices abertos pelo comando USE...INDEX ou SET INDEX TO na rea de trabalho corrente. O valor default zero especifica o ndice corrente, independentemente de sua posio real na lista.
E Retorno:
Caracter Expresso da chave do ndice especificado na forma de uma cadeia de caracteres. Caso no haja um ndice correspondente, INDEXKEY() retorna uma cadeia de caracteres vazia ("").
Exemplo:
cExpressao := SA1->(IndexKey())
- 436 -
Guia de Referncia Rpida ADVPL Avanado
INDEXORD()
A funo INDEXORD() verifica a posio do ndice corrente na lista de ndices do respectivo alias.
E Sintaxe: INDEXORD()
E Parmetros:
Nenhum .
E Retorno:
Numrico Posio do ndice corrente na lista de ndices da tabela. Retorna 0 se no existe ndice aberto na tabela corrente.
Exemplo:
USE Cliente NEW SET INDEX TO Nome, End, Cep nOrd:=INDEXORD() // Return: 1 - o primeiro ndice da lista
LUPDATE()
A funo LUPDATE() verifica qual a data da ltima modificao e fechamento da tabela corrente, sendo que caso no exista tabela corrente retornada uma data em branco.
E Sintaxe: LUPDATE()
E Parmetros:
Nenhum .
E Retorno:
Data Retorna um valor do tipo Data , indicando a data da ultima modificao e fechamento da Tabela. Caso no haja tabela selecionada na rea de trabalho atual , a funo retornar uma data vazia (ctod("")) .
Exemplo:
// Mostra a data da ltima modificao da tabela corrente, dModificacao := LUpdate() IF (EMPTY(dModificacao)) CONOUT("No h tabela corrente") ELSE CONOUT(("Data da ultima modificacao : " + DTOS(dModificacao))) ENDIF
- 437 -
Guia de Referncia Rpida ADVPL Avanado
MSAPPEND()
A funo MsAppend() adiciona registros de um arquivo para outro, respeitando a estrutura das tabelas.
E Sintaxe: MSAPPEND( [cArqDest], cArqOrig )
E Parmetros:
cArqDest Se o RDD corrente for DBFCDX os registros sero adicionados na rea selecionada, caso contrrio o arquivo destino ter que ser informado. cArqOrig Nome do arquivo origem contendo os registros a serem adicionados.
E Retorno:
Lgico Se a operao for realizada com sucesso o funo retornar verdadeiro (.T.).
Exemplo: dbSelectArea(XXX) MsAppend(,ARQ00001)
MSUNLOCK()
Libera o travamento (lock) do registro posicionado confirmando as atualizaes efetuadas neste registro.
IF Found() // Avalia o retorno do ltimo DbSeek realizado RecLock(SA1,.F.) SA1->A1_NOME := CLIENTE CURSO ADVPL BSICO SA1->A1_NREDUZ := ADVPL BSICO MsUnLock() // Confirma e finaliza a operao ENDIF
- 438 -
Guia de Referncia Rpida ADVPL Avanado
ORDBAGEXT()
A funo ORDBAGEXT utilizada no gerenciamento de indices para os arquivos de dados do sistema, permitindo avaliar qual a extenso deste ndices atualmente em uso, de acordo com a RDD ativa.
E Sintaxe: ORDBAGEXT()
E Parmetros:
Nenhum .
E Retorno:
cBagExt Extenso do arquivo dos arquivos de ndices em uso pelo sistema, determinado pela RDD ativa.
A funo ORDKEY() verifica qual a expresso de chave de determinada ordem. Caso no sejam especificados os parmetros de identificao da ordem, verificada a ordem corrente. Para evitar conflito, no caso de haver mais de uma ordem com o mesmo nome, pode-se passar o parmetro com o nome do ndice ao qual a ordem pertence.
A ordem passada no primeiro parmetro pode ser especificada atravs da sua posio na lista de ordens ativas (atravs do ORDLISTADD) ou atravs do nome dado ordem. A funo verifica automaticamente se o parmetro numrico ou caracter.
E Sintaxe: ORDKEY([cOrdem | nPosicao] , [cArqIndice])
E Parmetros:
cOrdem nPosicao H duas opes para o primeiro parmetro: cNome: tipo caracter, contm nome do ndice. nPosicao: tipo numrico, indica ordem do ndice. cArqIndice Nome do arquivo de ndice.
E Retorno:
Caracter Expresso de chave da ordem ativa ou especificada pelos parmetros. Cadeia vazia indica que no existe ordem corrente.
Exemplo:
USE Cliente NEW INDEX ON Nome+Cod TO Ind1 FOR Nome+Cod > 'AZZZZZZZ' ORDKEY('Ind1') // Retorna: Nome+Cod
RECLOCK()
Efetua o travamento do registro posicionado na rea de trabalho ativa, permitindo a incluso ou alterao das informaes do mesmo.
E Sintaxe: RecLock(cAlias,lInclui) E Parmetros
cAlias Alias que identifica a rea de trabalho que ser manipulada. lInclui Define se a operao ser uma incluso (.T.) ou uma alterao (.F.)
Exemplo 01 - Incluso DbSelectArea(SA1) RecLock(SA1,.T.) SA1->A1_FILIAL := xFilial(SA1) // Retorna a filial de acordo com as configuraes do ERP SA1->A1_COD := 900001 SA1->A1_LOJA := 01 MsUnLock() // Confirma e finaliza a operao
IF Found() // Avalia o retorno do ltimo DbSeek realizado RecLock(SA1,.F.) SA1->A1_NOME := CLIENTE CURSO ADVPL BSICO SA1->A1_NREDUZ := ADVPL BSICO MsUnLock() // Confirma e finaliza a operao ENDIF
A linguagem ADVPL possui variaes da funo RecLock(), as quais so:
E RLOCK() E DBRLOCK()
- 439 -
Guia de Referncia Rpida ADVPL Avanado
A sintaxe e a descrio destas funes esto disponveis no Guia de Referncia Rpido ao final deste material.
A linguagem ADVPL possui variaes da funo MsUnlock(), as quais so:
E UNLOCK() E DBUNLOCK() E DBUNLOCKALL()
A sintaxe e a descrio destas funes esto disponveis no Guia de Referncia Rpido ao final deste material.
RECNO()
A funo RECNO() retorna o nmero do registro atualmente posiconado na rea de trabalho ativa.
E Sintaxe: RECNO()
E Parmetros:
Nenhum .
E Retorno:
nRecno Identificador numrico do registro atualmente posicionando na rea de trabalho ativa.
Exemplo:
DbSelectArea(SA1) DbGoto(100) // Posiciona no registro de recno 100. MSGINFO(Registro posicionado:+cValToChar(RECNO()))
SELECT()
A funo SELECT() determina o nmero da rea de trabalho de um alias. O nmero retornado pode variar de zero a 250. Se <cAlias> no for especificado, retornado o nmero da rea de trabalho corrente. Caso <cAlias> seja especificado e o alias nao existir, SELECT() retorna zero.
E Sintaxe: SELECT([cAlias])
E Parmetros:
cAlias Nome da rea de trabalho a ser verificada.
E Retorno:
Numrico rea de trabalho do alias especificado na forma de um valor numrico inteiro.
- 440 -
Guia de Referncia Rpida ADVPL Avanado
Exemplo:
nArea := Select(SA1)
ALERT(Referncia do alias SA1: +STRZERO(nArea,3)) // 10 (proposto)
SET FILTER TO
O comando SET FILTER TO define uma condio de filtro que ser aplicada a rea de trabalho ativa.
Recomenda-se o uso da funo DbSetFilter() em substituio ao comando SET FILTER TO
E Sintaxe: SET FILTER TO cCondicao
E Parmetros:
cCondicao Expresso que ser avaliada pela SET FILTER, definindo os registros que ficaro disponveis na rea de trabalho ativa. Esta expresso obrigatoriamente deve ter um retorno lgico.
E Retorno:
Nenhum .
O uso da sintaxe SET FILTER TO desativa o filtro na rea de trabalho corrente.
Exemplo:
USE Employee INDEX Name NEW
SET FILTER TO Age > 50
LIST LastName, FirstName, Age, Phone
SET FILTER TO
- 441 -
Guia de Referncia Rpida ADVPL Avanado
SOFTLOCK()
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.
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.
E Sintaxe: SoftLock(cAlias)
E Parmetros
cAlias Alias de referncia da rea de trabalho ativa, para o qual o registro posicionado ser travado.
Exemplo:
cChave := GetCliente() // Funo ilustrativa que retorna os dados de busca de um cliente
DbSelectArea(SA1) DbSetOrder(1) DbSeek(cChave)
IF Found() SoftLock() // Reserva o registro localizado lConfirma := AlteraSA1() // Funo ilustrativa que exibe os dados do registro // posicionado e pemite a alterao dos mesmos.
IF lConfirma RecLock(SA1,.F.) GravaSA1() // Funo ilustrativa que altera os dados conforme a AlertaSA1() MsUnLock() // Liberado o RecLock() e o SoftLock() do registro. Endif Endif
- 442 -
Guia de Referncia Rpida ADVPL Avanado
- 443 -
Guia de Referncia Rpida ADVPL Avanado
USED()
A funo USED() utilizada para determinar se h um arquivo de banco de dados em uso em uma rea de trabalho especfica. O padro que USED() opere na rea de trabalho correntemente selecionada.
E Sintaxe: USED() E Parmetros:
Nenhum .
E Retorno:
Lgico Verdadeiro (.T.) caso haja um arquivo de banco de dados em uso; caso contrrio, retorna falso (.F.).
Exemplo: USE Customer NEW CONOUT(USED()) // Resulta: .T. CLOSE CONOUT (USED()) // Resulta: .F.
ZAP
O comando ZAP remove fisicamente todos os registro da tabela corrente. necessrio que o alias em questo seja aberto em modo exclusivo para esta operao ser realizada.
E Sintaxe: ZAP E Parmetros:
Nenhum .
E Retorno:
Nenhum .
Exemplo: cTabela := RetSqlName("SA4") cAlias := "TMP" USE (cTabela) ALIAS (cAlias) EXCLUSIVE NEW VIA "TOPCONN" IfNetErr() MsgStop("Nao foi possivel abrir "+cTabela+" em modo EXCLUSIVO.") Else ZAP USE MsgStop("Registros da tabela "+cTabela+" eliminados com sucesso.") Endif
Controle de numerao seqencial
GETSXENUM()
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.
E Sintaxe: GETSXENUM(cAlias, cCampo, cAliasSXE, nOrdem) E Parmetros
cAlias Alias de referncia da tabela para a qual ser efetuado o controle da numerao seqencial. cCampo Nome do campo no qual est implementado o controle da numerao. cAliasSXE Parmetro opcional, quando o nome do alias nos arquivos de controle de numerao no o nome convencional do alias para o sistema ERP. nOrdem Nmero do ndice para verificar qual a prxima ocorrncia do nmero.
CONFIRMSXE()
Confirma o nmero alocado atravs do ltimo comando GETSXENUM().
E Sintaxe: CONFIRMSXE(lVerifica) E Parmetros
lVerifica
Verifica se o nmero confirmado no foi alterado, e por conseqncia j existe na base de dados.
ROLLBACKSXE()
Descarta o nmero fornecido pelo ltimo comando GETSXENUM(), retornando a numerao disponvel para outras conexes.
E Sintaxe: ROLLBACKSXE() E Parmetros
Nenhum .
- 444 -
Guia de Referncia Rpida ADVPL Avanado
- 445 -
Guia de Referncia Rpida ADVPL Avanado
Validao
ALLWAYSFALSE()
A funo AllwaysFalse() foi criada com o objetivo de compatibilidade, sendo que sempre ir retornar um valor lgico falso, facilitando a especificao desta situao nas parametrizaes de validaes de modelos de interface pr-definidos no sistema.
E Sintaxe: ALLWAYSFALSE()
E Parmetros:
Nenhum .
E Retorno:
Lgico Retorna um valor lgico sempre falso.
ALLWAYSTRUE()
A funo AllwaysTrue() foi criada com o objetivo de compatibilidade, sendo que sempre ir retornar um valor lgico verdadeiro, facilitando a especificao desta situao nas parametrizaes de validaes de modelos de interface pr-definidos no sistema.
E Sintaxe: ALLWAYSTRUE()
E Parmetros:
Nenhum .
E Retorno:
Lgico Retorna um valor lgico sempre verdadeiro.
EXISTCHAV()
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.
E Sintaxe: ExistChav(cAlias, cConteudo, nIndice) E Parmetros
cAlias Alias de referncia para a validao da informao. cConteudo Chave a ser pesquisada, sem a filial. nIndice ndice de busca para consulta da chave.
- 446 -
Guia de Referncia Rpida ADVPL Avanado
EXISTCPO()
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.
E Sintaxe: ExistCpo(cAlias, cConteudo, nIndice) E Parmetros
cAlias Alias de referncia para a validao da informao. cConteudo Chave a ser pesquisada, sem a filial. nIndice ndice de busca para consulta da chave.
LETTERORNUM()
A funo LETTERORNUM() avalia se um determinado contedo composto apenas de letras e nmeros (alfanumrico).
E Sintaxe: LETTERORNUM(cString)
E Parmetros:
cString String que ter seu contedo avaliado.
E Retorno:
Lgico Indica que se a string avaliada contm apenas letras e nmero, ou seja, alfanumrico.
NAOVAZIO()
Retorna .T. ou .F. se o contedo do campo posicionado no momento no est vazio.
E Sintaxe: NaoVazio() E Parmetros
Nenhum .
NEGATIVO()
Retorna .T. ou .F. se o contedo digitado para o campo negativo.
E Sintaxe: Negativo() E Parmetros
Nenhum .
PERTENCE()
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().
E Sintaxe: Pertence(cString) E Parmetros
cString
String contendo as informaes vlidas que podem ser digitadas para um campo.
POSITIVO()
Retorna .T. ou .F. se o contedo digitado para o campo positivo.
E Sintaxe: Positivo() E Parmetros
Nenhum .
TEXTO()
Retorna .T. ou .F. se o contedo digitado para o campo contm apenas nmeros ou alfanumricos.
E Sintaxe: Texto() E Parmetros
Nenhum .
VAZIO()
Retorna .T. ou .F. se o contedo do campo posicionado no momento est vazio.
E Sintaxe: Vazio() E Parmetros
Nenhum .
- 447 -
Guia de Referncia Rpida ADVPL Avanado
Manipulao de parmetros do sistema
GETMV()
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.
E Sintaxe: GETMV(cParametro) E Parmetros
cParametro
Nome do parmetro do sistema no SX6, sem a especificao da filial de sistema.
GETNEWPAR()
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.
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.
E Sintaxe: GETNEWPAR(cParametro, cPadrao, cFilial) E Parmetros
cParametro
Nome do parmetro do sistema no SX6, sem a especificao da filial de sistema.
cPadrao Contedo padro que ser utilizado caso o parmetro no exista no SX6. cFilial
Define para qual filial ser efetuada a consulta do parmetro. Padro filial corrente da conexo.
- 448 -
Guia de Referncia Rpida ADVPL Avanado
PUTMV()
Atualiza o contedo do parmetro especificado no arquivo SX6, de acordo com as parametrizaes informadas.
E Sintaxe: PUTMV(cParametro, cConteudo) E Parmetros
cParametro Nome do parmetro do sistema no SX6, sem a especificao da filial de sistema. cConteudo Contedo que ser atribudo ao parmetro no SX6.
SUPERGETMV()
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.
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.
E Sintaxe: SUPERGETMV(cParametro , lHelp , cPadrao , cFilial) E Parmetros
cParametro
Nome do parmetro do sistema no SX6, sem a especificao da filial de sistema.
lHelp
Se ser exibida a mensagem de Help caso o parmetro no seja encontrado no SX6.
cPadrao Contedo padro que ser utilizado caso o parmetro no exista no SX6. cFilial
Define para qual filial ser efetuada a consulta do parmetro. Padro filial corrente da conexo.
- 449 -
Guia de Referncia Rpida ADVPL Avanado
- 450 -
Guia de Referncia Rpida ADVPL Avanado
Controle de impresso
AVALIMP()
A funo AVALIMP() utilzada em relatrios especficos em substituio da funo CABEC(), configurando a impressora de acordo com o driver escolhido e os parmetros de impresso disponveis no array aReturn, respeitando o formato utilizado pela funo SETPRINT().
E Sintaxe: AVALIMP(nLimite)
E Parmetros:
nLimite Tamanho do relatrio em colunas, podendo assumir os valores 80,132 ou 220 colunas, respectivamente para os formatos P, M ou G de impresso.
E Retorno:
Caracter String com caracteres de controle, dependente das configuraes escolhidas pelo usurio e do arquivo de driver especificado.
Exemplo:
/*/ +----------------------------------------------------------------------------- | Funo | XAVALIMP | Autor | ARNALDO RAYMUNDO JR. | Data | 01.01.2007 | +----------------------------------------------------------------------------- | Descrio | Exemplo de utilizao da funo AXCADASTRO() | |+---------------------------------------------------------------------------- | Uso | Curso ADVPL | |+---------------------------------------------------------------------------- /*/
USER FUNCTION XAVALIMP()
LOCAL cTitulo := PADC(AVALIMP,74) LOCAL cDesc1 := PADC(Demonstrao do uso da funo AVALIMP(),74) LOCAL cDesc2 := LOCAL cDesc3 := PADC(CURSO DE ADVPL,74) LOCAL cTamanho := G LOCAL cLimite := 220 LOCAL cNatureza := LOCAL aReturn := {Especial, 1,Administrao, 1, 2, 2,,1} LOCAL cNomeProg := RAVALIMP LOCAL cPerg := PADR(RAVALIMP,10) // Compatibilizao com MP10 LOCAL nLastKey := 0 LOCAL cString :=SF2"
cTitulo Ttulo do relatrio cCabec1 String contendo as informaes da primeira linha do cabealho cCabec2 String contendo as informaes da segunda linha do cabealho cNomeProg Nome do programa de impresso do relatrio. nTamanho Tamanho do relatrio em colunas (80, 132 ou 220) nCompress Indica se impresso ser comprimida (15) ou normal (18). aCustomText Texto especfico para o cabealho, substituindo a estrutura padro do sistema. lPerg Permite a supresso da impresso das perguntas do relatrio, mesmo que o parmetro MV_IMPSX1 esteja definido como S
- 452 -
Guia de Referncia Rpida ADVPL Avanado
E Parmetros (continuao):
cLogo Redefine o bitmap que ser impresso no relatrio, no necessitando que ele esteja no formato padro da Microsiga: "LGRL"+SM0->M0_CODIGO+SM0->M0_CODFIL+".BMP"
E Retorno:
Nenhum .
Exemplo:
#INCLUDE "protheus.ch"
/*/ +----------------------------------------------------------------------------- | Funo | MPTR001 | Autor | ARNALDO RAYMUNDO JR. | Data | 01.01.2007 | +----------------------------------------------------------------------------- | Descrio | Exemplo de utilizao das funes de impresso CABEC() | |+---------------------------------------------------------------------------- | Uso | Curso ADVPL | |+---------------------------------------------------------------------------- /*/
User Function MPTR001()
Local cDesc1 := "Este programa tem como objetivo imprimir relatorio " Local cDesc2 := "de acordo com os parametros informados pelo usuario." Local cDesc3 := "Listagem de clientes" Local cTitulo := "Listagem de clientes" Local lImprime := .T.
// Parametros da SetPrint() Local cString := "SA1" Local cPerg := "" Local lDic := .T. // Habilita a visalizacao do dicionario Local aOrd := RetSixOrd(cString) Local lCompres := .T. // .F. - Normal / .T. - Comprimido Local lFilter := .T. // Habilita o filtro para o usuario Local cNomeProg := "MPTR002" Local cTamanho := "M" Local nTipo := 18 Local nLimite := 132
// // Monta a interface padrao com o usuario... // wnrel := SetPrint(cString,cNomeProg,cPerg,@cTitulo,cDesc1,cDesc2,cDesc3,lDic,aOrd,lCompre s,cTamanho,,lFilter)
// // Processamento. RPTSTATUS monta janela com a regua de processamento. // RptStatus({|| RunReport(cTitulo,cString,cNomeProg,cTamanho,nTipo,nLimite)},cTitulo) Return
/*/ +----------------------------------------------------------------------------- | Funo | RUNREPORT | Autor | -------------------- | Data | 01.01.2007 | +----------------------------------------------------------------------------- | Descrio | Funo interna de processamento utilizada pela MPTR001() | |+---------------------------------------------------------------------------- | Uso | Curso ADVPL | |+---------------------------------------------------------------------------- /*/
Static Function RunReport(cTitulo,cString,cNomeProg,cTamanho,nTipo,nLimite)
Local nLin := 80 Local cCabec1 := "" Local cCabec2 := "" Local cArqInd
If lAbortPrint .OR. nLastKey == 27 @nLin,00 PSAY "*** CANCELADO PELO OPERADOR ***" Exit Endif
If nLin > 55 // Salto de Pgina. Neste caso o formulario tem 55 linhas... Cabec(cTitulo,cCabec1,cCabec2,cNomeProg,cTamanho,nTipo) nLin := 9 Endif ...
IMPCADAST()
A funo IMPCADAST() cria uma interface simples que permite a impresso dos cadastros do sistema com parametrizao DE/ATE.
E Sintaxe: IMPCADAST(cCab1, cCab2, cCab3, cNomeProg, cTam, nLimite, cAlias)
E Parmetros:
cCab1 Primeira linha do cabealho cCab2 Segunda linha do cabealho cCab3 Terceira linha do cabealho cNomeProg Nome do programa cTam Tamanho do relatrio nos formatos P, M e G. nLimite Nmero de colunas do relatrio, seguindo o formato especificado no tamanho, aonde: P- 80 colunas M- 132 colunas G- 220 colunas cAlias Alias do arquivo de cadastro que ser impresso
E Retorno:
Nenhum .
MS_FLUSH()
A funo MS_FLUSH() envia o spool de impresso para o dispositivo previamente especificado com a utilizao das funes AVALIMP() ou SETPRINT().
E Sintaxe: MS_FLUSH()
E Parmetros:
Nenhum .
- 455 -
Guia de Referncia Rpida ADVPL Avanado
E Retorno:
Nenhum .
Exemplo:
/*/ +----------------------------------------------------------------------------- | Funo | RUNREPORT | Autor | -------------------- | Data | 01.01.2007 | +----------------------------------------------------------------------------- | Descrio | Funo interna de processamento utilizada pela MPTR001() | |+---------------------------------------------------------------------------- | Uso | Curso ADVPL | |+---------------------------------------------------------------------------- | Observao| Continuao do exemplo da funo CABEC() | |+---------------------------------------------------------------------------- /*/
Static Function RunReport(cTitulo,cString,cNomeProg,cTamanho,nTipo,nLimite)
Local nLin := 80 Local cCabec1 := "" Local cCabec2 := "" Local cArqInd
If lAbortPrint .OR. nLastKey == 27 @nLin,00 PSAY "*** CANCELADO PELO OPERADOR ***" Exit Endif
If nLin > 55 // Salto de Pgina. Neste caso o formulario tem 55 linhas... Cabec(cTitulo,cCabec1,cCabec2,cNomeProg,cTamanho,nTipo) nLin := 9 Endif
// Primeira linha de detalhe: @nLin,000 PSAY TRBSA1->A1_COD @nLin,008 PSAY TRBSA1->A1_LOJA @nLin,014 PSAY TRBSA1->A1_NREDUZ @nLin,036 PSAY TRBSA1->A1_NOME @nLin,078 PSAY TRBSA1->A1_CGC @nLin,100 PSAY TRBSA1->A1_INSCR @nLin,122 PSAY TRBSA1->A1_CEP nLin++
- 456 -
Guia de Referncia Rpida ADVPL Avanado
Exemplo (continuao):
// Segunda linha de detalhe @nLin,000 PSAY TRBSA1->A1_EST @nLin,008 PSAY TRBSA1->A1_MUN @nLin,025 PSAY TRBSA1->A1_END nLin++
//Linha separadora de detalhes @nLin,000 PSAY Replicate("-",nLimite) nLin++
dbSkip() // Avanca o ponteiro do registro no arquivo EndDo
SET DEVICE TO SCREEN
If aReturn[5]==1 dbCommitAll() SET PRINTER TO OurSpool(wnrel) Endif
MS_FLUSH() RETURN
OURSPOOL()
A funo OURSPOOL() executa o gerenciador de impresso da aplicao Protheus, permitindo a visualizao do arquivo de impresso gerado pelo relatrio no formato PostScrip com extenso ##R.
E Sintaxe: OURSPOOL(cArquivo)
E Parmetros:
cArquivo Nome do relatrio a ser visualizado.
E Retorno:
. .
Exemplo:
If aReturn[5]==1 // Indica impresso em disco. dbCommitAll() SET PRINTER TO OurSpool(wnrel) Endif
RODA()
A funo RODA() imprime o rodap da pgina do relatrio, o que pode ser feito a cada pgina, ou somente ao final da impresso.
Pode ser utilizado o ponto de entrada "RodaEsp" para tratamento de uma impresso especfica.
E Sintaxe: Roda(uPar01, uPar02, cSize)
E Parmetros:
uPar01 No mais utilizado uPar02 No mais utilizado cSize Tamanho do relatrio (P,M,G)
E Retorno:
Nenhum .
Exemplo:
/*/ +----------------------------------------------------------------------------- | Funo | TESTIMPR | Autor | MICROSIGA | Data | 01.01.2007 | +----------------------------------------------------------------------------- | Descrio | Exemplo de utilizao da funo RODA() em conjunto com a CABEC.| |+---------------------------------------------------------------------------- | Uso | Curso ADVPL | |+---------------------------------------------------------------------------- /*/
#include "protheus.ch"
User Function TestImpr() Local wnrel Local cString := "SA1" Local titulo := "Teste Impresso de Relatorios" Local NomeProg := "XXX" Local Tamanho := "M"
aReturn Configuraes de impresso. cAlias Alias do arquivo a ser impresso. uParm3 Parmetro reservado. uParm4 Parmetro reservado. cSize Tamanho da pgina "P","M" ou "G" nFormat Formato da pgina, 1 retrato e 2 paisagem.
E Retorno:
Nenhum .
E Estrutura aReturn:
aReturn[1] Caracter, tipo do formulrio aReturn[2] Numrico, opo de margem aReturn[3] Caracter, destinatrio aReturn[4] Numrico, formato da impresso aReturn[5] Numrico, dispositivo de impresso aReturn[6] Caracter, driver do dispositivo de impresso aReturn[7] Caracter, filtro definido pelo usurio aReturn[8] Numrico, ordem aReturn[x] A partir a posio [9] devem ser informados os nomes dos campos que devem ser considerados no processamento, definidos pelo uso da opo Dicionrio da SetPrint().
- 459 -
Guia de Referncia Rpida ADVPL Avanado
- 460 -
Guia de Referncia Rpida ADVPL Avanado
SETPRC()
A funo SETPRC() utilizada para posicionar o dispositivo de impresso ativo, previamente definido pelo uso das funes AVALIMP() ou SETPRINT() , em uma linha/coluna especificada.
E Sintaxe: SETPRC(nLinha, nColuna)
E Parmetros:
nLinha Linha na qual dever ser posicionado o dispositivo de impresso. nColuna Coluna na qual dever ser posicionado o dispositivo de impresso.
A funo SetPrint() cria uma interface padro onde as opes de impresso de um relatrio podem ser configuradas. Basicamente duas variveis m_pag e aReturn precisam ser declaradas como privadas (private) antes de executar a SetPrint(), sendo que:
O m_pag: controla o nmero de pginas. O aReturn: vetor contendo as opes de impresso, sendo sua estrutura bsica composta de 8 (oito) elementos.
Aps confirmada, os dados so armazenados no vetor aReturn que ser passado como parmetro para funo SetDefault().
cAlias Alias do arquivo a ser impresso. cProgram Nome do arquivo a ser gerado em disco. cPergunte Grupo de perguntas cadastrado no dicionrio SX1. cTitle Ttulo do relatrio.
- 461 -
Guia de Referncia Rpida ADVPL Avanado
E Parmetros (continuao):
cDesc1 Descrio do relatrio. cDesc2 Continuao da descrio do relatrio. cDesc3 Continuao da descrio do relatrio. lDic Utilizado na impresso de cadastro genrico permite a escolha dos campos a serem impressos. Se o parametro cAlias no for informado o valor padro assumido ser .F. aOrd Ordem(s) de impresso. lCompres Se verdadeiro (.T.) permite escolher o formato da impresso, o valor padro assumido ser .T. cSize Tamanho do relatrio "P","M" ou "G". uParm12 Parmetro reservado lFilter Se verdadeiro (.T.) permite a utilizao do assistente de filtro, o valor padro assumido ser .T. lCrystal Se verdadeiro (.T.) permite integrao com Crystal Report, o valor padro assumido ser .F. cNameDrv Nome de um driver de impresso. uParm16 Parmetro reservado. lServer Se verdadeiro (.T.) fora impresso no servidor. cPortPrint Define uma porta de impresso padro.
E Retorno:
Caracter Nome do Relatrio
E Estrutura aReturn:
aReturn[1] Caracter, tipo do formulrio aReturn[2] Numrico, opo de margem aReturn[3] Caracter, destinatrio aReturn[4] Numrico, formato da impresso aReturn[5] Numrico, dispositivo de impresso aReturn[6] Caracter, driver do dispositivo de impresso aReturn[7] Caracter, filtro definido pelo usurio aReturn[8] Numrico, ordem aReturn[x] A partir a posio [9] devem ser informados os nomes dos campos que devem ser considerados no processamento, definidos pelo uso da opo Dicionrio da SetPrint().
- 462 -
Guia de Referncia Rpida ADVPL Avanado
Controle de processamentos
ABREEXCL()
A funo ABREEXCL() fecha o arquivo cujo alias est expresso em <cAlias> e o reabre em modo exclusivo para proceder operaes em que isto necessrio, como por exemplo, PACK. Se outra estao estiver usando o arquivo, o retorno ser .F..
E Sintaxe: ABREEXCL(cAlias)
E Parmetros:
cAlias Alias do arquivo que ser re-aberto em modo exclusivo.
E Retorno:
Lgico Indica se foi possvel abrir o arquivo em modo exclusivo.
CLOSEOPEN()
A funo CLOSEOPEN() utilizada para fechar e re-abrir uma lista de arquivos especificada.
E Sintaxe: CLOSEOPEN(aClose, aOpen)
E Parmetros:
aClose Array contendo os Aliases dos arquivos que devero ser fechados. aOpen Array contendo os Aliases dos arquivos que devero ser abertos.
E Retorno:
Lgico Indica se todos os arquivos especificados em aOpen foram abertos com sucesso.
CLOSESFILE()
A funo CLOSESFILE() fecha todos os arquivos em uso pela conexo, com exceo dos SXs (inclusive SIX), SM2 e SM4.
E Sintaxe: CLOSESFILE(cAlias)
E Parmetros:
cAlias String contendo os nomes dos demais Aliases que no devero ser fechados, separando os itens com /.
E Retorno:
Lgico Indica se todos os arquivos foram fechados com sucesso.
CHKFILE()
A funo CHKFILE() retorna verdadeiro (.T.) se o arquivo j estiver aberto ou se o Alias no for informado. Sempre que desejar mudar o modo de acesso do arquivo (de compartilhado para exclusivo ou vice-versa), feche-o antes de cham-la.
E Sintaxe: ChkFile(cAlias,lExcl,cNewAlias)
E Parmetros:
cAlias Alias do arquivo a ser re-aberto. lExcl Se for informado verdadeiro (.T.), o arquivo ser aberto em modo exclusivo, caso contrrio, o arquivo ser aberto em modo compartilhado. Se este parmetro no for informado, ser assumido falso (.F.). cNewAlias Novo Alias para re-abertura do arquivo.
E Retorno:
Lgico Indica se o arquivo foi re-aberto com sucesso.
Exemplo:
dbSelectArea(SA1) dbCloseArea() lOk := .T. While .T. IF !ChkFile(SA1,.T.) nResp := Alert(Outro usurio usando! Tenta de novo?,{Sim,Nao}) If nResp == 2 lOk := .F. Exit Endif Endif EndDo If lOk // Faz o processamento com o arquivo... Endif // Finaliza If Select(SA1) dbCloseArea() Endif ChkFile(SA1,.F.) Return
- 463 -
Guia de Referncia Rpida ADVPL Avanado
- 464 -
Guia de Referncia Rpida ADVPL Avanado
CONOUT()
A funo CONOUT() permite a exibio de uma mensagem de texto no console do Server do Protheus. Caso o Protheus esteja configurado como servio a mensagem ser gravada no arquivo de log.
E Sintaxe: CONOUT(cMensagem)
E Parmetros:
cMensagem String contendo a mensagem que dever ser exibida no console do Protheus.
E Retorno:
Nenhum .
CRIAVAR()
A funo CRIAVAR() cria uma varivel, retornando o valor do campo, de acordo com o dicionrio de dados, inclusive avaliando o inicializador padro, permitindo um retorno de acordo com o tipo de dado definido no dicionrio.
E Sintaxe: CriaVar(cCampo,lIniPad,cLado)
E Parmetros:
cCampo Nome do campo lIniPad Indica se considera (.T.) ou no (.F.) o inicializador cLado Se a varivel for caracter, cLado pode ser: C - centralizado, L - esquerdo ou R direito.
E Retorno:
Indefinido Tipo de dado de acordo com o dicionrio de dados, considerando inicializador padro
Exemplo:
// Exemplo do uso da funo CriaVar: cNumNota := CriaVar(F2_DOC) // Retorna o contedo do // inicializador padro, // se existir, ou espaos em branco Alert(cNumNota) Return
DISARMTRANSACTION()
A funo DISARMTRANSATCION() utilizada para realizar um RollBack de uma transao aberta com o comando BEGIN TRANSACTION e delimitada com o comando END TRANSACTION.
Ao utilizar esta funo, todas as alteraes realizadas no intervalo delimitado pela transao so desfeitas, restaurando a situao da base de dados ao ponto imediatamente anterior ao incio do processamento.
O uso da funo DISARMTRANSACTION() no finaliza a conexo ou o processamento corrente.
Caso seja necessrio alm de desfazer as alteraes, finalizar o processamento, dever ser utilizada a funo USEREXCEPTION().
A funo EXECBLOCK() executa uma funo de usurio que esteja compilada no repositrio. Esta funo normalmente utilizada pelas rotinas padres da aplicao Protheus para executar pontos de entrada durante seu processamento.
A funo de usurio executada atravs da EXECBLOCK() no recebe parmetros diretamente, sendo que estes estaro disponveis em uma varivel private denominada PARAMIXB.
A varivel PARAMIXB o reflexo do parmetro xParam, definido na execuo da funo EXECBLOCK(). Caso seja necessria a passagem de vrias informaes, as mesmas devero ser definidas na forma de um array, tornando PARAMIXB um array tambm, a ser tratado na funo de usurio que ser executada.
EXISTBLOCK()
A funo EXISTBLOCK() verifica a existncia de uma funo de usurio compilada no repositrio de objetos da aplicao Protheus. Esta funo normalmente utilizada nas rotinas padres da apliao Protheus para determinar a existncia de um ponto de entrada e permitir sua posterior execuo.
E Sintaxe: EXISTBLOCK(cFuno)
E Parmetros:
cFuno Nome da funo que ser avaliada.
E Retorno:
Lgico Indica se a funo de usurio existe compilada no repositrio de objetos corrente.
Exemplo:
IF EXISTBLOCK(MT100GRV) EXECBLOCK(MT100GRV,.F.,.F.,aParam) ENDIF
- 466 -
Guia de Referncia Rpida ADVPL Avanado
- 467 -
Guia de Referncia Rpida ADVPL Avanado
E Sintaxe: EXECBLOCK(cFuno, lReserv1, lReserv2, xParam)
E Parmetros:
cFuno Nome da funo de usurio que ser executada. lReserv1 Parmetro de uso reservado da aplicao. Definir como .F. lReserv2 Parmetro de uso reservado da aplicao. Definir como .F. xParam Contedo que ficar disponvel na funo de usurio executada, na forma da varivel private PARAMIXB.
E Retorno:
Indefinido O retorno da EXECBLOCK() definido pela funo que ser executada.
Exemplo:
aParam := {cNota, cSerie, cFornece, cLoja)
IF EXISTBLOCK(MT100GRV) lGravou := EXECBLOCK(MT100GRV,.F.,.F.,aParam) ENDIF
USER FUNCTION MT100GRV()
LOCAL cNota := PARAMIXB[1] LOCAL cSerie:= PARAMIXB[1] LOCAL cFornece:= PARAMIXB[1] LOCAL cLoja:= PARAMIXB[1]
RETURN .T.
ERRORBLOCK()
A funo ERRORBLOCK() efetua o tratamento de erros e define a atuao de um handler de erros sempre que ocorrer um erro em tempo de execuao. O manipulador de erros especificado como um bloco de cdigo da seguinte forma:
O { |<objError>| <lista de expressoes>, ... }, onde:
<objError> um error object que contm informaoes sobre o erro.Dentro do bloco de cdigo, podem ser enviadas mensagens ao error object para obter informaoes sobre o erro. Se o bloco de tratamento de erros retornar verdadeiro (.T.), a operaao que falhou repetida, e se retornar falso (.F.), o processamento recomea.
Se nao foi especificado nenhum <bErrorHandler> utilizando ERRORBLOCK() e ocorrer um erro em tempo de execuao, o bloco de tratamento ao de erros padrao avaliado. Este manipulador de erros exibe uma mensagem descritiva na tela, ajusta a funao ERRORLEVEL() para 1, e depois sai do programa (QUIT).
Como ERRORBLOCK() retorna o bloco de tratamento ao de erros corrente, possvel especificar um bloco de tratamento de erros para uma operaao gravando-se o bloco de manipulaao de erros corrente e depois recuperando-o aps o final da operaao. Alm disso,
- 468 -
Guia de Referncia Rpida ADVPL Avanado
uma importante consequncia do fato de os blocos de tratamento de erros serem especificados como blocos de cdigo, que eles podem ser passados pararotinas e funoes definidas por usurio e depois retornadas como valores.
E Sintaxe: ERRORBLOCK ( < bErrorHandler > ) E Parmetros:
bErrorHandler
O bloco de cdigo a ser executado toda vez que ocorrer um erro em tempo de execuao. Quando avaliado, o <bErrorHandler> passado na forma de um objeto erro como um argumento pelo sistema.
E Retorno:
Code-block Retorna o bloco de cdigo corrente que tratar o erro. Caso nao tenha sido enviado nenhum bloco de tratamento de erro desde que o programa foi invocado, ERRORBLOCK() retorna o bloco de tratamento de erro padrao.
Exemplo:
Function CA010Form() LOCAL xResult LOCAL cForm:= Upper(&(ReadVar())) LOCAL bBlock:= ErrorBlock( { |e| ChecErro(e) } ) LOCAL cOutMod Local lOptimize := GetNewPar("MV_OPTNFE",.F.) .Or. GetNewPar("MV_OPTNFS",.F.)
While ! Empty(cOutMod) If Left(cOutMod, At(",", cOutMod) - 1) $ Upper(cForm) // no modulo Help( " ",1,"ERR_FORM,,"Variavel nao disponivel para este modulo" Return .F. Endif cOutMod := Subs(cOutMod, At(",", cOutMod) + 1) EndDo If ("LERSTR"$cForm .or. "LERVAL"$cForm .or. "LERDATA"$cForm) .And. M->I5_CODIGO > "499" Help( " ",1,"CA010TXT") ErrorBlock(bBlock) Return .F. Endif BEGIN SEQUENCE If !"EXECBLOCK"$cForm .and. !"LERSTR"$cForm .And.; // nao executa execblock !"LERVAL"$cForm .And.; // nem funcao de leitura !"LERDATA"$cForm .And.; // de texto no cadastramento IIf(!lOptimize,.T.,!"CTBANFS"$cForm .And. !"CTBANFE"$cForm) xResult := &cForm Endif END SEQUENCE ErrorBlock(bBlock) Return lRet
- 469 -
Guia de Referncia Rpida ADVPL Avanado
FINAL()
A funo FINAL() executa as operaes bsicas que garantem a integridade dos dados ao finalizar o sistema desmontando as transaes (se houver), desbloqueando os semforos e fechando as tabelas abertas, finalizando-o em seguinda.
E Sintaxe: Final( [cMensagem1], [cMensagem2] )
E Parmetros:
cMensagem1 Primeira mensagem cMensagem2 Segunda mensagem
E Retorno:
Nenhum .
Exemplo:
User Function ValidUser( cUsuario, cSenha )
Local cMensag1 := Usurio invalido! Local cMensag2 := Opo disponvel para usurios Adminstradores!
If !PswAdmin( cUsuario, cSenha ) Final( cMensag1, cMensag2 ) EndIf
Return
FINDFUNCTION()
A funo FINDFUNCTION() tem como objetivo verificar se uma determinada funo se encontra no repositrio de objetos e at mesmo do binrio do Protheus, sendo uma funo bsica da linguagem.
E Sintaxe: FINDFUNCTION(cFuno)
E Parmetros:
cFuno Nome da funo que ser avaliada no repositrio de objetos corrente.
E Retorno:
Lgico Indica se a funo existe compilada no repositrio de objetos corrente.
- 470 -
Guia de Referncia Rpida ADVPL Avanado
FUNDESC()
A funo FunDesc() retornar a descrio de uma opo selecionada no menu da aplicao.
E Sintaxe: FUNDESC()
E Parmetros:
Nenhum .
E Retorno:
Caracter Descrio da opo selecionada no menu da aplicao.
FUNNAME()
A funo FunName() retornar o nome de uma funo executada a partir de um menu da aplicao.
E Sintaxe: FUNNAME()
E Parmetros:
Nenhum .
E Retorno:
Caracter Nome da funo executada a partir do menu da aplicao.
GETAREA()
Funo utilizada para proteger o ambiente ativo no momento de algum processamento especfico. Para salvar uma outra rea de trabalho (alias) que no o ativo, a funo GetArea() deve ser executada dentro do alias: ALIAS->(GetArea()).
E Sintaxe: GETAREA() E Retorno: Array contendo {Alias(),IndexOrd(),Recno()}
E Parmetros
Nenhum .
- 471 -
Guia de Referncia Rpida ADVPL Avanado
GETCOUNTRYLIST()
A funo GETCOUNTRYLIST() retorna um array de duas dimenses contendo informaes dos pases localizados.
E Sintaxe: GetCountryList()
E Parmetros:
Nenhum .
E Retorno:
Array Array de duas dimenses, sendo uma linha para cada pas localizado, contendo em cada posio a sigla dos pases, o nome do pas e a identificao do pas com dois dgitos.
Exemplo:
Local aArray := GetCountryList() Local cSigla := GetMv( MV_PAISLOC ) Local nPos
nPos := Ascan( aArray, {|d| d[1] == Upper(cSigla) } ) If nPos > 0 APMsgInfo( Pas de localizao + aArray[nPos,2] ) EndIf
ISINCALLSTACK()
A funo ISINCALLSTACK() verifica se uma determinada funo est existe dentro da pilha de chamadas do processamento corrente.
E Sintaxe: IsInCallStack( cIsInCallStack , cStackExit )
E Parmetros:
cIsInCallStack Nome da funo que desejasse pesquisar na pilha. cStackExit String que identifica o ponto em que desejasse finalizar a busca. Caso no seja informada, ser utilizada como padro a expresso "STACK_EXIT".
E Retorno:
Lgico Indica se a funo especificada encontrasse na pilha de chamadas do processsamento corrente, at o ponto de sada especificado.
REGTOMEMORY()
Inicializa as variveis de memria identificadas pelo uso do alias M-> de acordo com a estrutura e/ou informaes contidas no arquivo definido como referncia.
A funo REGTOMEMORY necessita que o ALIAS exista no SX3 para a operao de incluso, mesmo que o parmetro lDic seja definido como falso.
E Sintaxe: REGTOMEMORY(cAlias, lInclui, lDic, lInitPad)
E Parmetros:
cAlias Alias do arquivo que ser utilizado como referncia para inicializao das variveis de memria. lInclui Identifica se as variveis devero ser inicializadas com contedos padres, ou contendo as informaes do registro posicionado do alias especificado. lDic Define se ir utilizar o dicionrio de dados como base para inicializao das variveis ou se ir utilizar o comando CRIAVAR(). lInitPad Define se ir executar o inicializador padro do campo, contido no dicionrio de dados. Parmetro utilizado pela CRIAVAR().
E Retorno:
Nenhum .
- 472 -
Guia de Referncia Rpida ADVPL Avanado
- 473 -
Guia de Referncia Rpida ADVPL Avanado
RESTAREA()
Funo utilizada para devolver a situao do ambiente salva atravs do comando GETAREA(). Deve-se observar que a ltima rea restaurada a rea que ficar ativa para a aplicao.
E Sintaxe: RESTAREA(aArea) E Parmetros
aArea Array contendo: {cAlias, nOrdem, nRecno}, normalmente gerado pelo uso da funo GetArea().
Exemplo:
// ALIAS ATIVO ANTES DA EXECUO DA ROTINA SN3 User Function XATF001()
LOCAL cVar LOCAL aArea := GetArea() LOCAL lRet := .T.
cVar := &(ReadVar())
dbSelectArea("SX5") IF !dbSeek(xFilial()+"Z1"+cVar)
cSTR0001 := "REAV - Tipo de Reavaliacao" cSTR0002 := "Informe um tipo de reavalicao valido" cSTR0003 := "Continuar" Aviso(cSTR0001,cSTR0002,{cSTR0003},2) lRet := .F.
ENDIF
RestArea(aArea) Return( lRet )
USEREXCEPTION()
A funo USEREXCEPTION() tem o objetivo de forar um erro em ADVPL de forma que possamos tratar de alguma forma. USEREXCEPTION() recebe uma string contendo uma descrio do erro, essa descrio ser exibida de acordo com o ambiente que se est executando, caso um ambiente ERP, ser exibida uma tela de erro.
E Sintaxe: USEREXCEPTION(cMensagem)
E Parmetros:
cMensagem Mensagem que ser exibida no cabealho do erro, contendo a explicao da exceo.
E Retorno:
Nenhum .
- 474 -
Guia de Referncia Rpida ADVPL Avanado
- 475 -
Guia de Referncia Rpida ADVPL Avanado
Utilizao de recursos do ambiente ERP
AJUSTASX1()
A funo AJUSTASX1() permite a incluso simultnea de vrios itens de perguntas para um grupo de perguntas no SX1 da empresa ativa.
E Sintaxe: AJUSTASX1(cPerg, aPergs)
E Parmetros:
cPerg Grupo de perguntas do SX1 (X1_GRUPO) aPergs Array contendo a estrutura dos campos que sero gravados no SX1.
E Retorno:
Nenhum .
E Estrutura Item do array aPerg:
Posio Campo Tipo Descrio 01 X1_PERGUNT Caractere Descrio da pergunta em portugus 02 X1_PERSPA Caractere Descrio da pergunta em espanhol 03 X1_PERENG Caractere Descrio da pergunta em ingls 04 X1_VARIAVL Caractere Nome da varivel de controle auxiliar (mv_ch) 05 X1_TIPO Caractere Tipo do parmetro 06 X1_TAMANHO Numrico Tamanho do contedo do parmetro 07 X1_DECIMAL Numrico Nmero de decimais para contedos numricos 08 X1_PRESEL Numrico Define qual opo do combo a padro para o parmetro. 09 X1_GSC Caractere Define se a pergunta ser do tipo G Get ou C Choice (combo) 10 X1_VALID Caractere Expresso de validao do parmetro 11 X1_VAR01 Caractere Nome da varivel MV_PAR+Ordem do parmetro 12 X1_DEF01 Caractere Descrio da opo 1 do combo em portugus 13 X1_DEFSPA1 Caractere Descrio da opo 1 do combo em espanhol 14 X1_DEFENG1 Caractere Descrio da opo 1 do combo em ingls 15 X1_CNT01 Caractere Contedo padro ou ultimo contedo definido como respostas para a pergunta. 16 X1_VAR02 Caractere No informado 17 X1_DEF02 Caractere Descrio da opo X do combo em portugus 18 X1_DEFSPA2 Caractere Descrio da opo X do combo em espanhol 19 X1_DEFENG2 Caractere Descrio da opo X do combo em ingls 20 X1_CNT02 Caractere No informado 21 X1_VAR03 Caractere No informado 22 X1_DEF03 Caractere Descrio da opo X do combo em portugus E Estrutura Item do array aPerg (continuao):
23 X1_DEFSPA3 Caractere Descrio da opo X do combo em espanhol 24 X1_DEFENG3 Caractere Descrio da opo X do combo em ingls 25 X1_CNT03 Caractere No informado 26 X1_VAR04 Caractere No informado 27 X1_DEF04 Caractere Descrio da opo X do combo em portugus 28 X1_DEFSPA4 Caractere Descrio da opo X do combo em espanhol 29 X1_DEFENG4 Caractere Descrio da opo X do combo em ingls 30 X1_CNT04 Caractere No informado 31 X1_VAR05 Caractere No informado 32 X1_DEF05 Caractere Descrio da opo X do combo em portugus 33 X1_DEFSPA5 Caractere Descrio da opo X do combo em espanhol 34 X1_DEFENG5 Caractere Descrio da opo X do combo em ingls 35 X1_CNT05 Caractere No informado 36 X1_F3 Caractere Cdigo da consulta F3 vinculada ao parmetro 37 X1_GRPSXG Caractere Cdigo do grupo de campos SXG para atualizao automtica, quando o grupo for alterado. 38 X1_PYME Caractere Se a pergunta estar disponvel no ambiente Pyme 39 X1_HELP Caractere Contedo do campo X1_HELP 40 X1_PICTURE Caractere Picture de formatao do contedo do campo. 41 aHelpPor Array Vetor simples contendo as linhas de help em portugus para o parmetro. Trabalhar com linhas de at 40 caracteres. 42 aHelpEng Array Vetor simples contendo as linhas de help em ingls para o parmetro. Trabalhar com linhas de at 40 caracteres. 43 aHelpSpa Array Vetor simples contendo as linhas de help em espanhol para o parmetro. Trabalhar com linhas de at 40 caracteres.
- 476 -
Guia de Referncia Rpida ADVPL Avanado
- 477 -
Guia de Referncia Rpida ADVPL Avanado
ALLUSERS()
A funo ALLUSERS() retorna um array multidimensional contendo as informaes dos usurios do sistema.
E Sintaxe: ALLUSERS()
E Parmetros:
Nenhum .
E Retorno:
Array Array multidimensional contendo as informaes dos usurios do sistema, aonde para cada usurio sero demonstradas as seguintes informaes:
aArray[x][1] Configuraes gerais de acesso aArray[x][2] Configuraes de impresso aArray[x][3] Condiguraes de acesso aos mdulos
E Array de informaes dos usurios: Configuraes gerais de acesso
Elemento Descrio Tipo Qtd. 1 1 ID C 6 2 Nome C 15 3 Senha C 6 4 Nome Completo C 30 5 Vetor com n ltimas senhas A -- 6 Data de validade D 8 7 Quantas vezes para expirar N 4 8 Autorizado a alterar a senha L 1 9 Alterar a senha no prximo logon L 1 10 Vetor com os grupos A -- 11 ID do superior C 6 12 Departamento C 30 13 Cargo C 30 14 E-Mail C 130 15 Nmero de acessos simultneos N 4 16 Data da ltima alterao D 8 17 Usurio bloqueado L 1 18 Nmero de dgitos para o ano N 1 19 Listner de ligaes L 1 20 Ramal C 4
E Array de informaes dos usurios: Configuraes de impresso
Elemento Descrio Tipo Qtd. 2 1 Vetor com horrios de acesso A -- 2 Idioma N 1 3 Diretrio C 100 4 Impressora C -- 5 Acessos C 512 6 Vetor com empresas A -- 7 Ponto de entrada C 10 8 Tipo de impresso N 1 9 Formato N 1 10 Ambiente N 1 11 Prioridade p/ config. do grupo L 1 12 Opo de impresso C 50 13 Acesso a outros dir de impresso L 1
E Array de informaes dos usurios: Configuraes de acesso aos mdulos
Elemento Descrio Tipo Qtd. 3 1 Mdulo+nvel+menu C
- 478 -
Guia de Referncia Rpida ADVPL Avanado
- 479 -
Guia de Referncia Rpida ADVPL Avanado
ALLGROUPS()
A funo ALLGROUPS() retorna um array multidimensional contendo as informaes dos grupos de usurios do sistema.
E Sintaxe: ALLGROUPS()
E Parmetros:
Nenhum .
E Retorno:
Array Array multidimensional contendo as informaes dos grupos de usurios do sistema, aonde para cada grupo sero demonstradas as seguintes informaes:
aArray[x][1] Configuraes gerais de acesso aArray[x][2] Configuraes de acesso aos mdulos
E Array de informaes dos grupos: Configuraes gerais de acesso
Elemento Descrio Tipo Qtd. 1 1 ID C 6 2 Nome C 20 3 Vetor com horrios de acesso A 4 Data de validade D 8 5 Quantas vezes para expirar N 4 6 Autorizado a alterar a senha L 1 7 Idioma N 1 8 Diretrio C 100 9 Impressora C 10 Acessos C 512 11 Vetor com empresas A 12 Data da ltima alterao D 8 13 Tipo de impresso N 1 14 Formato N 1 15 Ambiente N 1 16 Opo de impresso L 1 17 Acesso a outros Dir de impresso L 1
E Array de informaes dos grupos: Configuraes de acesso aos mdulos
Elemento Descrio Tipo Qtd. 2 1 Modulo+nvel+menu C CGC()
A funo CGC() valida o CGC digitado, utilizando o algoritmo nacional para verificao do dgito de controle.
E Sintaxe: CGC(cCGC)
E Parmetros:
cCGC String contendo o CGC a ser validado
E Retorno:
Lgico Indica se o CGC informado vlido.
CONPAD1()
A funo CONPAD1() exibe uma tela de consulta padro baseada no Dicionrio de Dados (SXB).
uPar Parmetro reservado. uPar2 Parmetro reservado. uPar3 Parmetro reservado. cAlias Consulta padro cadastrada no Dicionrio de Dados (SXB) a ser utilizada. cCampoRet Nome da varivel ou campo que receber o retorno da consulta padro. uPar4 Parmetro Reservado.
lOnlyView Indica se ser somente para visualizao.
E Retorno:
Nenhum .
- 480 -
Guia de Referncia Rpida ADVPL Avanado
- 481 -
Guia de Referncia Rpida ADVPL Avanado
DATAVALIDA()
A funo DATAVALIDA() retorna a primeira data vlida a partir de uma data especificada como referncia, considerando inclusive a data informada para anlise.
E Sintaxe: DATAVALIDA(dData)
E Parmetros:
dData Data a partir da qual ser avaliada a prxima data vlida, considerando-a inclusive como uma possibilidade.
E Retorno:
Data Prxima data vlida, desconsiderando sbados, domingos e os feriados cadastrados no sistema.
EXISTINI()
A funo EXISTINI() verifica se o campo possui inicializador padro.
E Sintaxe: EXISTINI(cCampo)
E Parmetros:
cCampo Nome do campo para verificao.
E Retorno:
Lgico Indica se o campo possui um inicializador padro.
Exemplo:
// Exemplo de uso da funcao ExistIni: // Se existir inicializador no campo B1_COD: If ExistIni(B1_COD) // Executa o inicializador: cCod := CriaVar(B1_COD) Endif
Return
- 482 -
Guia de Referncia Rpida ADVPL Avanado
EXTENSO()
A funo EXTENSO() retorna uma string referente a descrio por extenso de um valor numrico, sendo comumente utilizada para impresso de cheques, valor de duplicatas, etc.
E Sintaxe: Extenso(nValor, lQtd, nMoeda)
E Parmetros:
nValor Valor para gerao do extenso. lQtd Indica se o valor representa uma quantidade (.T.) ou dinheiro (.F.) nMoeda Para qual moeda do sistema deve ser o extenso.
E Retorno:
String Descrio do valor por extenso.
FORMULA()
Interpreta uma frmula cadastrada. Esta funo interpreta uma frmula, previa-mente cadastrada no Arquivo SM4 atravs do Mdulo Configurador, e retorna o resultado com tipo de dado de acordo com a prpria frmula.
E Sintaxe: Formula(cFormula)
E Parmetros:
cFormula Cdigo da frmula a ser avaliada e cadastrada no SM4 Cadastro de Frmulas.
E Retorno:
Indefinido Resultado da interpretao da frmula cadastrada no SM4.
GETADVFVAL()
A funo GETADVFVAL() executa uma pesquisa em um arquivo pela chave de busca e na ordem especificadas, possibilitando o retorno de um ou mais campos.
E Sintaxe: GetAdvFVal(cAlias,uCpo,uChave,nOrder,uDef)
E Parmetros:
cAlias Alias do arquivo uCpo Nome de um campo ou array contendo os nomes dos campos desejados uChave Chave para a pesquisa nOrder Ordem do ndice para a pesquisa uDef Valor ou array default para ser retornado caso a chave no seja encontrada
E Retorno:
Indefinido Retorna o contedo de um campo ou array com o contedo de vrios campos
A funo GETADVFVAL() difere da funo POSICIONE() apenas por permitir o retorno de vrios campos em uma nica consulta.
As duas funes devem ser protegidas por GETAREA() / RESTAREA() dependendo da aplicao.
HELP()
Esta funo exibe a ajuda especificada para o campo e permite sua edio. Se for um help novo, escreve-se o texto em tempo de execuo.
E Sintaxe: Help(cHelp,nLinha, cTitulo, uPar4,cMensagem,nLinMen,nColMen)
E Parmetros:
cHelp Nome da Rotina chamadora do help. (sempre branco) nLinha Nmero da linha da rotina chamadora. (sempre 1) cTitulo Ttulo do help uPar4 Sempre NIL cMensagem Mensagem a ser exibida para o Help. nLinMen Nmero de linhas da Mensagem. (relativa janela) nColMen Nmero de colunas da Mensagem. (relativa janela)
E Retorno:
Nenhum .
A funo HELP() tratada na execuo das rotinas com o recurso de MSEXECAUTO(), permitindo a captura e exibio da mensagem no log de processamento.
Por esta razo, em rotinas que podem ser chamadas atravs da funo MSEXECAUTO() deve-se sempre utilizar avisos utilizando esta funo, para que este tipo de processamento no seja travado indevidamente.
Exemplo: IF lAuto // Se for rotina automtica Help("ESPECIFICO",1,"HELP","PROCESSAMENTO","Parmetros do JOB Invlidos",1,0) ELSE MsgAlert(Parmetros do JOB Invlidos, PROCESSAMENTO) ENDIF
- 483 -
Guia de Referncia Rpida ADVPL Avanado
MESEXTENSO()
A funo MESEXTENSO() retorna o nome de um ms por extenso.
E Sintaxe: MESEXTENSO(nMes)
E Parmetros:
nMes Indica o nmero do ms a ter seu nome escrito por extenso.
Este parmetro pode ser definido tambm como caracter ou como data.
E Retorno:
String Nome do ms indicado por extenso.
OBRIGATORIO()
A funo OBRIGATORIO() avalia se todos os campos obrigatrios de uma Enchoice() foram digitados.
E Sintaxe: OBRIGATORIO(aGets, aTela, aTitulos)
E Parmetros:
aGets Varivel PRIVATE tratada pelo objeto Enchoice(), previamente definida no fonte. aTela Varivel PRIVATE tratada pelo objeto Enchoice(), previamente definida no fonte. aTitulos Array contendo os ttulos dos campos exibidos na Enchoice().
E Retorno:
Lgico Indica se todos os campos obrigatrios foram preenchidos.
- 484 -
Guia de Referncia Rpida ADVPL Avanado
- 485 -
Guia de Referncia Rpida ADVPL Avanado
Exemplo:
#INCLUDE "protheus.ch"
/*/ +----------------------------------------------------------------------------- | Programa | ATFA010A | Autor | ARNALDO R. JUNIOR | Data | | +----------------------------------------------------------------------------- | Desc. | Cadastro de dados complementares do bem Ativo Fixo | +---------------------------------------------------------------------------- | Uso | Curso de ADVPL | +----------------------------------------------------------------------------- /*/
User Function ATFA010A()
Private cCadastro := "Atualizacao de dados do bem" Private aRotina := { {"Pesquisar" ,"AxPesqui" ,0,1} ,; {"Visualizar" ,"AxVisual" ,0,2} ,; {"Atualizar" ,"U_A010AATU" ,0,4}}
/*/ +----------------------------------------------------------------------------- | Programa | A010AATU | Autor | ARNALDO R. JUNIOR | Data | | +----------------------------------------------------------------------------- | Desc. | Atualizao de dados do bem Ativo Fixo | +----------------------------------------------------------------------------- | Uso | Curso de ADVPL | +----------------------------------------------------------------------------- /*/
User Function A010AATU(cAlias,nReg,nOpc)
Local aCpoEnch := {} Local aAlter := {}
Local aButtons := {} Local cAliasE := cAlias Local aAlterEnch := {} Local aPos := {015,000,400,600 Local nModelo := Local lF3 := .F. Local lMemoria := .T. Local lColumn := .F. Local caTela := "" Local lNoFolder := .F. Local lProperty := .F.
- 486 -
Guia de Referncia Rpida ADVPL Avanado
Exemplo (continuao):
Private oDlg Private oGetD Private oEnch Private aTELA[0][0] // Variveis que sero atualizadas pela Enchoice() Private aGETS[0] // e utilizadas pela funo OBRIGATORIO()
DbSelectArea("SX3") DbSetOrder(1) DbSeek(cAliasE) //+--------------------------------------------------------------------------+ //|Campos da enchoice | //+--------------------------------------------------------------------------+ 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 //+--------------------------------------------------------------------------+ //|Campos alterveis da enchoice | //+--------------------------------------------------------------------------+ AADD(aAlterEnch,"N1_TIPOADT") // Controle de Adiantamentos AADD(aAlterEnch,"N1_DESCRIC") // Descrio AADD(aAlterEnch,"N1_CHAPA") // Numero da plaqueta AADD(aAlterEnch,"N1_FORNEC") // Fornecedor AADD(aAlterEnch,"N1_LOJA") // Loja do Fornecedor AADD(aAlterEnch,"N1_NSERIE") // Serie da Nota AADD(aAlterEnch,"N1_NFISCAL") // Numero da Nota AADD(aAlterEnch,"N1_NFITEM") // Item da Nota AADD(aAlterEnch,"N1_UM") // Unidade de Medida AADD(aAlterEnch,"N1_PRODUTO") // Cdigo do Produto AADD(aAlterEnch,"N1_PEDIDO") // Codigo do Pedido de Compras AADD(aAlterEnch,"N1_ITEMPED") // Item do Pedido de Compras AADD(aAlterEnch,"N1_PRCIMP") // Codigo do Processo de Importacao AADD(aAlterEnch,"N1_CODPAIS") // Codigo do Pais AADD(aAlterEnch,"N1_ORIGCPR") // Origem de Compras AADD(aAlterEnch,"N1_CODSP") // Codigo da SP Interna AADD(aAlterEnch,"N1_CHASSIS") // Numero de serie
//+--------------------------------------------------------------------------+ //|Montagem do DIALOG | //+--------------------------------------------------------------------------+ DEFINE MSDIALOG oDlg TITLE cCadastro FROM 000,000 TO 400,600 PIXEL RegToMemory("SN1", .F.)
ACTIVATE MSDIALOG oDlg CENTERED; ON INIT EnchoiceBar(oDlg, {||IIF(A010AGRV(aCpoEnch,aAlterEnch,nOpc),; oDlg:End(),.F.)},; // Boto OK {||oDlg:End()},,aButtons) // Boto Cancelar
RETURN
- 487 -
Guia de Referncia Rpida ADVPL Avanado
Exemplo (continuao):
/*/ +----------------------------------------------------------------------------- | Programa | A010AGRV | Autor | ARNALDO R. JUNIOR | Data | | +----------------------------------------------------------------------------- | Desc. | Validao da enchoice e gravao dos dados do bem | +----------------------------------------------------------------------------- | Uso | Curso de ADVPL | +----------------------------------------------------------------------------- /*/ Static Function A010AGRV(aCpos,aAlter,nOpc)
Local aArea := GetArea() Local nX := 0
IF !Obrigatorio(aGets,aTela) /*Valida o cabecalho*/ Return .F. ENDIF
// Atualizacao dos campos passiveis de alteracao no SN1 RecLock("SN1",.F.) For nX := 1 to Len(aAlter) SN1->&(aAlter[nX]) := M->&(aAlter[nX]) Next nX MsUnLock()
Return .T.
OPENFILE()
A funo OPENFILE() exibe o diagnstico de arquivos, verificando a existncia dos arquivos de dados e os ndices do sistema, criando caso no existam e abre os arquivos de acordo com o mdulo onde executada ou de acordo com a parametrizao.
E Sintaxe: OPENFILE(cEmp)
E Parmetros:
cEmp Empresa cujo os arquivos sero re-abertos.
E Retorno:
Nenhum .
PERGUNTE()
A funo PERGUNTE() inicializa as variveis de pergunta (mv_par01,...) baseada na pergunta cadastrado no Dicionrio de Dados (SX1). Se o parmetro lAsk no for especificado ou for verdadeiro ser exibida a tela para edio da pergunta e se o usurio cofirmar as variveis sero atualizadas e a pergunta no SX1 tambm ser atualizada.
E Sintaxe: Pergunte( cPergunta , [lAsk] , [cTitle] )
E Parmetros:
cPergunta Pergunta cadastrada no dicionrio de dados ( SX1) a ser utilizada. |Ask Indica se exibir a tela para edio. cTitle Ttulo do dilogo.
E Retorno:
Lgico Indica se a tela de visualizao das perguntas foi confirmada (.T.) ou cancelada (.F.)
PESQPICT()
A funo PESQPICT() retorna a picture definida para um campo especificado no Dicionrio de Dados (SX3).
E Sintaxe: PesqPict(cAlias,cCampo,nTam)
E Parmetros:
cAlias Alias do arquivo cCampo Nome do campo nTam Opcional, para campos numricos, ser usado como o tamanho do campo para definio da picture. Se no informado, e usado o tamanho padro no dicionrio de dados.
E Retorno:
String Picture do campo especificado.
- 488 -
Guia de Referncia Rpida ADVPL Avanado
PESQPICTQT()
A funo PESQPICTQT() retorna a picture de um campo numrico referente a uma quantidade, de acordo com o Dicionrio de Dados (SX3). Esta funo geralmente utilizada quando h pouco espao disponvel para impresso de valores em relatrios, quando o valor nEdio no informado, ela tem o comportamento semelhante ao da funo X3Picture, pois busca o tamanho do campo no dicionrio de dados.
E Sintaxe: PesqPictQt(cCampo,nEdio)
E Parmetros:
cCampo Nome do campo a verificar a picture. nEdio Espao disponvel para edio.
E Retorno:
String Picture ideal para o espao definido por nEdio, sem a separao dos milhares por vrgula.
POSICIONE()
A funo POSICIONE() permite o retorno do contedo de um campo de um registro de uma tabela especificado atravs de uma chave de busca.
E Sintaxe: Posicione(cAlias, nOrdem, cChave, cCampo)
E Parmetros:
cAlias Alias do arquivo nOrdem Ordem utilizada cChave Chave pesquisa cCampo Campo a ser retornado
E Retorno:
Indefinido Contedo do campo solicitado.
A utilizao da funo POSICIONE() deve ser protegida com GETAREA() / RESTAREA() dependendo da aplicao.
- 489 -
Guia de Referncia Rpida ADVPL Avanado
- 490 -
Guia de Referncia Rpida ADVPL Avanado
PUTSX1()
A funo PUTSX1() permite a incluso de um nico item de pergunta em um grupo de definido no Dicionrio de Dados (SX1). Todos os vetores contendo os textos explicativos da pergunta devem conter at 40 caracteres por linha.
cGrupo Grupo de perguntas do SX1 (X1_GRUPO) cOrdem Ordem do parmetro no grupo (X1_ORDEM) cPergunt Descrio da pergunta em portugus cPerSpa Descrio da pergunta em espanhol cPerEng Descrio da pergunta em ingls cVar Nome da varivel de controle auxiliar (X1_VARIAVL) cTipo Tipo do parmetro nTamanho Tamanho do contedo do parmetro nDecimal Nmero de decimais para contedos numricos nPresel Define qual opo do combo a padro para o parmetro. cGSC Define se a pergunta ser do tipo G Get ou C Choice (combo) cValid Expresso de validao do parmetro cF3 Cdigo da consulta F3 vinculada ao parmetro cGrpSxg Cdigo do grupo de campos SXG para atualizao automtica, quando o grupo for alterado. cPyme Se a pergunta estar disponvel no ambiente Pyme cVar01 Nome da varivel MV_PAR+Ordem do parmetro. cDef01 Descrio da opo 1 do combo em portugus cDefSpa1 Descrio da opo 1 do combo em espanhol cDefEng1 Descrio da opo 1 do combo em ingls cCnt01 Contedo padro ou ultimo contedo definido como respostas para este item cDef0x Descrio da opo X do combo em portugus cDefSpax Descrio da opo X do combo em espanhol cDefEngx Descrio da opo X do combo em ingls aHelpPor Vetor simples contendo as linhas de help em portugus para o parmetro. aHelpEng Vetor simples contendo as linhas de help em ingls para o parmetro. aHelpSpa Vetor simples contendo as linhas de help em espanhol para o parmetro. cHelp Contedo do campo X1_HELP
RETINDEX()
A funo RETINDEX() restaura os ndices padres de um alias definidos no Dicionrio de Dados (SIX).
E Sintaxe: RETINDEX(cAlias)
E Parmetros:
cAlias Alias de um arquivo do sistema existente no Dicionrio de Dados.
E Retorno:
Numrico Indica quantos ndices padres o alias especificado possui no Dicionrio de Dados.
A funo RETINDEX() quando utilizada em ambientes TOPCONNECT retorna -1
SIXDESCRICAO()
A funo SIXDESCRICAO() retorna a descrio da chave de ndice, de acordo com o registro posicionado no SIX e idioma corrente.
E Sintaxe: SIXDESCRICAO()
E Parmetros:
Nenhum .
E Retorno:
String Descrio do indice posicionado no SIX de acordo com o idioma corrente.
Exemplo:
User Function <nome-da-funo>( cChave, cOrdem ) Local cSixDesc :=
dbSelectArea(SIX) dbSetOrder(1)
If dbSeek(cChave+cOrdem) cSixDescr := SixDescricao() EndIf Return
- 491 -
Guia de Referncia Rpida ADVPL Avanado
TABELA()
A funo TABELA() retorna o contedo de uma tabela cadastrada no Arquivo de Tabelas (SX5) de acordo com a chave especificada. Caso a tabela ou a chave especificada no existir ser exibido um HELP() padro do sistema.
E Sintaxe: Tabela(cTab,cChav,lPrint)
E Parmetros:
cTab Idenficao da tabela a pesquisar (deve ser informado como caracter). cChav Chave a pesquisar na tabela informada. lPrint Indica se deve (.T.) ou no (.F.) exibir o help ou a chave NOTAB se a tabela no existir.
E Retorno:
String Contedo da tabela na chave especificada. Retorna nulo caso a tabela no exista ou a chave no seja encontrada.
TAMSX3()
A funo TAMSX3() retorna o tamanho (total e parte decimal) de um campo especificado no Dicionrio de Dados (SX3).
E Sintaxe: TAMSX3(cCampo)
E Parmetros:
cCampo Nome do campo a ser consultado no Dicionrio de Dados (SX3).
E Retorno:
Array Array de duas posies contendo o tamanho total e o nmero de decimais do campo especificado respectivamente.
- 492 -
Guia de Referncia Rpida ADVPL Avanado
TM()
A funo TM() retorna a picture de impresso para valores numricos dependendo do espao disponvel.
E Sintaxe: TM(nValor, nEdio, nDec)
E Parmetros:
nValor Valor a ser avaliado. nEdio Espao disponvel para edio. nDec Nmero de casas decimais.
E Retorno:
String Picture ideal para edio do valor nValor
Esta rotina leva em considerao duas variveis:
MV_MILHAR Determina se deve haver separao de milhar; MV_CENT Nmero de casas decimais padro da moeda corrente.
Para ajustar o valor passado (nValor) ao espao disponvel (nEdio) a funo verifica se pode haver separao de milhar, neste caso, a rotina eliminar tantos pontos decimais quantos sejam necessrios ao ajuste do tamanho. Caso no seja possvel ajustar o valor ao espao dado, ser colocado na picture o caracter de estouro de campo *.A funo tambm ajusta um valor ao nmero de decimais (nDec), sempre imprimindo a quantidade de decimais passados no parmetro.
- 493 -
Guia de Referncia Rpida ADVPL Avanado
X1DEF01()
A funo X1DEF01() retorna o contedo da primeira definio da pergunta posicionada no SX1 (caso seja combo) no idioma corrente.
E Sintaxe: X1DEF01()
E Parmetros:
Nenhum .
E Retorno:
String Contedo da primeira definio da pergunta no idioma corrente.
Exemplo:
User Function <nome-da-funo>( cGrupo, cPerg ) Local cDef01 Local cDef02 Local cDef03 Local cDef04 Local cDef05
dbSelectArea(SX1) dbSetOrder(1)
If dbSeek( cGrupo + cPerg ) // grupo da pergunta + o numero da perg. cDef01 := X1Def01() cDef02 := X1Def02() cDef03 := X1Def03() cDef04 := X1Def04() cDef05 := X1Def05() EndIf
Return
- 494 -
Guia de Referncia Rpida ADVPL Avanado
- 495 -
Guia de Referncia Rpida ADVPL Avanado
X1PERGUNT()
A funo X1PERGUNT() retorna a descrio da pergunta posicionada no Dicionrio de Dados (SX1) para o idioma corrente.
E Sintaxe: X1PERGUNT()
E Parmetros:
Nenhum .
E Retorno:
String Descrio da pergunta do Dicionrio de Dados (SX1) no idioma corrente.
Exemplo:
User Function <nome-da-funo>( cGrupo, cPerg ) Local cDescr dbSelectArea(SX1) dbSetOrder(1) If dbSeek( cGrupo + cPerg ) // grupo da pergunta + o numero da perg. cDescr := X1Pergunt() EndIf Return
X2NOME()
A funo X2NOME() retorna a descrio de uma tabela posicionada no Dicionrio de Dados (SX2) no idioma corrente.
E Sintaxe: X2NOME()
E Parmetros:
Nenhum .
E Retorno:
String Descrio da tabela posicionada no Dicionrio de Dados (SX2) no idioma corrente.
Exemplo:
User Function <nome-da-funo>( ) Local cTabela dbSelectArea(SX2) dbSetOrder(1) If dbSeek( SA1 ) cTabela := X2Nome() EndIf Return
- 496 -
Guia de Referncia Rpida ADVPL Avanado
X3CBOX()
A funo X3CBOX() retorna o contedo de um campo tipo combo posicionado no Dicionrio de Dados (SX3) no idioma corrente.
E Sintaxe: X3CBOX()
E Parmetros:
Nenhum .
E Retorno:
String Contedo do campo do tipo combo posicionado no Dicionrio de Dados (SX3) no idioma corrente.
A funo XADESCRI() retorna o contedo da descrio dos folders de acordo com o registro posicionado no Dicionrio de Dados (SXA) no idioma corrente.
E Sintaxe: XADESCRIC()
E Parmetros:
Nenhum .
E Retorno:
String Descrio do folder posicionado no Dicionrio de Dados (SXA) no idioma corrente.
Exemplo:
User Function <nome-da-funo>( cFolder, cNumero ) Local cDescr dbSelectArea(SXA) dbSetOrder(1) If dbSeek( cFolder+cNumero ) // alias do folder + numero do folder cDescr := XADescric() EndIf Return
XBDESCRI()
A funo XBDESCRI() retorna o contedo da descrio de uma consulta de acordo com o registro posicionado no Dicionrio de Dados (SXB) no idioma corrente.
E Sintaxe: XBDESCRI()
E Parmetros:
Nenhum .
E Retorno:
String Descrio da consulta posicionada no Dicionrio de Dados (SXB) no idioma corrente.
Exemplo:
User Function <nome-da-funo>( cAlias ) Local cDescr dbSelectArea(SXB) dbSetOrder(1) If dbSeek( cAlias + 1 ) cDescr := XBDescri() EndIf Return XFILIAL()
A funo XFILIAL() retorna a filial utilizada por determinado arquivo.
Esta funo utilizada para permitir que pesquisas e consultas em arquivos trabalhem somente com os dados da filial corrente, dependendo claro se o arquivo est compartilhado ou no (definio que feita atravs do mdulo Configurador Dicionrio de Dados (SX2)).
importante verificar que esta funo no tem por objetivo retornar apenas a filial corrente, mas retorn-la caso o arquivo seja exclusivo. Se o arquivo estiver compartilhado, a funo xFilial retornar dois espaos em branco.
E Sintaxe: XFILIAL(cAlias)
E Parmetros:
cAlias Alias do arquivo desejado. Se no for especificado, o arquivo tratado ser o da rea corrente.
E Retorno:
Caracter String contendo a filial do arquivo corrente.
- 503 -
Guia de Referncia Rpida ADVPL Avanado
- 504 -
Guia de Referncia Rpida ADVPL Avanado
Interfaces de cadastro
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.
E Sintaxe: AxCadastro(cAlias, cTitulo, cVldExc, cVldAlt)
E 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: Funo AxCadastro()
#include "protheus.ch"
/*/ +----------------------------------------------------------------------------- | Funo | XCADSA2 | Autor | ARNALDO RAYMUNDO JR. | Data | | +----------------------------------------------------------------------------- | Descrio | Exemplo de utilizao da funo AXCADASTRO() | |+---------------------------------------------------------------------------- | Uso | Curso ADVPL | |+---------------------------------------------------------------------------- /*/
User Function XCadSA2()
Local cAlias := "SA2" Local cTitulo := "Cadastro de Fornecedores" Local cVldExc := ".T." Local cVldAlt := ".T."
/*/ +------------------------------------------------------------------------------ | Funo | VLDALT | Autor | ARNALDO RAYMUNDO JR. | Data | | +------------------------------------------------------------------------------ | Descrio | Funo de validao de alterao para a AXCADASTRO() | +------------------------------------------------------------------------------ | Uso | Curso ADVPL | +------------------------------------------------------------------------------ /*/
User Function VldAlt(cAlias,nReg,nOpc)
Local lRet := .T. Local aArea := GetArea() Local nOpcao := 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 | Autor | ARNALDO RAYMUNDO JR. | Data | | +------------------------------------------------------------------------------ | Descrio | Funo de validao de excluso para a AXCADASTRO() | +------------------------------------------------------------------------------ | Uso | Curso ADVPL | +------------------------------------------------------------------------------ /*/
User Function VldExc(cAlias,nReg,nOpc)
Local lRet := .T. Local aArea := GetArea() Local nOpcao := 0
nOpcao := AxExclui(cAlias,nReg,nOpc)
If nOpcao == 1 MsgInfo(Excluso concluda com sucesso!) Endif
RestArea(aArea) Return lRet
AXPESQUI()
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.
E Sintaxe: AXPESQUI() E Parmetros
Nenhum .
AXVISUAL()
Funo de visualizao padro das informaes de um registro, no formato Enchoice, conforme demonstrado no tpico sobre a interface AxCadastro().
cAlias Tabela cadastrada no Dicionrio de Tabelas (SX2) que ser editada nReg Record number (recno) do registro posicionado no alias ativo. nOpc Nmero da linha do aRotina que definir o tipo de edio (Incluso, Alterao, Excluso, Visualizao). aAcho 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". nColMens Parmetro no utilizado. cMensagem Parmetro no utilizado. cFunc Funo que dever ser utilizada para carregar as variveis que sero utilizadas pela Enchoice. Neste caso o parmetro lVirtual definido internamente pela AxFunction() executada como .T. aButtons Botes adicionais para a EnchoiceBar, no formato: aArray[n][1] -> Imagem do boto aArray[n][2] -> bloco de cdigo contendo a ao do boto aArray[n][3] -> ttulo do boto lMaximized Indica se a janela dever ser ou no maximizada
- 506 -
Guia de Referncia Rpida ADVPL Avanado
- 507 -
Guia de Referncia Rpida ADVPL Avanado
AXINCLUI()
Funo de incluso padro das informaes de um registro, no formato Enchoice, conforme demonstrado no tpico sobre a interface AxCadastro().
cAlias Tabela cadastrada no Dicionrio de Tabelas (SX2) que ser editada nReg Record number (recno) do registro posicionado no alias ativo. nOpc Nmero da linha do aRotina que definir o tipo de edio (Incluso, Alterao, Excluso, Visualizao). aAcho 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". cFunc Funo que dever ser utilizada para carregar as variveis que sero utilizadas pela Enchoice. Neste caso o parmetro lVirtual definido internamente pela AxFunction() executada como .T. aCpos Vetor com nome dos campos que podero ser editados cTudoOk Funo de validao de confirmao da tela. No deve ser passada como Bloco de Cdigo, mas pode ser passada como uma lista de expresses, desde que a ltima ao efetue um retorno lgico:
(Func1(), Func2(), ...,FuncX(), .T. )
lF3 Indica se a enchoice esta sendo criada em uma consulta F3 para utilizar variveis de memria cTransact Funo que ser executada dentro da transao da AxFunction() aButtons Botes adicionais para a EnchoiceBar, no formato: aArray[n][1] -> Imagem do boto aArray[n][2] -> bloco de cdigo contendo a ao do boto aArray[n][3] -> ttulo do boto aParam Funes para execuo em pontos pr-definidos da AxFunction(), conforme abaixo: aParam[1] := Bloco de cdigo que ser processado antes da exibio da interface. aParam[2] := Bloco de cdigo para processamento na validao da confirmao. aParam[3] := Bloco de cdigo que ser executado dentro da transao da AxFunction(). aParam[4] := Bloco de cdigo que ser executado fora da transao da AxFunction(). aAuto Array no formato utilizado pela funcionalidade MsExecAuto(). Caso seja informado este array, no ser exibida a tela de interface, e ser executada a funo EnchAuto(). aAuto[n][1] := Nome do campo aAuto[n][2] := Contedo do campo aAuto[n][3] := Validao que ser utilizada em substituio as validaes do SX3
- 508 -
Guia de Referncia Rpida ADVPL Avanado
lVirtual Indica se a Enchoice() chamada pela AxFunction() utilizar variveis de memria ou os campos da tabela na edio lMaximized Indica se a janela dever ser ou no maximizada
AXALTERA()
Funo de alterao padro das informaes de um registro, no formato Enchoice, conforme demonstrado no tpico sobre a interface AxCadastro().
cAlias Tabela cadastrada no Dicionrio de Tabelas (SX2) que ser editada nReg Record number (recno) do registro posicionado no alias ativo. nOpc Nmero da linha do aRotina que definir o tipo de edio (Incluso, Alterao, Excluso, Visualizao). cTransact Funo que ser executada dentro da transao da AxFunction() aCpos Vetor com nome dos campos que podero ser editados aButtons Botes adicionais para a EnchoiceBar, no formato: aArray[n][1] -> Imagem do boto aArray[n][2] -> bloco de cdigo contendo a ao do boto aArray[n][3] -> ttulo do boto aParam Funes para execuo em pontos pr-definidos da AxFunction(), conforme abaixo: aParam[1] := Bloco de cdigo que ser processado antes da exibio da interface. aParam[2] := Bloco de cdigo para processamento na validao da confirmao. aParam[3] := Bloco de cdigo que ser executado dentro da transao da AxFunction(). aParam[4] := Bloco de cdigo que ser executado fora da transao da AxFunction(). aAuto Array no formato utilizado pela funcionalidade MsExecAuto(). Caso seja informado este array, no ser exibida a tela de interface, e ser executada a funo EnchAuto(). aAuto[n][1] := Nome do campo aAuto[n][2] := Contedo do campo aAuto[n][3] := Validao que ser utilizada em substituio as validaes do SX3 lMaximized Indica se a janela dever ser ou no maximizada
BRWLEGENDA()
A BrwLegenda() uma funcionalidade que permite a incluso de legendas na MBrowse().
E Sintaxe: BrwLegenda(cCadastro , cTitulo, aLegenda)
E Parmetros:
cCadastro Mesma varivel utilizada para a MBrowse, que identifica o cadastro que est em uso no momento cTitulo Ttulo (identificao) da Legenda aLegenda
Array contendo de definio da cor e do texto, explicativo sobre o que ela representa na MBrowse
Ex: {{Cor,Texto}}
Lista de cores disponveis no Protheus
O BR_AMARELO O BR_AZUL O BR_BRANCO O BR_CINZA O BR_LARANJA O BR_MARRON O BR_VERDE O BR_VERMELHO O BR_PINK O BR_PRETO
ENDFILBRW()
A EndFilBrw() uma funcionalidade que permite eliminar o filtro e o arquivo temporrio criados pela FilBrowse().
E Sintaxe: EndFilBrw(cAlias, aQuery)
E Parmetros:
cAlias Alias ativo definido para a Mbrowse() aQuery Array de retorno passado por referncia para a FilBrowse().
[1]=>Nome do Arquivo Fsico [2]=>Ordem correspondente ao Sindex
- 509 -
Guia de Referncia Rpida ADVPL Avanado
FILBROWSE()
A FilBrowse() uma funcionalidade que permite a utilizao de filtros na MBrowse().
E Sintaxe: FilBrowse(cAlias, aQuery, cFiltro, lShowProc)
E Parmetros:
cAlias Alias ativo definido para a Mbrowse() aQuery Este parmetro dever ser inicializado sempre vazio e sua passagem obrigatoriamente por referncia, pois, seu retorno ser enviado para a funo EndFilBrw().
[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.
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().
E Sintaxe: PesqBrw(cAlias , nReg, bBrwFilter)
E Parmetros:
cAlias Alias ativo definido para a Mbrowse() nReg Nmero do registro bBrwFilter Bloco de Cdigo que contm a FilBrowse()
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.
cAlias Alias ativo definido para a Mbrowse() cCampo Campo do arquivo onde ser feito o controle (gravao) da marca. cCpo Campo onde ser feita a validao para marcao e exibio do bitmap de status. aCampos Vetor de colunas a serem exibidas no browse, deve conter as seguintes dimenses:
[n][1] nome do campo; [n][2] - Nulo (Nil); [n][3] - Ttulo do campo; [n][4] - Mscara (picture). 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 Funo que retorna o contedo inicial do filtro baseada na chave de ndice selecionada. cExpFim 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
E 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.
- 512 -
Guia de Referncia Rpida ADVPL Avanado
Exemplo: Funo MarkBrow() e acessrias
#include "protheus.ch" /*/ +----------------------------------------------------------------------------- | Programa | MkBrwSA1 | Autor | ARNALDO RAYMUNDO JR. | Data | | +----------------------------------------------------------------------------- | Desc. | MarkBrowse Genrico | +----------------------------------------------------------------------------- | Uso | Curso de ADVPL | +----------------------------------------------------------------------------- /*/
USER FUNCTION MkBrwSA1()
Local aCpos := {} Local aCampos := {} Local nI := 0 Local cAlias := "SA1"
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
Exemplo: Funo VisLote() utilizao das funes acessrias da MarkBrow()
/*/ +----------------------------------------------------------------------------- | Programa | VisLote() | Autor | ARNALDO RAYMUNDO JR. | Data | | +----------------------------------------------------------------------------- | 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
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 ACTIVATE MSDIALOG oDlg CENTER 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
- 514 -
Guia de Referncia Rpida ADVPL Avanado
- 515 -
Guia de Referncia Rpida ADVPL Avanado
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:
Browse padro para visualizao das informaes da base de dados, de acordo com as configuraes do SX3 Dicionrio de Dados (campo browse).
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.
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. aFixe Array bi-dimensional contendo os nomes dos campos fixos pr- definidos, 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
[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
- 516 -
Guia de Referncia Rpida ADVPL Avanado
E 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 Funo que retornar um valor lgico para exibio do bitmap de status. Quando esse parmetro utilizado, o parmetro cCpo automaticamente desconsiderado. nClickDef 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. aColors 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. cTopFun 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. 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. nPar14 Parmetro reservado. bInitBloc 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. lNoMnuFilter 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. lSeeAll 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. lChgAll 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.
E Variveis private adicionais
aRotina 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:
Ele ainda pode ser parametrizado com as funes bsicas da AxCadastro conforme abaixo:
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}) cCadastro Ttulo do browse que ser exibido.
E 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 :
// Exemplo: Funo Inclui() substituindo a funo AxInclui() Funo Inclui()
/*/ +----------------------------------------------------------------------------- | Funo | INCLUI | Autor | ARNALDO RAYMUNDO JR. | Data | | +----------------------------------------------------------------------------- | Descrio | Funo de incluso especfica chamando a AXINCLUI() | +----------------------------------------------------------------------------- | Uso | Curso ADVPL | +----------------------------------------------------------------------------- /*/
User Function Inclui(cAlias, nReg, nOpc)
Local cTudoOk := "(Alert('OK'),.T.)" 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
#include "protheus.ch"
/*/ +----------------------------------------------------------------------------- | Funo | EXCLUI | Autor | ARNALDO RAYMUNDO JR. | Data | | +----------------------------------------------------------------------------- | Descrio | Funo de excluso especifica chamando a AxDeleta | +----------------------------------------------------------------------------- | Uso | Curso ADVPL | +----------------------------------------------------------------------------- /*/
User Function Exclui(cAlias, nReg, nOpc)
Local cTudoOk := "(Alert('OK'),.T.)"
- 520 -
Guia de Referncia Rpida ADVPL Avanado
Exemplo (continuao):
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
Exemplo: Mbrowse() utilizando as funes acessrias
#Include "Protheus.ch"
/*/ +----------------------------------------------------------------------------- | Programa | MBrwSA2 | Autor | SERGIO FUZINAKA | Data | | +----------------------------------------------------------------------------- | Descrio | Exemplo da MBrowse utilizando a tabela de Cadastro de | | | Fornecedores | +----------------------------------------------------------------------------- | Uso | Curso de ADVPL | +----------------------------------------------------------------------------- /*/
User Function MBrwSA2()
Local cAlias := "SA2" Local aCores := {} Local cFiltra := "A2_FILIAL == '"+xFilial('SA2')+"' .And. A2_EST == 'SP'"
//+------------------------------------------------------------ //| Cria o filtro na MBrowse utilizando a funo FilBrowse //+------------------------------------------------------------ Eval(bFiltraBrw)
//+------------------------------------------------ //| 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
- 522 -
Guia de Referncia Rpida ADVPL Avanado
Exemplo (continuao):
//+----------------------------------------- //|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()
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:
O MsDialog() O TGet() O TSay() O MsNewGetDados() O EnchoiceBar()
O A funo Modelo2() no implementa as regras de visualizao, incluso, alterao e excluso, como uma AxCadastro() ou AxFunction().
O 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().
O Da mesma forma, o Browse deve ser tratado por esta rotina, sendo comum a Modelo2() estar vinculada ao uso de uma MBrowse().
E Sintaxe: Modelo2([cTitulo], [aCab], [aRoda], [aGrid], [nOpc], [cLinhaOk], [cTudoOk])
E Parmetros:
cTitulo Ttulo da janela aCab 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. aGrid Array contendo as coordenadas da GetDados() na tela. Padro := {44,5,118,315} nOpc Opo selecionada na MBrowse, ou que deseje ser passada para controle da Modelo2, aonde:2 Visualizar, 3 Incluir, 4 - Alterar, 5 - Excluir cLinhaOk Funo para validao da linha na GetDados() cTudoOk Funo para validao na confirmao da tela de interface da Modelo2().
- 523 -
Guia de Referncia Rpida ADVPL Avanado
- 524 -
Guia de Referncia Rpida ADVPL Avanado
E 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)
#include "protheus.ch" //+--------------------------------------------------------------------+ //| 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
//Local nUsado := 0 Local cTitulo := "Inclusao de itens - Arquivo de Tabelas" Local aCab := {} // Array com descricao dos campos do Cabecalho do Modelo 2 Local aRoda := {} // Array com descricao dos campos do Rodape do Modelo 2 Local aGrid := {80,005,050,300} //Array com coordenadas da GetDados no modelo2 - Padrao: {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
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 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:
O MsDialog() O Enchoice() O EnchoiceBar() O MsNewGetDados()
O A funo Modelo3() no implementa as regras de visualizao, incluso, alterao e excluso, como uma AxCadastro() ou AxFunction().
O 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().
O Da mesma forma, o Browse deve ser tratado por esta rotina, sendo comum a Modelo3() estar vinculada ao uso de uma MBrowse().
cTitulo Ttulo da janela cAliasE Alias da tabela que ser utilizada na Enchoice cAliasGetD Alias da tabela que ser utilizada na GetDados aCposE Nome dos campos, pertencentes ao Alias especificado o parmetro cAliasE, que devero ser exibidos na Enchoice: AADD(aCposE,{nome_campo}) cLinhaOk Funo para validao da linha na GetDados() cTudoOk Funo para validao na confirmao da tela de interface da Modelo2(). nOpcE Opo selecionada na MBrowse, ou que deseje ser passada para controle da Enchoice da Modelo3, aonde: 2 Visualizar 3 - Incluir 4 - Alterar 5 - Excluir nOpcG Opo selecionada na MBrowse, ou que deseje ser passada para controle da GetDados da Modelo3, aonde: 2 Visualizar 3 - Incluir 4 - Alterar 5 - Excluir cFieldOk Validao dos campos da Enchoice()
- 526 -
Guia de Referncia Rpida ADVPL Avanado
- 527 -
Guia de Referncia Rpida ADVPL Avanado
E 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"
Local cTitulo := "Cadastro de Pedidos de Venda" Local cAliasE := "SC5" Local cAliasG := "SC6" Local cLinOk := "AllwaysTrue()" Local cTudOk := "AllwaysTrue()" Local cFieldOk:= "AllwaysTrue()" Local aCposE := {} Local nUsado, nX := 0
- 528 -
Guia de Referncia Rpida ADVPL Avanado
Exemplo (continuao):
// // Opcoes de acesso para a Modelo 3 // Do Case Case nOpcx==3; nOpcE:=3 ; nOpcG:=3 // 3 - "INCLUIR" Case nOpcx==4; nOpcE:=3 ; nOpcG:=3 // 4 - "ALTERAR" Case nOpcx==2; nOpcE:=2 ; nOpcG:=2 // 2 - "VISUALIZAR" Case nOpcx==5; nOpcE:=2 ; nOpcG:=2 // 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
Exemplo (continuao):
If Len(aCols)>0 // // Executa a Modelo 3 // aCposE := {"C5_CLIENTE"}
E Sintaxe: AVISO(cTitulo, cTexto, aBotoes, nTamanho) E Retorno: numrico indicando o boto selecionado. E Parmetros:
cTitulo Ttulo da janela cTexto Texto do aviso aBotoes Array simples (vetor) com os botes de opo nTamanho Tamanho (1,2 ou 3)
FORMBACTH()
E Sintaxe: FORMBATCH(cTitulo, aTexto, aBotoes, bValid, nAltura, nLargura ) E Parmetros: cTitulo Ttulo da janela aTexto Array simples (vetor) contendo cada uma das linhas de texto que sero exibidas no corpo da tela. aBotoes Array com os botes do tipo SBUTTON(), com a seguinte estrutura:
{nTipo,lEnable,{|| Ao() }}
bValid (opcional) Bloco de validao do janela nAltura (opcional) Altura em pixels da janela nLargura (opcional) Largura em pixels da janela
- 530 -
Guia de Referncia Rpida ADVPL Avanado
MSGFUNCTIONS()
E Sintaxe: MSGALERT(cTexto, cTitulo) E Sintaxe: MSGINFO(cTexto, cTitulo) E Sintaxe: MSGSTOP(cTexto, cTitulo) E Sintaxe: MSGYESNO(cTexto, cTitulo)
E Parmetros
cTexto Texto a ser exibido como mensagem cTitulo Ttulo da janela de mensagem MSGALERT
MSGINFO
MSGSTOP
MSGYESNO
- 531 -
Guia de Referncia Rpida ADVPL Avanado
- 532 -
Guia de Referncia Rpida ADVPL Avanado
Recursos das interfaces visuais
GDFIELDGET()
A funo GDFIELDGET() retorna o contedo de um campo especificado em uma grid formada por um objeto do tipo MsNewGetDados() de acordo com a linha da grid desejada.
E Sintaxe: GDFIELDGET(cCampo, nLinha)
E Parmetros:
cCampo Nome do campo para retorno do contedo. nLinha Linha da grid que dever ser avaliada.
E Retorno:
Indefinido Contedo do campo especificado de acordo com a linha da grid informada.
GDFIELDPOS()
A funo GDFIELDPOS() retorna a posio de um campo especificado em uma gria formada por um objeto do tipo MsNewGetDados().
E Sintaxe: GDFIELDPOS(cCampo)
E Parmetros:
cCampo Nome do campo a ser avaliado na grid.
E Retorno:
Numrico Posio que o campo ocupada na grid. Caso o mesmo no exista ser retornado 0.
GDFIELDPUT()
A funo GDFIELDPUT() atualiza o contedo de uma grid formada por um objeto do tipo MsNewGetDados() de acordo com o campo e linha da grid especificados.
E Sintaxe: GDFIELDPUT(cCampo, xConteudo, nLinha)
E Parmetros:
cCampo Nome do campo a ser atualizado. xConteudo Contedo que ser atribudo a clula da grid. nLinha Linha da grid que ser atualizada.
E Retorno:
Nenhum .
GETMARK()
A funo GETMARK() utilizada em conjunto com a funo MarkBrow(), para retornar o conjunto de caracteres que sero utilizados para identificar os registros marcados pelo browse.
E Sintaxe: GETMARK( [lUpper] )
E Parmetros:
lUpper Se verdadeiro (.T.) retorna somente caracteres em maisculos.
E Retorno:
String Conjunto de caracteres que definem a marca que dever ser utilizada pela MarkBrowse durante o processamento corrente.
O retorno da funo GETMARK() depende do contedo atual do parmetro MV_MARCA.
altamente recomendvel limpar o contedo do campo marcado pela MarkBrowse() ao trmino do processamento, para se evitar problemas com a reutilizao da marca aps a exausto das possibilidades de combinao de dois caracteres, o qual o tamanho padro do campos utilizados para marcao de registros pela MarkBrowse(), que neste caso somam 1891 possibilidades de 00 a zz.
A funo ISMARK() utilizada em conjunto com a funo MarkBrow() para identificar se o campo ou string contm a marca em uso no momento pela rotina.
E Sintaxe: ISMARK(cCampo, cMarca, lInvert)
E Parmetros:
cCampo Campo para ser avaliado em funo da marca em uso pela MarkBrowse cMarca Marca em uso pela MarkBrowse lInvert Se foi utilizado o recurso de inverter seleo na MarkBrowse
E Retorno:
Lgico Se o contedo do campo ou string verificada contm a marca em uso pela MarkBrow().
MARKBREFRESH()
A funo MARKBREFRESH() atualiza a exibio da marca no MarkBrowse(), sendo utilizada quando algum processamento paralelo atualiza o contedo do campo definido como controle de marca para os registros em exibio pelo browse.
Este tipo de processamento comum, e normalmente est associonada a clique de inverter seleo, ou a opes de marcar e desmarcar todas.
A MarkBrowse() atualiza automaticamente a exibio da marca de registros quando utilizado o browse.
E Sintaxe: MARKBREFRESH()
E Parmetros:
Nenhum .
E Retorno:
Nenhum .
- 534 -
Guia de Referncia Rpida ADVPL Avanado
- 535 -
Guia de Referncia Rpida ADVPL Avanado
READVAR()
A funo READVAR() retorna o nome da varivel ou campo associoado ao objeto do tipo GET() atualmente selecionado ou em edio.
E Sintaxe: READVAR()
E Parmetros:
Nenhum .
E Retorno:
String Nome da varivel ou campo associado ao objeto do tipo GET.
THISINV()
A funo THISINV() utilizada em conjunto com a funo MarkBrow() para identificar se o foi utilizado o recurso de inverso de seleo dos itens exibidos em uma MarkBrowse.
E Sintaxe: THISINV()
E Parmetros:
Nenhum -
E Retorno:
Lgico Indica se foi utilizada a opo de inverso da seleo dos itens exibidos em uma MarkBrowse.
THISMARK()
A funo THISMARK() utilizada em conjunto com a funo MarkBrow(), e retorna a marca em uso no momento para a MarkBrow().