Escolar Documentos
Profissional Documentos
Cultura Documentos
AMM - ADVPL Intermediário-Rev01 - 1 PDF
AMM - ADVPL Intermediário-Rev01 - 1 PDF
ADVPL Intermedirio
(Capacitao Interna)
ESTRUTURA DO TREINAMENTO
OBJETIVOS DO CURSO................................................................................................................................. 9
MDULO 04: Desenvolvendo aplicaes em ADVPL ................................................................................... 10
1.
A linguagem ADVPL........................................................................................................................... 10
2.
3.
4.
5.
3.2.
3.3.
Escopo de variveis................................................................................................................... 19
3.4.
Palavras reservadas.................................................................................................................. 24
4.2.
Programas de Atualizao................................................................................................................. 26
5.1.
5.2.
Modelo2() ................................................................................................................................. 29
5.2.1. Componentes de uma tela no formato Modelo 2 ........................................................................... 29
5.2.2. Estrutura de um programa utilizando a Modelo2()......................................................................... 37
5.2.3. Funo Modelo2() ..................................................................................................................... 45
5.3.
Modelo3() ................................................................................................................................. 49
5.3.1. Estrutura de um programa utilizando a Modelo3()......................................................................... 52
5.3.2. Funo Modelo3() ..................................................................................................................... 61
5.4.
Mbrowse() ................................................................................................................................ 65
5.4.1. AxFunctions()........................................................................................................................... 70
5.4.2. FilBrowse() .............................................................................................................................. 72
5.4.3. EndFilBrw() .............................................................................................................................. 72
5.4.4. PesqBrw()................................................................................................................................ 73
5.4.5. BrwLegenda () ......................................................................................................................... 73
5.5.
6.
MarkBrowse() ........................................................................................................................... 77
6.2.
Funes para manipulao de arquivos e ndices temporrios.................................................. 81
6.2.1. CriaTrab()................................................................................................................................ 81
6.2.2. dbUseArea()............................................................................................................................. 82
6.2.3. IndRegua() .............................................................................................................................. 82
7.
Relatrios no grficos...................................................................................................................... 86
7.1.1. Estrutura de relatrios baseados na SetPrint().............................................................................. 86
8.
9.
9.2.
Rguas de processamento ...................................................................................................... 107
9.2.1. RptStatus() ............................................................................................................................ 107
SETREGUA()............................................................................................................................... 109
INCREGUA()............................................................................................................................... 110
9.2.2. Processa() ............................................................................................................................. 111
-2ADVPL Intermedirio
SETPROC()................................................................................................................................. 113
INCPROC()................................................................................................................................. 113
9.2.3. MsNewProcess(). .................................................................................................................... 114
9.2.4. MsAguarde(). ......................................................................................................................... 116
9.2.5. MsgRun()............................................................................................................................... 118
9.3.
ListBox()................................................................................................................................. 119
9.3.1. ListBox simples ...................................................................................................................... 119
9.3.2. ListBox mltiplas colunas......................................................................................................... 122
9.4.
ScrollBox().............................................................................................................................. 124
9.5.
10.1.
10.2.
10.3.
O Modelo de Objetos (OMT) .................................................................................................... 137
10.3.1.
Objetos e Classes ............................................................................................................... 137
10.3.2.
Atributos ........................................................................................................................... 138
10.3.3.
Operaes e Mtodos .......................................................................................................... 139
10.3.4.
Sugestes de desenvolvimento............................................................................................. 140
11.
11.1.
11.2.
11.3.
12.1.
Particularidades dos componentes visuais.............................................................................. 155
12.1.1.
Configurando as cores para os componentes.......................................................................... 155
13.
13.1.
Captura de informaes simples (Multi-Gets) ......................................................................... 157
13.1.1.
Enchoice() ......................................................................................................................... 158
13.1.2.
MsMGet() .......................................................................................................................... 160
13.2.
Captura de mltiplas informaes (Multi-Lines) ..................................................................... 162
13.2.1.
MsGetDB()......................................................................................................................... 163
13.2.2.
MsGetDados() .................................................................................................................... 167
13.2.3.
MsNewGetDados() .............................................................................................................. 171
13.2.3.1. Definindo cores personalizadas para o objeto MsNewGetDados() .......................................... 176
13.3.
Barras de botes..................................................................................................................... 181
13.3.1.
EnchoiceBar() .................................................................................................................... 181
13.3.2.
TBar() ............................................................................................................................... 183
13.3.3.
ButtonBar.......................................................................................................................... 184
13.3.4.
Imagens pr-definidas para as barras de botes..................................................................... 187
APNDICES.............................................................................................................................................. 188
BOAS PRTICAS DE PROGRAMAO ........................................................................................................ 188
14.
15.
16.
16.1.
17.
18.
RTRIM()..................................................................................................................................... 244
SPACE()..................................................................................................................................... 245
STRTOKARR()............................................................................................................................. 245
STRTRAN()................................................................................................................................. 246
STUFF() ..................................................................................................................................... 246
SUBSTR() .................................................................................................................................. 247
TRANSFORM() ............................................................................................................................ 247
UPPER()..................................................................................................................................... 248
Manipulao de data / hora................................................................................................................. 249
CDOW()..................................................................................................................................... 249
CMONTH() ................................................................................................................................. 249
DATE() ...................................................................................................................................... 250
DAY() ........................................................................................................................................ 250
DOW()....................................................................................................................................... 251
DTOC()...................................................................................................................................... 251
DTOS()...................................................................................................................................... 252
ELAPTIME() ................................................................................................................................ 252
MONTH() ................................................................................................................................... 253
SECONDS() ................................................................................................................................ 253
TIME()....................................................................................................................................... 254
YEAR() ...................................................................................................................................... 254
Manipulao de variveis numricas ................................................................................................... 255
ABS() ........................................................................................................................................ 255
ALEATORIO() ............................................................................................................................. 255
INT()......................................................................................................................................... 256
NOROUND() ............................................................................................................................... 256
RANDOMIZE() ............................................................................................................................ 257
ROUND() ................................................................................................................................... 257
Manipulao de arquivos ..................................................................................................................... 258
ADIR()....................................................................................................................................... 258
CGETFILE() ................................................................................................................................ 259
CPYS2T() ................................................................................................................................... 265
CPYT2S() ................................................................................................................................... 265
CURDIR()................................................................................................................................... 266
DIRECTORY() ............................................................................................................................. 267
DIRREMOVE()............................................................................................................................. 268
DISKSPACE() ............................................................................................................................. 269
EXISTDIR() ................................................................................................................................ 270
FCLOSE()................................................................................................................................... 270
FCREATE() ................................................................................................................................. 271
FERASE() ................................................................................................................................... 272
FILE()........................................................................................................................................ 272
FILENOEXT() .............................................................................................................................. 273
FOPEN() .................................................................................................................................... 274
FREAD() .................................................................................................................................... 276
FREADSTR () .............................................................................................................................. 276
FRENAME() ................................................................................................................................ 277
FSEEK()..................................................................................................................................... 278
FT_FEOF() ................................................................................................................................. 278
FT_FGOTO()............................................................................................................................... 279
FT_FGOTOP() ............................................................................................................................. 279
FT_FLASTREC() .......................................................................................................................... 279
FT_FREADLN()............................................................................................................................ 280
FT_FRECNO() ............................................................................................................................. 281
FT_FSKIP() ................................................................................................................................ 281
FT_FUSE() ................................................................................................................................. 281
FWRITE() ................................................................................................................................... 282
MSCOPYFILE() ............................................................................................................................ 284
MSCOPYTO() .............................................................................................................................. 285
MSCREATE() .............................................................................................................................. 285
MSERASE() ................................................................................................................................ 286
MSRENAME().............................................................................................................................. 287
RETFILENAME() .......................................................................................................................... 287
Manipulao de arquivos e ndices temporrios .................................................................................. 288
CRIATRAB() ............................................................................................................................... 288
Manipulao de bases de dados........................................................................................................... 289
ALIAS() ..................................................................................................................................... 289
-5ADVPL Intermedirio
LETTERORNUM()......................................................................................................................... 332
NAOVAZIO() .............................................................................................................................. 332
NEGATIVO() ............................................................................................................................... 332
PERTENCE() ............................................................................................................................... 333
POSITIVO() ................................................................................................................................ 333
TEXTO() .................................................................................................................................... 333
VAZIO()..................................................................................................................................... 333
Manipulao de parmetros do sistema............................................................................................... 334
GETMV() .................................................................................................................................... 334
GETNEWPAR() ............................................................................................................................ 334
PUTMV() .................................................................................................................................... 335
SUPERGETMV()........................................................................................................................... 335
Controle de impresso......................................................................................................................... 336
AVALIMP() ................................................................................................................................. 336
CABEC() .................................................................................................................................... 337
IMPCADAST() ............................................................................................................................. 340
MS_FLUSH()............................................................................................................................... 340
OURSPOOL() .............................................................................................................................. 342
RODA()...................................................................................................................................... 343
SETDEFAULT()............................................................................................................................ 345
SETPRC() ................................................................................................................................... 346
SETPRINT()................................................................................................................................ 346
Controle de processamentos ............................................................................................................... 348
ABREEXCL() ............................................................................................................................... 348
CLOSEOPEN()............................................................................................................................. 348
CLOSESFILE() ............................................................................................................................ 348
CHKFILE().................................................................................................................................. 349
CONOUT().................................................................................................................................. 350
CRIAVAR() ................................................................................................................................. 350
DISARMTRANSACTION() .............................................................................................................. 351
EXECBLOCK() ............................................................................................................................. 352
EXISTBLOCK()............................................................................................................................ 352
ERRORBLOCK() .......................................................................................................................... 353
FINAL() ..................................................................................................................................... 355
FINDFUNCTION() ........................................................................................................................ 355
FUNDESC() ................................................................................................................................ 356
FUNNAME() ................................................................................................................................ 356
GETAREA()................................................................................................................................. 356
GETCOUNTRYLIST() .................................................................................................................... 357
ISINCALLSTACK() ....................................................................................................................... 357
REGTOMEMORY()........................................................................................................................ 358
RESTAREA() ............................................................................................................................... 359
USEREXCEPTION() ...................................................................................................................... 359
Utilizao de recursos do ambiente ERP .............................................................................................. 361
AJUSTASX1() ............................................................................................................................. 361
ALLUSERS() ............................................................................................................................... 363
ALLGROUPS() ............................................................................................................................. 365
CGC()........................................................................................................................................ 366
CONPAD1() ................................................................................................................................ 366
DATAVALIDA()............................................................................................................................ 367
EXISTINI() ................................................................................................................................. 367
EXTENSO() ................................................................................................................................ 368
FORMULA() ................................................................................................................................ 368
GETADVFVAL() ........................................................................................................................... 368
HELP()....................................................................................................................................... 369
MESEXTENSO() .......................................................................................................................... 370
OBRIGATORIO() ......................................................................................................................... 370
OPENFILE() ................................................................................................................................ 373
PERGUNTE()............................................................................................................................... 374
PESQPICT()................................................................................................................................ 374
PESQPICTQT() ............................................................................................................................ 375
POSICIONE().............................................................................................................................. 375
PUTSX1()................................................................................................................................... 376
RETINDEX() ............................................................................................................................... 377
SIXDESCRICAO() ........................................................................................................................ 377
TABELA() ................................................................................................................................... 378
TAMSX3() .................................................................................................................................. 378
TM().......................................................................................................................................... 379
-7ADVPL Intermedirio
-8ADVPL Intermedirio
OBJETIVOS DO CURSO
Objetivos especficos do curso:
Ao final do curso o treinando dever ter desenvolvido os seguintes conceitos, habilidades e
atitudes:
a) Conceitos a serem aprendidos
-9ADVPL Intermedirio
- 10 ADVPL Intermedirio
Rotinas escritas em ADVPL podem ser iniciadas como processos individuais (sem interface) no
Protheus Server atravs de duas maneiras: Iniciadas por outra rotina ADVPL atravs da
chamada de funes como StartJob() ou CallProc() ou iniciadas automaticamente na
inicializao do Protheus Server (quando propriamente configurado).
Programao de RPC
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.
- 11 ADVPL Intermedirio
Linhas de Programa
As linhas existentes dentro de um arquivo texto de cdigo de programa podem ser linhas de
comando, linhas de comentrio ou linhas mistas.
Linhas de Comando
Linhas de comando possuem os comandos ou instrues que sero executadas. Por exemplo:
Local nCnt
Local nSoma := 0
For nCnt := 1 To 10
nSoma += nCnt
Next nCnt
Linhas de Comentrio
- 12 ADVPL Intermedirio
Todas as linhas iniciadas com um sinal de asterisco so consideradas como comentrio. Podese utilizar a palavra NOTE ou dois smbolos da letra "e" comercial (&&) para realizar a funo
do sinal de asterisco. Porm todas estas formas de comentrio de linhas so obsoletas e
existem apenas para compatibilizao com o padro xBase. A melhor maneira de comentar
linhas em ADVPL utilizar duas barras transversais:
// Programa para clculo do total
// Autor: Microsiga Software S.A.
// Data: 2 de outubro de 2001
Outra forma de documentar textos utilizar as barras transversais juntamente com o
asterisco, podendo-se comentar todo um bloco de texto sem precisar comentar linha a linha:
/*
Programa para clculo do total
Autor: Microsiga Software S.A.
Data: 2 de outubro de 2001
*/
Todo o texto encontrado entre a abertura (indicada pelos caracteres /*) e o fechamento
(indicada pelos caracteres */) considerado como comentrio.
Linhas Mistas
O ADVPL tambm permite que existam linhas de comando com comentrio. Isto possvel
adicionando-se as duas barras transversais (//) ao final da linha de comando e adicionando-se
o texto do comentrio:
Local nCnt
Local nSoma := 0 // Inicializa a varivel com zero para a soma
For nCnt := 1 To 10
nSoma += nCnt
Next nCnt
Tamanho da Linha
Assim como a linha fsica, delimitada pela quantidade de caracteres que pode ser digitado no
editor de textos utilizado, existe uma linha considerada linha lgica. A linha lgica, aquela
considerada para a compilao como uma nica linha de comando.
A princpio, cada linha digitada no arquivo texto diferenciada aps o pressionamento da tecla
<Enter>. Ou seja, a linha lgica, a linha fsica no arquivo. Porm algumas vezes, por
limitao fsica do editor de texto ou por esttica, pode-se "quebrar" a linha lgica em mais de
uma linha fsica no arquivo texto. Isto efetuado utilizando-se o sinal de ponto-e-vrgula (;).
If !Empty(cNome) .And. !Empty(cEnd) .And. ; <enter>
!Empty(cTel) .And. !Empty(cFax) .And. ; <enter>
!Empty(cEmail)
GravaDados(cNome,cEnd,cTel,cFax,cEmail)
Endif
Neste exemplo existe uma linha de comando para a checagem das variveis utilizadas. Como a
linha torna-se muito grande, pode-se dividi-la em mais de uma linha fsica utilizando o sinal de
- 13 ADVPL Intermedirio
- 14 ADVPL Intermedirio
rea de Identificao
Esta uma rea que no obrigatria e dedicada a documentao do programa. Quando
existente, contm apenas comentrios explicando a sua finalidade, data de criao, autor, etc.,
e aparece no comeo do programa, antes de qualquer linha de comando.
O formato para esta rea no definido. Pode-se colocar qualquer tipo de informao
desejada e escolher a formatao apropriada.
#include protheus.ch
/*
+==========================================+
| Programa: Clculo do Fatorial
|
| Autor
: Microsiga Software S.A.
|
| Data
: 02 de outubro de 2001
|
+==========================================+
*/
User Function CalcFator()
- 15 ADVPL Intermedirio
// Clculo do fatorial
nFator := GetFator()
// GetFator funo ilustrativa na qual a varivel recebe a informao do
usurio.
If nFator <= 0
Alert(Informao invlida)
Return
Endif
For nCnt := nFator To 1 Step -1
nResultado *= nCnt
Next nCnt
rea de Encerramento
nesta rea onde as finalizaes so efetuadas. onde os arquivos abertos so fechados, e o
resultado da execuo do programa utilizado. Pode-se exibir o resultado armazenado em
uma varivel ou em um arquivo ou simplesmente finalizar, caso a tarefa j tenha sido toda
completada no corpo do programa. nesta rea que se encontra o encerramento do
programa. Todo programa em ADVPL deve sempre terminar com a palavra chave return.
// Exibe o resultado na tela, atravs da funo alert
Alert("O fatorial de " + cValToChar(nFator) + ;
" " + cValToChar(nResultado))
// Termina o programa
Return
- 16 ADVPL Intermedirio
- 17 ADVPL Intermedirio
Array
O Array um tipo de dado especial. a disposio de outros elementos em colunas e linhas. O
ADVPL suporta arrays unidimensionais (vetores) ou multidimensionais (matrizes). Os
elementos de um array so acessados atravs de ndices numricos iniciados em 1,
identificando a linha e coluna para quantas dimenses existirem.
Arrays devem ser utilizadas com cautela, pois se forem muito grandes podem exaurir a
memria do servidor.
Bloco de Cdigo
O bloco de cdigo um tipo de dado especial. utilizado para armazenar instrues escritas
em ADVPL que podero ser executadas posteriormente.
- 18 ADVPL Intermedirio
Local
Static
Private
Public
- 19 ADVPL Intermedirio
Function Pai()
Local nVar := 10, aMatriz := {0,1,2,3}
.
<comandos>
.
Filha()
.
<mais comandos>
.
Return(.T.)
Neste exemplo, a varivel nVar foi declarada como local e atribuda com o valor 10. Quando a
funo Filha executada, nVar ainda existe mas no pode ser acessada. Quando a execuo
da funo Pai terminar, a varivel nVar destruda. Qualquer varivel com o mesmo nome no
programa que chamou a funo Pai no afetada.
Variveis de escopo local so criadas automaticamente cada vez que a funo onde forem
declaradas for ativada. Elas continuam a existir e mantm seu valor at o fim da ativao da
funo (ou seja, at que a funo retorne o controle para o cdigo que a executou). Se uma
funo chamada recursivamente (por exemplo, chama a si mesma), cada chamada em
recurso cria um novo conjunto de variveis locais.
A visibilidade de variveis de escopo locais idntica ao escopo de sua declarao, ou seja, a
varivel visvel em qualquer lugar do cdigo fonte em que foi declarada. Se uma funo
chamada recursivamente, apenas as variveis de escopo local criadas na mais recente ativao
so visveis.
Variveis de escopo static
Variveis de escopo static funcionam basicamente como as variveis de escopo local, mas
mantm seu valor atravs da execuo e devem ser declaradas explicitamente no cdigo com
o identificador STATIC.
O escopo das variveis static depende de onde so declaradas. Se forem declaradas dentro do
corpo de uma funo ou procedimento, seu escopo ser limitado quela rotina. Se forem
declaradas fora do corpo de qualquer rotina, seu escopo afeta a todas as funes declaradas
no fonte. Neste exemplo, a varivel nVar declarada como static e inicializada com o valor 10:
Function Pai()
Static nVar := 10
.
<comandos>
.
Filha()
.
<mais comandos>
.
Return(.T.)
- 20 ADVPL Intermedirio
Quando a funo Filha executada, nVar ainda existe mas no pode ser acessada. Diferente
de variveis declaradas como LOCAL ou PRIVATE, nVar continua a existir e mantm seu valor
atual quando a execuo da funo Pai termina. Entretanto, somente pode ser acessada por
execues subseqentes da funo Pai.
Variveis de escopo private
A declarao opcional para variveis privadas. Mas podem ser declaradas explicitamente com
o identificador PRIVATE.
Adicionalmente, a atribuio de valor a uma varivel no criada anteriormente
automaticamente cria a varivel como privada. Uma vez criada, uma varivel privada continua
a existir e mantm seu valor at que o programa ou funo onde foi criada termine (ou seja,
at que a funo onde foi criada retorne para o cdigo que a executou). Neste momento,
automaticamente destruda.
possvel criar uma nova varivel privada com o mesmo nome de uma varivel j existente.
Entretanto, a nova (duplicada) varivel pode apenas ser criada em um nvel de ativao
inferior ao nvel onde a varivel foi declarada pela primeira vez (ou seja, apenas em uma
funo chamada pela funo onde a varivel j havia sido criada). A nova varivel privada ir
esconder qualquer outra varivel privada ou pblica (veja a documentao sobre variveis
pblicas) com o mesmo nome enquanto existir.
Uma vez criada, uma varivel privada visvel em todo o programa enquanto no for
destruda automaticamente quando a rotina que a criou terminar ou uma outra varivel
privada com o mesmo nome for criada em uma subfuno chamada (neste caso, a varivel
existente torna-se inacessvel at que a nova varivel privada seja destruda).
Em termos mais simples, uma varivel privada visvel dentro da funo de criao e todas as
funes chamadas por esta, a menos que uma funo chamada crie sua prpria varivel
privada com o mesmo nome.
Por exemplo:
Function Pai()
Private nVar := 10
<comandos>
.
Filha()
<mais comandos>
.
Return(.T.)
Neste exemplo, a varivel nVar criada com escopo private e inicializada com o valor 10.
Quando a funo Filha executada, nVar ainda existe e, diferente de uma varivel de escopo
local, pode ser acessada pela funo Filha. Quando a funo Pai terminar, nVar ser destruda
e qualquer declarao de nVar anterior se tornar acessvel novamente.
No ambiente ERP Protheus, existe uma conveno adicional a qual deve ser
respeitada que variveis em uso pela aplicao no sejam incorretamente
manipuladas. Por esta conveno deve ser adicionado o caracter _ antes
do nome de variveis PRIVATE e PUBLIC. Maiores informaes avaliar o
tpico: Boas Prticas de Programao.
Exemplo: Private _dData
- 21 ADVPL Intermedirio
Function Pai()
Public nVar := 10
<comandos>
.
Filha()
<mais comandos>
.
Return(.T.)
Neste exemplo, nVar criada como public e inicializada com o valor 10. Quando a funo Filha
executada, nVar ainda existe e pode ser acessada. Diferente de variveis locais ou privates,
nVar ainda existe aps o trmino da a execuo da funo Pai.
Diferentemente dos outros identificadores de escopo, quando uma varivel declarada como
pblica sem ser inicializada, o valor assumido falso (.F.) e no nulo (nil).
No ambiente ERP Protheus, existe uma conveno adicional a qual deve ser
respeitada que variveis em uso pela aplicao no sejam incorretamente
manipuladas. Por esta conveno deve ser adicionado o caracter _ antes
do nome de variveis PRIVATE e PUBLIC. Maiores informaes avaliar o
tpico: Boas Prticas de Programao.
Exemplo: Public _cRotina
- 22 ADVPL Intermedirio
Se esta linha for executada em um programa ADVPL, ocorrer um erro de execuo com a
mensagem "variable does not exist: nPercentual", pois esta varivel est sendo utilizada em
uma expresso de clculo sem ter sido declarada. Para solucionar este erro, deve-se declarar a
varivel previamente:
- 23 ADVPL Intermedirio
DTOS
ELSE
ELSEIF
EMPTY
ENDCASE
ENDDO
LOWER
SETPOS
COL
FIELDNAME
PCOL
TIME
DEVPOS
IF
RECNO
THROW
INKEY
INT
LASTREC
LEN
LOCK
LOG
SELECT
CMONTH
FCOUNT
MONTH
SUBSTR
DELETED
FUNCTION
RECCOUNT
UPPER
Palavras reservadas no
procedimentos ou funes;
REPLICATE
RLOCK
ROUND
ROW
RTRIM
SECONDS
CHR
EXP
MIN
STR
DAY
FOUND
PROW
TYPE
TRY
podem
ser
VAL
VALTYPE
WHILE
WORD
YEAR
CDOW
EOF
MAX
SQRT
DATE
FLOCK
PROCEDURE
TRIM
DTOC
AS
utilizadas
para
variveis,
- 24 ADVPL Intermedirio
Funcionalidade
Permite apenas caracteres alfabticos.
Exibe CR depois de nmeros positivos.
Exibe numrico com o ponto e vrgula invertidos (formato Europeu).
Insere caracteres diferentes dos caracteres de template na exibio, mas no os
insere na varivel do GET.
Permite rolamento horizontal do texto dentro do GET, <n> um nmero inteiro
que identifica o tamanho da regio.
Exibe DB depois de nmeros negativos.
Exibe zeros como brancos.
Exibe nmeros negativos entre parnteses com os espaos em branco iniciais.
Exibe nmeros negativos entre parnteses sem os espaos em branco iniciais.
Converte caracteres alfabticos para maisculo.
Templates
Contedo Funcionalidade
X
Permite qualquer caractere.
9
Permite apenas dgitos para qualquer tipo de dado, incluindo o sinal para
numricos.
#
Permite dgitos, sinais e espaos em branco para qualquer tipo de dado.
!
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 01 Picture campo numrico
CT2_VALOR Numrico 17,2
Picture: @E 99,999,999,999,999.99
- 25 ADVPL Intermedirio
5. Programas de Atualizao
Os programas de atualizao de cadastros e digitao de movimentos seguem um padro que
se apia no Dicionrio de Dados.
Basicamente so trs os modelos mais utilizados:
Modelo 1 ou AxCadastro:
Para
cadastramentos
em
Exemplo: Cadastro de Cliente.
Modelo 2:
Cadastramentos
tabela,
mas
envolvendo
com
um
tela
apenas
cabealho
cheia.
uma
e,
Ideal para
itens
que,
por
isso,
so
Modelo 3:
- 26 ADVPL Intermedirio
Browse padro para visualizao das informaes da base de dados, de acordo com as
configuraes do SX3 Dicionrio de Dados (campo browse).
Parmetros:
cAlias
cTitulo
Ttulo da Janela
cVldExc
cVldAlt
#include "protheus.ch"
/*/
+----------------------------------------------------------------------------| Funo
| XCADSA2
| Autor | ARNALDO RAYMUNDO JR. | Data |
|
+----------------------------------------------------------------------------| Descrio | Exemplo de utilizao da funo AXCADASTRO()
|
|+---------------------------------------------------------------------------| Uso
| Curso ADVPL
|
|+---------------------------------------------------------------------------/*/
User Function XCadSA2()
Local
Local
Local
Local
cAlias
cTitulo
cVldExc
cVldAlt
:=
:=
:=
:=
"SA2"
"Cadastro de Fornecedores"
".T."
".T."
dbSelectArea(cAlias)
dbSetOrder(1)
AxCadastro(cAlias,cTitulo,cVldExc,cVldAlt)
Return Nil
- 27 ADVPL Intermedirio
/*/
+-----------------------------------------------------------------------------| 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
Local aArea
Local nOpcao
:= .T.
:= GetArea()
:= 0
nOpcao := AxAltera(cAlias,nReg,nOpc)
If nOpcao == 1
MsgInfo(Aterao concluda com sucesso!)
Endif
RestArea(aArea)
Return lRet
/*/
+-----------------------------------------------------------------------------| 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
Local aArea
Local nOpcao
:= .T.
:= GetArea()
:= 0
nOpcao := AxExclui(cAlias,nReg,nOpc)
If nOpcao == 1
MsgInfo(Excluso concluda com sucesso!)
Endif
RestArea(aArea)
Return lRet
- 28 ADVPL Intermedirio
5.2. Modelo2()
O nome Modelo 2 foi conceituado pela Microsiga por se tratar de um prottipo de tela para
entrada de dados. Inicialmente vamos desmistificar dois pontos:
Funo Modelo2() Trata-se de uma funo pronta que contempla o prottipo
Modelo 2, porm, este um assunto que no iremos tratar aqui, visto que
uma funcionalidade simples que quando necessrio intervir em algo na rotina
no h muito recurso para tal.
Prottipo Modelo 2 Trata-se de uma tela, como a figura abaixo, onde seu
objetivo efetuar a manuteno em vrios registros de uma s vez. Por
exemplo: efetuar o movimento interno de vrios produtos do estoque em um
nico lote.
5.2.1.
Objeto MsDialog()
Deve ser utilizada como janela padro para entrada de dados, um tipo de objeto modal, ou
seja, no permite que outra janela ativa receba dados enquanto esta estiver ativa.
- 29 ADVPL Intermedirio
Toda vez que utilizar este comando o ADVPL exige que seja declarado a diretiva Include no
cabealho do programa o arquivo Protheus.ch, isto porque o compilador precisar porque
este comando trata-se de um pseudo cdigo e sua traduo ser feita na compilao. Vale
lembrar tambm que este s ser acionado depois que instanciado e ativado por outro
comando.
DEFINE MSDIALOG oDlg TITLE "Prottipo Modelo 2" FROM 0,0 TO 280,552 OF;
oMainWnd PIXEL
ACTIVATE MSDIALOG oDlg CENTER
Funo EnchoiceBar()
Funo que cria uma barra de botes padro de Ok e Cancelar, permitindo a implementao
de botes adicionais.
Objeto
bOk
Objeto
bCancelar
Objeto
lMensApag
Lgico
aBotes
Vetor
- 30 ADVPL Intermedirio
Parmetros:
nRow
nCol
cText
oWnd
oFont
lCentered
lPar6
Reservado.
nClrText
nClrBack
nWidth
nHeight
lLowered
lRaised
- 31 ADVPL Intermedirio
Sintaxe
TSay():
TSay():New([anRow],
[anCol],
[abText],
[aoWnd],
[acPicture],
[aoFont],
[lPar7],
[lPar8],
[lPar9],
[alPixels],
[anClrText], [anClrBack], [anWidth], [anHeight], [lPar15], [lPar16],
[lPar17], [lPar18], [lPar19])
Parmetros:
anRow
anCol
abText
aoWnd
acPicture
aoFont
lPar7
lPar8
lPar9
alPixels
anClrText
anClrBack
anWidth
anHeight
lPar15
lPar16
lPar17
lPar18
lPar19
- 32 ADVPL Intermedirio
Sintaxe
Parmetros:
anRow
anCol
abSetGet
aoWnd
anWidth
anHeight
acPict
abValid
anClrFore
anClrBack
aoFont
lPar12
oPar13
alPixel
cPar15
lPar16
abWhen
lPar18
lPar19
abChange
alReadOnly
alPassword
cPar23
acReadVar
cPar25
lPar26
nPar27
lPar18
Reservado.
Bloco de cdigo, opcional. Executado quando o controle
modifica o valor da varivel associada.
Lgico, opcional. Se .T. o controle no poder ser editado.
Lgico, opcional. Se .T. o controle exibir asteriscos * no
lugar dos caracteres exibidos pelo controle para simular
entrada de senha.
Reservado.
Caractere, opcional. Nome da varivel que o controle dever
manipular, dever ser a mesma varivel informada no
parmetro abSetGet, e ser o retorno da funo ReadVar( ).
Reservado.
Reservado.
Reservado.
Reservado.
Objeto MsGetDados()
Objeto tipo lista com uma ou mais colunas para cadastramento de dados baseado em um
vetor. Sua utilizao exige que seja utilizado trs variveis com seu escopo Private, so elas:
aRotina, aHeader e aCOLS.
Observaes importantes:
O vetor aHeader deve ser construdo com base no dicionrio de dados.
O vetor aCOLS deve ser construdo com base no vetor aHeader, porm devese criar uma coluna adicional para o controle de excluso do registro, ou
seja, quando o usurio teclar a tecla <DELETE> a linha ficar na cor cinza e
esta coluna estar com o seu valor igual a verdadeiro (.T.).
Quando instanciado este objeto possvel saber em que linha o usurio est
porque o objeto trabalha com uma varivel de escopo Public denominada n,
seu valor numrico e ter sempre no contedo a linha em que o usurio
encontra-se com o cursor.
- 34 ADVPL Intermedirio
Sintaxe:
Parmetros:
nSuperior
nEsquerda
nInferior
nDireita
nOpc
cLinhaOk
cTudoOk
cIniCpos
lApagar
aAlter
uPar1
lVazio
nMax
cCampoOk
cSuperApagar
uPar2
cApagaOk
oWnd
Contedo
Ttulo da opo.
Nome da rotina (Function).
Reservado.
Operao (1-Pesquisar;2-Visualizar;3-Incluir;4-Alterar;5-Excluso).
Acesso relacionado a rotina, se est opo no for informada nenhum
acesso ser validado.
- 35 ADVPL Intermedirio
Contedo
Ttulo do campo
Nome do campo
Mscara do campo
Tamanho do campo
Decimal do campo
Validao de usurio do campo
Uso do campo
Tipo do campo (caractere, numrico, data e etc.)
Prefixo da tabela
Contexto do campo (real ou virtual)
- 36 ADVPL Intermedirio
5.2.2.
Programa
Funo principal;
Declarao e atribuio de variveis;
Acesso a tabela principal e sua ordem;
Chamada da funo MBrowse;
Fim da funo principal.
Funo de visualizao, alterao e excluso;
Declarao e atribuio de variveis;
Acesso ao primeiro registro da chave em que est posicionado na MBrowse;
Montagem das variveis estticas em tela;
Montagem do vetor aHeader por meio do dicionrio de dados;
Montagem do vetor aCOLS de todos os registros referente a chave principal em que est
posicionado na MBrowse;
Instncia da MsDialog;
Instncia dos objetos TSay e TGet;
Instncia do objeto MsGetDados;
Ativar o objeto principal que o objeto da janela;
Se for operao diferente de visualizao e clicou no boto OK;
A operao e de Alterao?
Chamar a funo para alterar os dados;
Caso contrrio
Chamar a funo para excluir os dados;
Fim da funo de visualizao, alterao e excluso.
Funo de incluso;
Declarao e atribuio de variveis;
Montagem das variveis estticas em tela;
Montagem do vetor aHeader por meio do dicionrio de dados;
Montagem do vetor aCOLS com o seu contedo conforme o inicializador padro do campo ou
vazio, pois trata-se de uma incluso;
Instncia da MsDialog;
Instncia dos objetos TSay e TGet;
Instncia do objeto MsGetDados;
Ativar o objeto principal que o objeto da janela;
Se clicou no boto OK;
Chamar a funo para incluir os dados;
Fim da funo de incluso.
- 37 ADVPL Intermedirio
Rotina principal
#include "protheus.ch"
//+--------------------------------------------------------------------+
//| Rotina | xModelo2 | Autor | Robson Luiz (rleg) | Data | 01.01.2007 |
//+--------------------------------------------------------------------+
//| Descr. | Funo exemplo do prottipo Modelo2.
|
//+--------------------------------------------------------------------+
//| Uso
| Para treinamento e capacitao.
|
//+--------------------------------------------------------------------+
User Function xModelo2()
Private cCadastro := "Prottipo Modelo 2"
Private aRotina := {}
AADD(
AADD(
AADD(
AADD(
AADD(
aRotina,
aRotina,
aRotina,
aRotina,
aRotina,
{"Pesquisar"
{"Visualizar"
{"Incluir"
{"Alterar"
{"Excluir"
,"AxPesqui" ,0,1})
,'U_Mod2Mnt',0,2})
,'U_Mod2Inc',0,3})
,'U_Mod2Mnt',0,4})
,'U_Mod2Mnt',0,5})
dbSelectArea("ZA3")
dbSetOrder(1)
dbGoTop()
MBrowse(,,,,"ZA3")
Return
Rotina de incluso
//+--------------------------------------------------------------------+
//| Rotina | Mod2Inc | Autor | Robson Luiz (rleg) | Data | 01.01.2007 |
//+--------------------------------------------------------------------+
//| Descr. | Rotina para incluir dados.
|
//+--------------------------------------------------------------------+
//| Uso
| Para treinamento e capacitao.
|
//+--------------------------------------------------------------------+
User Function Mod2Inc( cAlias, nReg, nOpc )
Local oDlg
Local oGet
Local oTPanel1
Local oTPAnel2
Local cCodigo := ZA3->ZA3_CODIGO
Local cNome
:= ZA3->ZA3_NOME
Local dData
:= dDataBase
Private aHeader := {}
Private aCOLS := {}
Private aREG := {}
dbSelectArea( cAlias )
dbSetOrder(1)
- 38 ADVPL Intermedirio
Mod2aHeader( cAlias )
Mod2aCOLS( cAlias, nReg, nOpc )
DEFINE MSDIALOG oDlg TITLE cCadastro From 8,0 To 28,80 OF oMainWnd
oTPanel1 := TPanel():New(0,0,"",oDlg,NIL,.T.,;
.F.,NIL,NIL,0,16,.T.,.F.)
oTPanel1:Align := CONTROL_ALIGN_TOP
@ 4, 006 SAY "Cdigo:" SIZE 70,7 PIXEL OF oTPanel1
@ 4, 062 SAY "Nome:"
SIZE 70,7 PIXEL OF oTPanel1
@ 4, 166 SAY "Emissao:" SIZE 70,7 PIXEL OF oTPanel1
@ 3, 026 MSGET cCodigo F3 "SA3" PICTURE "@!" VALID;
Mod2Vend(cCodigo, @cNome);
SIZE 030,7 PIXEL OF oTPanel1
@ 3, 080 MSGET cNome When .F. SIZE 78,7 PIXEL OF oTPanel1
@ 3, 192 MSGET dData PICTURE "99/99/99" SIZE 40,7 PIXEL OF
oTPanel1
oTPanel2 := TPanel():New(0,0,"",oDlg,NIL,.T.,;
.F.,NIL,NIL,0,16,.T.,.F.)
oTPanel2:Align := CONTROL_ALIGN_BOTTOM
oGet := MSGetDados():New(0,0,0,0,nOpc,"U_Mod2LOk()",;
".T.","+ZA3_ITEM",.T.)
oGet:oBrowse:Align := CONTROL_ALIGN_ALLCLIENT
ACTIVATE MSDIALOG oDlg CENTER ON INIT ;
EnchoiceBar(oDlg,{|| IIF(U_Mod2TOk(), Mod2GrvI(),;
( oDlg:End(), NIL ) )},{|| oDlg:End() })
Return
//+--------------------------------------------------------------------+
//| Rotina | Mod2Mnt | Autor | Robson Luiz (rleg) | Data | 01.01.2007 |
//+--------------------------------------------------------------------+
//| Descr. | Rotina para Visualizar, Alterar e Excluir dados.
|
//+--------------------------------------------------------------------+
//| Uso
| Para treinamento e capacitao.
|
//+--------------------------------------------------------------------+
User Function Mod2Mnt( cAlias, nReg, nOpc )
Local
Local
Local
Local
oDlg
oGet
oTPanel1
oTPAnel2
Private aCOLS := {}
Private aREG := {}
dbSelectArea( cAlias )
dbGoTo( nReg )
cCodigo := ZA3->ZA3_CODIGO
cNome
:= ZA3->ZA3_NOME
cData
:= ZA3->ZA3_DATA
Mod2aHeader( cAlias )
Mod2aCOLS( cAlias, nReg, nOpc )
DEFINE MSDIALOG oDlg TITLE cCadastro From 8,0 To 28,80 OF oMainWnd
oTPane1 := TPanel():New(0,0,"",oDlg,NIL,.T.,;
.F.,NIL,NIL,0,16,.T.,.F.)
oTPane1:Align := CONTROL_ALIGN_TOP
@ 4, 006 SAY "Cdigo:" SIZE 70,7 PIXEL OF oTPanel1
@ 4, 062 SAY "Nome:"
SIZE 70,7 PIXEL OF oTPanel1
@ 4, 166 SAY "Emissao:" SIZE 70,7 PIXEL OF oTPanel1
@ 3, 026 MSGET cCodigo When .F. SIZE 30,7 PIXEL OF oTPanel1
@ 3, 080 MSGET cNome
When .F. SIZE 78,7 PIXEL OF oTPanel1
@ 3, 192 MSGET dData
When .F. SIZE 40,7 PIXEL OF oTPanel1
oTPanel2 := TPanel():New(0,0,"",oDlg,NIL,.T.,;
.F.,NIL,NIL,0,16,.T.,.F.)
oTPanel2:Align := CONTROL_ALIGN_BOTTOM
If nOpc == 4
oGet := MSGetDados():New(0,0,0,0,nOpc,"U_Mod2LOk()",;
".T.","+ZA3_ITEM",.T.)
Else
oGet := MSGetDados():New(0,0,0,0,nOpc)
Endif
oGet:oBrowse:Align := CONTROL_ALIGN_ALLCLIENT
ACTIVATE MSDIALOG oDlg CENTER ON INIT ;
EnchoiceBar(oDlg,{|| ( IIF( nOpc==4, Mod2GrvA(), ;
IIF( nOpc==5, Mod2GrvE(), oDlg:End() ) ), oDlg:End() ) },;
{|| oDlg:End() })
Return
- 40 ADVPL Intermedirio
//+--------------------------------------------------------------------+
//| Rotina | Mod2aHeader | Autor | Robson Luiz (rleg) |Data|01.01.2007 |
//+--------------------------------------------------------------------+
//| Descr. | Rotina para montar o vetor aHeader.
|
//+--------------------------------------------------------------------+
//| Uso
| Para treinamento e capacitao.
|
//+--------------------------------------------------------------------+
Static Function Mod2aHeader( cAlias )
Local aArea := GetArea()
dbSelectArea("SX3")
dbSetOrder(1)
dbSeek( cAlias )
While !EOF() .And. X3_ARQUIVO == cAlias
If X3Uso(X3_USADO) .And. cNivel >= X3_NIVEL
AADD( aHeader, { Trim( X3Titulo() ),;
X3_CAMPO,;
X3_PICTURE,;
X3_TAMANHO,;
X3_DECIMAL,;
X3_VALID,;
X3_USADO,;
X3_TIPO,;
X3_ARQUIVO,;
X3_CONTEXT})
Endif
dbSkip()
End
RestArea(aArea)
Return
//+--------------------------------------------------------------------+
//| Rotina | Mod2aCOLS | Autor | Robson Luiz (rleg) |Data | 01.01.2007 |
//+--------------------------------------------------------------------+
//| Descr. | Rotina para montar o vetor aCOLS.
|
//+--------------------------------------------------------------------+
//| Uso
| Para treinamento e capacitao.
|
//+--------------------------------------------------------------------+
Static Function Mod2aCOLS( cAlias, nReg, nOpc )
Local aArea := GetArea()
Local cChave := ZA3->ZA3_CODIGO
Local nI := 0
If nOpc <> 3
dbSelectArea( cAlias )
dbSetOrder(1)
dbSeek( xFilial( cAlias ) + cChave )
While !EOF() .And. ;
ZA3->( ZA3_FILIAL + ZA3_CODIGO ) == xFilial( cAlias ) + cChave
AADD( aREG, ZA3->( RecNo() ) )
- 41 ADVPL Intermedirio
//+--------------------------------------------------------------------+
//| Rotina | Mod2GrvI | Autor | Robson Luiz (rleg) | Data | 01.01.2007 |
//+--------------------------------------------------------------------+
//| Descr. | Rotina para gravar os dados na incluso.
|
//+--------------------------------------------------------------------+
//| Uso
| Para treinamento e capacitao.
|
//+--------------------------------------------------------------------+
Static Function Mod2GrvI()
Local aArea := GetArea()
Local nI := 0
Local nX := 0
dbSelectArea("ZA3")
dbSetOrder(1)
For nI := 1 To Len( aCOLS )
If ! aCOLS[nI,Len(aHeader)+1]
RecLock("ZA3",.T.)
ZA3->ZA3_FILIAL := xFilial("ZA3")
ZA3->ZA3_CODIGO := cCodigo
ZA3->ZA3_DATA
:= dData
For nX := 1 To Len( aHeader )
FieldPut( FieldPos( aHeader[nX, 2] ), aCOLS[nI, nX] )
Next nX
MsUnLock()
Endif
Next nI
RestArea(aArea)
Return
- 42 ADVPL Intermedirio
Efetivao da alterao
//+--------------------------------------------------------------------+
//| Rotina | Mod2GrvA | Autor | Robson Luiz (rleg) | Data | 01.01.2007 |
//+--------------------------------------------------------------------+
//| Descr. | Rotina para gravar os dados na alterao.
|
//+--------------------------------------------------------------------+
//| Uso
| Para treinamento e capacitao.
|
//+--------------------------------------------------------------------+
Static Function Mod2GrvA()
Local aArea := GetArea()
Local nI := 0
Local nX := 0
dbSelectArea("ZA3")
For nI := 1 To Len( aREG )
If nI <= Len( aREG )
dbGoTo( aREG[nI] )
RecLock("ZA3",.F.)
If aCOLS[nI, Len(aHeader)+1]
dbDelete()
Endif
Else
RecLock("ZA3",.T.)
Endif
If !aCOLS[nI, Len(aHeader)+1]
ZA3->ZA3_FILIAL := xFilial("ZA3")
ZA3->ZA3_CODIGO := cCodigo
ZA3->ZA3_DATA
:= dData
For nX := 1 To Len( aHeader )
FieldPut( FieldPos( aHeader[nX, 2] ), aCOLS[nI, nX] )
Next nX
Endif
MsUnLock()
Next nI
RestArea( aArea )
Return
- 43 ADVPL Intermedirio
Efetivao da excluso
//+--------------------------------------------------------------------+
//| Rotina | Mod2GrvE | Autor | Robson Luiz (rleg) | Data | 01.01.2007 |
//+--------------------------------------------------------------------+
//| Descr. | Rotina para excluir os registros.
|
//+--------------------------------------------------------------------+
//| Uso
| Para treinamento e capacitao.
|
//+--------------------------------------------------------------------+
Static Function Mod2GrvE()
Local nI := 0
dbSelectArea("ZA3")
For nI := 1 To Len( aCOLS )
dbGoTo(aREG[nI])
RecLock("ZA3",.F.)
dbDelete()
MsUnLock()
Next nI
Return
Funo auxiliar: Validao do cdigo do vendedor
//+--------------------------------------------------------------------+
//| Rotina | Mod2Vend | Autor | Robson Luiz (rleg) | Data | 01.01.2007 |
//+--------------------------------------------------------------------+
//| Descr. | Rotina para validar o cdigo do vendedor.
|
//+--------------------------------------------------------------------+
//| Uso
| Para treinamento e capacitao.
|
//+--------------------------------------------------------------------+
Static Function Mod2Vend( cCodigo, cNome )
If ExistCpo("SA3",cCodigo) .And. ExistChav("ZA3",cCodigo)
cNome := Posicione("SA3",1,xFilial("SA3")+cCodigo,"A3_NOME")
Endif
Return(!Empty(cNome))
- 44 ADVPL Intermedirio
//+--------------------------------------------------------------------+
//| Rotina | Mod2TOk | Autor | Robson Luiz (rleg)
| Data |01.01.2007 |
//+--------------------------------------------------------------------+
//| Descr. | Rotina para validar toda as linhas de dados.
|
//+--------------------------------------------------------------------+
//| Uso
| Para treinamento e capacitao.
|
//+--------------------------------------------------------------------+
User Function Mod2TOk()
Local lRet := .T.
Local nI := 0
Local cMensagem := "No ser permitido linhas sem o centro de custo."
For nI := 1 To Len( aCOLS )
If aCOLS[nI, Len(aHeader)+1]
Loop
Endif
If !aCOLS[nI, Len(aHeader)+1]
If Empty(aCOLS[n,GdFieldPos("ZA3_CCUSTO")])
MsgAlert(cMensagem,cCadastro)
lRet := .F.
Exit
Endif
Endif
Next nI
Return( lRet )
5.2.3.
Funo Modelo2()
A funo Modelo2() uma interface pr-definida pela Microsiga que implementa de forma
padronizada os compontes necessrios a manipulao de estruturas de dados nas quais o
cabealho e os itens da informao compartilham o mesmo registro fsico.
Seu objetivo atuar como um facilitador de codificao, permitindo a utilizao dos recursos
bsicos dos seguintes componentes visuais:
MsDialog()
TGet()
TSay()
MsNewGetDados()
EnchoiceBar()
- 45 ADVPL Intermedirio
Parmetros:
cTitulo
aCab
Ttulo da janela
Array contendo as informaes que sero exibidas no cabealho na forma de
Enchoice()
aCab[n][1] (Caractere) := Nome da varivel private que ser vinculada ao
campo da Enchoice().
aCab[n][2] (Array) := Array com as coordenadas do campo na tela {Linha,
Coluna}
aCab[n][3] (Caractere) := Ttulo do campo na tela
aCab[n][4] (Caractere) := Picture de formatao do get() do campo.
aCab[n][5] (Caractere) := Funo de validao do get() do campo.
aCab[n][6] (Caractere) := Nome da consulta padro que ser executada
para o campo via tecla F3
aCab[n][7] (Lgico) := Se o campo estar livre para digitao.
aRoda
aGrid
nOpc
cLinhaOk
cTudoOk
Retorno:
Lgico
- 46 ADVPL Intermedirio
#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
AADD(aRotina,{"Pesquisar"
AADD(aRotina,{"Visualizar"
AADD(aRotina,{"Incluir"
AADD(aRotina,{"Alterar"
AADD(aRotina,{"Excluir"
,"AxPesqui"
,"U_SX52Vis"
,"U_SX52Inc"
,"U_SX52Alt"
,"U_SX52Exc"
,0,1})
,0,2})
,0,3})
,0,4})
,0,5})
dbSelectArea(cAlias)
dbSetOrder(1)
mBrowse( 6,1,22,75,cAlias)
Return
USER FUNCTION SX52INC(cAlias,nReg,nOpc)
//Local nUsado
Local cTitulo
Local aCab
2
Local aRoda
Local aGrid
modelo2 - Padrao:
:= 0
:= "Inclusao de itens - Arquivo de Tabelas"
:= {} // Array com descricao dos campos do Cabecalho do Modelo
- 47 ADVPL Intermedirio
Exemplo (continuao):
// Variaveis para campos da Enchoice()
Private cX5Filial := xFilial("SX5")
Private cX5Tabela := SPACE(5)
// Montagem do array de cabealho
// AADD(aCab,{"Varivel"
,{L,C} ,"Ttulo","Picture","Valid","F3",lEnable})
AADD(aCab,{"cX5Filial" ,{015,010} ,"Filial","@!",,,.F.})
AADD(aCab,{"cX5Tabela" ,{015,080} ,"Tabela","@!",,,.T.})
// Montagem do aHeader
AADD(aHeader,{"Chave"
,"X5_CHAVE","@!",5,0,"AllwaysTrue()",;
"","C","","R"})
AADD(aHeader,{"Descricao"
,"X5_DESCRI","@!",40,0,"AllwaysTrue()",;
"","C","","R"})
// Montagem do aCols
aCols := Array(1,Len(aHeader)+1)
// Inicializao do aCols
For nColuna := 1 to Len(aHeader)
If aHeader[nColuna][8] == "C"
aCols[1][nColuna] := SPACE(aHeader[nColuna][4])
ElseIf aHeader[nColuna][8] == "N"
aCols[1][nColuna] := 0
ElseIf aHeader[nColuna][8] == "D"
aCols[1][nColuna] := CTOD("")
ElseIf aHeader[nColuna][8] == "L"
aCols[1][nColuna] := .F.
ElseIf aHeader[nColuna][8] == "M"
aCols[1][nColuna] := ""
Endif
Next nColuna
aCols[1][Len(aHeader)+1] := .F. // Linha no deletada
lRetMod2 := Modelo2(cTitulo,aCab,aRoda,aGrid,nOpc,cLinhaOk,cTudoOk)
IF lRetMod2
//MsgInfo("Voc confirmou a operao","MBRW2SX5")
For nLinha := 1 to len(aCols)
// Campos de Cabealho
Reclock("SX5",.T.)
SX5->X5_FILIAL := cX5Filial
SX5->X5_TABELA := cX5Tabela
// Campos do aCols
//SX5->X5_CHAVE := aCols[nLinha][1]
//SX5->X5_DESCRI := aCols[nLinha][2]
For nColuna := 1 to Len(aHeader)
SX5->&(aHeader[nColuna][2]) := aCols[nLinha][nColuna]
Next nColuna
MsUnLock()
Next nLinha
ELSE
MsgAlert("Voc cancelou a operao","MBRW2SX5")
ENDIF
Return
- 48 ADVPL Intermedirio
5.3. Modelo3()
O nome Modelo 3, assim como a Modelo 2 foi conceituado pela Microsiga por se tratar de um
prottipo de tela para entrada de dados. Inicialmente vamos desmistifica dois pontos:
Funo Modelo3() Trata-se de uma funo pronta que contempla o prottipo
Modelo 3, porm, este um assunto que no iremos tratar aqui, visto que
uma funcionalidade simples que quando necessrio intervir em algo na rotina
no h muito recurso para tal.
Prottipo Modelo 3 Trata-se de uma tela, como a figura abaixo, onde seu
objetivo efetuar a manuteno em vrios registros de uma s vez relacionada
a outro registro de outra tabela, ou seja, aqui teremos o relacionamento de
registros pai e filho, ento preciso se preocupar com este relacionamento.
Por exemplo: efetuar a manuteno em um pedido de vendas, onde ter um
registro em uma tabela referente cabea do pedido e outra tabela com os
registros referentes aos itens deste pedido de vendas.
Para ganharmos tempo no ser apresentado aqui toda a explicao e montagens para a
funo EnchoiceBar, comando MsDialog, Say e MsGet e para os vetores aHeader e
aCOLS, entretanto todos estes estaro na codificao do cdigo fonte. A figura abaixo mostra
exatamente o que a tela prottipo Modelo 3:
- 49 ADVPL Intermedirio
aCpos
uPar4
uPar5
uPar6
uPar7
oWnd
uPar8
lMemoria
lColuna
uPar9
lSemPastas
- 50 ADVPL Intermedirio
Vale lembrar que ns programadores reaproveitamos muito o que j existe, isto para
simplesmente ganharmos tempo, e no caso da utilizao da funo Enchoice preciso criar as
variveis de memrias que levam o mesmo nome dos campos da tabela em questo. Por
exemplo o campo A2_NOME da tabela SA2 (cadastro de fornecedores) quando queremos
referenciar o campo usa-se o prefixo da tabela e o campo em questo, desta forma:
SA2->A2_NOME
Agora quando queremos referenciar a uma varivel que est com o contedo do mesmo
campo criamos outro recurso, desta forma:
M->A2_NOME
E para criar variveis com o nome do campo utilizamos um cdigo de bloco (code-block) e
mais um lao de leitura para atribuir valores iniciais a cada uma dela. Ento fica assim o
procedimento:
Private bCampo
:= { |nField| Field(nField) }
E em outro momento aproveitamos est varivel bCampo para facilitar a atribuio, veja o
exemplo abaixo :
For nX := 1 To FCount()
M->&( Eval( bCampo, nX ) ) := Atribuio inicial ou atribuio de valor
Next nX
Ou seja, fazer para todos os campos, e a cada campo criar a varivel com a atribuio inicial
ou atribuio de valor.
- 51 ADVPL Intermedirio
5.3.1.
Programa
Funo principal;
Declarao e atribuio de variveis;
Acesso a tabela principal e sua ordem;
Chamada da funo MBrowse;
Fim da funo principal.
Funo de visualizao, alterao e excluso;
Declarao e atribuio de variveis;
Acesso ao primeiro registro da chave em que est posicionado na MBrowse;
Construo das variveis de memria M->???;
Montagem do vetor aHeader por meio do dicionrio de dados;
Montagem do vetor aCOLS de todos os registros referente a chave principal em que est
posicionado na MBrowse;
Instncia da MsDialog;
Execuo da funo Enchoice;
Instncia do objeto MsGetDados;
Ativar o objeto principal que o objeto da janela;
Se for operao diferente de visualizao e clicou no boto OK;
A operao e de Alterao?
Chamar a funo para alterar os dados;
Caso contrrio
Chamar a funo para excluir os dados;
Fim da funo de visualizao, alterao e excluso.
Funo de incluso;
Declarao e atribuio de variveis;
Construo das variveis de memria M->???;
Montagem do vetor aHeader por meio do dicionrio de dados;
Montagem do vetor aCOLS com o seu contedo conforme o inicializador padro do campo ou
vazio, pois trata-se de uma incluso;
Instncia da MsDialog;
Instncia dos objetos TSay e TGet;
Instncia do objeto MsGetDados;
Ativar o objeto principal que o objeto da janela;
Se clicou no boto OK;
Chamar a funo para incluir os dados;
Fim da funo de incluso.
- 52 ADVPL Intermedirio
Rotina principal
//+--------------------------------------------------------------------+
//| Rotina | xModelo3 | Autor | Robson Luiz (rleg) | Data | 01.01.2007 |
//+--------------------------------------------------------------------+
//| Descr. | Funo exemplo do prottipo Modelo3.
|
//+--------------------------------------------------------------------+
//| Uso
| Para treinamento e capacitao.
|
//+--------------------------------------------------------------------+
#Include "Protheus.ch"
User Function xModelo3()
Private cCadastro := "Prottipo Modelo 3"
Private aRotina := {}
Private oCliente
Private oTotal
Private cCliente := ""
Private nTotal := 0
Private bCampo := {|nField| FieldName(nField) }
Private
Private
Private
Private
Private
aSize := {}
aInfo := {}
aObj := {}
aPObj := {}
aPGet := {}
aRotina,
aRotina,
aRotina,
aRotina,
aRotina,
{"Pesquisar"
{"Visualizar"
{"Incluir"
{"Alterar"
{"Excluir"
,"AxPesqui" ,0,1})
,'U_Mod3Mnt',0,2})
,'U_Mod3Inc',0,3})
,'U_Mod3Mnt',0,4})
,'U_Mod3Mnt',0,5})
dbSelectArea("ZA1")
dbSetOrder(1)
dbGoTop()
MBrowse(,,,,"ZA1")
Return
- 53 ADVPL Intermedirio
Funo de Incluso
//+--------------------------------------------------------------------+
//| Rotina | Mod3Inc | Autor | Robson Luiz (rleg) | Data | 01.01.2007 |
//+--------------------------------------------------------------------+
//| Descr. | Rotina para incluir dados.
|
//+--------------------------------------------------------------------+
//| Uso
| Para treinamento e capacitao.
|
//+--------------------------------------------------------------------+
User Function Mod3Inc( cAlias, nReg, nOpc )
Local oDlg
Local oGet
Local nX := 0
Local nOpcA := 0
Private
Private
Private
Private
aHeader := {}
aCOLS := {}
aGets := {}
aTela := {}
dbSelectArea( cAlias )
dbSetOrder(1)
For nX := 1 To FCount()
M->&( Eval( bCampo, nX ) ) := CriaVar( FieldName( nX ), .T. )
Next nX
Mod3aHeader()
Mod3aCOLS( nOpc )
DEFINE MSDIALOG oDlg TITLE cCadastro FROM ;
aSize[7],aSize[1] TO aSize[6],aSize[5] OF oMainWnd PIXEL
EnChoice( cAlias, nReg, nOpc, , , , , aPObj[1])
// Atualizao do nome do cliente
@ aPObj[3,1],aPGet[1,1] SAY "Cliente: " SIZE 70,7 OF oDlg PIXEL
@ aPObj[3,1],aPGet[1,2] SAY oCliente VAR cCliente SIZE 98,7 OF oDlg PIXEL
// Atualizao do total
@ aPObj[3,1],aPGet[1,3] SAY "Valor Total: " SIZE 70,7 OF oDlg PIXEL
@ aPObj[3,1],aPGet[1,4] SAY oTotal VAR nTotal ;
PICT "@E 9,999,999,999.99" SIZE 70,7 OF oDlg PIXEL
oGet := MSGetDados():New(aPObj[2,1],aPObj[2,2],aPObj[2,3],aPObj[2,4],;
nOpc,"U_Mod3LOk()",".T.","+ZA2_ITEM",.T.)
ACTIVATE MSDIALOG oDlg ON INIT EnchoiceBar(oDlg,;
{|| IIF( Mod3TOk().And.Obrigatorio( aGets, aTela ), ( nOpcA := 1, oDlg:End() ),
NIL) },;
{|| oDlg:End() })
If nOpcA == 1 .And. nOpc == 3
Mod3Grv( nOpc )
ConfirmSXE()
Endif
Return
- 54 ADVPL Intermedirio
//+--------------------------------------------------------------------+
//| Rotina | Mod3Mnt | Autor | Robson Luiz (rleg) | Data | 01.01.2007 |
//+--------------------------------------------------------------------+
//| Descr. | Rotina para Visualizar, Alterar e Excluir dados.
|
//+--------------------------------------------------------------------+
//| Uso
| Para treinamento e capacitao.
|
//+--------------------------------------------------------------------+
User Function Mod3Mnt( cAlias, nReg, nOpc )
Local oDlg
Local oGet
Local nX := 0
Local nOpcA := 0
Private aHeader := {}
Private aCOLS := {}
Private aGets := {}
Private aTela := {}
Private aREG := {}
dbSelectArea( cAlias )
dbSetOrder(1)
For nX := 1 To FCount()
M->&( Eval( bCampo, nX ) ) := FieldGet( nX )
Next nX
Mod3aHeader()
Mod3aCOLS( nOpc )
DEFINE MSDIALOG oDlg TITLE cCadastro FROM ;
aSize[7],aSize[1] TO aSize[6],aSize[5] OF oMainWnd PIXEL
EnChoice( cAlias, nReg, nOpc, , , , , aPObj[1])
// Atualizao do nome do cliente
@ aPObj[3,1],aPGet[1,1] SAY "Cliente: " SIZE 70,7 OF oDlg PIXEL
@ aPObj[3,1],aPGet[1,2] SAY oCliente VAR cCliente SIZE 98,7 OF oDlg PIXEL
// Atualizao do total
@ aPObj[3,1],aPGet[1,3] SAY "Valor Total: " SIZE 70,7 OF oDlg PIXEL
@ aPObj[3,1],aPGet[1,4] SAY oTotal VAR nTotal PICTURE ;
"@E 9,999,999,999.99" SIZE 70,7 OF oDlg PIXEL
U_Mod3Cli()
oGet := MSGetDados():New(aPObj[2,1],aPObj[2,2],aPObj[2,3],aPObj[2,4],;
nOpc,"U_Mod3LOk()",".T.","+ZA2_ITEM",.T.)
ACTIVATE MSDIALOG oDlg ON INIT EnchoiceBar(oDlg,;
{|| IIF( Mod3TOk().And.Obrigatorio( aGets, aTela ), ( nOpcA := 1, oDlg:End() ),
NIL ) },;
{|| oDlg:End() })
If nOpcA == 1 .And. ( nOpc == 4 .Or. nOpc == 5 )
Mod3Grv( nOpc, aREG )
Endif
Return
- 55 ADVPL Intermedirio
//+--------------------------------------------------------------------+
//| Rotina | Mod3aHeader | Autor | Robson Luiz (rleg) |Data|01.01.2007 |
//+--------------------------------------------------------------------+
//| Descr. | Rotina para montar o vetor aHeader.
|
//+--------------------------------------------------------------------+
//| Uso
| Para treinamento e capacitao.
|
//+--------------------------------------------------------------------+
Static Function Mod3aHeader()
Local aArea := GetArea()
dbSelectArea("SX3")
dbSetOrder(1)
dbSeek("ZA2")
While !EOF() .And. X3_ARQUIVO == "ZA2"
If X3Uso(X3_USADO) .And. cNivel >= X3_NIVEL
AADD( aHeader, { Trim( X3Titulo() ),;
X3_CAMPO,;
X3_PICTURE,;
X3_TAMANHO,;
X3_DECIMAL,;
X3_VALID,;
X3_USADO,;
X3_TIPO,;
X3_ARQUIVO,;
X3_CONTEXT})
Endif
dbSkip()
End
RestArea(aArea)
Return
Funo para montar o vetor aCols
//+--------------------------------------------------------------------+
//| Rotina | Mod3aCOLS | Autor | Robson Luiz (rleg) |Data | 01.01.2007 |
//+--------------------------------------------------------------------+
//| Descr. | Rotina para montar o vetor aCOLS.
|
//+--------------------------------------------------------------------+
//| Uso
| Para treinamento e capacitao.
|
//+--------------------------------------------------------------------+
Static Function Mod3aCOLS( nOpc )
Local aArea := GetArea()
Local cChave := ""
Local cAlias := "ZA2"
Local nI := 0
If nOpc <> 3
cChave := ZA1->ZA1_NUM
dbSelectArea( cAlias )
dbSetOrder(1)
dbSeek( xFilial( cAlias ) + cChave )
- 56 ADVPL Intermedirio
Continuao:
While !EOF() .And. ZA2->( ZA2_FILIAL + ZA2_NUM ) == xFilial( cAlias ) +
cChave
AADD( aREG, ZA2->( RecNo() ) )
AADD( aCOLS, Array( Len( aHeader ) + 1 ) )
For nI := 1 To Len( aHeader )
If aHeader[nI,10] == "V"
aCOLS[Len(aCOLS),nI] := CriaVar(aHeader[nI,2],.T.)
Else
aCOLS[Len(aCOLS),nI] :=
FieldGet(FieldPos(aHeader[nI,2]))
Endif
Next nI
aCOLS[Len(aCOLS),Len(aHeader)+1] := .F.
dbSkip()
End
Else
AADD( aCOLS, Array( Len( aHeader ) + 1 ) )
For nI := 1 To Len( aHeader )
aCOLS[1, nI] := CriaVar( aHeader[nI, 2], .T. )
Next nI
aCOLS[1, GdFieldPos("ZA2_ITEM")] := "01"
aCOLS[1, Len( aHeader )+1 ] := .F.
Endif
Restarea( aArea )
Return
//+--------------------------------------------------------------------+
//| Rotina | Mod3Cli | Autor | Robson Luiz (rleg)
|Data | 01.01.2007 |
//+--------------------------------------------------------------------+
//| Descr. | Rotina para atualizar a varivel com o nome do cliente.
|
//+--------------------------------------------------------------------+
//| Uso
| Para treinamento e capacitao.
|
//+--------------------------------------------------------------------+
User Function Mod3Cli()
cCliente := Posicione( "SA1", 1, xFilial("SA1") + M->(ZA1_CLIENT + ZA1_LOJA),
"A1_NREDUZ" )
oCliente:Refresh()
Return(.T.)
- 57 ADVPL Intermedirio
- 58 ADVPL Intermedirio
Funo para efetuar a gravao dos dados em ZA1 e ZA2 na incluso, alterao e
excluso.
//+--------------------------------------------------------------------+
//| Rotina | Mod3Grv | Autor | Robson Luiz (rleg)
|Data | 01.01.2007 |
//+--------------------------------------------------------------------+
//| Descr. | Rotina para efetuar a gravao nas tabelas.
|
//+--------------------------------------------------------------------+
//| Uso
| Para treinamento e capacitao.
|
//+--------------------------------------------------------------------+
Static Function Mod3Grv( nOpc, aAltera )
Local nX := 0
Local nI := 0
// Se for incluso
If nOpc == 3
// Grava os itens
dbSelectArea("ZA2")
dbSetOrder(1)
For nX := 1 To Len( aCOLS )
If !aCOLS[ nX, Len( aCOLS ) + 1 ]
RecLock( "ZA2", .T. )
For nI := 1 To Len( aHeader )
FieldPut( FieldPos( Trim( aHeader[nI, 2] ) ),
aCOLS[nX,nI] )
Next nI
ZA2->ZA2_FILIAL := xFilial("ZA2")
ZA2->ZA2_NUM := M->ZA1_NUM
MsUnLock()
Endif
Next nX
// Grava o Cabealho
dbSelectArea( "ZA1" )
RecLock( "ZA1", .T. )
For nX := 1 To FCount()
If "FILIAL" $ FieldName( nX )
FieldPut( nX, xFilial( "ZA1" ) )
Else
FieldPut( nX, M->&( Eval( bCampo, nX ) ) )
Endif
Next nX
MsUnLock()
Endif
// Se for alterao
If nOpc == 4
// Grava os itens conforme as alteraes
dbSelectArea("ZA2")
dbSetOrder(1)
For nX := 1 To Len( aCOLS )
If nX <= Len( aREG )
dbGoto( aREG[nX] )
RecLock("ZA2",.F.)
If aCOLS[ nX, Len( aHeader ) + 1 ]
dbDelete()
Endif
Else
- 59 ADVPL Intermedirio
Continuao:
If !aCOLS[ nX, Len( aHeader ) + 1 ]
RecLock( "ZA2", .T. )
Endif
Endif
If !aCOLS[ nX, Len(aHeader)+1 ]
For nI := 1 To Len( aHeader )
FieldPut( FieldPos( Trim( aHeader[ nI, 2] ) ),;
aCOLS[ nX, nI ] )
Next nI
ZA2->ZA2_FILIAL := xFilial("ZA2")
ZA2->ZA2_NUM := M->ZA1_NUM
Endif
MsUnLock()
Next nX
// Grava o Cabealho
dbSelectArea("ZA1")
RecLock( "ZA1", .F. )
For nX := 1 To FCount()
If "FILIAL" $ FieldName( nX )
FieldPut( nX, xFilial("ZA1"))
Else
FieldPut( nX, M->&( Eval( bCampo, nX ) ) )
Endif
Next
MsUnLock()
Endif
// Se for excluso
If nOpc == 5
// Deleta os Itens
dbSelectArea("ZA2")
dbSetOrder(1)
dbSeek(xFilial("ZA2") + M->ZA1_NUM)
While !EOF() .And. ZA2->(ZA2_FILIAL + ZA2_NUM) == xFilial("ZA2") +;
M->ZA1_NUM
RecLock("ZA2")
dbDelete()
MsUnLock()
dbSkip()
End
// Deleta o Cabealho
dbSelectArea("ZA1")
RecLock("ZA1",.F.)
dbDelete()
MsUnLock()
Endif
Return
- 60 ADVPL Intermedirio
5.3.2.
Funo Modelo3()
A funo Modelo3) uma interface pr-definida pela Microsiga que implementa de forma
padronizada os compontes necessrios a manipulao de estruturas de dados nas quais o
cabealho e os itens da informao esto em tabelas separadas.
Seu objetivo atuar como um facilitador de codificao, permitindo a utilizao dos recursos
bsicos dos seguintes componentes visuais:
MsDialog()
Enchoice()
EnchoiceBar()
MsNewGetDados()
Parmetros:
cTitulo
cAliasE
cAliasGetD
aCposE
cLinhaOk
cTudoOk
nOpcE
nOpcG
cFieldOk
Ttulo da janela
Alias da tabela que ser utilizada na Enchoice
Alias da tabela que ser utilizada na GetDados
Nome dos campos, pertencentes ao Alias especificado o parmetro cAliasE,
que devero ser exibidos na Enchoice:
AADD(aCposE,{nome_campo})
Funo para validao da linha na GetDados()
Funo para validao na confirmao da tela de interface da Modelo2().
Opo selecionada na MBrowse, ou que deseje ser passada para controle da
Enchoice da Modelo3, aonde:
2 Visualizar
3 - Incluir
4 - Alterar
5 - Excluir
Opo selecionada na MBrowse, ou que deseje ser passada para controle da
GetDados da Modelo3, aonde:
2 Visualizar
3 - Incluir
4 - Alterar
5 - Excluir
Validao dos campos da Enchoice()
- 61 ADVPL Intermedirio
Retorno:
Lgico
#INCLUDE "protheus.ch"
//+--------------------------------------------------------------------+
//| Rotina | MBRWMOD3| Autor | ARNALDO RAYMUNDO JR. |Data | 01.01.2007 |
//+--------------------------------------------------------------------+
//| Descr. | EXEMPLO DE UTILIZACAO DA MODELO3().
|
//+--------------------------------------------------------------------+
//| Uso
| CURSO DE ADVPL
|
//+--------------------------------------------------------------------+
User Function MbrwMod3()
Private cCadastro
:= "Pedidos de Venda"
Private aRotina
:= {}
Private cDelFunc := ".T." // Validacao para a exclusao. Pode-se utilizar
ExecBlock
Private cAlias
:= "SC5"
AADD(aRotina,{
AADD(aRotina,{
AADD(aRotina,{
AADD(aRotina,{
AADD(aRotina,{
"Pesquisa","AxPesqui"
"Visual" ,"U_Mod3All"
"Inclui" ,"U_Mod3All"
"Altera" ,"U_Mod3All"
"Exclui" ,"U_Mod3All"
,0,1})
,0,2})
,0,3})
,0,4})
,0,5})
dbSelectArea(cAlias)
dbSetOrder(1)
mBrowse( 6,1,22,75,cAlias)
Return
User Function Mod3All(cAlias,nReg,nOpcx)
Local
Local
Local
Local
Local
Local
Local
Local
cTitulo :=
cAliasE :=
cAliasG :=
cLinOk :=
cTudOk :=
cFieldOk:=
aCposE :=
nUsado, nX
- 62 ADVPL Intermedirio
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
- 63 ADVPL Intermedirio
Exemplo (continuao):
If Len(aCols)>0
//
// Executa a Modelo 3
//
aCposE := {"C5_CLIENTE"}
//
If lRetMod3
Aviso("Modelo3()","Confirmada operacao!",{"Ok"})
Endif
Endif
Return
- 64 ADVPL Intermedirio
5.4. Mbrowse()
A Mbrowse() uma funcionalidade de cadastro que permite a utilizao de recursos mais
aprimorados na visualizao e manipulao das informaes do sistema, possuindo os
seguintes componentes:
Browse padro para visualizao das informaes da base de dados, de acordo com as
configuraes do SX3 Dicionrio de Dados (campo browse).
Parmetros:
nLin1
nCol1
nLin2
nCol2
cAlias
aFixe
[n][1]=>Descrio do campo
[n][2]=>Nome do campo
Arquivos de trabalho
[n][1]=>Descrio do campo
[n][2]=>Nome do campo
[n][3]=>Tipo
[n][4]=>Tamanho
[n][5]=>Decimal
[n][6]=>Picture
- 65 ADVPL Intermedirio
Parmetros:
cCpo
nPar08
Parmetro reservado.
cFun
nClickDef
aColors
cTopFun
cBotFun
nPar14
bInitBloc
lNoMnuFilter
lSeeAll
lChgAll
aRotina
cCadastro
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
nReg
nOpc
1.
2.
3.
4.
5.
6.
Pesquisar
Visualizar
Incluir
Alterar
Excluir
Livre
- 67 ADVPL Intermedirio
#include "protheus.ch"
/*/
+----------------------------------------------------------------------------| Funo
| MBRWSA1
| Autor | ARNALDO RAYMUNDO JR. | Data |
|
+----------------------------------------------------------------------------| Descrio | Exemplo de utilizao da funo MBROWSE()
|
+----------------------------------------------------------------------------| Uso
| Curso ADVPL
|
+----------------------------------------------------------------------------/*/
User Function MBrwSA1()
Local cAlias
:= "SA1"
Private cCadastro
:= "Cadastro de Clientes"
Private aRotina
:= {}
AADD(aRotina,{"Pesquisar"
,"AxPesqui" ,0,1})
AADD(aRotina,{"Visualizar"
,"AxVisual" ,0,2})
AADD(aRotina,{"Incluir" ,"U_Inclui"
,0,3})
- 68 ADVPL Intermedirio
Exemplo (continuao):
AADD(aRotina,{"Alterar" ,"AxAltera" ,0,4})
AADD(aRotina,{"Excluir" ,"AxDeleta" ,0,5})
dbSelectArea(cAlias)
dbSetOrder(1)
mBrowse(6,1,22,75,cAlias)
Return Nil
/*/
+----------------------------------------------------------------------------| 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
- 69 ADVPL Intermedirio
5.4.1.
AxFunctions()
AXPESQUI()
AXVISUAL()
AXINCLUI()
AXALTERA()
AXDELETA()
- 70 ADVPL Intermedirio
AXPESQUI()
Sintaxe
AXPESQUI()
Descrio
AXVISUAL()
Sintaxe
Descrio
AXINCLUI()
Sintaxe
Descrio
AXALTERA()
Sintaxe
Descrio
AXDELETA()
Sintaxe
Descrio
- 71 ADVPL Intermedirio
5.4.2.
FilBrowse()
Parmetros:
Alias ativo definido para a Mbrowse()
cAlias
aQuery
lShowProc
5.4.3.
EndFilBrw()
Parmetros:
cAlias
aQuery
- 72 ADVPL Intermedirio
5.4.4.
PesqBrw()
A PesqBrw() uma funcionalidade que permite a pesquisa dentro da MBrowse(). Esta funo
dever obrigatoriamente substituir a funo AxPesqui, no array do aRotina, sempre que for
utilizada a funo FilBrowse().
Parmetros:
cAlias
nReg
Nmero do registro
Bloco de Cdigo que contm a FilBrowse()
bBrwFilter
5.4.5.
BrwLegenda ()
Parmetros:
cCadastro
cTitulo
aLegenda
Ex: {{Cor,Texto}}
BR_AMARELO
BR_AZUL
BR_BRANCO
BR_CINZA
BR_LARANJA
BR_MARRON
BR_VERDE
BR_VERMELHO
BR_PINK
BR_PRETO
- 73 ADVPL Intermedirio
#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'"
Private
Private
Private
Private
cCadastro :=
aRotina
:=
aIndexSA2 :=
bFiltraBrw:=
"Cadastro de Fornecedores"
{}
{}
{ || FilBrowse(cAlias,@aIndexSA2,@cFiltra) }
AADD(aRotina,{"Pesquisar"
AADD(aRotina,{"Visualizar"
AADD(aRotina,{"Incluir"
AADD(aRotina,{"Alterar"
AADD(aRotina,{"Excluir"
AADD(aRotina,{"Legenda"
,"PesqBrw"
,"AxVisual"
,"U_BInclui"
,"U_BAltera"
,"U_BDeleta"
,"U_BLegenda"
,0,1})
,0,2})
,0,3})
,0,4})
,0,5})
,0,3})
/*
-- CORES DISPONIVEIS PARA LEGENDA -BR_AMARELO
BR_AZUL
BR_BRANCO
BR_CINZA
BR_LARANJA
BR_MARRON
BR_VERDE
BR_VERMELHO
BR_PINK
BR_PRETO
*/
AADD(aCores,{"A2_TIPO == 'F'"
AADD(aCores,{"A2_TIPO == 'J'"
AADD(aCores,{"A2_TIPO == 'X'"
AADD(aCores,{"A2_TIPO == 'R'"
AADD(aCores,{"Empty(A2_TIPO)"
,"BR_VERDE"
,"BR_AMARELO"
,"BR_LARANJA"
,"BR_MARRON"
,"BR_PRETO"
})
})
})
})
})
dbSelectArea(cAlias)
dbSetOrder(1)
- 74 ADVPL Intermedirio
Exemplo (continuao):
//+-----------------------------------------------------------//| Cria o filtro na MBrowse utilizando a funo FilBrowse
//+-----------------------------------------------------------Eval(bFiltraBrw)
dbSelectArea(cAlias)
dbGoTop()
mBrowse(6,1,22,75,cAlias,,,,,,aCores)
//+-----------------------------------------------//| Deleta o filtro utilizado na funo FilBrowse
//+-----------------------------------------------EndFilBrw(cAlias,aIndexSA2)
Return Nil
//+--------------------------------------//|Funo: BInclui - Rotina de Incluso
//+--------------------------------------User Function BInclui(cAlias,nReg,nOpc)
Local nOpcao := 0
nOpcao := AxInclui(cAlias,nReg,nOpc)
If nOpcao == 1
MsgInfo("Incluso efetuada com sucesso!")
Else
MsgInfo("Incluso cancelada!")
Endif
Return Nil
//+----------------------------------------//|Funo: BAltera - Rotina de Alterao
//+----------------------------------------User Function BAltera(cAlias,nReg,nOpc)
Local nOpcao := 0
nOpcao := AxAltera(cAlias,nReg,nOpc)
If nOpcao == 1
MsgInfo("Alterao efetuada com sucesso!")
Else
MsgInfo("Alterao cancelada!")
Endif
Return Nil
- 75 ADVPL Intermedirio
Exemplo (continuao):
//+----------------------------------------//|Funo: BDeleta - Rotina de Excluso
//+----------------------------------------User Function BDeleta(cAlias,nReg,nOpc)
Local nOpcao := 0
nOpcao := AxDeleta(cAlias,nReg,nOpc)
If nOpcao == 1
MsgInfo("Excluso efetuada com sucesso!")
Else
MsgInfo("Excluso cancelada!")
Endif
Return Nil
//+------------------------------------------//|Funo: BLegenda - Rotina de Legenda
//+------------------------------------------User Function BLegenda()
Local aLegenda := {}
AADD(aLegenda,{"BR_VERDE"
AADD(aLegenda,{"BR_AMARELO"
AADD(aLegenda,{"BR_LARANJA"
AADD(aLegenda,{"BR_MARRON"
AADD(aLegenda,{"BR_PRETO"
,"Pessoa Fsica" })
,"Pessoa Jurdica"
,"Exportao"
,"Fornecedor Rural"
,"No Classificado"
- 76 ADVPL Intermedirio
})
})
})
})
5.5. MarkBrowse()
A funo MarkBrow() permite que os elementos de um browse, sejam marcados ou
desmarcados. Para utilizao da MarkBrow() necessrio declarar as variveis cCadastro e
aRotina como Private, antes da chamada da funo.
Parmetros:
cAlias
cCampo
cCpo
aCampos
[n][1]
[n][2]
[n][3]
[n][4]
lInvert
Inverte a marcao.
cMarca
cCtrlM
uPar8
Parmetro reservado.
cExpIni
cExpFim
nome do campo;
- Nulo (Nil);
- Ttulo do campo;
- Mscara (picture).
cAval
bParBloco
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
nReg
nOpc
cMarca
lInverte
- 77 ADVPL Intermedirio
#include "protheus.ch"
/*/
+----------------------------------------------------------------------------| Programa | MkBrwSA1 | Autor | ARNALDO RAYMUNDO JR. | Data |
|
+----------------------------------------------------------------------------| Desc.
| MarkBrowse Genrico
|
+----------------------------------------------------------------------------| Uso
| Curso de ADVPL
|
+----------------------------------------------------------------------------/*/
USER FUNCTION MkBrwSA1()
Local
Local
Local
Local
aCpos
aCampos
nI
cAlias
:= {}
:= {}
:= 0
:= "SA1"
Private aRotina
:= {}
Private cCadastro
:= "Cadastro de Clientes"
Private aRecSel
:= {}
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})
AADD(aRotina,{"Visualizar Lote"
,"U_VisLote"
,0,5})
AADD(aCpos,
AADD(aCpos,
AADD(aCpos,
AADD(aCpos,
AADD(aCpos,
AADD(aCpos,
"A1_OK"
"A1_FILIAL"
"A1_COD"
"A1_LOJA"
"A1_NOME"
"A1_TIPO"
)
)
)
)
)
)
dbSelectArea("SX3")
dbSetOrder(2)
For nI := 1 To Len(aCpos)
IF dbSeek(aCpos[nI])
AADD(aCampos,{X3_CAMPO,"",IIF(nI==1,"",Trim(X3_TITULO)),;
Trim(X3_PICTURE)})
ENDIF
Next
DbSelectArea(cAlias)
DbSetOrder(1)
MarkBrow(cAlias,aCpos[1],"A1_TIPO == ' '",aCampos,.F.,GetMark(,"SA1","A1_OK"))
Return Nil
- 78 ADVPL Intermedirio
/*/
+----------------------------------------------------------------------------| 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
DbSelectArea("SA1")
DbGoTop()
While SA1->(!EOF())
// IsMark("A1_OK", cMarca, lInverte)
IF SA1->A1_OK == cMarca .AND. !lInvert
AADD(aRecSel,{SA1->(Recno()),SA1->A1_COD, SA1->A1_LOJA, SA1->A1_NREDUZ})
ELSEIF SA1->A1_OK != cMarca .AND. lInvert
AADD(aRecSel,{SA1->(Recno()),SA1->A1_COD,SA1->A1_LOJA, SA1->A1_NREDUZ})
ENDIF
SA1->(dbSkip())
Enddo
IF Len(aRecSel) > 0
cTexto := "Cdigo | Loja | Nome Reduzido
"+cEol
//
"1234567890123456789012345678901234567890
//
"CCCCCC | LL | NNNNNNNNNNNNNNNNNNNN +cEol
For nX := 1 to Len(aRecSel)
cTexto += aRecSel[nX][2]+Space(1)+ "|"+Space(2) +
aRecSel[nX][3]+Space(3)+"|"
cTexto += Space(1)+SUBSTRING(aRecSel[nX][4],1,20)+Space(1)
cTexto += cEOL
Next nX
DEFINE MSDIALOG oDlg TITLE "Clientes Selecionados" From 000,000 TO 350,400
PIXEL
@ 005,005 GET oMemo VAR cTexto MEMO SIZE 150,150 OF oDlg PIXEL
oMemo:bRClicked := {||AllwaysTrue()}
DEFINE SBUTTON FROM 005,165 TYPE 1 ACTION oDlg:End() ENABLE OF oDlg PIXEL
ACTIVATE MSDIALOG oDlg CENTER
LimpaMarca()
ENDIF
RETURN
- 79 ADVPL Intermedirio
/*/
+----------------------------------------------------------------------------| 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
- 80 ADVPL Intermedirio
CriaTrab()
A CriaTrab() uma funcionalidade que permite criar um arquivo fsico ou gerar um nome
aleatrio.
Parmetros
aCampo
lCriar
cExt
- 81 ADVPL Intermedirio
6.2.2.
dbUseArea()
A dbUseArea() uma funcionalidade que permite definir um arquivo de base de dados, com
uma rea de trabalho disponvel na aplicao.
Parmetros
lNewArea
cDriver
cName
cAlias
lShared
lReadOnly
6.2.3.
IndRegua()
A IndRegua() uma funcionalidade que permite criar ndices temporrios para o alias
especificado, podendo ou no ter um filtro.
Parmetros
cAlias
cNIndex
cExpress
xOrdem
Parmetro nulo
cFor
cMens
Parmetro nulo
lShow
- 82 ADVPL Intermedirio
#include protheus.ch
/*/
+----------------------------------------------------------------------------| Programa | GeraTrab | Autor | ROBSON LUIZ
| Data |
|
+----------------------------------------------------------------------------| Desc.
| Utilizao de arquivos e ndices temporrios
|
+----------------------------------------------------------------------------| Uso
| Curso de ADVPL
|
+----------------------------------------------------------------------------/*/
User Function GeraTrab()
Local
Local
Local
Local
Local
aStru
aArqTRB
nI
cIndTRB
cNomArq
AADD(
AADD(
AADD(
AADD(
AADD(
AADD(
AADD(
AADD(
AADD(
AADD(
AADD(
AADD(
AADD(
AADD(
AADD(
AADD(
AADD(
AADD(
AADD(
AADD(
AADD(
AADD(
AADD(
AADD(
AADD(
AADD(
AADD(
aStru,
aStru,
aStru,
aStru,
aStru,
aStru,
aStru,
aStru,
aStru,
aStru,
aStru,
aStru,
aStru,
aStru,
aStru,
aStru,
aStru,
aStru,
aStru,
aStru,
aStru,
aStru,
aStru,
aStru,
aStru,
aStru,
aStru,
:=
:=
:=
:=
:=
{
{
{
{
{
{
{
{
{
{
{
{
{
{
{
{
{
{
{
{
{
{
{
{
{
{
{
{}
{}
0
""
""
"PRODUTO"
"DESCRICAO"
"GRUPO"
"DESCGRUPO"
"TIPO"
"DESCTIPO"
"CC"
"DESC_CC"
"SERIE"
"DOCTO"
"TIPONOTA"
"EMISSAO"
"CLIENTE"
"LOJA"
"NOME"
"QTDE"
"UNIT"
"TOTAL"
"ALIQICMS"
"VALICMS"
"ALIQIPI"
"VALIPI"
"VALMERC"
"TOTSEMICMS"
"VALPIS"
"LIQUIDO"
"CUSTO"
,"B1_COD"
,"B1_DESC"
,"BM_GRUPO"
,"BM_DESC"
,"B1_TIPO"
,"B1_DESC"
,"CTT_CC"
,"CTT_DESC"
,"D2_SERIE"
,"D2_COD"
,"D2_TP"
,"D2_EMISSAO"
,"D2_CLIENTE"
,"D2_LOJA"
,"A1_NOME"
,"D2_QUANT"
,"D2_PRCVEN"
,"D2_TOTAL"
,"D2_PICM"
,"D2_VALICM"
,"D2_IPI"
,"D2_VALIPI"
,"D2_TOTAL"
,"D2_TOTAL"
,"D2_TOTAL"
,"D2_TOTAL"
,"D2_TOTAL"
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
)
)
)
)
)
)
)
)
)
)
)
)
)
)
)
)
)
)
)
)
)
)
)
)
)
)
)
dbSelectArea("SX3")
dbSetOrder(2)
For nI := 1 To Len( aStru )
dbSeek( aStru[nI,2] )
AADD( aArqTRB, { aStru[nI,1], X3_TIPO, X3_TAMANHO, X3_DECIMAL } )
Next nI
- 83 ADVPL Intermedirio
Exemplo (continuao):
// ndice que ser criado
cIndTRB := "PRODUTO+DTOS(EMISSAO)"
cNomArq := CriaTrab( aArqTRB, .T. )
dbUseArea( .T., "DBFCDX", cNomArq, "TRB", .T. ,.T. )
IndRegua( "TRB", cNomArq, cIndTRB )
dbSetOrder(1)
// ( ... ) fazer o processamento necessrio
dbSelectArea("TRB")
dbCloseArea()
If MsgYesNo("Apagar o arquivo gerado \system\"+cNomArq+".dbf ?",FunName())
Ferase(cNomArq+".dbf")
Ferase(cNomArq+OrdBagExt())
Endif
Return Nil
O array aStru foi criado com base nos campos existentes no sistema,
ao invs de criarmos novas estruturas dos campos, utilizamos as j
existentes no dicionrios de dados (SX3).
- 84 ADVPL Intermedirio
/*/
+----------------------------------------------------------------------------| Programa | IndTwoReg | Autor | MICHEL DANTAS
| Data |
|
+----------------------------------------------------------------------------| Desc.
| Utilizao de dois ndices temporrios com DBFCDX
|
+----------------------------------------------------------------------------| Uso
| Curso de ADVPL
|
+----------------------------------------------------------------------------/*/
User Function IndTwoReg()
LOCAL
LOCAL
LOCAL
LOCAL
LOCAL
nOrder
cArq1
cChave1
cArq2
cChave2
:=
:=
:=
:=
:=
0
CriaTrab(NIL,.F.)
"A1_FILIAL+A1_EST"
CriaTrab(NIL,.F.)
"A1_FILIAL+A1_NOME"
dbSelectArea("SA1")
IndRegua("SA1",cArq1,cChave1,,,"Selecionando Regs...")
IndRegua("SA1",cArq2,cChave2,,,"Selecionando Regs...")
nOrder := RetIndex("SA1")
dbSetIndex(cArq1+OrdBagExt())
dbSetIndex(cArq2+OrdBagExt())
Alert("Agora vai por estado")
dbsetOrder(nOrder+1)
dbGoTop()
While !Eof()
Alert("Estado : " + SA1->A1_EST +"
dbSkip()
End
"+" Nome
: " + SA1->A1_NOME)
"+" Nome
: " + SA1->A1_NOME)
- 85 ADVPL Intermedirio
7. Relatrios no grficos
Os relatrios desenvolvidos em ADVPL possuem um padro de desenvolvimento que mais
depende de layout e tipos de parmetros do que qualquer outro tipo de informao, visto que
at o momento percebemos que a linguagem padro da Microsiga muito mais composta de
funes genricas do que de comandos.
Este tipo de relatrio caracterizado por um formato de impresso tipo PostScript, e permite
a gerao de um arquivo em formato texto (.txt), com uma extenso prpria da aplicao ERP
(.##R).
A estrutura de um relatrio no grfico baseada no uso da funo SetPrint(), complementada
pelo uso de outras funes acessrias, as quais esto detalhadas no Guia de Referncia Rpida
que acompanha este material.
7.1.1.
Neste tpico ser demonstrada a construo de relatrio no grfico baseado no uso da funo
SetPrint() o qual atende os formatos de base de dados ISAM e Topconnect, porm no
contemplando a tecnologia Protheus Embedded SQL.
Estrutura do programa
Linhas
1
2
3
4
5
6
7
8
9
Programa
Funo principal;
Declarao e atribuio de variveis;
Atualizao do arquivo de perguntas atravs da funo especfica CriaSX1();
Definio as perguntas atravs da funo Pergunte();
Definio das ordens disponveis para impresso do relatrio;
Chamada da funo SetPrint;
Atualizao das configuraes de impresso com a funo SetDefault();
Execuo da rotina de impresso atravs da funo RptStatus()
Fim da funo principal.
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
25
26
- 86 ADVPL Intermedirio
Funo Principal
//+-----------------------------------------------------------------+
//| Rotina | Inform | Autor | Robson Luiz (rleg) | Data | 01.01.07 |
//+-----------------------------------------------------------------+
//| Descr. | Rotina para gerar relatrio utilizando as funes
|
//|
| SetPrint() e SetDefault().
|
//+-----------------------------------------------------------------+
//| Uso
| Para treinamento e capacitao.
|
//+-----------------------------------------------------------------+
User Function INFORM()
//+------------------------//| Declaraes de variveis
//+------------------------Local cDesc1
conforme"
Local cDesc2
Local cDesc3
Continuao:
- 87 ADVPL Intermedirio
VENCTO"
SALDO "
AADD(
AADD(
AADD(
AADD(
AADD(
aOrd,
aOrd,
aOrd,
aOrd,
aOrd,
"Fornecedor"
"Titulo"
"Emisso"
"Vencimento"
"Vencto. Real"
)
)
)
)
)
//+-----------------------------------------------------------------+
//| Rotina | ImpRel | Autor | Robson Luiz (rleg) | Data | 01.01.07 |
//+-----------------------------------------------------------------+
//| Descr. | Rotina de processamento e impresso.
|
//+-----------------------------------------------------------------+
//| Uso
| Para treinamento e capacitao.
|
//+-----------------------------------------------------------------+
Static Function ImpRel(lEnd)
Local
Local
Local
Local
Local
Local
Local
Local
Local
Local
Local
Local
Local
Local
Local
nIndice := 0
cArq := ""
cIndice := ""
cFiltro := ""
aCol := {}
cFornec := ""
nValor := 0
nPago := 0
nSaldo := 0
nT_Valor := 0
nT_Pago := 0
nT_Saldo := 0
cArqExcel := ""
cAliasImp
oExcelApp
Titulo += aOrd[aReturn[8]]
#IFNDEF TOP
cAliasImp := "SE2"
cFiltro
cFiltro
cFiltro
cFiltro
cFiltro
cFiltro
cFiltro
:=
+=
+=
+=
+=
+=
+=
If aReturn[8] == 1 //Fornecedor
cIndice := "E2_FORNECE+E2_LOJA+E2_NUM"
Elseif aReturn[8] == 2 //Titulo
cIndice := "E2_NUM+E2_FORNECE+E2_LOJA"
Elseif aReturn[8] == 3 //Emissao
Continuao:
- 89 ADVPL Intermedirio
cIndice := "Dtos(E2_EMISSAO)+E2_FORNECE+E2_LOJA"
Elseif aReturn[8] == 4 //Vencimento
cIndice := "Dtos(E2_VENCTO)+E2_FORNECE+E2_LOJA"
Elseif aReturn[8] == 5 //Vencimento Real
cIndice := "Dtos(E2_VENCREA)+E2_FORNECE+E2_LOJA"
Endif
cArq := CriaTrab(NIL,.F.)
dbSelectArea(cAliasImp)
IndRegua(cAliasImp,cArq,cIndice,,cFiltro)
nIndice := RetIndex()
nIndice := nIndice + 1
dbSetIndex(cArq+OrdBagExt())
dbSetOrder(nIndice)
#ELSE
cAliasImp := GetNextAlias()
cQuery := "SELECT "
cQuery += "E2_PREFIXO, E2_NUM, E2_PARCELA, E2_TIPO, E2_FORNECE, E2_LOJA,
E2_NOMFOR, "
cQuery += "E2_EMISSAO, E2_VENCTO, E2_VENCREA, E2_VALOR, E2_SALDO "
cQuery += "FROM "+RetSqlName("SE2")+" "
cQuery += "WHERE E2_FILIAL = '"+xFilial("SE2")+"' "
cQuery += "AND E2_FORNECE >= '"+mv_par01+"' "
cQuery += "AND E2_FORNECE <= '"+mv_par02+"' "
cQuery += "AND E2_TIPO >= '"+mv_par03+"' "
cQuery += "AND E2_TIPO <= '"+mv_par04+"' "
cQuery += "AND E2_VENCTO >= '"+Dtos(mv_par05)+"' "
cQuery += "AND E2_VENCTO <= '"+Dtos(mv_par06)+"' "
cQuery += "AND D_E_L_E_T_ <> '*' "
cQuery += "ORDER BY "
If aReturn[8] == 1 //Fornecedor
cQuery += "E2_FORNECE,E2_LOJA,E2_NUM"
Elseif aReturn[8] == 2 //Titulo
cQuery += "E2_NUM,E2_FORNECE,E2_LOJA"
Elseif aReturn[8] == 3 //Emissao
cQuery += "E2_EMISSAO,E2_FORNECE,E2_LOJA"
Elseif aReturn[8] == 4 //Vencimento
cQuery += "E2_VENCTO,E2_FORNECE,E2_LOJA"
Elseif aReturn[8] == 5 //Vencimento Real
cQuery += "E2_VENCREA,E2_FORNECE,E2_LOJA"
Endif
dbUseArea( .T., "TOPCONN", TcGenQry(,,cQuery), cAliasImp, .T., .F. )
dbSelectArea(cAliasImp)
/* Instruo SQL Embedded
---------------------If aReturn[8] == 1 //Fornecedor
cOrder := "E2_FORNECE,E2_LOJA,E2_NUM"
Elseif aReturn[8] == 2 //Titulo
cOrder := "E2_NUM,E2_FORNECE,E2_LOJA"
Elseif aReturn[8] == 3 //Emissao
cOrder := "E2_EMISSAO,E2_FORNECE,E2_LOJA"
Elseif aReturn[8] == 4 //Vencimento
cOrder := "E2_VENCTO,E2_FORNECE,E2_LOJA"
Continuao:
- 90 ADVPL Intermedirio
Date
Date
Date
Numeric(12)
Numeric(12)
SELECT
E2_PREFIXO, E2_NUM, E2_PARCELA, E2_TIPO, E2_FORNECE,
E2_LOJA, E2_NOMFOR, E2_EMISSAO, E2_VENCTO, E2_VENCREA, E2_VALOR,
E2_SALDO
FROM
%Table:SE2
WHERE
E2_FILIAL = %xFilial% AND
E2_FORNECE BETWEEN %Exp:mv_par01% AND %Exp:mv_par02% AND
E2_TIPO BETWEEN%Exp:mv_par03% AND %Exp:mv_par04% AND
E2_VENCTO BETWEEN %Exp:mv_par05% AND %Exp:mv_par06% AND
%NotDel%
ORDER BY %Order:cOrder%
EndSQL
*/
#ENDIF
dbGoTop()
SetRegua(0)
//+-------------------//| Coluna de impresso
//+-------------------AADD( aCol, 004 ) //Prefixo
AADD( aCol, 012 ) //Titulo
AADD( aCol, 024 ) //Parcela
AADD( aCol, 031 ) //Tipo
AADD( aCol, 036 ) //Emissao
AADD( aCol, 046 ) //Vencimento
AADD( aCol, 058 ) //Vencimento Real
AADD( aCol, 070 ) //Valor Original
AADD( aCol, 090 ) //Pago
AADD( aCol, 110 ) //Saldo
cFornec := (cAliasImp)->E2_FORNECE+(cAliasImp)->E2_LOJA
While !Eof() .And. !lEnd
If Li > 55
Cabec(Titulo,Cabec1,Cabec2,NomeProg,Tamanho,nTipo)
Endif
Continuao:
- 91 ADVPL Intermedirio
:=
:=
:=
:=
Replicate("-",Limite)
PSay
PSay
PSay
PSay
"TOTAL....."
nValor PICTURE "@E 99,999,999,999.99"
nPago PICTURE "@E 99,999,999,999.99"
nSaldo PICTURE "@E 99,999,999,999.99"
(cAliasImp)->E2_FORNECE+(cAliasImp)->E2_LOJA
0
0
0
End
Continuao:
- 92 ADVPL Intermedirio
If lEnd
@ Li, aCol[1] PSay cCancel
Return
Endif
@ Li,
Li ++
@ Li,
@ Li,
@ Li,
@ Li,
PSay
PSay
PSay
PSay
"TOTAL GERAL....."
nT_Valor PICTURE "@E 99,999,999,999.99"
nT_Pago PICTURE "@E 99,999,999,999.99"
nT_Saldo PICTURE "@E 99,999,999,999.99"
If Li <> 80
Roda(cbCont,cbTxt,Tamanho)
Endif
//+---------------------------------------------------------------------//| Gera arquivo do tipo .DBF com extenso .XLS p/ usurio abrir no Excel
//+---------------------------------------------------------------------cArqExcel := __RELDIR+NomeProg+"_"+Substr(cUsuario,7,4)+".XLS"
Copy To &cArqExcel
#IFNDEF TOP
dbSelectArea(cAliasImp)
RetIndex(cAliasImp)
Set Filter To
#ELSE
dbSelectArea(cAliasImp)
dbCloseArea()
#ENDIF
dbSetOrder(1)
dbGoTop()
If aReturn[5] == 1
Set Printer TO
dbCommitAll()
OurSpool(wnrel)
EndIf
//+-----------------------//| Abrir planilha MS-Excel
//+-----------------------If mv_par08 == 1
__CopyFile(cArqExcel,"c:\"+NomeProg+"_"+Substr(cUsuario,7,4)+".XLS")
If ! ApOleClient("MsExcel")
MsgAlert("MsExcel no instalado")
Return
Endif
oExcelApp := MsExcel():New()
oExcelApp:WorkBooks:Open( "c:\"+NomeProg+"_"+Substr(cUsuario,7,4)+".XLS" )
oExcelApp:SetVisible(.T.)
Endif
Ms_Flush()
Return
- 93 ADVPL Intermedirio
//+-----------------------------------------------------------------+
//| Rotina | CriaSX1 | Autor | Robson Luiz (rleg)| Data | 01.01.07 |
//+-----------------------------------------------------------------+
//| Descr. | Rotina para criar o grupo de parmetros.
|
//+-----------------------------------------------------------------+
//| Uso
| Para treinamento e capacitao.
|
//+-----------------------------------------------------------------+
Static Function CriaSx1()
Local aP := {}
Local i := 0
Local cSeq
Local cMvCh
Local cMvPar
Local aHelp := {}
/******
Parmetros da funo padro
--------------------------PutSX1(cGrupo,;cOrdem,;
cPergunt,cPerSpa,cPerEng,;
cVar,;
cTipo,;
nTamanho,;
nDecimal,;
nPresel,;
cGSC,;
cValid,;
cF3,;
cGrpSxg,;
cPyme,;
cVar01,;
cDef01,cDefSpa1,cDefEng1,;
cCnt01,;
cDef02,cDefSpa2,cDefEng2,;
cDef03,cDefSpa3,cDefEng3,;
cDef04,cDefSpa4,cDefEng4,;
cDef05,cDefSpa5,cDefEng5,;
aHelpPor,aHelpEng,aHelpSpa,;
cHelp)
Caracterstica do vetor p/ utilizao da funo SX1
--------------------------------------------------[n,1] --> texto da pergunta
[n,2] --> tipo do dado
[n,3] --> tamanho
[n,4] --> decimal
[n,5] --> objeto G=get ou C=choice
[n,6] --> validao
[n,7] --> F3
[n,8] --> definio 1
[n,9] --> definio 2
[n,10] -> definio 3
[n,11] -> definio 4
[n,12] -> definio 5
***/
- 94 ADVPL Intermedirio
Continuao:
AADD(aP,{"Fornecedor de","C",6,0,"G","","SA2",""
,""
,"","",""})
AADD(aP,{"Fornecedor ate","C",6,0,"G","(mv_par02>=mv_par01)","SA2",;
""
,""
,"","",""})
AADD(aP,{"Tipo de","C",3,0,"G","","05" ,""
,""
,"","",""})
AADD(aP,{"Tipo ate","C",3,0,"G","(mv_par04>=mv_par03)","05" ,""
,;
""
,"","",""})
AADD(aP,{"Vencimento de","D",8,0,"G","",""
,""
,""
,"","",""})
AADD(aP,{"Vencimento ate","D",8,0,"G","(mv_par06>=mv_par05)",""
,;
""
,""
,"","",""})
AADD(aP,{"Aglutinar pagto.de fornec.","N",1,0,"C","","",;
"Sim","No","","",""})
AADD(aP,{"Abrir planilha MS-Excel"
,"N",1,0,"C","","",;
"Sim","No","","",""})
AADD(aHelp,{"Informe o cdigo do fornecedor.","inicial."})
AADD(aHelp,{"Informe o cdigo do fornecedor.","final."})
AADD(aHelp,{"Tipo de ttulo inicial."})
AADD(aHelp,{"Tipo de ttulo final."})
AADD(aHelp,{"Digite a data do vencimento inicial."})
AADD(aHelp,{"Digite a data do vencimento final."})
AADD(aHelp,{"Aglutinar os ttulos do mesmo forne-",;
"cedor totalizando seus valores."})
AADD(aHelp,{"Ser gerada uma planilha para ",;
"MS-Excel, abrir esta planilha?"})
For i:=1 To Len(aP)
cSeq
:= StrZero(i,2,0)
cMvPar := "mv_par"+cSeq
cMvCh := "mv_ch"+IIF(i<=9,Chr(i+48),Chr(i+87))
PutSx1(cPerg,;
cSeq,;
aP[i,1],aP[i,1],aP[i,1],;
cMvCh,;
aP[i,2],;
aP[i,3],;
aP[i,4],;
0,;
aP[i,5],;
aP[i,6],;
aP[i,7],;
"",;
"",;
cMvPar,;
aP[i,8],aP[i,8],aP[i,8],;
"",;
aP[i,9],aP[i,9],aP[i,9],;
aP[i,10],aP[i,10],aP[i,10],;
aP[i,11],aP[i,11],aP[i,11],;
aP[i,12],aP[i,12],aP[i,12],;
aHelp[i],;
{},;
{},;
"")
Next i
Return
- 95 ADVPL Intermedirio
8. Manipulao de arquivos I
8.1. Gerao e leitura de arquivos em formato texto
Arquivos do tipo texto (tambm conhecidos como padro TXT) so arquivos com registros de
tamanho varivel. A indicao do final de cada registro representada por dois bytes, 0D
0A em hexadecimal ou 13 10 em decimal ou, ainda, CR LF para padro ASCII.
Apesar do tamanho dos registros ser varivel, a maioria dos sistemas gera este tipo de arquivo
com registros de tamanho fixo, de acordo com um layout especfico que indica quais
so os dados gravados.
Para ilustrar estes procedimentos, sero gerados arquivos textos, com duas famlias de
funes:
1) Famlia: nesta famlia sero utilizadas as funes: FCreate(),
FSeek(), FOpen() e FRead().
FWrite(),
FClose(),
- 96 ADVPL Intermedirio
#include "protheus.ch"
/*/
+----------------------------------------------------------------------------| Programa | GeraTXT
| Autor | SERGIO FUZINAKA | Data |
|
+----------------------------------------------------------------------------| Descrio | Gera o arquivo TXT, a partir do Cadastro de Clientes
|
+----------------------------------------------------------------------------| Uso
| Curso ADVPL
|
+----------------------------------------------------------------------------/*/
User Function GeraTXT()
//+--------------------------------+
//| Declarao de Variveis
|
//+--------------------------------+
Local oGeraTxt
Private cPerg
:= "EXPSA1"
Private cAlias
:= "SA1"
//CriaSx1(cPerg)
//Pergunte(cPerg,.F.)
dbSelectArea(cAlias)
dbSetOrder(1)
//+-----------------------------------+
//| Montagem da tela de processamento.|
//+-----------------------------------+
DEFINE MSDIALOG oGeraTxt TITLE OemToAnsi("Gerao de Arquivo Texto") ;
FROM 000,000 TO 200,400 PIXEL
@ 005,005 TO 095,195 OF oGeraTxt PIXEL
@ 010,020 Say " Este programa ira gerar um arquivo texto, conforme os parame- ";
OF oGeraTxt PIXEL
@ 018,020 Say " tros definidos pelo usurio, com os registros do arquivo de ";
OF oGeraTxt PIXEL
@ 026,020 Say " SA1 " OF oGeraTxt PIXEL
DEFINE SBUTTON FROM 070, 030 TYPE 1 ;
ACTION (OkGeraTxt(),oGeraTxt:End()) ENABLE OF oGeraTxt
DEFINE SBUTTON FROM 070, 070 TYPE 2 ;
ACTION (oGeraTxt:End()) ENABLE OF oGeraTxt
DEFINE SBUTTON FROM 070, 110 TYPE 5 ;
ACTION (Pergunte(cPerg,.T.)) ENABLE OF oGeraTxt
ACTIVATE DIALOG oGeraTxt CENTERED
Return Nil
- 97 ADVPL Intermedirio
Exemplo (continuao):
/*/
+----------------------------------------------------------------------------| Funo
| OKGERATXT | Autor | SERGIO FUZINAKA | Data |
|
+----------------------------------------------------------------------------| Descrio | Funo chamada pelo boto OK na tela inicial de processamento. |
|
| Executa a gerao do arquivo texto.
|
+----------------------------------------------------------------------------/*/
Static Function OkGeraTxt
//+----------------------------------------------------------------------------//| Cria o arquivo texto
//+----------------------------------------------------------------------------Private cArqTxt := "\SYSTEM\EXPSA1.TXT"
Private nHdl
:= fCreate(cArqTxt)
If nHdl == -1
MsgAlert("O arquivo de nome "+cArqTxt+" no pode ser executado! Verifique os
parmetros.","Ateno!")
Return
Endif
// Inicializa a rgua de processamento
Processa({|| RunCont() },"Processando...")
Return Nil
/*/
+----------------------------------------------------------------------------| Funo
| RUNCONT | Autor | SERGIO FUZINAKA | Data |
|
+----------------------------------------------------------------------------| Descrio | Funo auxiliar chamada pela PROCESSA. A funo PROCESSA
|
|
| monta a janela com a rgua de processamento.
|
+----------------------------------------------------------------------------/*/
Static Function RunCont
Local cLin
dbSelectArea(cAlias)
dbGoTop()
ProcRegua(RecCount()) // Numero de registros a processar
While (cAlias)->(!EOF())
//Incrementa a rgua
IncProc()
cLin := (cAlias)->A1_FILIAL
cLin += (cAlias)->A1_COD
cLin += (cAlias)->A1_LOJA
cLin += (cAlias)->A1_NREDUZ
cLin += STRZERO((cAlias)->A1_MCOMPRA*100,16) // 14,2
cLin += DTOS((cAlias)->A1_ULTCOM)//AAAAMMDD
cLin += CRLF
- 98 ADVPL Intermedirio
Exemplo (continuao):
//+-------------------------------------------------------------------+
//| Gravao no arquivo texto. Testa por erros durante a gravao da |
//| linha montada.
|
//+-------------------------------------------------------------------+
If fWrite(nHdl,cLin,Len(cLin)) != Len(cLin)
If !MsgAlert("Ocorreu um erro na gravao do arquivo."+;
"Continua?","Ateno!")
Exit
Endif
Endif
(cAlias)->(dbSkip())
EndDo
// O arquivo texto deve ser fechado, bem como o dialogo criado na funo
anterior
fClose(nHdl)
Return Nil
Note que para a gerao do arquivo TXT foram utilizadas, basicamente, as funes
FCreate, FWrite e FClose que, respectivamente, gera o arquivo, adiciona dados e fecha
o arquivo.
No exemplo, o formato estabelecido pela concatenao dos dados na
varivel cLin a qual utilizada na gravao dos dados. Para a leitura de dados TXT sero
utilizada as funes FOpen e FRead.
Exemplo: Leitura de arquivo TXT, utilizando a primeira famlia de funes
#Include "protheus.ch"
/*/
+----------------------------------------------------------------------| Programa | LeTXT
| Autor | SERGIO FUZINAKA | Data |
|
+----------------------------------------------------------------------| Descrio | Leitura de arquivo TXT
|
+----------------------------------------------------------------------| Uso
| Curso ADVPL
|
+----------------------------------------------------------------------/*/
User Function LeTXT()
//+-------------------------------------------------------------------+
//| Declarao de Variveis
|
//+-------------------------------------------------------------------+
Local cPerg := "IMPSA1"
Local oLeTxt
Private cAlias := "SA1"
//CriaSx1(cPerg)
//Pergunte(cPerg,.F.)
- 99 ADVPL Intermedirio
Exemplo (continuao):
dbSelectArea(cAlias)
dbSetOrder(1)
//+-------------------------------------------------------------------+
// Montagem da tela de processamento
|
//+-------------------------------------------------------------------+
DEFINE MSDIALOG oLeTxt TITLE OemToAnsi("Leitura de Arquivo Texto");
FROM 000,000 TO 200,400 PIXEL
@ 005,005 TO 095,195 OF oLeTxt PIXEL
@ 10,020 Say " Este programa ira ler o contedo de um arquivo texto, conforme";
OF oLeTxt PIXEL
@ 18,020 Say " os parmetros definidos pelo usurio, com os registros do
arquivo";
OF oLeTxt PIXEL
@ 26,020 Say " SA1" OF oLeTxt PIXEL
DEFINE SBUTTON FROM 070, 030 TYPE 1 ;
ACTION (OkLeTxt(),oLeTxt:End()) ENABLE OF oLeTxt
DEFINE SBUTTON FROM 070, 070 TYPE 2 ;
ACTION (oLeTxt:End()) ENABLE OF oLeTxt
DEFINE SBUTTON FROM 070, 110 TYPE 5 ;
ACTION (Pergunte(cPerg,.T.)) ENABLE OF oLeTxt
ACTIVATE DIALOG oLeTxt CENTERED
Return Nil
/*/
+----------------------------------------------------------------------------| Funo
| OKLETXT
| Autor | SERGIO FUZINAKA | Data |
|
+----------------------------------------------------------------------------| Descrio | Funo chamada pelo boto OK na tela inicial de processamento |
|
| Executa a leitura do arquivo texto
|
+----------------------------------------------------------------------------/*/
Static Function OkLeTxt()
//+-------------------------------------------------------------------+
//| Abertura do arquivo texto
|
//+-------------------------------------------------------------------+
Private cArqTxt := "\SYSTEM\EXPSA1.TXT"
Private nHdl
:= fOpen(cArqTxt,68)
If nHdl == -1
MsgAlert("O arquivo de nome "+cArqTxt+" no pode ser aberto! Verifique os
parmetros.","Ateno!")
Return
Endif
// Inicializa a rgua de processamento
Processa({|| RunCont() },"Processando...")
Return Nil
Exemplo (continuao):
/*/
+----------------------------------------------------------------------------| Funo
| RUNCONT
| Autor | SERGIO FUZINAKA | Data |
|
+----------------------------------------------------------------------------| Descrio | Funo auxiliar chamada pela PROCESSA. A funo PROCESSA
|
|
| monta a janela com a rgua de processamento.
|
+----------------------------------------------------------------------------/*/
Static Function RunCont
Local
Local
Local
Local
Local
Local
Local
nTamFile
nTamLin
cBuffer
nBtLidos
cFilSA1
cCodSA1
cLojaSA1
:= 0
:= 56
:= ""
:= 0
:= ""
:= ""
:= ""
//1234567890123456789012345678901234567890123456789012345678901234567890
//00000000010000000002000000000300000000040000000005000000000600000000070
//FFCCCCCCLLNNNNNNNNNNNNNNNNNNNNVVVVVVVVVVVVVVVVDDDDDDDD
//A1_FILIAL
- 01, 02 - TAM: 02
//A1_COD
- 03, 08 - TAM: 06
//A1_LOJA
- 09, 10 - TAM: 02
//A1_NREDUZ - 11, 30 - TAM: 20
//A1_MCOMPRA
- 31, 46 - TAM: 14,2
//A1_ULTCOM - 47, 54 - TAM: 08
nTamFile := fSeek(nHdl,0,2)
fSeek(nHdl,0,0)
cBuffer := Space(nTamLin) // Varivel para criao da linha do registro para
leitura
ProcRegua(nTamFile) // Numero de registros a processar
While nBtLidos < nTamFile
//Incrementa a rgua
IncProc()
// Leitura da primeira linha do arquivo texto
nBtLidos += fRead(nHdl,@cBuffer,nTamLin)
cFilSA1
cCodSA1
cLojaSA1
While .T.
IF dbSeek(cFilSA1+cCodSA1+cLojaSA1)
cCodSA1 := SOMA1(cCodSA1)
Loop
Else
Exit
Endif
Enddo
Exemplo (continuao):
dbSelectArea(cAlias)
RecLock(cAlias,.T.)
(cAlias)->A1_FILIAL
(cAlias)->A1_COD
(cAlias)->A1_LOJA
(cAlias)->A1_NREDUZ
//- 11, 30 - TAM: 20
(cAlias)->A1_MCOMPRA
//- 31, 46 - TAM: 14,2
(cAlias)->A1_ULTCOM
//- 47, 54 - TAM: 08
MSUnLock()
:=
:=
:=
:=
:= Val(Substr(cBuffer,31,16))/100
:= STOD(Substr(cBuffer,47,08))
EndDo
// O arquivo texto deve ser fechado, bem como o dialogo criado na funo
anterior.
fClose(nHdl)
Return Nil
#Include "Protheus.ch"
/*/
+----------------------------------------------------------------------------| Programa | LeArqTXT | Autor | Robson Luiz
| Data |
|
+----------------------------------------------------------------------------| Descrio | Leitura de arquivo TXT
|
+----------------------------------------------------------------------------| Uso
| Curso ADVPL
|
+----------------------------------------------------------------------------/*/
User Function LeArqTxt()
Private
Private
Private
Private
nOpc
cCadastro
aSay
aButton
:=
:=
:=
:=
0
"Ler arquivo texto"
{}
{}
AADD( aSay, "O objetivo desta rotina e efetuar a leitura em um arquivo texto" )
AADD( aButton, { 1,.T.,{|| nOpc := 1,FechaBatch()}})
AADD( aButton, { 2,.T.,{|| FechaBatch() }} )
FormBatch( cCadastro, aSay, aButton )
If nOpc == 1
Processa( {|| Import() }, "Processando..." )
Endif
Return Nil
- 102 ADVPL Intermedirio
Exemplo (continuao):
//+------------------------------------------//| Funo - Import()
//+------------------------------------------Static Function Import()
Local
Local
Local
Local
cBuffer
cFileOpen
cTitulo1
cExtens
:=
:=
:=
:=
""
""
"Selecione o arquivo"
"Arquivo TXT | *.txt"
/***
* _________________________________________________________
* cGetFile(<ExpC1>,<ExpC2>,<ExpN1>,<ExpC3>,<ExpL1>,<ExpN2>)
*
* <ExpC1> - Expresso de filtro
* <ExpC2> - Titulo da janela
* <ExpN1> - Numero de mascara default 1 para *.Exe
* <ExpC3> - Diretrio inicial se necessrio
* <ExpL1> - .F. boto salvar - .T. boto abrir
* <ExpN2> - Mascara de bits para escolher as opes de visualizao do objeto
* (prconst.ch)
*/
cFileOpen := cGetFile(cExtens,cTitulo1,,cMainPath,.T.)
If !File(cFileOpen)
MsgAlert("Arquivo texto: "+cFileOpen+" no localizado",cCadastro)
Return
Endif
FT_FUSE(cFileOpen) //ABRIR
FT_FGOTOP() //PONTO NO TOPO
ProcRegua(FT_FLASTREC()) //QTOS REGISTROS LER
While !FT_FEOF()
IncProc()
// Capturar dados
cBuffer := FT_FREADLN() //LENDO LINHA
cMsg
cMsg
cMsg
cMsg
cMsg
cMsg
:=
+=
+=
+=
+=
+=
"Filial: "
+SubStr(cBuffer,01,02) +
"Cdigo: "
+SubStr(cBuffer,03,06) +
"Loja: "
+SubStr(cBuffer,09,02) +
"Nome fantasia: " +SubStr(cBuffer,11,15) +
"Valor: "
+SubStr(cBuffer,26,14) +
"Data: "
+SubStr(cBuffer,40,08) +
MsgInfo(cMsg)
FT_FSKIP()
EndDo
Chr(13)+Chr(10)
Chr(13)+Chr(10)
Chr(13)+Chr(10)
Chr(13)+Chr(10)
Chr(13)+Chr(10)
Chr(13)+Chr(10)
9. Oficina de programao I
9.1. Interfaces com sintaxe clssica
A sintaxe convencional para definio de componentes visuais da linguagem ADVPL depende
diretamente no include especificado no cabealho do fonte. Os dois includes disponveis para o
ambiente ADVPL Protheus so:
RWMAKE.CH: permite a utilizao da sintaxe CLIPPER na definio dos componentes
visuais.
PROTHEUS.CH: permite a utilizao da sintaxe ADVPL convencional, a qual um
aprimoramento da sintaxe CLIPPER, com a incluso de novos atributos para os
componentes visuais disponibilizados no ERP Protheus.
Para ilustrar a diferena na utilizao destes dois includes, segue abaixo as diferentes
definies para o componentes Dialog e MsDialog:
Exemplo 01 Include Rwmake.ch
#include rwmake.ch
@ 0,0 TO 400,600 DIALOG oDlg TITLE "Janela em sintaxe Clipper"
ACTIVATE DIALOG oDlg CENTERED
Os componentes da interface visual que sero tratados neste tpico, utilizando a sintaxe
clssica da linguagem ADVPL so:
BUTTON()
CHECKBOX()
COMBOBOX()
FOLDER()
MSDIALOG()
MSGET()
- 104 ADVPL Intermedirio
RADIO()
SAY()
SBUTTON()
BUTTON()
Sintaxe
Descrio
CHECKBOX()
Sintaxe
Descrio
COMBOBOX()
Sintaxe
Descrio
FOLDER()
Sintaxe
Descrio
MSDIALOG()
Sintaxe
Descrio
MSGET()
Sintaxe
Descrio
RADIO()
Sintaxe
Descrio
SAY()
Sintaxe
Descrio
SBUTTON()
Sintaxe
Descrio
RPTSTATUS()
PROCESSA()
MSNEWPROCESS()
MSAGUARDE()
MSGRUN()
9.2.1.
RptStatus()
Retorno: Nil
Parmetros:
bAcao
cMensagem
Aparncia
/*/
+--------------------------------------------------------------------------| Funo
| GRPTSTATUS | Autor | ROBSON LUIZ
| Data |
|
+--------------------------------------------------------------------------| Descrio | Programa que demonstra a utilizao das funes RPTSTATUS() |
|
| SETREGUA() E INCREGUA()
|
+--------------------------------------------------------------------------| Uso
| Curso ADVPL
|
+--------------------------------------------------------------------------/*/
User Function
Local aSay
Local aButton
Local nOpc
Local cTitulo
Local cDesc1
conjunto"
Local cDesc2
GRptStatus()
:= {}
:= {}
:= 0
:= "Exemplo de Funes"
:= "Este programa exemplifica a utilizao da funo Processa() em
:= "com as funes de incremento ProcRegua() e IncProc()"
/*/
+----------------------------------------------------------------------------| Funo
| RUNPROC
| Autor | ROBSON LUIZ
| Data |
|
+----------------------------------------------------------------------------| Descrio | Funo de processamento executada atravs da
RPTSTATUS()
|
+----------------------------------------------------------------------------| Uso
| Curso ADVPL
|
+----------------------------------------------------------------------------/*/
Static Function RunProc(lEnd)
Local nCnt := 0
dbSelectArea("SX5")
dbSetOrder(1)
dbSeek(xFilial("SX5")+mv_par01,.T.)
While !Eof() .And. X5_FILIAL == xFilial("SX5") .And. X5_TABELA <= mv_par02
nCnt++
dbSkip()
End
dbSeek(xFilial("SX5")+mv_par01,.T.)
SetRegua(nCnt)
While !Eof() .And. X5_FILIAL == xFilial("SX5") .And. X5_TABELA <= mv_par02
IncRegua()
If lEnd
MsgInfo(cCancel,"Fim")
Exit
Endif
dbSkip()
End
Return .T.
SETREGUA()
A funo SetRegua() utilizada para definir o valor mximo da rgua de progresso criada
atravs da funo RptStatus().
Sintaxe: SetRegua(nMaxProc)
Parmetros:
nMaxProc
Retorno:
Nenhum
Exemplo:
...
dbSelectArea("SA1")
dbGoTop()
SetRegua(LastRec())
While !Eof()
IncRegua()
If Li > 60
...
INCREGUA()
A funo IncRegua() utilizada para incrementar valor na rgua de progresso criada atravs
da funo RptStatus()
Sintaxe: IncRegua(cMensagem)
Parmetros:
cMensagem
Retorno:
Nenhum
Exemplo:
...
dbSelectArea("SA1")
dbGoTop()
SetRegua(LastRec())
While !Eof()
IncRegua(Avaliando cliente:+SA1->A1_COD)
If Li > 60
...
9.2.2.
Processa()
Retorno: Nil
Parmetros:
bAcao
cMensagem
Aparncia
/*/
+----------------------------------------------------------------------------| Funo
| GPROCES1
| Autor | ROBSON LUIZ
| Data |
|
+----------------------------------------------------------------------------| Descrio | Programa que demonstra a utilizao das funes PROCESSA()
|
|
| PROCREGUA() E INCPROC()
|
+----------------------------------------------------------------------------| Uso
| Curso ADVPL
|
+----------------------------------------------------------------------------/*/
User Function
Local aSay
Local aButton
Local nOpc
Local cTitulo
Local cDesc1
Local cDesc2
Local cDesc3
GProces1()
:= {}
:= {}
:= 0
:= "Exemplo de Funes"
:= "Este programa exemplifica a utilizao da funo Processa()"
:= " em conjunto com as funes de incremento ProcRegua() e"
:= " IncProc()"
Exemplo (continuao):
Private cPerg := "PROCES"
CriaSX1()
Pergunte(cPerg,.F.)
AADD( aSay, cDesc1 )
AADD( aSay, cDesc2 )
AADD( aButton, { 5, .T., {|| Pergunte(cPerg,.T. )
}} )
AADD( aButton, { 1, .T., {|| nOpc := 1, FechaBatch() }} )
AADD( aButton, { 2, .T., {|| FechaBatch()
}} )
FormBatch( cTitulo, aSay, aButton )
If nOpc <> 1
Return Nil
Endif
Processa( {|lEnd| RunProc(@lEnd)}, "Aguarde...","Executando rotina.", .T. )
Return Nil
/*/
+----------------------------------------------------------------------------| Funo
| RUNPROC
| Autor | ROBSON LUIZ
| Data |
|
+----------------------------------------------------------------------------| Descrio | Funo de processamento executada atravs da
PROCRSSA()
|
+----------------------------------------------------------------------------| Uso
| Curso ADVPL
|
+----------------------------------------------------------------------------/*/
Static Function RunProc(lEnd)
Local nCnt := 0
dbSelectArea("SX5")
dbSetOrder(1)
dbSeek(xFilial("SX5")+mv_par01,.T.)
dbEval( {|x| nCnt++ },,{||X5_FILIAL==xFilial("SX5").And.X5_TABELA<=mv_par02})
dbSeek(xFilial("SX5")+mv_par01,.T.)
ProcRegua(nCnt)
While !Eof() .And. X5_FILIAL == xFilial("SX5") .And. X5_TABELA <= mv_par02
IncProc("Processando tabela: "+SX5->X5_CHAVE)
If lEnd
MsgInfo(cCancela,"Fim")
Exit
Endif
dbSkip()
End
Return .T.
SETPROC()
A funo SetProc() utilizada para definir o valor mximo da rgua de progresso criada
atravs da funo Processa().
Sintaxe: Processa(nMaxProc)
Parmetros:
nMaxProc
Retorno:
Nenhum
Exemplo:
...
dbSelectArea("SA1")
dbGoTop()
SetProc(LastRec())
While !Eof()
IncProc()
If Li > 60
...
INCPROC()
A funo IncProc() utilizada para incrementar valor na rgua de progresso criada atravs da
funo Processa()
Sintaxe: IncProc(cMensagem)
Parmetros:
cMensagem
Retorno:
Nenhum
Exemplo:
...
dbSelectArea("SA1")
dbGoTop()
SetProc(LastRec())
While !Eof()
IncProc(Avaliando cliente:+SA1->A1_COD)
If Li > 60
...
9.2.3.
MsNewProcess().
Parmetros:
bAcao
cMensagem
Aparncia
Mtodos:
Activate()
SetRegua1()
IncRegua1()
SetRegua2()
IncRegua2()
/*/
+----------------------------------------------------------------------------| Funo
| GPROCES2
| Autor | ROBSON LUIZ
| Data |
|
+----------------------------------------------------------------------------| Descrio | Programa que demonstra a utilizao do objeto MsNewProcess()
|
|
| e seus mtodos IncReguaX() e SetReguaX()
|
+----------------------------------------------------------------------------| Uso
| Curso ADVPL
|
+----------------------------------------------------------------------------/*/
User Function GProces2()
Private oProcess := NIL
oProcess := MsNewProcess():New({|lEnd| RunProc(lEnd,oProcess)};
"Processando","Lendo...",.T.)
oProcess:Activate()
Return Nil
/*/
+----------------------------------------------------------------------------| Funo
| RUNPROC
| Autor | ROBSON LUIZ
| Data |
|
+----------------------------------------------------------------------------| Descrio | Funo de processamento executada atravs da MsNewProcess()
|
+----------------------------------------------------------------------------| Uso
| Curso ADVPL
|
+----------------------------------------------------------------------------/*/
Static Function RunProc(lEnd,oObj)
Local i := 0
Local aTabela := {}
Local nCnt := 0
aTabela := {{"00",0},{"13",0},{"35",0},{"T3",0}}
dbSelectArea("SX5")
cFilialSX5 := xFilial("SX5")
dbSetOrder(1)
For i:=1 To Len(aTabela)
dbSeek(cFilialSX5+aTabela[i,1])
While !Eof() .And. X5_FILIAL+X5_TABELA == cFilialSX5+aTabela[i,1]
If lEnd
Exit
Endif
nCnt++
dbSkip()
End
aTabela[i,2] := nCnt
nCnt := 0
Next i
Exemplo (continuao):
oObj:SetRegua1(Len(aTabela))
For i:=1 To Len(aTabela)
If lEnd
Exit
Endif
oObj:IncRegua1("Lendo Tabela: "+aTabela[i,1])
dbSelectArea("SX5")
dbSeek(cFilialSX5+aTabela[i,1])
oObj:SetRegua2(aTabela[i,2])
While !Eof() .And. X5_FILIAL+X5_TABELA == cFilialSX5+aTabela[i,1]
oObj:IncRegua2("Lendo chave: "+X5_CHAVE)
If lEnd
Exit
Endif
dbSkip()
End
Next i
Return
9.2.4.
MsAguarde().
Retorno: Nil
Parmetros:
bAcao
cMensagem
cTitulo
Aparncia
Exemplo: MSAguarde()
/*/
+----------------------------------------------------------------------------| Funo
| GMSAGUARDE | Autor | ROBSON LUIZ
| Data |
|
+----------------------------------------------------------------------------| Descrio | Programa que demonstra a utilizao das funes MSAGUARDE()
|
|
| e MSPROCTXT()
|
+----------------------------------------------------------------------------| Uso
| Curso ADVPL
|
+----------------------------------------------------------------------------/*/
USER FUNCTION GMsAguarde()
PRIVATE lEnd := .F.
MsAguarde({|lEnd| RunProc(@lEnd)},"Aguarde...","Processando Clientes",.T.)
RETURN
/*/
+----------------------------------------------------------------------------| Funo
| RUNPROC
| Autor | ROBSON LUIZ
| Data |
|
+----------------------------------------------------------------------------| Descrio | Funo de processamento
|
+----------------------------------------------------------------------------| Uso
| Curso ADVPL
|
+----------------------------------------------------------------------------/*/
STATIC FUNCTION RunProc(lEnd)
dbSelectArea("SX5")
dbSetOrder(1)
dbGoTop()
While !Eof()
If lEnd
MsgInfo(cCancel,"Fim")
Exit
Endif
MsProcTxt("Tabela: "+SX5->X5_TABELA+" Chave: "+SX5->X5_CHAVE)
dbSkip()
End
RETURN
9.2.5.
MsgRun().
Retorno: Nil
Parmetros:
cMensagem
cTitulo
bAcao
Aparncia
Exemplo: MSGRun()
/*/
+----------------------------------------------------------------------------| Funo
| GMSGRUN
| Autor | ROBSON LUIZ
|Data |
|
+----------------------------------------------------------------------------| Descrio | Programa que demonstra a utilizao das funes MSGRUN()
|
|
| e DBEVAL()
|
+----------------------------------------------------------------------------| Uso
| Curso ADVPL
|
+----------------------------------------------------------------------------/*/
USER FUNCTION GMsgRun()
LOCAL nCnt := 0
dbSelectArea("SX1")
dbGoTop()
MsgRun("Lendo arquivo, aguarde...","Ttulo opcional",{|| dbEval({|x| nCnt++}) })
MsgInfo("Ufa!!!, li "+AllTrim(Str(nCnt))+" registros",FunName())
RETURN
9.3. ListBox()
A sintaxe clssica da linguagem ADVPL permite que o componente visual ListBox implemente
dois tipos distintos de objetos:
Lista simples: lista de apenas uma coluna no formato de um vetor, a qual no
necessita da especificao de um cabealho.
Lista com colunas: lista com diversas colunas que necessita de um cabealho no
formato de um aHeader (array de cabealho).
9.3.1.
ListBox simples
Sintaxe:
Parmetros:
nLinha,nColuna
oListBox
nLista
aLista
nLargura,nAltura
oObjetoRef
UNIDADE
CHANGE
Aparncia:
#include "protheus.ch"
/*/
+----------------------------------------------------------------------------| Funo
| LISTBOXITE | Autor | ROBSON LUIZ
|Data |
|
+----------------------------------------------------------------------------| Descrio | Programa que demonstra a utilizao do LISTBOX() como lista
|
|
| simples.
|
+----------------------------------------------------------------------------| Uso
| Curso ADVPL
|
+----------------------------------------------------------------------------/*/
User Function ListBoxIte()
Local
Local
Local
Local
Local
Local
aVetor
oDlg
oLbx
cTitulo
nChave
cChave
:=
:=
:=
:=
:=
:=
{}
Nil
Nil
"Consulta Tabela"
0
""
dbSelectArea("SX5")
dbSetOrder(1)
dbSeek(xFilial("SX5"))
CursorWait()
//+-----------------------------------------+
//| Carrega o vetor conforme a condio |
//+-----------------------------------------+
While !Eof() .And. X5_FILIAL == xFilial("SX5") .And. X5_TABELA=="00"
AADD( aVetor, Trim(X5_CHAVE)+" - "+Capital(Trim(X5_DESCRI)) )
dbSkip()
End
CursorArrow()
If Len( aVetor ) == 0
Aviso( cTitulo, "No existe dados a consultar", {"Ok"} )
Return
Endif
//+-----------------------------------------------+
//| Monta a tela para usurio visualizar consulta |
//+-----------------------------------------------+
DEFINE MSDIALOG oDlg TITLE cTitulo FROM 0,0 TO 240,500 PIXEL
@ 10,10 LISTBOX oLbx VAR nChave ITEMS aVetor SIZE 230,95 OF oDlg PIXEL
oLbx:bChange := {|| cChave := SubStr(aVetor[nChave],1,2) }
DEFINE SBUTTON FROM 107,183 TYPE 14 ACTION LoadTable(cChave) ENABLE OF oDlg
DEFINE SBUTTON FROM 107,213 TYPE 1 ACTION oDlg:End() ENABLE OF oDlg
ACTIVATE MSDIALOG oDlg CENTER
Return
/*/
+----------------------------------------------------------------------------| Funo
| LISTBOXITE | Autor | ROBSON LUIZ
|Data |
|
+----------------------------------------------------------------------------| Descrio | Funo que carrega os dados da tabela selecionada em um
|
|
| listbox.
|
+----------------------------------------------------------------------------| Uso
| Curso ADVPL
|
+----------------------------------------------------------------------------/*/
STATIC FUNCTION LoadTable(cTabela)
LOCAL aTabela := {}
LOCAL oDlg := NIL
LOCAL oLbx := NIL
dbSelectArea("SX5")
dbSeek(xFilial("SX5")+cTabela)
//+------------------------------------------------------------//| O vetor pode receber carga de duas maneiras, acompanhe... |
//+------------------------------------------------------------//| Utilizando While/End
|
//+------------------------------------------------------------dbEval({|| AADD(aTabela,{X5_CHAVE,Capital(X5_DESCRI)})},,{||
X5_TABELA==cTabela})
If Len(aTabela)==0
Aviso( "FIM", "Necessrio selecionar um item", {"Ok"} )
Return
Endif
DEFINE MSDIALOG oDlg TITLE "Dados da tabela selecionada" FROM 300,400 TO 540,900
PIXEL
@ 10,10 LISTBOX oLbx FIELDS HEADER "Tabela", "Descrio" SIZE 230,095 OF oDlg
PIXEL
oLbx:SetArray( aTabela )
oLbx:bLine := {|| {aTabela[oLbx:nAt,1],aTabela[oLbx:nAt,2]} }
DEFINE SBUTTON FROM 107,213 TYPE 1 ACTION oDlg:End() ENABLE OF oDlg
ACTIVATE MSDIALOG oDlg
RETURN
9.3.2.
Sintaxe:
Parmetros:
nLinha,nColuna
oListBox
nLista
Header1,...,HeaderX
nLargura,nAltura
oObjetoRef
UNIDADE
CHANGE
Mtodos:
SetArray()
Atributos:
bLine
Aparncia:
#include protheus.ch
/*/
+----------------------------------------------------------------------------| Funo
| LIST_BOX
| Autor | ROBSON LUIZ
|Data |
|
+----------------------------------------------------------------------------| Descrio | Programa que demonstra a utilizao de um LISTBOX() com
|
|
| grid.
|
+----------------------------------------------------------------------------| Uso
| Curso ADVPL
|
+----------------------------------------------------------------------------/*/
User Function List_Box()
Local
Local
Local
Local
Local
aVetor := {}
oDlg
oLbx
cTitulo := "Cadastro de Bancos"
cFilSA6
dbSelectArea("SA6")
dbSetOrder(1)
cFilSA6 := xFilial("SA6")
dbSeek(cFilSA6)
// Carrega o vetor conforme a condio.
While !Eof() .And. A6_FILIAL == cFilSA6
AADD( aVetor, { A6_COD, A6_AGENCIA, A6_NUMCON, A6_NOME, A6_NREDUZ, A6_BAIRRO,
A6_MUN } )
dbSkip()
End
// Se no houver dados no vetor, avisar usurio e abandonar rotina.
If Len( aVetor ) == 0
Aviso( cTitulo, "No existe dados a consultar", {"Ok"} )
Return
Endif
// Monta a tela para usurio visualizar consulta.
DEFINE MSDIALOG oDlg TITLE cTitulo FROM 0,0 TO 240,500 PIXEL
// Primeira opo para montar o listbox.
@ 10,10 LISTBOX oLbx FIELDS HEADER ;
"Banco", "Agencia", "C/C", "Nome Banco", "Fantasia", "Bairro", "Municpio" ;
SIZE 230,95 OF oDlg PIXEL
oLbx:SetArray( aVetor )
oLbx:bLine := {|| {aVetor[oLbx:nAt,1],;
aVetor[oLbx:nAt,2],;
aVetor[oLbx:nAt,3],;
aVetor[oLbx:nAt,4],;
aVetor[oLbx:nAt,5],;
aVetor[oLbx:nAt,6],;
aVetor[oLbx:nAt,7]}}
Exemplo (continuao):
// Segunda opo para monta o listbox
/*
oLbx :=
TWBrowse():New(10,10,230,95,,aCabecalho,,oDlg,,,,,,,,,,,,.F.,,.T.,,.F.,,,)
oLbx:SetArray( aVetor )
oLbx:bLine := {|| aEval(aVetor[oLbx:nAt],{|z,w| aVetor[oLbx:nAt,w] } ) }
*/
DEFINE SBUTTON FROM 107,213 TYPE 1 ACTION oDlg:End() ENABLE OF oDlg
ACTIVATE MSDIALOG oDlg CENTER
Return
9.4. ScrollBox()
O ScrollBox o objeto utilizado para permitir a um Dialog exibir barras de rolagem verticais e
Horizontais. Algumas aplicaes com objetos definem automaticamente o ScrollBox, tais como:
Enchoice() ou MsMGet()
NewGetDados()
ListBox()
Quando definido um objeto ScrollBox, os demais componentes da janela devero referenciar
este objeto e no mais o objeto Dialog.
Desta forma o ScrollBox atribudo a um objeto Dialog, e os componentes ao ScrollBox.
MsDialog() ScrollBox()
ScrollBox() Componentes Visuais
Sintaxe:
@
nLinha,nColuna
SCROLLBOX
oScrollBox
nLargura,nAltura OF oObjetoRef BORDER
HORIZONTAL
VERTICAL
Parmetros:
nLinha,nColuna
oScrollBox
HORIZONTAL
VERTICAL
nLargura,nAltura
oObjetoRef
BORDER
SIZE
Aparncia:
#INCLUDE "PROTHEUS.CH"
/*/
+-----------------------------------------------------------------------| Funo
| SCROLL()
| Autor | ROBSON LUIZ
|Data |
|
+-----------------------------------------------------------------------| Descrio | Programa que demonstra como montar uma enchoice apenas
|
|
| com variveis, incluindo o recurso de rolagem.
|
+-----------------------------------------------------------------------| Uso
| Curso ADVPL
|
+-----------------------------------------------------------------------/*/
USER FUNCTION Scroll()
LOCAL
LOCAL
LOCAL
LOCAL
LOCAL
LOCAL
LOCAL
LOCAL
LOCAL
LOCAL
LOCAL
LOCAL
LOCAL
LOCAL
oDlg := NIL
oScroll := NIL
oLbx1 := NIL
oLbx2 := NIL
bGet := NIL
oGet := NIL
aAIIPM := {}
aTitulo := {}
nTop := 5
nWidth := 0
cGet := ""
cPict := ""
cVar := ""
n := 0
Exemplo (continuao):
PRIVATE
PRIVATE
PRIVATE
PRIVATE
cProcesso
cPrefixo
cTipo
cCliente
cLoja
cNome
cCGC
dData
nTotal
nUFESP
cStatus
cCond
:=
:=
:=
:=
:=
:=
:=
:=
:=
:=
:=
:=
"P00001"
"UNI"
"MAN"
"000001"
"01"
"JOSE DA SILVA SANTOS SOARES"
"00.000.000/0001-91"
"26/03/03"
5922.00
1000.00
"Z"
"001"
,"@!"})
,"@!"})
,"@!"})
,"@!"})
,"@!"})
,"@!"})
,"@!"})
,"@!"})
,"@!"})
,"@!"})
,"@!"})
,"@!"})
TO
OF
OF
OF
//scrollbox
@ 019,006 SCROLLBOX oScroll HORIZONTAL VERTICAL SIZE 131,182 OF oDlg BORDER
For n:=1 TO Len(aSay)
- 126 ADVPL Intermedirio
Exemplo (continuao):
bGet := &("{|| '"+aSay[n][1]+"'}")
cVar := aSay[n][5]
cGet := "{|u| IIF(PCount()>0,"+cVar+":=u,"+cVar+")}"
cPict := aSay[n][6]
TSay():New(nTop,5,bGet,oScroll,,,.F.,.F.,.F.,.T.,,,;
GetTextWidth(0,Trim(aSay[n][1])),15,;
.F.,.F.,.F.,.F.,.F.)
oGet:=TGet():New(nTop-2,40,&cGet,oScroll,,7,cPict,,,,,.F.,,.T.,;
,.F.,,.F.,.F.,,.T.,.F.,,(cVar),,,,.T.)
nTop+=11
Next n
//listbox ttulos
@ 019,199 LISTBOX oLbx1 FIELDS HEADER ;
"Parcela","Vencto","Vencto.Real","Valor R$","Qtd.UFESP";
COLSIZES 21,24,33,63,100;
SIZE 095,059 OF oDlg PIXEL
oLbx1:SetArray( aTitulo )
oLbx1:bLine := {||{aTitulo[oLbx1:nAt,1],aTitulo[oLbx1:nAt,2],;
aTitulo[oLbx1:nAt,3],aTitulo[oLbx1:nAt,4],aTitulo[oLbx1:nAt,5]}}
//listbox aiipm
@ 089,199 LISTBOX oLbx2 FIELDS HEADER "AIIPM","Placa","Data Multa" ;
COLSIZES 24,21,30 SIZE 095,061 OF oDlg PIXEL
oLbx2:SetArray( aAIIPM )
oLbx2:bLine :=
{||{aAIIPM[oLbx2:nAt,1],aAIIPM[oLbx2:nAt,2],aAIIPM[oLbx2:nAt,3]}}
ACTIVATE MSDIALOG oDlg CENTER ON INIT
EnchoiceBar(oDlg,{||oDlg:End()},{||oDlg:End()})
RETURN
9.5. ParamBox()
Implementa uma tela de parmetros, que no necessita da criao de um grupo de perguntas
no SX1, e com funcionalidades que a Pergunte() no disponibiliza, tais como CheckBox e
RadioButtons.
Cada componente da ParamBox ser associado a um parmetro Private denominado
MV_PARxx, de acordo com a ordem do componente na tela. Os parmetros da ParamBox
podem ser utilizados de forma independente em uma rotina especfica, ou complementando
opes de uma rotina padro.
Cuidados
Ao utilizar a ParamBox em uma funo que tambm utilize parmetros definidos pela
funo Pergunte() deve-se:
Salvar e restaurar os MV_PARs da Pergunte()
Definir variveis Private prprias para a ParamBox, as quais iro armazenar o
contedo das MV_PARs que esta retorna.
Parmetros:
aParamBox
cTitulo
aRet
bOk
aButtons
lCentered
nPosx
nPosy
oMainDlg
cLoad
lCanSave
lUserSave
Aparncia:
[1] Tipo do parmetro: Para cada tipo de parmetro as demais posies do array variam de
contedo conforme abaixo:
1[2]
[3]
[4]
[5]
[6]
[7]
[8]
[9]
MsGet
: Descrio
: String contendo o inicializador do campo
: String contendo a Picture do campo
: String contendo a validao
: Consulta F3
: String contendo a validao When
: Tamanho do MsGet
: Flag .T./.F. Parmetro Obrigatrio ?
2[2]
[3]
[4]
[5]
[6]
[7]
Combo
: Descrio
: Numrico contendo a opo inicial do combo
: Array contendo as opes do Combo
: Tamanho do Combo
: Validao
: Flag .T./.F. Parmetro Obrigatrio ?
- 129 ADVPL Intermedirio
3[2]
[3]
[4]
[5]
[6]
[7]
Radio
: Descrio
: Numrico contendo a opo inicial do Radio
: Array contendo as opes do Radio
: Tamanho do Radio
: Validao
: Flag .T./.F. Parmetro Obrigatrio ?
4[2]
[3]
[4]
[5]
[6]
[7]
5[2]
[3]
[4]
[5]
[6]
6 - File
[2] : Descrio
[3] : String contendo o inicializador do campo
[4] : String contendo a Picture do campo
[5] : String contendo a validao
[6] : String contendo a validao When
[7] : Tamanho do MsGet
[8] : Flag .T./.F. Parmetro Obrigatrio ?
[9] : Texto contendo os tipos de arquivo
Ex.: "Arquivos .CSV |*.CSV"
[10]: Diretrio inicial do CGETFILE()
[11]: Parmetros do CGETFILE()
7[2]
[3]
[4]
[5]
8[2]
[3]
[4]
[5]
[6]
[7]
[8]
[9]
MsGet Password
: Descrio
: String contendo o inicializador do campo
: String contendo a Picture do campo
: String contendo a validao
: Consulta F3
: String contendo a validao When
: Tamanho do MsGet
: Flag .T./.F. Parmetro Obrigatrio ?
9[2]
[3]
[4]
[5]
MsGet Say
: String Contendo o Texto a ser apresentado
: Tamanho da String
: Altura da String
: Negrito (lgico)
#include protheus.ch
/*/
+----------------------------------------------------------------------| Funo
| xParamBox
| Autor | ROBSON LUIZ
|Data |
|
+----------------------------------------------------------------------| Descrio | Programa que demonstra a utilizao da PARAMBOX como
|
|
| forma alternativa de disponibilizar parmetros em um
|
|
| processamento.
|
+----------------------------------------------------------------------| Uso
| Curso ADVPL
|
+----------------------------------------------------------------------/*/
User Function xParamBox()
Local aRet := {}
Local aParamBox := {}
Local aCombo :=
{"Janeiro","Fevereiro","Maro","Abril","Maio","Junho","Julho","Agosto","Setembro
","Outubro","Novembro","Dezembro"}
Local i
:= 0
Private cCadastro := "xParambox"
AADD(aParamBox,{1,"Produto",Space(15),"","","SB1","",0,.F.})
AADD(aParamBox,{2,"Tipo de cliente",1,aCombo,50,"",.F.})
AADD(aParamBox,{3,"Mostra
deletados",IIF(Set(_SET_DELETED),1,2),{"Sim","No"},50,"",.F.})
AADD(aParamBox,{4,"Marca todos ?",.F.,"Marque todos se necessrio
for.",50,"",.F.})
AADD(aParamBox,{5,"Marca todos ?",.F.,50,"",.F.})
AADD(aParamBox,{6,"Qual arquivo",Space(50),"","","",50,.F.,;
"Arquivo .DBF |*.DBF"})
AADD(aParamBox,{7,"Monte o filtro","SX5","X5_FILIAL==xFilial('SX5')"})
AADD(aParamBox,{8,"Digite a senha",Space(15),"","","","",80,.F.})
If ParamBox(aParamBox,"Teste Parmetros...",@aRet)
For i:=1 To Len(aRet)
MsgInfo(aRet[i],"Opo escolhida")
Next
Endif
Return
#include "protheus.ch"
/*/
+----------------------------------------------------------------------------| Funo
| XPARBOX()
| Autor | ARNALDO RAYMUNDO JR.|Data |
|
+----------------------------------------------------------------------------| Descrio | Funo utilizando a PARAMBOX() e protegendo os MV_PARs
|
|
| ativos do programa principal.
|
+----------------------------------------------------------------------------| Uso
| Curso ADVPL
|
+----------------------------------------------------------------------------/*/
Static Function XPARBOX(cPerg)
Local
Local
Local
Local
Local
Local
Local
Local
aParamBox
:= {}
cTitulo
:= "Transferncia para Operao"
bOk
:= {|| .T.}
aButtons
:= {}; Local aRet := {}
nPosx; Local nPosy; Local nX := 0
cLoad
:= ""
lCentered
:= .T.; Local lCanSave := .F.; Local lUserSave := .F.
aParamAtu := Array(4)
10.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 .
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.
10.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.
10.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.
10.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:
10.3.4.
Sugestes de desenvolvimento
11.
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.
CLASS
CONSTRUCTOR
DATA
ENDCLASS
FROM
METHOD
SELF
CLASS
Descrio
Sintaxe 1
CLASS <nome_da_classe>
Sintaxe 2
CONSTRUCTOR
Descrio
Sintaxe
DATA
Descrio
Sintaxe
DATA <nome_do_atributo>
ENDCLASS
Descrio
Sintaxe
ENDCLASS
FROM
Descrio
Sintaxe
METHOD
Descrio
Sintaxe 1
METHOD <nome_do_mtodo()>
Sintaxe 2
SELF
Descrio
Sintaxe
Return SELF
Operadores especficos
Exemplo 1
cNome := oAluno:sNome
Exemplo 2
cNota := oAluno:GetNota(cCurso)
::
Exemplo
IF nPosCurso > 0
nNota := ::aCursos[nPosCurso][2]
ENDIF
Return nNota
Exemplo:
#include protheus.ch
CLASS Pessoa()
DATA cNome
DATA nIdade
METHOD Create() CONSTRUCTOR
METHOD SetNome()
METHOD SetIdade()
ENDCLASS
Manipulao de atributos
Os atributos definidos para uma classe com a utilizao da palavra reservada DATA em sua
declarao podem ser manipulados por seus mtodos utilizando o operador ::.
A utilizao deste operador permite ao interpretador ADVPL diferenciar variveis comuns
criadas pelas funes e mtodos que utilizam este objeto dos atributos propriamente ditos.
Exemplo:
#include protheus.ch
CLASS Pessoa()
DATA cNome
DATA nIdade
METHOD Create() CONSTRUCTOR
METHOD SetNome()
METHOD SetIdade()
ENDCLASS
METHOD Create(cNome, nIdade) CLASS Pessoa
::cNome := cNome
::nIdade := nIdade
Return SELF
oPessoa
cNome :=
dNascimento:= CTOD()
aDados := {}
aDados := GetDados()
oPessoa := Pessoa():Create(cNome,dNascimento)
Return
Create() CONSTRUCTOR
Inscrever()
Avaliar()
GetNota()
GetStatus()
ENDCLASS
// Os objetos da classe Aluno, possuem todos os mtodos e atributos da classe
Pessoa, alm
// dos mtodos e atributos declarados na prpria classe.
12.
A linguagem ADVPL possui diversos componentes visuais e auxiliares, os quais podem ser
representados utilizando a estrutura abaixo:
Classes Auxiliares
Tfont
Classes de Janelas
Msdialog
Tdialog
Twindow
Classes de Componentes
Tcontrol
Classes de Componentes
Visuais
Brgetddb
Mscalend
Mscalendgrid
Msselbr
Msworktime
Sbutton
Tbar
Tbitmap
Tbrowsebutton
Tbtnbmp
Tbtnbmp2
Tbutton
Tcbrowse
Tcheckbox
Tcolortriangle
Tcombobox
Tfolder
Tfont
Tget
Tgroup
Thbutton
Tibrowser
Tlistbox
Tmenu
Tmenubar
Tmeter
Tmsgraphic
Tmsgbar
Tmultibtn
Tmultiget
Tolecontainer
Tpageview
Tpanel
Tradmenu
Tsbrowse
Tsay
Tscrollbox
Tsimpleeditor
Tslider
Classes de Componentes
Visuais
Tsplitter
Ttabs
Ttoolbox
Twbrowse
Vcbrowse
Classes auxiliares
TFONT()
Descrio
Classes de janelas
MSDIALOG()
Descrio
Classe de objetos que deve ser utilizada como padro de janela para
entrada de dados. MSDialog um tipo de janela dilogo modal, isto ,
no permite que outra janela ativa receba dados enquanto esta estiver
ativa.
TDIALOG()
Descrio
TWINDOW()
Descrio
Classes de componentes
TCONTROL()
Descrio
MSCALEND()
Descrio
MSCALENDGRID()
Descrio
MSSELBR()
Descrio
MSWORKTIME()
Descrio
SBUTTON()
Descrio
TBAR()
Descrio
TBITMAP()
Descrio
TBROWSEBUTTON()
Descrio
TBTNBMP()
Descrio
TBTNBMP2()
Descrio
TBUTTON()
Descrio
TCBROWSE()
Descrio
TCHECKBOX()
Descrio
TCOLORTRIANGLE()
Descrio
TCOMBOBOX()
Descrio
TFOLDER()
Descrio
TGET()
Descrio
TGROUP()
Descrio
THBUTTON()
Descrio
TIBROWSER()
Descrio
TLISTBOX()
Descrio
TMENU()
Descrio
TMENUBAR()
Descrio
TMETER()
Descrio
TMSGRAPHIC()
Descrio
TMSGBAR()
Descrio
TMULTIBTN()
Descrio
TMULTIGET()
Descrio
TOLECONTAINER()
Descrio
TPAGEVIEW()
Descrio
TPANEL()
Descrio
TRADMENU()
Descrio
TSBROWSE()
Descrio
TSAY()
Descrio
TSCROLLBOX()
Descrio
TSIMPLEEDITOR()
Descrio
TSLIDER()
Descrio
TSPLITTER()
Descrio
TTABS()
Descrio
TTOOLBOX()
Descrio
TWBROWSE()
Descrio
VCBROWSE()
Descrio
R
0
0
0
0
255
255
255
255
G
0
0
255
255
0
0
255
255
B
0
255
0
255
0
255
0
255
Valor
0
16711680
65280
16776960
255
16711935
65535
16777215
Para atribuir as cores aos objetos visuais devem ser observados os atributos utilizados para
estes fins em cada objeto, como por exemplo:
MSDIALOG()
nClrPane
nClrText
TSAY()
nClrPane
nClrText
Funo RGB()
A linguagem ADVPL possui a funo RGB() a qual retorna o valor da cor a ser definido, de
acordo com a parametrizao de cada um dos elementos da paleta RGB.
nGreen
nBlue
Retorno
13.
13.1.1.
Enchoice()
Sintaxe: Enchoice( cAlias, nReg, nOpc, aCRA, cLetra, cTexto, aAcho, aPos,
aCpos, nModelo, nColMens, cMensagem, cTudoOk, oWnd, lF3,
lMemoria, lColumn, caTela, lNoFolder, lProperty)
Retorno: Nil
Parmetros:
cAlias
nReg
nOpc
aCRA
cLetra
cTexto
aAcho
aPos
aCpos
nModelo
nColMens
cMensagem
cTudoOk
oWnd
lF3
lMemoria
lColumn
caTela
lNoFolder
lProperty
#include "protheus.ch"
/*/
+----------------------------------------------------------------------------| Funo
| MBRWENCH
| Autor | ARNALDO RAYMUNDO JR.|Data |
|
+----------------------------------------------------------------------------| Descrio | Programa que demonstra a utilizao da funo Enchoice()
|
+----------------------------------------------------------------------------| Uso
| Curso ADVPL
|
+----------------------------------------------------------------------------/*/
User Function MrbwEnch()
Private cCadastro := " Cadastro de Clientes"
Private aRotina
:=
{{"Pesquisar"
, "axPesqui"
{"Visualizar"
, "U_ModEnc"
DbSelectArea("SA1")
DbSetOrder(1)
MBrowse(6,1,22,75,"SA1")
Return
User Function ModEnc(cAlias,nReg,nOpc)
Local aCpoEnch
Local aAlter
:= {}
:= {}
Local cAliasE
:=
Local aAlterEnch :=
Local aPos
:=
Local nModelo
:=
Local lF3
:=
Local lMemoria
:=
Local lColumn
:=
Local caTela
:=
Local lNoFolder
:=
Local lProperty
:=
Private oDlg
Private oGetD
Private oEnch
Private aTELA[0][0]
Private aGETS[0]
cAlias
{}
{000,000,400,600}
3
.F.
.T.
.F.
""
.F.
.F.
DbSelectArea("SX3")
DbSetOrder(1)
DbSeek(cAliasE)
, 0, 1},;
, 0, 2}}
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.))
Enchoice(cAliasE, nReg, nOpc, /*aCRA*/, /*cLetra*/, /*cTexto*/, ;
aCpoEnch, aPos, aAlterEnch, nModelo, /*nColMens*/,;
/*cMensagem*/,/*cTudoOk*/, oDlg, lF3, lMemoria, lColumn,;
caTela, lNoFolder, lProperty)
ACTIVATE MSDIALOG oDlg CENTERED
Return
13.1.2.
MsMGet()
aPos
aCpos
nModelo
nColMens
cMensagem
cTudoOk
oWnd
lF3
lMemoria
lColumn
caTela
lNoFolder
lProperty
#include "protheus.ch"
/*/
+----------------------------------------------------------------------------| Funo
| MBRWMSGET | Autor | ARNALDO RAYMUNDO JR. |Data |
|
+----------------------------------------------------------------------------| Descrio | Programa que demonstra a utilizao do objeto MsMget()
|
+----------------------------------------------------------------------------| Uso
| Curso ADVPL
|
+----------------------------------------------------------------------------/*/
User Function MrbwMsGet()
Private cCadastro := " Cadastro de Clientes"
Private aRotina
:=
{{"Pesquisar"
, "axPesqui"
{"Visualizar"
, "U_ModEnc"
DbSelectArea("SA1")
DbSetOrder(1)
MBrowse(6,1,22,75,"SA1")
Return
User Function ModEnc(cAlias,nReg,nOpc)
Local aCpoEnch
:= {}
Local aAlter
:= {}
Local cAliasE
Local aAlterEnch :=
Local aPos
:=
Local nModelo
:=
Local lF3
:=
Local lMemoria
:=
Local lColumn
Local caTela
Local lNoFolder
:=
Local lProperty
:=
Private oDlg
Private oGetD
Private oEnch
Private aTELA[0][0]
Private aGETS[0]
:= cAlias
{}
{000,000,400,600}
3
.F.
.T.
:= .F.
:= ""
.F.
.F.
, 0, 1},;
, 0, 2}}
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
aAlterEnch := aClone(aCpoEnch)
oDlg
:= MSDIALOG():New(000,000,400,600,cCadastro,,,,,,,,,.T.)
RegToMemory(cAliasE, If(nOpc==3,.T.,.F.))
oEnch := MsMGet():New(cAliasE, nReg, nOpc, /*aCRA*/, /*cLetra*/,;
/*cTexto*/, aCpoEnch, aPos, aAlterEnch, nModelo, /*nColMens*/,;
/*cMensagem*/, /*cTudoOk*/,oDlg,lF3,lMemoria,lColumn, caTela,;
lNoFolder, lProperty)
oDlg:lCentered := .T.
oDlg:Activate()
Return
MSGETDB()
MSGETDADOS()
MSNEWGETDADOS()
Grids no digitveis: permitem somente a visualizao de informaes, comumente
utilizados como browses do ERP Protheus, tais como:
TWBROWSE()
MAWNDBROWSE()
MBROWSE()
Neste tpico sero tratadas as grids digitveis disponveis na linguagem ADVPL para o
desenvolvimento de interfaces de cadastros e manuteno de informaes.
13.2.1.
MsGetDB()
A classe de objetos visuais MsGetDB() permite a criao de um grid digitvel com uma ou mais
colunas, baseado em uma tabela temporria.
Sintaxe:
Retorno: oMsGetDB
objeto do tipo MsGetDB()
Parmetros:
nTop
nLeft
nBottom
nRight
nOpc
cLinhaOk
cTudoOk
cIniCpos
lDelete
aAlter
nFreeze
lEmpty
uPar1
cFieldOk
cTRB
lCondicional
lAppend
cDelOk
lDisparos
uPar2
cSuperDel
oWnd
Aparncia:
Variveis private:
aRotina
aHeader
Pesquisar
Visualizar
Incluir
Alterar
Excluir
lRefresh
Variveis pblicas:
nBrLin
Funes de validao:
cLinhaOk
cTudoOk
Mtodos adicionais:
ForceRefresh()
#include protheus.ch
/*/
+----------------------------------------------------------------------------| Funo
| GETDBSA1
| Autor | MICROSIGA
|Data |
|
+----------------------------------------------------------------------------| Descrio | Programa que demonstra a utilizao do objeto MsGetDB()
|
+----------------------------------------------------------------------------| Uso
| Curso ADVPL
|
+----------------------------------------------------------------------------/*/
User Function GetDbSA1()
Local
Local
Local
Local
Local
nI
oDlg
oGetDB
nUsado := 0
aStruct := {}
Private
Private
Private
Private
lRefresh := .T.
aHeader := {}
aCols := {}
aRotina := {{"Pesquisar", "AxPesqui", 0, 1},;
{"Visualizar", "AxVisual", 0, 2},;
{"Incluir", "AxInclui", 0, 3},;
{"Alterar", "AxAltera", 0, 4},;
{"Excluir", "AxDeleta", 0, 5}}
DbSelectArea("SX3")
DbSetOrder(1)
DbSeek("SA1")
Exemplo (continuao):
While !Eof() .and. SX3->X3_ARQUIVO == "SA1"
If X3Uso(SX3->X3_USADO) .and. cNivel >= SX3->X3_NIVEL
nUsado++
AADD(aHeader,{Trim(X3Titulo()),;
SX3->X3_CAMPO,;
SX3->X3_PICTURE,;
SX3->X3_TAMANHO,;
SX3->X3_DECIMAL,;
SX3->X3_VALID,;
"",;
SX3->X3_TIPO,;
"",;
"" })
AADD(aStruct,{SX3->X3_CAMPO,SX3->X3_TIPO,SX3->X3_TAMANHO,;
SX3->X3_DECIMAL})
EndIf
DbSkip()
End
AADD(aStruct,{"FLAG","L",1,0})
cCriaTrab := CriaTrab(aStruct,.T.)
DbUseArea(.T.,__LocalDriver,cCriaTrab,,.T.,.F.)
oDlg
13.2.2.
MsGetDados()
A classe de objetos visuais MsGetDados() permite a criao de um grid digitvel com uma ou
mais colunas, baseado em um array.
Parmetros:
nTop
nLeft
nBottom
nRight
nOpc
cLinhaOk
cTudoOk
cIniCpos
lDelete
aAlter
uPar1
lEmpty
nMax
cFieldOk
cSuperDel
uPar2
cDelOk
oWnd
Aparncia:
Variveis private:
aRotina
aHeader
lRefresh
Variveis pblicas:
N
Funes de validao:
cLinhaOk
cTudoOk
Mtodos adicionais:
ForceRefresh()
Hide()
Show()
#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 := {}
Private aRotina := {{"Pesquisar", "AxPesqui", 0, 1},;
{"Visualizar", "AxVisual", 0, 2},;
{"Incluir", "AxInclui", 0, 3},;
{"Alterar", "AxAltera", 0, 4},;
{"Excluir", "AxDeleta", 0, 5}}
DbSelectArea("SX3")
DbSetOrder(1)
DbSeek("SA1")
Exemplo (continuao):
While !Eof() .and. SX3->X3_ARQUIVO == "SA1"
If X3Uso(SX3->X3_USADO) .and. cNivel >= SX3->X3_NIVEL
nUsado++
AADD(aHeader,{Trim(X3Titulo()),;
SX3->X3_CAMPO,;
SX3->X3_PICTURE,;
SX3->X3_TAMANHO,;
SX3->X3_DECIMAL,;
SX3->X3_VALID,;
"",;
SX3->X3_TIPO,;
"",;
"" })
EndIf
DbSkip()
End
AADD(aCols,Array(nUsado+1))
For nI := 1 To nUsado
aCols[1][nI] := CriaVar(aHeader[nI][2])
Next
aCols[1][nUsado+1] := .F.
oDlg
13.2.3.
MsNewGetDados()
A classe de objetos visuais MsNewGetDados() permite a criao de um grid digitvel com uma
ou mais colunas, baseado em um array.
Parmetros:
nSuperior
nEsquerda
nInferior
nDireita
nOpc
cLinOk
cTudoOk
cIniCpos
aAlterGDa
nFreeze
nMax
cFieldOk
cSuperDel
cDelOk
oDLG
aHeader
aCols
Aparncia:
Variveis private:
aRotina
aHeader
Pesquisar
Visualizar
Incluir
Alterar
Excluir
lRefresh
Variveis pblicas:
Indica qual a linha posicionada do aCols.
N
Funes de validao:
Funo de validao na mudana das linhas da grid. No
pode ser definida como Static Function.
Funo de validao da confirmao da operao com o grid.
No pode ser definida como Static Function.
cLinhaOk
cTudoOk
Mtodos adicionais:
Atualiza a MsNewGetDados com a tabela e posiciona na
primeira linha.
Oculta a MsNewGetDados.
Mostra a MsNewGetDados.
ForceRefresh()
Hide()
Show()
#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
|
+----------------------------------------------------------------------------/*/
User Function MrbwGetD()
Private cCadastro := "Pedidos de Venda"
Private aRotina
:=
{{"Pesquisar"
{"Visualizar"
{"Incluir"
, "axPesqui"
, "U_ModGtd"
, "U_ModGtd"
DbSelectArea("SC5")
DbSetOrder(1)
MBrowse(6,1,22,75,"SC5")
Return
User Function ModGtd(cAlias,nReg,nOpc)
Local
Local
Local
Local
Local
Local
nX
nUsado
aButtons
aCpoEnch
cAliasE
aAlterEnch
:=
:=
:=
:=
:=
:=
0
0
{}
{}
cAlias
{}
, 0, 1},;
, 0, 2},;
, 0, 3}}
Exemplo (continuao):
Local
Local
Local
Local
Local
Local
Local
Local
Local
Local
Local
Local
Local
Local
Local
Local
Local
Local
Local
Local
Local
Local
Local
Local
Local
aPos
nModelo
lF3
lMemoria
lColumn
caTela
lNoFolder
lProperty
aCpoGDa
cAliasGD
nSuperior
nEsquerda
nInferior
nDireita
cLinOk
cTudoOk
cIniCpos
nFreeze
nMax
cFieldOk
cSuperDel
cDelOk
aHeader
aCols
aAlterGDa
Private
Private
Private
Private
Private
:=
:=
:=
:=
:=
:=
:=
:=
{000,000,080,400}
3
.F.
.T.
:= .F.
:= ""
.F.
.F.
:= {}
"SC6"
:= 081
:= 000
:= 250
:= 400
:= "AllwaysTrue"
:= "AllwaysTrue"
:= "C6_ITEM"
:= 000
:= 999
:= "AllwaysTrue"
:= ""
:= "AllwaysFalse"
:= {}
:= {}
{}
oDlg
oGetD
oEnch
aTELA[0][0]
aGETS[0]
DbSelectArea("SX3")
DbSetOrder(1)
DbSeek(cAliasE)
While !Eof() .And. SX3->X3_ARQUIVO == cAliasE
If !(SX3->X3_CAMPO $ "C5_FILIAL") .And. cNivel >= SX3->X3_NIVEL .And.;
X3Uso(SX3->X3_USADO)
AADD(aCpoEnch,SX3->X3_CAMPO)
EndIf
DbSkip()
End
aAlterEnch := aClone(aCpoEnch)
DbSelectArea("SX3")
DbSetOrder(1)
MsSeek(cAliasGD)
While !Eof() .And. SX3->X3_ARQUIVO == cAliasGD
If
!(AllTrim(SX3->X3_CAMPO) $ "C6_FILIAL") .And.;
cNivel >= SX3->X3_NIVEL .And. X3Uso(SX3->X3_USADO)
AADD(aCpoGDa,SX3->X3_CAMPO)
EndIf
DbSkip()
End
- 174 ADVPL Intermedirio
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
oDlg
:= MSDIALOG():New(000,000,400,600, cCadastro,,,,,,,,,.T.)
RegToMemory("SC5", If(nOpc==3,.T.,.F.))
oEnch := MsMGet():New(cAliasE,nReg,nOpc,/*aCRA*/,/*cLetra*/,/*cTexto*/,;
aCpoEnch,aPos,aAlterEnch, nModelo, /*nColMens*/, /*cMensagem*/,;
/*cTudoOk*/, oDlg,lF3, lMemoria,lColumn,caTela,lNoFolder,;
lProperty)
oGetD:= MsNewGetDados():New(nSuperior, nEsquerda, nInferior, nDireita,;
nOpc,cLinOk,cTudoOk, cIniCpos, aAlterGDa, nFreeze, nMax,cFieldOk,;
cSuperDel,cDelOk, oDLG, aHeader, aCols)
oDlg:bInit := {|| EnchoiceBar(oDlg, {||oDlg:End()},{||oDlg:End()},,aButtons)}
oDlg:lCentered := .T.
oDlg:Activate()
Return
13.2.3.1.
Conforme visto no tpico sobre definio das propriedades de cores para os componentes
visuais, cada objeto possui caractersticas que devem ser respeitadas para correta utilizao
deste recurso.
Atributos adicionais:
lUseDefaultColors
Mtodos adicionais:
SetBlkBackColor
Mtodo que define a cor que ser utilizada para cada linha do
grid. No necessrio utilizar o mtodo Refresh() aps a
definio da cor por este mtodo.
Aparncia:
#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
|
+----------------------------------------------------------------------------/*/
User Function MrbwGtCl()
Private cCadastro := "Pedidos de Venda"
Private aRotina
:=
{{"Pesquisar"
{"Visualizar"
{"Incluir"
, "axPesqui"
, "U_ModGtd"
, "U_ModGtd"
DbSelectArea("SC5")
DbSetOrder(1)
MBrowse(6,1,22,75,"SC5")
Return
User Function ModGtd(cAlias,nReg,nOpc)
Local nX
:= 0
Local nUsado
Local
Local
Local
Local
Local
Local
Local
Local
Local
Local
Local
Local
Local
Local
Local
Local
Local
Local
Local
Local
Local
Local
Local
aButtons
aCpoEnch
cAliasE
aAlterEnch
aPos
nModelo
lF3
lMemoria
lColumn
caTela
lNoFolder
lProperty
aCpoGDa
cAliasGD
nSuperior
nEsquerda
nInferior
nDireita
cLinOk
cTudoOk
cIniCpos
nFreeze
nMax
:= 0
:= {}
:= {}
:= cAlias
{}
{000,000,080,400}
3
.F.
.T.
:= .F.
:= ""
:= .F.
:= .F.
:= {}
:= "SC6"
:= 081
:= 000
:= 250
:= 400
:= "AllwaysTrue"
:= "AllwaysTrue"
:= "C6_ITEM"
:= 000
:= 999
:=
:=
:=
:=
:=
, 0, 1},;
, 0, 2},;
, 0, 3}}
Exemplo (continuao):
Local
Local
Local
Local
Local
Local
cFieldOk
cSuperDel
cDelOk
aHeader
aCols
aAlterGDa
Private
Private
Private
Private
Private
:=
:=
:=
:=
:=
"AllwaysTrue"
""
"AllwaysFalse"
{}
{}
:= {}
oDlg
oGetD
oEnch
aTELA[0][0]
aGETS[0]
DbSelectArea("SX3")
DbSetOrder(1)
DbSeek(cAliasE)
While !Eof() .And. SX3->X3_ARQUIVO == cAliasE
If !(SX3->X3_CAMPO $ "C5_FILIAL") .And. cNivel >= SX3->X3_NIVEL .And.;
X3Uso(SX3->X3_USADO)
AADD(aCpoEnch,SX3->X3_CAMPO)
EndIf
DbSkip()
End
aAlterEnch := aClone(aCpoEnch)
DbSelectArea("SX3")
DbSetOrder(1)
MsSeek(cAliasGD)
While !Eof() .And. SX3->X3_ARQUIVO == cAliasGD
If
!(AllTrim(SX3->X3_CAMPO) $ "C6_FILIAL") .And. cNivel >= SX3>X3_NIVEL .And. X3Uso(SX3->X3_USADO)
AADD(aCpoGDa,SX3->X3_CAMPO)
EndIf
DbSkip()
End
aAlterGDa := aClone(aCpoGDa)
nUsado:=0
dbSelectArea("SX3")
dbSeek("SC6")
aHeader:={}
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
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
oDlg := MSDIALOG():New(000,000,400,600, cCadastro,,,,,,,,,.T.)
RegToMemory("SC5", If(nOpc==3,.T.,.F.))
oEnch := MsMGet():New(cAliasE,nReg,nOpc,/*aCRA*/,/*cLetra*/, /*cTexto*/,;
aCpoEnch,aPos, aAlterEnch, nModelo, /*nColMens*/, /*cMensagem*/,;
cTudoOk,oDlg,lF3, lMemoria,lColumn,caTela,lNoFolder,lProperty)
oGetD:= MsNewGetDados():New(nSuperior,nEsquerda,nInferior,nDireita, nOpc,;
cLinOk,cTudoOk,cIniCpos,aAlterGDa,nFreeze,nMax,cFieldOk, cSuperDel,;
cDelOk, oDLG, aHeader, aCols)
// Tratamento para definio de cores especficas,
// logo aps a declarao da MsNewGetDados
oGetD:oBrowse:lUseDefaultColors := .F.
oGetD:oBrowse:SetBlkBackColor({|| GETDCLR(oGetD:aCols,oGetD:nAt,aHeader)})
oDlg:bInit := {|| EnchoiceBar(oDlg, {||oDlg:End()}, {||oDlg:End()},,aButtons)}
oDlg:lCentered := .T.
oDlg:Activate()
Return
Exemplo (continuao):
// Funo para tratamento das regras de cores para a grid da MsNewGetDados
Static Function GETDCLR(aLinha,nLinha,aHeader)
Local
Local
Local
Local
Local
nCor2
nCor3
nPosProd
nUsado
nRet
:=
:=
:=
:=
:=
13.3.1.
EnchoiceBar()
Funo que cria uma barra de botes no formato padro utilizado pelas interfaces de cadastro
da aplicao Protheus.
Esta barra possui os botes padres para confirmar ou cancelar a interface e ainda permite a
adio de botes adicionais com a utilizao do parmetro aButtons.
Sintaxe:
Parmetros:
oDlg
bOk
bCancel
lMsgDel
aButtons
nRecno
cAlias
Aparncia:
#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
AADD( aButtons, {"HISTORIC", {|| TestHist()}, "Histrico...",;
"Histrico",{|| .T.}} )
@ -15,-15 BUTTON oBtn PROMPT "..." SIZE 1,1 PIXEL OF oDlg
ACTIVATE MSDIALOG oDlg ;
ON INIT (EnchoiceBar(oDlg,{||lOk:=.T.,oDlg:End()},{||oDlg:End()},,@aButtons))
Return
13.3.2.
TBar()
Parmetros:
oWnd
nBtnWidth
nBtnHeight
l3D
cMode
No utilizado.
oCursor
cResource
lNoAutoAdjust
Aparncia:
#include 'protheus.ch'
/*/
+----------------------------------------------------------------------------| Funo
| TSTBAR
| Autor | MICROSIGA
|Data |
|
+----------------------------------------------------------------------------| Descrio | Programa que demonstra a utilizao do objeto TBar()
|
+----------------------------------------------------------------------------| Uso
| Curso ADVPL
|
+----------------------------------------------------------------------------/*/
User Function TstTBar()
Local oDlg
oDlg
Exemplo (continuao):
oTBar := TBar():New( oDlg,25,32,.T.,,,,.F. )
oTBtnBmp2_1 := TBtnBmp2():New( 00, 00, 35, 25, 'copyuser' ,,,,;
{||Alert('TBtnBmp2_1')}, oTBar,'msGetEx',,.F.,.F. )
oTBtnBmp2_2 := TBtnBmp2():New( 00, 00, 35, 25, 'critica'
{||},oTBar,'Critica',,.F.,.F. )
,,,,;
,,,,;
,,,,;
oDlg:lCentered := .T.
oDlg:Activate()
Return
13.3.3.
ButtonBar
Sintaxe:
Retorno: ().
Parmetros:
oBar
nWidth
nHeight
3D
oDlg
MODE
CURSOR
A sintaxe ButtonBar requer a adio dos botes como recursos adicionais da barra
previamente definida utilizando a sintaxe abaixo:
Sintaxe adicional:
Parmetros:
cBitMap
oBar
cAcao
cTexto
Aparncia:
#include 'protheus.ch'
/*/
+----------------------------------------------------------------------| Funo
| TstBBar
| Autor | MICROSIGA
|Data |
|
+----------------------------------------------------------------------| Descrio | Programa que demonstra a utilizao do objeto TBar()
|
+----------------------------------------------------------------------| Uso
| Curso ADVPL
|
+----------------------------------------------------------------------/*/
User Function TstBBar()
Local oDlg
Local oBtn1
Local oBtn2
oDlg
Exemplo (continuao):
DEFINE
DEFINE
DEFINE
DEFINE
ACTION
oBtn1:cTitle:="Calc"
DEFINE BUTTON RESOURCE "S4WB009N"
DEFINE BUTTON RESOURCE "S4WB010N"
DEFINE BUTTON RESOURCE "S4WB016N"
ACTION HelProg() TOOLTIP "Ajuda"
13.3.4.
Conforme mencionado nos tpicos anteriores, os botes visuais do tipo barra de botes
permitem a definio de itens com aes e imagens vinculadas.
Dentre os objetos e funes mencionados, foi citada a EnchoiceBar(), a qual permite a adio
de botes adicionais atravs do parmetro aButton, sendo que os itens deste array devem
possuir o seguinte formato:
Sintaxe: AADD(aButtons,{cBitMap, bAcao, cTexto})
Estrutura:
cBitMap
bAcao
cTexto
DISCAGEM
EDIT
EDITABLE
EXCLUIR
FORM
GRAF2D
GRAF3D
LINE
NOTE
OBJETIVO
OK
PENDENTE
PRECO
PRODUTO
S4SB014N
S4WB001N
S4WB005N
S4WB006N
S4WB007N
S4WB008N
S4WB009N
S4WB010N
S4WB011N
S4WB013N
S4WB014A
S4WB016N
SIMULACA
VENDEDOR
USER
Exemplo:
AADD(aButtons,{"USER",{||AllwaysTrue()},"Usurio"})
APNDICES
BOAS PRTICAS DE PROGRAMAO
14.
Arredondamento
If (Valor/30) == 50
If Round(Valor/30, 0) == 50
Exemplo 02:
15.
Utilizao de Identao
obrigatria a utilizao da identao, pois torna o cdigo muito mais legvel. Veja os
exemplos abaixo:
While !SB1->(Eof())
If mv_par01 == SB1->B1_COD
dbSkip()
Loop
Endif
Do Case
Case SB1->B1_LOCAL == 01 .OR. SB1->B1_LOCAL == 02
TrataLocal(SB1->B1_COD, SB1->B1_LOCAL)
Case SB1->B1_LOCAL == 03
TrataDefeito(SB1->B1_COD)
OtherWise
TrataCompra(SB1->B1_COD, SB1->B1_LOCAL)
EndCase
dbSkip()
EndDo
A utilizao da identao seguindo as estruturas de controle de fluxo (while, IF, caso etc.)
torna a compreenso do cdigo muito mais fcil:
While !SB1->(Eof())
If mv_par01 == SB1->B1_COD
dbSkip()
Loop
Endif
Do Case
Case SB1->B1_LOCAL == 01 .OR. SB1->B1_LOCAL == 02
TrataLocal(SB1->B1_COD, SB1->B1_LOCAL)
Case SB1->B1_LOCAL == 03
TrataDefeito(SB1->B1_COD)
OtherWise
TrataCompra(SB1->B1_COD, SB1->B1_LOCAL)
EndCase
dbSkip()
EndDo
Para identar o cdigo utilize a tecla <TAB> e na ferramenta DEV-Studio, a qual pode ser
configurada atravs da opo Preferncias:
16.
Capitulao de Palavras-Chave
Variveis de memria:
Campos:
SC6->C6_NUMPED
Querys:
SELECT * FROM...
17.
18.
Tipo de dado
Array
Bloco de cdigo
Caracter
Data
Lgico
Numrico
Objeto
Indefinido
Exemplo
aValores
bSeek
cNome
dDataBase
lContinua
nValor
oMainWindow
xConteudo
Funcionalmente correto
Eficiente
Legvel
Reutilizvel
Extensvel
Portvel
Com a otimizao do cdigo da funo GetAnswer(), pode facilmente verificar que a mesma
no realiza nada adicional chamada de GetOk(), podendo ser substituda por uma chamada
direta desta, continuando a funcionar corretamente.
Codificao auto-documentvel
Nenhum comentrio substitui um cdigo claramente escrito, e este no um acidente.
Considere o exemplo:
cVar := "
" // 11 espaos
cVar := Space(11)
O mesmo princpio pode ser aplicado para qualquer string longa de caracteres repetidos. A
funo Replicate pode ser utilizada como a seguir:
Este tipo de programao deixa o cdigo fcil de digitar, fcil de ler e mais flexvel.
Se o valor da varivel nVar for igual a zero (0) no momento da execuo desta linha de
cdigo, ambas as comparaes separadas pelo operador lgico .Or. sero efetuadas: Aps ser
avaliada, a primeira comparao ir falhar. A segunda comparao ser ento avaliada e
falhar tambm. Como resultado, o cdigo existente dentro da estrutura de fluxo If no ser
executado. Tal cdigo somente ser executado quando o valor desta varivel for maior OU
menor do que zero. Ou seja, sempre que for DIFERENTE de zero, o que torna a linha a seguir
mais eficiente:
If nVar != 0
Este tipo de alterao torna o cdigo mais legvel e o processamento mais rpido, evitando a
avaliao de instrues desnecessariamente.
Existem outras situaes onde a simplificao pode ser utilizada. A expresso de avaliao a
seguir:
If cVar $ "ABCD"
Existe uma opo de soluo de auto-ajuste disponvel que fcil de digitar e tem a garantia
de executar a tarefa igualmente (tornar todos os caracteres maisculos):
Este cdigo pode ser escrito de uma forma muito mais simples, conforme demonstrado abaixo:
nVar := nVar + 1
nVar := nVar -1
++nVar
--nVar
Deve-se apenas
podem aparecer
utilizada dentro
resultado. Para
ADVPL.
Local nCnt := 0
For nCnt := 1 To 10
<cdigo>
Next nCnt
Local nCnt
While ( nCnt++ < 10 )
<cdigo>
EndDo
Em ADVPL, variveis no inicializadas sempre tem seu valor contendo nulo (nil) a princpio, o
que far com que uma exceo em tempo de execuo acontea quando a instruo de
repetio while for executada.
Diferentemente do primeiro exemplo, onde a inicializao da varivel no fazia diferena
alguma, neste segundo exemplo a inicializao absolutamente necessria. Deve-se procurar
inicializar variveis numricas com zero (0) e variveis caracter com string nula ("") apenas
quando realmente necessrio.
Utilizao de alternativas
Quando se est trabalhando em uma simples rotina, deve-se tomar algum tempo para
explorar duas ou trs diferentes abordagens. Quando se est trabalhando em algo mais
complexo, deve-se planejar prototipar algumas a mais. Considere o seguinte cdigo:
If cHair = "A"
Replace hair With "Loira"
Else
If cHair = "B"
Replace hair With "Morena"
Else
If cHair = "C"
Replace hair With "Ruiva"
Else
If cHair = "D"
Replace hair With "Grisalho"
Else
Replace hair With "Preto"
Endif
Endif
Endif
Endif
Um cdigo de uma nica letra, (A at E), foi informado para indicar a cor de cabelo. Este
cdigo foi ento convertido e armazenado como uma string. Pode-se notar que a cor "Preto"
ser atribuda se nenhuma outra opo for verdadeira.
Uma alternativa que reduz o nvel de identao torna o cdigo mais fcil de ler enquanto reduz
o nmero de comandos replace:
Do Case
Case cHair == "A"
cColor := "Loira"
Case cHair == "B"
cColor := "Morena"
Case cHair == "C"
cColor := "Ruiva"
Case cHair == "D"
cColor := "Grisalho"
OtherWise
cColor := "Preto"
EndCase
Replace hair With cColor
local ncnt
while ( ncnt++ < 10 )
ntotal += ncnt * 2
enddo
Local nCnt
While ( nCnt++ < 10 )
nTotal += nCnt * 2
EndDo
Esse tipo de mensagem pode dar informaes demais para o usurio e deix-lo sentindo-se
desconfortvel se no souber o que significa "reindexando", etc. E de fato, o usurio no devia
ser incomodado com tais detalhes. Apenas a frase "Aguarde, indexando." funcionaria
corretamente, assim como palavras "processando" ou "reorganizando".
Outra boa idia evitar a referencia a um item corrente de uma tabela como um "registro":
A impresso que se tem aps uma leitura deste cdigo de que valores esto sendo atribudos
s variveis ou que constantes esto sendo utilizadas. Se o objetivo flexibilidade, o cdigo
anterior deve ser substitudo por:
#define NUMLINES 1
#define NUMPAGES 2
#define ISDISK
5
If aReturn[ISDISK] == 1
aPrintDefs[ NUMLINES ] := 55
Endif
aPrintDefs[ NUMPAGES ] += 1
LISTAS DE EXERCCIOS
Mdulo 04.1.: Desenvolvendo aplicaes em ADVPL
01
02
03
04
05
06
07
08
09
10
11
12
13
14
15
16
17
18
19
20
21
22
23
25
26
27
28
29
para
interagir
com
classe
Aluno()
30
31
32
33
34
35
36
01
02
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
Oficina de Programao
Robson Luiz Estefani Gonalves
Apostila de Treinamento - ADVPL
Educao corporativa
Apostila de Treinamento Boas Prticas de Programao
Inteligncia Protheus e Fbrica de Software
DEM Documentao Eletrnica Microsiga
Microsiga Software S.A.
Materiais diversos de colaboradores Microsiga
Colaboradores Microsiga
Colaboradores
Reviso 01
Arnaldo Raymundo Junior
Luis Akira Tamura
Mrcia Satiko Sasaki Tokura
Patricia Lopes Legas
Robson Luiz Estefani Gonalves
Srgio Sueo Fuzinaka
Data: 10.2007
CSA
Educao Corporativa
ACR-N1_FRAMEW1
Educao Corporativa
Fbrica de Software
Inteligncia Protheus
Educao Corporativa
Sintaxe: CTOD(cData)
Parmetros
cData
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.
Sintaxe: CVALTOCHAR(nValor)
Parmetros
nValor
Exemplo:
FOR nPercorridos := 1 to 10
MSGINFO(Passos percorridos: +CvalToChar(nPercorridos))
NEXT nPercorridos
DTOC()
Realiza a converso de uma informao do tipo data para em caracter, sendo o resultado no
formato DD/MM/AAAA.
Sintaxe: DTOC(dData)
Parmetros
dData
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.
Sintaxe: DTOS(dData)
Parmetros
dData
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.
Sintaxe: STOD(sData)
Parmetros
sData
Exemplo:
sData := LERSTR(01,08) // Funo que realiza a leitura de uma string de um txt previamente
// aberto
dData := STOD(sData)
STR()
Realiza a converso de uma informao do tipo numrico em uma string, adicionando espaos
direita.
Sintaxe: STR(nValor)
Parmetros
nValor
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.
nTamanho
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.
Sintaxe: VAL(cValor)
Parmetros
cValor
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)
Matemticas
ACOS()
Funo utilizada para calcular o valor do arco co-seno.
Sintaxe: ACOS(nValor)
Parmetros:
nValor
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.
Sintaxe: CELLING(nMax)
Parmetros
nMax
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().
Sintaxe: COS(nAngulo)
Parmetros:
nAngulo
Retorno:
Numrico
Situaes invlidas:
Entrada
QNAN,IND
(cosf, cos)
x 7.104760e+002 (cosh, coshf)
Exceo apresentada
None
INVALID
INEXACT+OVERFLOW
Significado da Exceo
Sem Domnio
Sem Domnio
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.
Sintaxe: LOG10(nNatural)
Parmetros:
nNatural
Retorno:
Numrico
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().
Sintaxe: SIN(nAngulo)
Parmetros:
nAngulo
Retorno:
Numrico
Situaes invlidas:
Entrada
QNAN,IND
(senf, sen)
x 7.104760e+002 (senh, senhf)
Exceo apresentada
None
INVALID
INEXACT+OVERFLOW
Significado da Exceo
Sem Domnio
Sem Domnio
OVERFLOW
SQRT()
Funo utilizada para calcular a raiz quadrada de um nmero positivo.
Sintaxe: SQRT(nValor)
Parmetros:
nValor
Retorno:
Numrico
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.
Sintaxe: TAN(nAngulo)
Parmetros:
nAngulo
Retorno:
Numrico
Situaes invlidas:
Entrada
QNAN,IND
Exceo apresentada
None
INVALID
Significado da Exceo
Sem Domnio
Sem Domnio
Anlise de variveis
TYPE()
Determina o tipo do contedo de uma varivel, a qual no foi definida na funo em execuo.
Sintaxe: TYPE(cVariavel)
Parmetros
cVariavel
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.
Sintaxe: VALTYPE(cVariavel)
Parmetros
cVariavel
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
cTexto
nColf
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.
xItem
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
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.
Sintaxe: AADD(aArray)
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.
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.
aDestino
nInicio
nQtde
nPosDestino
Retorno:
aDestino
Exemplo:
LOCAL nCount := 2, nStart := 1, aOne, aTwo
aOne := { 1, 1, 1 }
aTwo := { 2, 2, 2 }
ACOPY(aOne, aTwo, nStart, nCount)
// Result: aTwo is now { 1, 1, 2 }
ADEL()
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.
nPosio
Exemplo:
// Utilizando o array aItens do exemplo da funo ACLONE() temos:
ADEL(aItens,1) // Ser removido o primeiro elemento do array aItens.
//
//
//
//
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().
Parmetros:
cArqEspec
aNomeArq
aTamanho
aData
aHora
aAtributos
Retorno:
nArquivos
Exemplo:
LOCAL aFiles[ADIR("*.TXT")]
ADIR("*.TXT", aFiles)
AEVAL(aFiles, { |element| QOUT(element) })
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.
xExpValor
nInicio
nCount
Retorno:
aDestino
Exemplo:
LOCAL aLogic[3]
// Resultado: aLogic
AFILL(aLogic, .F.)
// Resultado: aLogic
AFILL(aLogic, .T., 2,
// Resultado: aLogic
AINS()
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.
nPosicao
Exemplo:
aAlunos := {Edson, Robson, Renato, Tatiana}
AINS(aAlunos,3)
// Neste ponto o array aAlunos ter o seguinte contedo:
// {Edson, Robson, nulo, Renato, Tatiana}
ARRAY()
A funo Array() utilizada na definio de variveis de tipo array, como uma opo a sintaxe
utilizando chaves ({}).
nColunas
Exemplo:
aDados := Array(3,3) // Cria um array de trs linhas, cada qual com 3 colunas.
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.
Exemplo:
aAlunos := {Mrcio, Denis, Arnaldo, Patrcia}
bSeek := {|x| x == Denis}
nPosAluno := aScan(aAlunos,bSeek) // retorno esperado 2
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.
Sintaxe: ASCANX ( < xDestino > , < bSeek > , [ nInicio ] , [ nCont ] )
Parmetros:
xDestino
bSeek
nInicio
nCont
Exemplo.:
nPos := aScanX( ARRAY, { |X,Y| X[1] == cNome .OR. y<=100})
ASIZE()
A funo ASIZE permite a redefinio da estrutura de um array pr-existente, adicionando ou
removendo itens do mesmo.
nTamanho
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.
ASORT()
A funo ASORT() permite que os itens de um array sejam ordenados a partir de um critrio
pr-estabelecido.
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:
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 )]
Retorno:
nUltimo
Exemplo:
aArray := {"a", "b", "c", "d"}
ATAIL(aArray) // Resultado: d
xParamZ
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.
bFor
bWhile
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():
dbEval({|| AADD(aTabela,{X5_CHAVE,Capital(X5_DESCRI)})},,{|| X5_TABELA==cTabela})
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.
bBloco
nInicio
nFim
Exemplo 01:
Manipulao de strings
ALLTRIM()
Retorna uma string sem os espaos direita e esquerda, referente ao contedo informado
como parmetro.
A funo ALLTRIM() implementa as aes das funes RTRIM (right trim) e LTRIM (left
trim).
Sintaxe: ALLTRIM(cString)
Parmetros
cString
String que ser avaliada para remoo dos espaos a direita e a esquerda.
Exemplo:
cNome := ALLTRIM(SA1->A1_NOME)
MSGINFO(Dados do campo A1_NOME:+CRLF
Tamanho: + CVALTOCHAR(LEN(SA1->A1_NOME))+CRLF
Texto: + CVALTOCHAR(LEN(cNome)))
ASC()
Converte uma informao caractere em seu valor de acordo com a tabela ASCII.
Sintaxe: ASC(cCaractere)
Parmetros
cCaractere
Exemplo:
USER FUNCTION NoAcento(Arg1)
Local nConta := 0
Local cLetra := ""
Local cRet := ""
Arg1 := Upper(Arg1)
For nConta:= 1 To Len(Arg1)
cLetra := SubStr(Arg1, nConta, 1)
Do Case
Case (Asc(cLetra) > 191 .and. Asc(cLetra) < 198) .or.;
(Asc(cLetra) > 223 .and. Asc(cLetra) < 230)
cLetra := "A"
Case (Asc(cLetra) > 199 .and. Asc(cLetra) < 204) .or.;
(Asc(cLetra) > 231 .and. Asc(cLetra) < 236)
cLetra := "E"
Exemplo (continuao):
Case (Asc(cLetra) > 204 .and. Asc(cLetra) < 207) .or.;
(Asc(cLetra) > 235 .and. Asc(cLetra) < 240)
cLetra := "I"
Case (Asc(cLetra) > 209 .and. Asc(cLetra) < 215) .or.;
(Asc(cLetra) == 240) .or. (Asc(cLetra) > 241 .and. Asc(cLetra) < 247)
cLetra := "O"
Case (Asc(cLetra) > 216 .and. Asc(cLetra) < 221) .or.;
(Asc(cLetra) > 248 .and. Asc(cLetra) < 253)
cLetra := "U"
Case Asc(cLetra) == 199 .or. Asc(cLetra) == 231
cLetra := "C"
EndCase
cRet := cRet+cLetra
Next
Return UPPER(cRet)
AT()
Retorna a primeira posio de um caracter ou string dentro de outra string especificada.
cString
Exemplo:
STATIC FUNCTION NOMASCARA(cString,cMascara,nTamanho)
LOCAL cNoMascara
LOCAL nX := 0
:= ""
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.
Sintaxe: BITON ( < cValue > , < nBitIni > , < nBitEnd > , < nStrLen > )
Parmetros
cValue
nBitIni
nBitEnd
nStrLen
CAPITAL()
Funo que avalia a string passada como parmetro alterando a primeira letra de cada palavra
para maiscula e as demais letras como minsculas.
Sintaxe: CAPITAL(cFrase)
Parmetros:
cFrase
Retorno:
String
CHR()
Converte um valor nmero referente a uma informao da tabela ASCII no caractere que esta
informao representa.
Sintaxe: CHR(nASCII)
Parmetros
nASCII
Exemplo:
#DEFINE CRLF CHR(13)+CHR(10) // FINAL DE LINHA
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
Retorno:
Caracter
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.
Parmetros:
cDtoVal
Retorno:
Numrico
Exemplo:
GetDtoVal('123456')
//retorno 123456.0000
GetDtoVal('1/2/3/4/5/6') //retorno 123456.0000
GetDtoVal('fim.123456') //retorno 0.123456
GetDtoVal('teste')
//retorno 0.0
ISALPHA()
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.
Parmetros:
cString
Retorno:
Lgico
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.
Parmetros:
cString
Retorno:
Lgico
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.
Parmetros:
cString
Retorno:
Lgico
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.
Parmetros:
cString
Retorno:
Lgico
LEN()
Retorna o tamanho da string especificada no parmetro.
Sintaxe: LEN(cString)
Parmetros
cString
Exemplo:
cNome := ALLTRIM(SA1->A1_NOME)
MSGINFO(Dados do campo A1_NOME:+CRLF
Tamanho: + CVALTOCHAR(LEN(SA1->A1_NOME))+CRLF
Texto: + CVALTOCHAR(LEN(cNome)))
LOWER()
Retorna uma string com todos os caracteres minsculos, tendo como base a string passada
como parmetro.
Sintaxe: LOWER(cString)
Parmetros
cString
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.
Retorno:
Caracter
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.
Sintaxe: MATHC ( < cNum1 > , < cOperacao > , < cNum2 > )
Parmetros:
cNum1
cOperacao
cNum2
Retorno:
Caracter
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().
Retorno:
Caracter
Sintaxe: PADL / PADR / PADC ( < cExp > , < nTamanho > , [ cCaracPreench ] )
Parmetros
Caractere, data, ou numrico no qual sero inseridos caracteres de
preenchimento.
Tamanho da cadeia de caracteres a ser retornada.
cExp
nTamanho
cCaracPreench
Retorno:
Caracter
RAT()
Retorna a ltima posio de um caracter ou string dentro de outra string especificada.
cString
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.
Parmetros:
cString
nCount
Retorno:
cReplicated
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.
Parmetros:
cString
Retorno:
Caracter
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 > )
Parmetros:
nCont
Retorno:
Caracter
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.
Parmetros:
cValue
cToken
Retorno:
Array
Exemplo:
STRTOKARR('1;2;3;4;5', ';')
//retorna {'1','2','3','4','5'}
STRTRAN()
Funo utilizada para realizar a busca da ocorrncia da string, sendo case sensitive.
Sintaxe: STRTRAN ( < cString > , < cSearch > , [ cReplace ] , [ nStart ] , [
nCount ] )
Parmetros:
cString
cSearch
cReplace
nStart
nCount
Retorno:
Code-Block
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.
Parmetros:
nExcluir
cAdicao
cString
nPosInicial
Retorno:
Caracter
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).
nPosInicial
nCaracteres
Exemplo:
cCampo := A1_NOME
nPosUnder := AT(cCampo)
cPrefixo := SUBSTR(cCampo,1, nPosUnder) // A1_
TRANSFORM()
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.
Parmetros:
cExp
cSayPicture
O valor a ser formatado. Esta expresso pode ser qualquer tipo de dados
vlidos, exceto vetor, bloco de cdigo, e NIL.
Uma string de caracteres de mscara e template usado para descrever o
formato da cadeia de caracteres a ser retornada.
Retorno:
-
UPPER()
Retorna uma string com todos os caracteres maisculos, tendo como base a string passada
como parmetro.
Sintaxe: UPPER(cString)
Parmetros
cString
Exemplo:
cTexto := ADVPL
MSGINFO(Texto:+LOWER(cTexto))
dExp
Retorno:
Nome do dia da semana como uma cadeia de caracteres. A primeira letra
maiscula e as demais minsculas.
cDayWeek
Exemplo:
dData := DATE() // Resultado: 09/01/90
cDiaDaSemana := CDOW(DATE()) // Resultado: Friday
cDiaDaSemana := CDOW(DATE() + 7) // Resultado: Friday
cDiaDaSemana := CDOW(CTOD("06/12/90")) // Resultado: Tuesday
CMONTH()
Funo de converso de datas que retorna uma cadeia de caracteres com o nome do ms em
ingls.
Retorno:
cMonth
Exemplo:
cMes
cMes
cMes
cMes
:=
:=
:=
:=
DATE()
Funo que retorna a data do atual sistema. O formato de sada controlado pelo comando
SET DATE, sendo que o formato padro mm/dd/yy.
Sintaxe: DATE()
Parmetros:
Nenhum
Retorno:
dData
Data do sistema.
Exemplo:
dData := DATE() // Resultado: 09/01/01
dData := DATE() + 30 // Resultado: 10/01/01
dData := DATE() - 30 // Resultado: 08/02/90
dData := DATE()
cMes := CMONTH(dData) // Resultado: September
DAY()
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.
Retorno:
nDias
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
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.
Retorno:
nDia
Exemplo:
dData := DATE() // Resultado: 09/01/01
nDiaDaSemana := DOW(DATE()) // Resultado: 3
cDiaDaSemana := CDOW(DATE()) // Resultado: Tuesday
nDiaDaSemana := DOW(DATE() - 2) // Resultado: 1
cDiaDaSemana := CDOW(DATE() - 2) // Resultado: Sunday
DTOC()
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.
Retorno:
cData
Exemplo:
cData := DATE() // Resultado: 09/01/90
cData := DTOC(DATE()) // Resultado: 09/01/90
cData := "Today is " + DTOC(DATE()) // Resultado: Today is 09/01/90
DTOS()
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).
Retorno:
sData
Exemplo:
cData := DATE() // Resultado: 09/01/90
cData := DTOS(DATE()) // Resultado: 19900901
nLen := LEN(DTOS(CTOD(""))) // Resultado: 8
ELAPTIME()
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.
Retorno:
Caracter
Exemplo:
cHoraInicio := TIME() // Resultado: 10:00:00
...
<instrues>
...
cElapsed := ELAPTIME(TIME(), cHoraInicio)
MONTH()
Funo de converso que extrai da data o valor numrico do ms, semelhante a funo que
retorna o nome do ms a partir do valor de dData.
Retorno:
Numrico
Exemplo:
dData := DATE() // Resultado: 09/01/01
nMes := MONTH(DATE()) // Resultado: 9
nMes := MONTH(DATE()) + 1 // Resultado: 10
SECONDS()
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.
Sintaxe: SECONDS()
Parmetros:
Nenhum
Retorno:
Numrico
Exemplo:
cHora := TIME() // Resultado: 10:00:00
cSegundos := SECONDS() // Resultado: 36000.00
//Este exemplo usa a funo SECONDS() para cronometrar o tempo decorrido:
LOCAL nStart, nElapsed
nStart:= SECONDS()
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.
Sintaxe: TIME()
Parmetros:
Nenhum
Retorno:
Caracter
Exemplo:
cTime := TIME() // Resultado: 10:37:17
cHora := SUBSTR(cTime, 1, 2) // Resultado: 10
cMinutos := SUBSTR(cTime, 4, 2) // Resultado: 37
cSegundos := SUBSTR(cTime, 7, 2) // Resultado: 17
YEAR()
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.
Retorno:
Numrico
Exemplo 01:
dData := DATE() // Resultado: 09/20/01
dAno := YEAR(dData) // Resultado: 2001
dAno := YEAR(dData) + 11 // Resultado: 2012
Exemplo 02:
// Este exemplo cria uma funo de usurio que usa a funo YEAR() para formatar o valor da
// data:
cData := Mdy(DATE()) // Result: September 20, 1990
FUNCTION Mdy( dDate )
RETURN CMONTH(dDate) + " " + LTRIM(STR(DAY(dDate))) + "," + STR(YEAR(dDate))
Sintaxe: ABS(nValor)
Parmetros
nValor
Exemplo:
nPessoas := 20
nLugares := 18
IF nPessoas < nLugares
MSGINFO(Existem +CVALTOCHAR(nLugares- nPessoas)+disponveis)
ELSE
MSGSTOP(Existem +CVALTOCHAR(ABS(nLugares- nPessoas))+faltando)
ENDIF
ALEATORIO()
Gera um nmero aleatrio de acordo com a semente passada. Esta funo retorna um nmero
aleatrio menor ou igual ao primeiro parmetro informado, usando como semente o segundo
parmetro. recomendado que esta semente seja sempre o ltimo nmero aleatrio gerado
por esta funo.
Sintaxe: Aleatorio(nMax,nSeed)
Parmetros
nMax
nSeed
INT()
Retorna a parte inteira de um valor especificado no parmetro.
Sintaxe: INT(nValor)
Parmetros
nValor
Exemplo:
STATIC FUNCTION COMPRAR(nQuantidade)
LOCAL nDinheiro := 0.30
LOCAL nPrcUnit := 0.25
IF nDinheiro >= (nQuantidade*nPrcUnit)
RETURN nQuantidade
ELSEIF nDinheiro > nPrcUnit
nQuantidade := INT(nDinheiro / nPrcUnit)
ELSE
nQuantidade := 0
ENDIF
RETURN nQuantidade
NOROUND()
Retorna um valor, truncando a parte decimal do valor especificado no parmetro de acordo
com a quantidade de casas decimais solicitadas.
nCasas
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 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 .
Parmetros
nMinimo
nMaximo
Retorno:
Numrico
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.
nCasas
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().
Parmetros:
cArqEspec
aNomeArq
aTamanho
aData
aHora
aAtributos
Retorno:
nArquivos
Exemplo:
LOCAL aFiles[ADIR("*.TXT")]
ADIR("*.TXT", aFiles)
AEVAL(aFiles, { |element| QOUT(element) })
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.
Parmetros:
ExpC1
ExpC2
Titilo da Janela
ExpN1
ExpC3
Expl1
.T. para mostrar boto como 'Salvar' e .F. para boto 'Abrir'
ExpN2
ExpL2
GETF_MULTISELECT
GETF_NOCHANGEDIR
GETF_LOCALFLOPPY
GETF_LOCALHARD
GETF_NETWORKDRIVE
GETF_SHAREWARE
No implementado
GETF_RETDIRECTORY
Retorna um diretrio
Exemplo:
cGetFile ( '*.PRW|*.CH'
GETF_LOCALFLOPPY)
'Fontes',
1,
'C:\VER507',
.F.,
GETF_LOCALHARD
Aparncia:
#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
//+--------------------------------------------------------------------+
//| 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
Local
Local
Local
Local
Local
Local
Local
Local
Local
Local
Local
Local
aParamBox := {}
cTitulo
:= "Filtros Adicionais"
aRet := {}
bOk
:= {|| .T.}
aButtons
:= {}
lCentered
:= .T.
nPosx
nPosy
cLoad := ""
lCanSave
:= .F.
lUserSave := .F.
nX
:= 0
lRet := .T.
AADD(aParamBox,{2,"Tipo de arquivo"
,2,{"*.dbf","*.dtc"},100,"AllwaysTrue()",.T.})
lRet := ParamBox(aParamBox, cTitulo, aRet, bOk, aButtons, lCentered, nPosx,
nPosy,, cLoad, lCanSave, lUserSave)
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
//+--------------------------------------------------------------------+
//| 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
//+--------------------------------------------------------------------+
//| 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
//+--------------------------------------------------------------------+
//| 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
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.
Sintaxe: CPYS2T ( < cOrigem > , < cDestino > , [ lCompacta ] )
Parmetros:
cDestino
lCompacta
cOrigem
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.
Sintaxe: CpyT2S( cOrigem, cDestino, [ lCompacta ])
Parmetros:
cDestino
lCompacta
cOrigem
Retorno:
Lgico
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 .
Parmetros:
cNovoPath
Caminho relativo , com o novo diretrio que ser ajustado como corrente.
Retorno:
Caracter
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
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.
Significado
Incluir diretrios
Nota: Arquivos normais so sempre includos na pesquisa, a no ser que V seja especificado.
Metasmbolo
Directry.ch
cNome
F_NAME
cTamanho
F_SIZE
dData
F_DATE
cHora
F_TIME
cAtributos
F_ATT
Parmetros:
cDirSpec
cAtributos>
Retorno:
Array
Exemplo:
#INCLUDE "Directry.ch"
aDirectory := DIRECTORY("*.*","D")
AEVAL( aDirectory, {|aFile| CONOUT(aFile[F_NAME])} )
DIRREMOVE()
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.
Parmetros:
cDiretorio
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().
Exemplo:
cDelPath := 'c:\TmpFiles'
lRemoveOk := DIRREMOVE(cDelPath)
IF !lRemoveOk
MsgStop('Falha ao remover a pasta '+cDelPath+' ( File Error '+str(Fewrror(),4)+' ) ')
Else
MsgStop('Pasta '+cDelPath+' removida com sucesso.')
Endif
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
1
2
3
4
:
:
:
:
:
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
Parmetros:
nDrive
Retorno:
Numrico
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
EXISTDIR()
Funo utilizada para determinar se um path de diretrio existe e valido.
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.
Retorno:
Lgico
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.
Parmetros:
nHandle
Retorno:
Lgico
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
Valor
Descrio
FC_NORMAL
FC_READONLY
FC_HIDDEN
FC_SYSTEM
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.
Parmetros:
cArquivo
nAtributo
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() .
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).
Parmetros:
cArquivo
Retorno:
Numrico
Exemplo:
#include 'DIRECTRY.CH'
aEval(Directory("*.BAK"), { |aFile| FERASE(aFile[F_NAME]) })
// 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.
Parmetros:
cArquivo
Retorno:
Lgico
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")
FILENOEXT()
Funo que retorna o nome de um arquivo contido em uma string, ignorando a extenso.
Parmetros
cString
Exemplo:
Local cString := '\SIGAADV\ARQZZZ.DBF'
cString := FileNoExt( cString )
// Retorno \SIGAADV\ARQZZZ
FOPEN()
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.
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.
Retorno:
Numrico
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
...
Constate(fileio.ch)
Operao
FO_READ
FO_WRITE
FO_READWRITE
Constate(fileio.ch)
Operao
FO_COMPAT
16
FO_EXCLUSIVE
32
FO_DENYWRITE
48
FO_DENYREAD
64
FO_DENYNONE
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.
Sintaxe: FREAD ( < nHandle > , < cBuffer > , < nQtdBytes > )
Parmetros:
nHandle
cBuffer
nQtdBytes
Retorno:
Numrico
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().
Parmetros:
nHandle
nQtdBytes
Retorno:
Caracter
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.
Parmetros:
cOldFile
cNewFile
Retorno:
Numrico
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:
Constate(fileio.ch)
Operao
FS_SET
FS_RELATIVE
FS_END
Parmetros:
nHandle
nOffSet
nOrigem
Retorno:
Numrico
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.
Sintaxe: FT_FEOF( )
Parmetros:
Nenhum
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>.
Parmetros:
nPos
Indica a posio que ser colocado o ponteiro para leitura dos dados no
arquivo.
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>.
Parmetros:
nPos
Indica a posio que ser colocado o ponteiro para leitura dos dados no
arquivo.
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.
Sintaxe: FT_FLASTREC( )
Parmetros:
Nenhum
Retorno:
Numrico
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.
Sintaxe: FT_FREADLN( )
Parmetros:
Nenhum
Retorno:
Caracter
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.
Sintaxe: FT_FRECNO ( )
Parmetros:
Nenhum
Retorno:
Caracter
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.
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.
Retorno:
Numrico
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().
Parmetros:
nHandle
cBuffer
nQtdBytes
Retorno:
Numrico
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)
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
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.
Parmetros:
cArqOrig
cArqDest
Retorno:
Lgico
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.
Parmetros:
cArqOrig
cArqDest
Retorno:
Lgico
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.
Parmetros:
cArquivo
Nome do arquivo.
aStruct
Estrutura do arquivo.
cDriver
RDD do arquivo.
Retorno:
Lgico
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.
Parmetros:
cArquivo
cIndice
cDriver
Retorno:
Lgico
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
MSRENAME()
Funo que verifica a existncia do arquivo especificado.
Parmetros:
cArquivo
cIndice
cDriver
Retorno:
Lgico
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.
Parmetros:
cArquivo
Retorno:
Caracter
Exemplo:
Local cArquivo := '\SIGAADV\ARQZZZ.DBF'
cArquivo := RetFileName( cArquivo )
// retorno ARQZZZ
Sintaxe: CriaTrab(aArray,lDbf)
Parmetros:
Array multidimensional contendo a estrutura de campos da tabela que ser
criada no formato: {Nome, Tipo, Tamanho, Decimal}
Determina se o arquivo de trabalho deve ser criado ( .T.) ou no (.F. )
aArray
lDbf
Retorno:
Caracter
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
Parmetros:
nAreaTrabalho
Retorno:
Caracter
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:
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.
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.)
Parmetros:
Nenhum
Retorno:
Lgico
Lgico
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 ) .
A tabela de destino dos dados copiados criada, e aberta em modo exclusivo, antes da
operao de cpia efetiva ser iniciada.
Elemento do Arquivo
Formato
T ou F
(campo ignorado)
Delimitador de Campos
Nenhum
Separador de Registros
Nenhum
Elemento do Arquivo
Formato
T ou F
(campo ignorado)
Delimitador de Campos
Vrgula
Separador de Registros
Nenhum
Sintaxe:
Parmetros:
FIELDS <campo,...>
TO cFile
cEscopo
WHILE <lCondicao>
FOR <lCondicao>
[SDF|DELIMITED]
VIA <cDriver>
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'
Sintaxe:
Parmetros:
TO <xcDataBase>
Retorno:
.
Nenhum
DBAPPEND()
Parmetros:
lLiberaBloqueios
Retorno:
Nenhum
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.
Sintaxe: DBCLEARALLFILTER()
Parmetros:
Nenhum
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
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.
Sintaxe: DBCLEARFILTER()
Parmetros:
Nenhum
Retorno:
Nenhum
Exemplo:
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.
Sintaxe: DBCLEARINDEX()
Parmetros:
Nenhum
Retorno:
Nenhum
Exemplo:
USE Clientes NEW
DBSETINDEX("Nome") // Abre o arquivo de ndice "Nome"
...
DBCLEARINDEX()
// Fecha todos os arquivos de ndices
DBCLOSEALL()
A funo DBCLOSEALL() salva as atualizaes pendentes,
bloqueados e fecha todas as tabelas abertas (reas
chamasse DBCLOSEAREA para cada rea de trabalho.
Sintaxe: DBCLOSEALL()
Parmetros:
Nenhum
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().
Sintaxe: DBCLOSEAREA()
Parmetros:
Nenhum
Retorno:
Nenhum
Exemplo:
DbUserArea(.T., DBFCDX, \SA1010.DBF, SA1DBF, .T., .F.)
DbSelectArea(SA1DBF)
MsgInfo(A tabela SA1010.DBF possui: + STRZERO(RecCount(),6) + registros.)
DbCloseArea()
DBCOMMIT()
A funo DBCOMMIT() salva em disco todas as atualizaes pendentes na rea de
trabalho corrente.
Sintaxe: DBCOMMIT()
Parmetros:
Nenhum
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.
Sintaxe: DBCOMMITALL()
Parmetros:
Nenhum
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}.
Parmetros:
cNOME
aESTRUTURA
Nome da RDD a ser utilizado para a criao da tabela. Se for omitido ser
criada com a corrente.
cDRIVER
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
total do campo numrico e 'dec' o nmero de decimais, ocorre este erro se:
(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).
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:
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.
Sintaxe:
Parmetros:
DBCREATEINDEX(<cNOME>,
[lUNICO])
<cEXPCHAVE>,
[bEXPCHAVE],
cNOME
cEXPCHAVE
bEXPCHAVE
lUNICO
Retorno:
Nenhum
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().
Sintaxe: DBDELETE ( )
Parmetros:
Nenhum
Retorno:
Nenhum
Exemplo:
DbSelectArea(SA1)
DbSetOrder(1) // A1_FILIAL + A1_COD + A1_LOJA
DbSeek(01 + 900001 + 01) // Busca exata
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
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.
Sintaxe: DBF()
Parmetros:
Nenhum
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:
Descrio
Retorno
DBS_NAME
Nome do campo.
Caracter
DBS_DEC
Numrico
DBS_LEN
Tamanho.
Numrico
DBS_TYPE
Tipo.
Caracter
Parmetros:
nINFOTIPO
nCAMPO
Retorno:
Indefinido
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.
Sintaxe: DBFILTER()
Parmetros:
Nenhum
Retorno:
Caracter
Exemplo:
USE Cliente INDEX Ind1 NEW
SET FILTER TO Nome > "Jose"
DBFILTER() // retorna: Nome > "Jose"
SET FILTER TO Num < 1000
DBFILTER() // retorna: Num < 1000
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.
Sintaxe: DbGoto(nRecno)
Parmetros
nRecno
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.
Sintaxe: DbGoTop()
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
DBGOBOTTON()
Move o cursor da rea de trabalho ativa para o ltimo registro lgico.
Sintaxe: DbGoBotton()
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:
Descrio
Retorno
DBI_GETRECSIZE
Numrico
DBI_TABLEEXT
Caracter
DBI_FULLPATH
Caracter
DBI_BOF
Lgico
DBI_EOF
Lgico
DBI_FOUND
Lgico
DBI_FCOUNT
Numrico
DBI_ALIAS
DBI_LASTUPDATE
da
de trabalho
Caracter
Data
Sintaxe: DBINFO(<nINFOTIPO>)
Parmetros:
nINFOTIPO
Retorno:
Indefinido
Exemplo:
USE Clientes NEW
DBINFO(DBI_FULLPATH) // Retorno: C:\Teste\Clientes.dbf
DBINFO(DBI_FCOUNT) // Retorno: 12
DBGOTOP()
DBINFO(DBI_BOF) // Retorno: .F.
DBSKIP(-1)
DBINFO(DBI_BOF) // Retorno: .T.
DBNICKINDEXKEY()
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.
Sintaxe: DBNICKINDEXKEY(<cNick>)
Parmetros:
cNick
Retorno:
Caracter
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:
Descrio
Retorno
DBOI_BAGNAME
Caracter
DBOI_FULLPATH
Caracter
DBOI_ORDERCOUNT
Caracter
Sintaxe: DBORDERINFO(<nINFOTIPO>)
Parmetros:
nINFOTIPO
Retorno:
Caracter
Exemplo:
DBORDERINFO(DBOI_BAGNAME) // retorna: Ind
DBORDERINFO(DBOI_FULLPATH) // retorna: C:\AP6\Teste\Ind.cdx
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.
Sintaxe: DBORDERNICKNAME(<cAPELIDO>)
Parmetros:
cAPELIDO
Retorno:
Lgico
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.
Sintaxe: __DBPACK()
Parmetros:
Nenhum
Retorno:
Nenhum
Exemplo:
USE Clientes NEW
DBGOTO(100)
DBDELETE()
DBGOTO(105)
DBDELETE()
DBGOTO(110)
DBDELETE()
// Se a excluso for confirmada:
__DBPACK()
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.
Sintaxe: DBRECALL()
Parmetros:
Nenhum
Retorno:
Nenhum
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:
Descrio
Retorno
DBRI_DELETED
Lgico
DBRI_RECSIZE
Numrico
Lgico
DBRI_UPDATED
Parmetros:
nINFOTIPO
nREGISTRO
Retorno:
Indefinido
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.
Sintaxe: DBREINDEX()
Parmetros:
Nenhum
Retorno:
Nenhum
Exemplo:
USE Clientes NEW
DBSETINDEX("IndNome")
DBREINDEX()
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.
Sintaxe: DBRLOCK([nREGISTRO])
Parmetros:
nREGISTRO
Retorno:
Lgico
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.
Sintaxe: DBRLOCKLIST()
Parmetros:
Nenhum
Retorno:
Array
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.
Sintaxe: DBRUNLOCK([nREGISTRO])
Parmetros:
Nmero do registro a ser desbloqueado.
nREGISTRO
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.
Sintaxe: DBSETDRIVER([cNOVORDD])
Parmetros:
cNOVORDD
Retorno:
Caracter
Exemplo:
DBSETDRIVER("CTREECDX") // Retorna: DBFCDX
DBSETDRIVER() // Retorna: CTREECDX
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.
Sintaxe: DBSETINDEX(<@cARQINDICE>)
Parmetros:
cARQINDICE
Retorno:
Nenhum
Exemplo:
USE Cliente NEW
DBSETINDEX("Ind1")
DBSETINDEX("\teste\Ind2.cdx")
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.
Parmetros:
cINDICE
cAPELIDO
Retorno:
Caracter
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.
nArea
cArea
Sintaxe: DbSetOrder(nOrdem)
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.
Sintaxe: DbOrderNickName(NickName)
Parmetros
NickName
Exemplo:
DbSelectArea(SA1)
DbOrderNickName(Tipo) // De acordo com o arquivo SIX -> A1_FILIAL+A1_TIPO
NickName: Tipo
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.
cChave
lSoftSeek
lLast
Sintaxe: DbSkip(nRegistros)
Parmetros
nRegistros
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.
cCondicao
DBSTRUCT()
Retorna um array contendo a estrutura da rea de trabalho (alias) ativo. A estrutura ser um
array bidimensional conforme abaixo:
ID*
Nome campo
Tipo campo
Tamanho
Decimais
*ndice do array
Sintaxe: DbStruct()
Parmetros
Nenhum
Exemplo:
cCampos :=
DbSelectArea(SA1)
aStructSA1 := DbStruct()
FOR nX := 1 to Len(aStructSA1)
cCampos += aStructSA1[nX][1] + /
NEXT nX
ALERT(cCampos)
DBUNLOCK()
A funo DBUNCLOK() retira os bloqueios dos registros e do arquivo da tabela corrente.
Sintaxe: DBUNLOCK()
Parmetros:
Nenhum
Retorno:
Nenhum
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.
Sintaxe: DBUNLOCKALL()
Parmetros:
Nenhum
Retorno:
Nenhum
DBUSEAREA()
Define um arquivo de base de dados como uma rea de trabalho disponvel na aplicao.
Sintaxe: DbUseArea(lNovo, cDriver, cArquivo, cAlias, lComparilhado,;
lSoLeitura)
Parmetros
lNovo
cDriver
cArquivo
cAlias
lComparilhado
lSoLeitura
Exemplo:
DbUserArea(.T., DBFCDX, \SA1010.DBF, SA1DBF, .T., .F.)
DbSelectArea(SA1DBF)
MsgInfo(A tabela SA1010.DBF possui: + STRZERO(RecCount(),6) + registros.)
DbCloseArea()
DELETED()
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.
Sintaxe: DELETED()
Parmetros:
Nenhum
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.
Sintaxe: FCOUNT()
Parmetros:
Nenhum
Retorno:
Numrico
Exemplo:
DbSelectArea(SA1)
nFields := FCOUNT()
IF nFields > 0
MSGINFO(A estrutura da tabela contm :+CvalToChar(nFields)+campos.)
ENDIF
FOUND()
A funo FOUND() recupera o resultado de sucesso referente a ltima operao de busca
efetuada pelo processamento corrente.
Sintaxe: FOUND()
Parmetros:
Nenhum
Retorno:
Lgico
Exemplo:
Pergunte(cPerg,.T.)
DbSelectArea(SA1)
DbSetOrder(1)
DbSeek(xFilial(SA1)+MVPAR01)
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.
Sintaxe: INDEXKEY()
Parmetros:
nOrdem
Retorno:
Caracter
Exemplo:
cExpressao := SA1->(IndexKey())
INDEXORD()
A funo INDEXORD() verifica a posio do ndice corrente na lista de ndices do respectivo
alias.
Sintaxe: INDEXORD()
Parmetros:
Nenhum
Retorno:
Numrico
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.
Sintaxe: LUPDATE()
Parmetros:
Nenhum
Retorno:
Data
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
MSAPPEND()
A funo MsAppend() adiciona registros de um arquivo para outro, respeitando a estrutura das
tabelas.
Parmetros:
cArqDest
cArqOrig
Retorno:
Lgico
Exemplo:
dbSelectArea(XXX)
MsAppend(,ARQ00001)
MSUNLOCK()
Libera o travamento (lock) do registro posicionado confirmando as atualizaes efetuadas
neste registro.
Sintaxe: MsUnLock()
Parmetros
Nenhum
Exemplo:
DbSelectArea(SA1)
DbSetOrder(1) // A1_FILIAL + A1_COD + A1_LOJA
DbSeek(01 + 900001 + 01) // Busca exata
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
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.
Sintaxe: ORDBAGEXT()
Parmetros:
Nenhum
Retorno:
cBagExt
Exemplo:
cArqTRB := CriaTrab(aStruTRB,.T.)
// RDD UTILIZADA: DBFCDXADS
DbUseArea(.T., DBFCDXADS, cArqTRB, "TRBSA1", .F., .F.)
DbSelectArea("TRBSA1")
cArqInd := CriaTrab(Nil,.F.)
IndRegua("TRBSA1",cArqInd,cChaveInd,,"","Selecionando registros ...")
#IFNDEF TOP
DbSetIndex(cArqInd+OrdBagExt())
// RETORNO: .CDX
#ENDIF
DbSetOrder(1)
ORDKEY()
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.
Parmetros:
cOrdem
nPosicao
cArqIndice
Retorno:
Caracter
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.
Sintaxe: RecLock(cAlias,lInclui)
Parmetros
cAlias
lInclui
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
Exemplo 02 - Alterao
DbSelectArea(SA1)
DbSetOrder(1) // A1_FILIAL + A1_COD + A1_LOJA
DbSeek(01 + 900001 + 01) // Busca exata
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
RECNO()
A funo RECNO() retorna o nmero do registro atualmente posiconado na rea de trabalho
ativa.
Sintaxe: RECNO()
Parmetros:
Nenhum
Retorno:
nRecno
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.
Sintaxe: SELECT([cAlias])
Parmetros:
cAlias
Retorno:
Numrico
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.
Parmetros:
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.
cCondicao
Retorno:
Nenhum
Exemplo:
USE Employee INDEX Name NEW
SET FILTER TO Age > 50
LIST LastName, FirstName, Age, Phone
SET FILTER TO
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.
Sintaxe: SoftLock(cAlias)
Parmetros
cAlias
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
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.
Sintaxe: USED()
Parmetros:
Nenhum
Retorno:
Lgico
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.
Sintaxe: ZAP
Parmetros:
Nenhum
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
cCampo
cAliasSXE
nOrdem
CONFIRMSXE()
Confirma o nmero alocado atravs do ltimo comando GETSXENUM().
Sintaxe: CONFIRMSXE(lVerifica)
Parmetros
lVerifica
ROLLBACKSXE()
Descarta o nmero fornecido pelo ltimo comando GETSXENUM(), retornando a numerao
disponvel para outras conexes.
Sintaxe: ROLLBACKSXE()
Parmetros
Nenhum
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.
Sintaxe: ALLWAYSFALSE()
Parmetros:
Nenhum
Retorno:
Lgico
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.
Sintaxe: ALLWAYSTRUE()
Parmetros:
Nenhum
Retorno:
Lgico
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.
cConteudo
nIndice
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.
cAlias
cConteudo
nIndice
LETTERORNUM()
A funo LETTERORNUM() avalia se um determinado contedo composto apenas de letras e
nmeros (alfanumrico).
Sintaxe: LETTERORNUM(cString)
Parmetros:
cString
Retorno:
Lgico
NAOVAZIO()
Retorna .T. ou .F. se o contedo do campo posicionado no momento no est vazio.
Sintaxe: NaoVazio()
Parmetros
Nenhum
NEGATIVO()
Retorna .T. ou .F. se o contedo digitado para o campo negativo.
Sintaxe: Negativo()
Parmetros
Nenhum
.
- 332 Guia de Referncia Rpida
ADVPL Intermedirio
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().
Sintaxe: Pertence(cString)
Parmetros
cString
POSITIVO()
Retorna .T. ou .F. se o contedo digitado para o campo positivo.
Sintaxe: Positivo()
Parmetros
Nenhum
TEXTO()
Retorna .T. ou .F. se o contedo digitado para o campo contm apenas nmeros ou
alfanumricos.
Sintaxe: Texto()
Parmetros
Nenhum
VAZIO()
Retorna .T. ou .F. se o contedo do campo posicionado no momento est vazio.
Sintaxe: Vazio()
Parmetros
Nenhum
Sintaxe: GETMV(cParametro)
Parmetros
cParametro
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.
cParametro
cPadrao
cFilial
Define para qual filial ser efetuada a consulta do parmetro. Padro filial
corrente da conexo.
PUTMV()
Atualiza o contedo do parmetro especificado no arquivo SX6, de acordo com as
parametrizaes informadas.
cConteudo
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.
cParametro
lHelp
cPadrao
cFilial
Define para qual filial ser efetuada a consulta do parmetro. Padro filial
corrente da conexo.
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().
Sintaxe: AVALIMP(nLimite)
Parmetros:
nLimite
Retorno:
Caracter
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
LOCAL
LOCAL
LOCAL
LOCAL
LOCAL
LOCAL
LOCAL
LOCAL
LOCAL
LOCAL
LOCAL
cTitulo
cDesc1
cDesc2
cDesc3
cTamanho
cLimite
cNatureza
aReturn
cNomeProg
cPerg
nLastKey
cString
:= PADC(AVALIMP,74)
:= PADC(Demonstrao do uso da funo AVALIMP(),74)
:=
:= PADC(CURSO DE ADVPL,74)
:= G
:= 220
:=
:= {Especial, 1,Administrao, 1, 2, 2,,1}
:= RAVALIMP
:= PADR(RAVALIMP,10) // Compatibilizao com MP10
:= 0
:=SF2"
Exemplo (continuao):
If nLastKey == 27
Return
Endif
RptStatus({|| RunReport(cString)},cTitulo)
Return
/*/
+----------------------------------------------------------------------------| Funo
| RUNREPORT
| Autor | -------------------- | Data | 01.01.2007 |
+----------------------------------------------------------------------------| Descrio | Funo interna de processamento utilizada pela XAVALIMP()
|
|+---------------------------------------------------------------------------| Uso
| Curso ADVPL
|
|+---------------------------------------------------------------------------/*/
Static Function RunReport(cString)
SetPrc(0,0)
//+-------------------------------------------------------------------------+
//| Chamada da funo AVALIMP()
|
//+-------------------------------------------------------------------------+
@ 00,00 PSAY AvalImp(220)
dbSelectArea(cString)
dbSeek(xFilial()+mv_par01+mv_par03,.T.)
...
Return
CABEC()
A funo CABEC() determina as configuraes de impresso do relatrio e imprime o cabealho
do mesmo.
Sintaxe: Cabec(cTitulo, cCabec1, cCabec2, cNomeProg, nTamanho, nCompress,
aCustomText, lPerg, cLogo)
Parmetros:
cTitulo
Ttulo do relatrio
cCabec1
cCabec2
cNomeProg
nTamanho
nCompress
aCustomText
lPerg
Parmetros (continuao):
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"
cLogo
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
Local
Local
Local
Local
cDesc1
cDesc2
cDesc3
cTitulo
lImprime
:=
:=
:=
:=
:=
// 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
Default lCriaTrab := .T.
Private lEnd
:= .F.
Private lAbortPrint
:= .F.
Private aReturn
:= { "Zebrado", 1, "Administracao", 2, 2, 1, "", 1}
//aReturn[4] 1- Retrato, 2- Paisagem
//aReturn[5] 1- Em Disco, 2- Via Spool, 3- Direto na Porta, 4- Email
Private nLastKey
Private m_pag
Private wnrel
:= 0
:= 01
:= "MPTR002"
dbSelectArea("SA1")
dbSetOrder(1)
Exemplo (continuao):
//
// Monta a interface padrao com o usuario...
//
wnrel :=
SetPrint(cString,cNomeProg,cPerg,@cTitulo,cDesc1,cDesc2,cDesc3,lDic,aOrd,lCompre
s,cTamanho,,lFilter)
If nLastKey == 27
Return
Endif
SetDefault(aReturn,cString,,,cTamanho,aReturn[4]) // nFormato: 1- Retrato, 2Paisagem
If nLastKey == 27
Return
Endif
nTipo := IIF(aReturn[4]==1,15,18)
//
// 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
Local
Local
Local
nLin
cCabec1
cCabec2
cArqInd
cCabec1
cCabec1
cCabec1
cCabec2
:=
+=
+=
:=
:= 80
:= ""
:= ""
"CODIGO"+Space(2)+"LOJA"+Space(2)+"NOME REDUZIDO"+Space(9)
"RAZAO SOCIAL"+Space(30)+"CNPJ"+Space(18)+"INSCR.ESTADUAL"+Space(8)
"CEP"
"ESTADO"+Space(2)+"MUNICIPIO"+Space(8)+"ENDERECO"
dbSelectArea("TRBSA1")
dbGoTop()
SetRegua(RecCount())
Exemplo (continuao):
While !EOF()
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.
Parmetros:
cCab1
cCab2
cCab3
cNomeProg
Nome do programa
cTam
nLimite
cAlias
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().
Sintaxe: MS_FLUSH()
Parmetros:
Nenhum
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
Local
Local
Local
nLin
cCabec1
cCabec2
cArqInd
cCabec1
cCabec1
cCabec1
cCabec2
:=
+=
+=
:=
:= 80
:= ""
:= ""
"CODIGO"+Space(2)+"LOJA"+Space(2)+"NOME REDUZIDO"+Space(9)
"RAZAO SOCIAL"+Space(30)+"CNPJ"+Space(18)+"INSCR.ESTADUAL"+Space(8)
"CEP"
"ESTADO"+Space(2)+"MUNICIPIO"+Space(8)+"ENDERECO"
dbSelectArea("TRBSA1")
dbGoTop()
SetRegua(RecCount())
While !EOF()
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++
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.
Sintaxe: OURSPOOL(cArquivo)
Parmetros:
cArquivo
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.
Parmetros:
uPar01
No mais utilizado
uPar02
No mais utilizado
cSize
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"
PRIVATE aReturn := { "Zebrado", 1,"Administracao", 1, 2, 1, "",1 }
wnrel:=SetPrint(cString,NomeProg,"",@titulo,"", "", "",.F.,.F.,.F.,Tamanho,,.F.)
SetDefault(aReturn,cString)
RptStatus({|lEnd| TestRel(@lEnd,wnRel,cString,Tamanho,NomeProg)},titulo)
Return
Exemplo (continuao):
/*/
+----------------------------------------------------------------------------| Funo
| TESTREL
| Autor | MICROSIGA
| Data | 01.01.2007 |
+----------------------------------------------------------------------------| Descrio | Funo interna de impresso da TestImpr().
|
|+---------------------------------------------------------------------------| Uso
| Curso ADVPL
|
|+---------------------------------------------------------------------------/*/
User Function TestRel(lEnd,WnRel,cString,Tamanho,NomeProg)
LOCAL
LOCAL
Local
Local
cabec1,cabec2
cRodaTxt := oemtoansi("Rodap")
nCntImpr
nTipo
nCntImpr := 0
li := 80
m_pag := 1
nTipo := 15
titulo:= oemtoansi("Lista de Clientes")
cabec1:= oemtoansi("COD LOJA NOME"+Space(27)+ "NOME FANTASIA")
cabec2:=""
dbSelectArea("SA1")
dbGoTop()
SetRegua(LastRec())
While !Eof()
IncRegua()
If Li > 60
cabec(titulo,cabec1,cabec2,nomeprog,tamanho,15)
@ Li,0 PSAY __PrtThinLine()
Endif
nCntImpr++
Li++
@ Li,01 PSAY A1_COD
@ Li,05 PSAY A1_LOJA
@ Li,10 PSAY A1_NOME
@ Li,51 PSAY A1_NREDUZ
If Li > 60
Li:=66
Endif
dbSkip()
EndDO
If li != 80
Roda(nCntImpr,cRodaTxt,Tamanho)
EndIf
Set Device to Screen
If aReturn[5] = 1
Set Printer To
dbCommitAll()
OurSpool(wnrel)
Endif
MS_FLUSH()
Return
- 344 Guia de Referncia Rpida
ADVPL Intermedirio
SETDEFAULT()
A funo SetDefault() prepara o ambiente de impresso de acordo com as informaes
configuradas no array aReturn, obtidas atravs da funo SetPrint().
Sintaxe:
Parmetros:
aReturn
Configuraes de impresso.
cAlias
uParm3
Parmetro reservado.
uParm4
Parmetro reservado.
cSize
nFormat
Retorno:
Nenhum
Estrutura aReturn:
aReturn[1]
aReturn[2]
aReturn[3]
Caracter, destinatrio
aReturn[4]
aReturn[5]
aReturn[6]
aReturn[7]
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().
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.
Parmetros:
nLinha
nColuna
Retorno:
Nenhum
Exemplo:
aReturn := { "", 1, "" , 2, 3, cPorta , "",IndexOrd() }
SetPrint(Alias(),"","","",,,,.F.,,,,,,,'EPSON.DRV',.T.,,cPorta)
if nLastKey == 27
Return (.F.)
Endif
SetDefault(aReturn,Alias())
SetPrc(0,0)
SETPRINT()
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:
m_pag: controla o nmero de pginas.
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().
Sintaxe: SetPrint ( < cAlias > , < cProgram > , [ cPergunte ] , [ cTitle ] , [
cDesc1 ] , [ cDesc2 ] , [ cDesc3 ] , [ lDic ] , [ aOrd ] , [ lCompres ] , [
cSize ] , [ uParm12 ] , [ lFilter ] , [ lCrystal ] , [ cNameDrv ] , [
uParm16 ] , [ lServer ] , [ cPortPrint ] ) --> cReturn
Parmetros:
cAlias
cProgram
cPergunte
cTitle
Ttulo do relatrio.
Parmetros (continuao):
cDesc1
Descrio do relatrio.
cDesc2
cDesc3
lDic
aOrd
Ordem(s) de impresso.
lCompres
cSize
uParm12
Parmetro reservado
lFilter
lCrystal
cNameDrv
uParm16
Parmetro reservado.
lServer
cPortPrint
Retorno:
Caracter
Nome do Relatrio
Estrutura aReturn:
aReturn[1]
aReturn[2]
aReturn[3]
Caracter, destinatrio
aReturn[4]
aReturn[5]
aReturn[6]
aReturn[7]
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().
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..
Sintaxe: ABREEXCL(cAlias)
Parmetros:
cAlias
Retorno:
Lgico
CLOSEOPEN()
A funo CLOSEOPEN() utilizada para fechar e re-abrir uma lista de arquivos especificada.
Parmetros:
aClose
aOpen
Retorno:
Lgico
CLOSESFILE()
A funo CLOSESFILE() fecha todos os arquivos em uso pela conexo, com exceo dos SXs
(inclusive SIX), SM2 e SM4.
Sintaxe: CLOSESFILE(cAlias)
Parmetros:
cAlias
String contendo os nomes dos demais Aliases que no devero ser fechados,
separando os itens com /.
Retorno:
Lgico
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.
Sintaxe: ChkFile(cAlias,lExcl,cNewAlias)
Parmetros:
cAlias
lExcl
cNewAlias
Retorno:
Lgico
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
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.
Sintaxe: CONOUT(cMensagem)
Parmetros:
String contendo a mensagem que dever ser exibida no console do
Protheus.
cMensagem
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.
Sintaxe: CriaVar(cCampo,lIniPad,cLado)
Parmetros:
cCampo
Nome do campo
lIniPad
cLado
Retorno:
Indefinido
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.
Sintaxe: DISARMTRANSACTION()
Parmetros:
Nenhum
Retorno:
Nenhum
Exemplo:
lMsErroAuto := .F.
MSExecAuto({|x,y| MATA240(x,y)}, aCampos, 3)
If lMsErroAuto
aAutoErro := GETAUTOGRLOG()
DisarmTransaction()
MostraErro()
EndIf
finalizar
EXECBLOCK()
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.
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.
Sintaxe: EXISTBLOCK(cFuno)
Parmetros:
cFuno
Retorno:
Lgico
Exemplo:
IF EXISTBLOCK(MT100GRV)
EXECBLOCK(MT100GRV,.F.,.F.,aParam)
ENDIF
Parmetros:
cFuno
lReserv1
lReserv2
xParam
Retorno:
Indefinido
Exemplo:
aParam := {cNota, cSerie, cFornece, cLoja)
IF EXISTBLOCK(MT100GRV)
lGravou := EXECBLOCK(MT100GRV,.F.,.F.,aParam)
ENDIF
USER FUNCTION MT100GRV()
LOCAL
LOCAL
LOCAL
LOCAL
cNota := PARAMIXB[1]
cSerie:= PARAMIXB[1]
cFornece:= PARAMIXB[1]
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:
{ |<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,
- 353 Guia de Referncia Rpida
ADVPL Intermedirio
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.)
PRIVATE lRet:=.T.
cVarOutMod := If(Type("cVarOutMod") = "U", "", cVarOutMod)
cOutMod
:= cVarOutMod + If(Right(cVarOutMod, 1) = ",", "", ",")
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
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.
Parmetros:
cMensagem1
Primeira mensagem
cMensagem2
Segunda mensagem
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.
Sintaxe: FINDFUNCTION(cFuno)
Parmetros:
cFuno
Retorno:
Lgico
FUNDESC()
A funo FunDesc() retornar a descrio de uma opo selecionada no menu da aplicao.
Sintaxe: FUNDESC()
Parmetros:
Nenhum
Retorno:
Caracter
FUNNAME()
A funo FunName() retornar o nome de uma funo executada a partir de um menu da
aplicao.
Sintaxe: FUNNAME()
Parmetros:
Nenhum
Retorno:
Caracter
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()).
Sintaxe: GETAREA()
Retorno: Array contendo {Alias(),IndexOrd(),Recno()}
Parmetros
Nenhum
GETCOUNTRYLIST()
A funo GETCOUNTRYLIST() retorna um array de duas dimenses contendo informaes dos
pases localizados.
Sintaxe: GetCountryList()
Parmetros:
Nenhum
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.
Parmetros:
cIsInCallStack
cStackExit
Retorno:
Lgico
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.
Parmetros:
cAlias
lInclui
Alias do arquivo que ser utilizado como referncia para inicializao das
variveis de memria.
Identifica se as variveis devero ser inicializadas com contedos padres,
ou contendo as informaes do registro posicionado do alias especificado.
Retorno:
Nenhum
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.
Sintaxe: RESTAREA(aArea)
Parmetros
Array contendo: {cAlias, nOrdem, nRecno}, normalmente gerado pelo
uso da funo GetArea().
aArea
Exemplo:
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.
Sintaxe: USEREXCEPTION(cMensagem)
Parmetros:
cMensagem
Retorno:
- 359 Guia de Referncia Rpida
ADVPL Intermedirio
Nenhum
Parmetros:
cPerg
aPergs
Retorno:
Nenhum
Campo
X1_PERGUNT
X1_PERSPA
X1_PERENG
X1_VARIAVL
Tipo
Caractere
Caractere
Caractere
Caractere
05
06
07
X1_TIPO
X1_TAMANHO
X1_DECIMAL
Caractere
Numrico
Numrico
08
X1_PRESEL
Numrico
09
X1_GSC
Caractere
10
11
X1_VALID
X1_VAR01
Caractere
Caractere
12
X1_DEF01
Caractere
13
14
15
X1_DEFSPA1
X1_DEFENG1
X1_CNT01
Caractere
Caractere
Caractere
16
17
X1_VAR02
X1_DEF02
Caractere
Caractere
18
19
20
21
22
X1_DEFSPA2
X1_DEFENG2
X1_CNT02
X1_VAR03
X1_DEF03
Caractere
Caractere
Caractere
Caractere
Caractere
Descrio
Descrio da pergunta em portugus
Descrio da pergunta em espanhol
Descrio da pergunta em ingls
Nome da varivel de controle auxiliar
(mv_ch)
Tipo do parmetro
Tamanho do contedo do parmetro
Nmero de decimais para contedos
numricos
Define qual opo do combo a padro para
o parmetro.
Define se a pergunta ser do tipo G Get ou
C Choice (combo)
Expresso de validao do parmetro
Nome da varivel MV_PAR+Ordem do
parmetro
Descrio da opo 1 do combo em
portugus
Descrio da opo 1 do combo em espanhol
Descrio da opo 1 do combo em ingls
Contedo padro ou ultimo contedo
definido como respostas para a pergunta.
No informado
Descrio da opo X do combo em
portugus
Descrio da opo X do combo em espanhol
Descrio da opo X do combo em ingls
No informado
No informado
Descrio da opo X do combo em
portugus
X1_DEFSPA3
X1_DEFENG3
X1_CNT03
X1_VAR04
X1_DEF04
Caractere
Caractere
Caractere
Caractere
Caractere
28
29
30
31
32
X1_DEFSPA4
X1_DEFENG4
X1_CNT04
X1_VAR05
X1_DEF05
Caractere
Caractere
Caractere
Caractere
Caractere
33
34
35
36
X1_DEFSPA5
X1_DEFENG5
X1_CNT05
X1_F3
Caractere
Caractere
Caractere
Caractere
37
X1_GRPSXG
Caractere
38
X1_PYME
Caractere
39
40
X1_HELP
X1_PICTURE
Caractere
Caractere
41
aHelpPor
Array
42
aHelpEng
Array
43
aHelpSpa
Array
ALLUSERS()
A funo ALLUSERS() retorna um array multidimensional contendo as informaes dos
usurios do sistema.
Sintaxe: ALLUSERS()
Parmetros:
.
Nenhum
Retorno:
Array multidimensional contendo as informaes dos usurios do sistema,
aonde para cada usurio sero demonstradas as seguintes informaes:
Array
Descrio
Tipo
Qtd.
ID
Nome
15
Senha
Nome Completo
30
--
Data de validade
10
--
11
ID do superior
12
Departamento
30
13
Cargo
30
14
130
15
16
17
Usurio bloqueado
18
19
Listner de ligaes
20
Ramal
Descrio
Tipo
Qtd.
--
Idioma
Diretrio
100
Impressora
--
Acessos
512
--
Ponto de entrada
10
Tipo de impresso
Formato
10
Ambiente
11
12
Opo de impresso
50
13
Descrio
Tipo
Mdulo+nvel+menu
3
1
Qtd.
ALLGROUPS()
A funo ALLGROUPS() retorna um array multidimensional contendo as informaes dos
grupos de usurios do sistema.
Sintaxe: ALLGROUPS()
Parmetros:
.
Nenhum
Retorno:
Array multidimensional contendo as informaes dos grupos de usurios do
sistema, aonde para cada grupo sero demonstradas as seguintes
informaes:
Array
Descrio
Tipo
Qtd.
ID
Nome
20
Data de validade
Idioma
Diretrio
100
Impressora
10
Acessos
11
12
13
Tipo de impresso
14
Formato
15
Ambiente
16
Opo de impresso
17
8
4
512
Descrio
Tipo
Modulo+nvel+menu
2
1
Qtd.
CGC()
A funo CGC() valida o CGC digitado, utilizando o algoritmo nacional para verificao do dgito
de controle.
Sintaxe: CGC(cCGC)
Parmetros:
cCGC
Retorno:
Lgico
CONPAD1()
A funo CONPAD1() exibe uma tela de consulta padro baseada no Dicionrio de Dados
(SXB).
Parmetros:
uPar
Parmetro reservado.
uPar2
Parmetro reservado.
uPar3
Parmetro reservado.
cAlias
cCampoRet
uPar4
lOnlyView
Parmetro Reservado.
Indica se ser somente para visualizao.
Retorno:
Nenhum
DATAVALIDA()
A funo DATAVALIDA() retorna a primeira data vlida a partir de uma data especificada como
referncia, considerando inclusive a data informada para anlise.
Sintaxe: DATAVALIDA(dData)
Parmetros:
dData
Retorno:
Data
EXISTINI()
A funo EXISTINI() verifica se o campo possui inicializador padro.
Sintaxe: EXISTINI(cCampo)
Parmetros:
cCampo
Retorno:
Lgico
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
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.
Parmetros:
nValor
lQtd
nMoeda
Retorno:
String
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.
Sintaxe: Formula(cFormula)
Parmetros:
cFormula
Retorno:
Indefinido
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.
Sintaxe: GetAdvFVal(cAlias,uCpo,uChave,nOrder,uDef)
Parmetros:
cAlias
Alias do arquivo
uCpo
uChave
nOrder
uDef
Valor ou array default para ser retornado caso a chave no seja encontrada
Retorno:
Retorna o contedo de um campo ou array com o contedo de vrios
campos
Indefinido
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.
Parmetros:
cHelp
nLinha
cTitulo
Ttulo do help
uPar4
Sempre NIL
cMensagem
nLinMen
nColMen
Retorno:
Nenhum
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
MESEXTENSO()
A funo MESEXTENSO() retorna o nome de um ms por extenso.
Sintaxe: MESEXTENSO(nMes)
Parmetros:
nMes
Este parmetro pode ser definido tambm como caracter ou como data.
Retorno:
String
OBRIGATORIO()
A funo OBRIGATORIO() avalia se todos os campos obrigatrios de uma Enchoice() foram
digitados.
Parmetros:
aGets
aTela
aTitulos
Retorno:
Lgico
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"
{"Visualizar"
,"AxVisual"
{"Atualizar"
,"U_A010AATU"
,0,1} ,;
,0,2} ,;
,0,4}}
:= {}
:= {}
Local
Local
Local
Local
Local
Local
Local
Local
Local
Local
Local
:=
:=
:=
:=
:=
:=
:=
:=
:=
:=
:=
aButtons
cAliasE
aAlterEnch
aPos
nModelo
lF3
lMemoria
lColumn
caTela
lNoFolder
lProperty
{}
cAlias
{}
{015,000,400,600
.F.
.T.
.F.
""
.F.
.F.
Exemplo (continuao):
Private
Private
Private
Private
Private
oDlg
oGetD
oEnch
aTELA[0][0]
aGETS[0]
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.)
oEnch :=
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
Local nX
:= GetArea()
:= 0
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.
Sintaxe: OPENFILE(cEmp)
Parmetros:
cEmp
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.
Parmetros:
cPergunta
|Ask
cTitle
Ttulo do dilogo.
Retorno:
Lgico
PESQPICT()
A funo PESQPICT() retorna a picture definida para um campo especificado no Dicionrio de
Dados (SX3).
Sintaxe: PesqPict(cAlias,cCampo,nTam)
Parmetros:
cAlias
Alias do arquivo
cCampo
Nome do campo
nTam
Retorno:
String
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.
Sintaxe: PesqPictQt(cCampo,nEdio)
Parmetros:
cCampo
nEdio
Retorno:
Picture ideal para o espao definido por nEdio, sem a separao dos
milhares por vrgula.
String
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.
Parmetros:
cAlias
Alias do arquivo
nOrdem
Ordem utilizada
cChave
Chave pesquisa
cCampo
Retorno:
Indefinido
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.
Parmetros:
cGrupo
cOrdem
cPergunt
cPerSpa
cPerEng
cVar
cTipo
Tipo do parmetro
nTamanho
nDecimal
nPresel
cGSC
cValid
cF3
cGrpSxg
cPyme
cVar01
cDef01
cDefSpa1
cDefEng1
cCnt01
Contedo padro ou ultimo contedo definido como respostas para este item
cDef0x
cDefSpax
cDefEngx
aHelpPor
aHelpEng
aHelpSpa
cHelp
RETINDEX()
A funo RETINDEX()
Dados (SIX).
Sintaxe: RETINDEX(cAlias)
Parmetros:
Alias de um arquivo do sistema existente no Dicionrio de Dados.
cAlias
Retorno:
Indica quantos ndices padres o alias especificado possui no Dicionrio de
Dados.
Numrico
SIXDESCRICAO()
A funo SIXDESCRICAO() retorna a descrio da chave de ndice, de acordo com o registro
posicionado no SIX e idioma corrente.
Sintaxe: SIXDESCRICAO()
Parmetros:
Nenhum
Retorno:
String
Exemplo:
User Function <nome-da-funo>( cChave, cOrdem )
Local cSixDesc :=
dbSelectArea(SIX)
dbSetOrder(1)
If dbSeek(cChave+cOrdem)
cSixDescr := SixDescricao()
EndIf
Return
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.
Sintaxe: Tabela(cTab,cChav,lPrint)
Parmetros:
cTab
cChav
lPrint
Retorno:
String
TAMSX3()
A funo TAMSX3() retorna o tamanho (total e parte decimal) de um campo especificado no
Dicionrio de Dados (SX3).
Sintaxe: TAMSX3(cCampo)
Parmetros:
cCampo
Retorno:
Array
TM()
A funo TM() retorna a picture de impresso para valores numricos dependendo do espao
disponvel.
Parmetros:
nValor
nEdio
nDec
Retorno:
String
X1DEF01()
A funo X1DEF01() retorna o contedo da primeira definio da pergunta posicionada no SX1
(caso seja combo) no idioma corrente.
Sintaxe: X1DEF01()
Parmetros:
Nenhum
Retorno:
String
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
X1PERGUNT()
A funo X1PERGUNT() retorna a descrio da pergunta posicionada no Dicionrio de Dados
(SX1) para o idioma corrente.
Sintaxe: X1PERGUNT()
Parmetros:
Nenhum
Retorno:
String
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.
Sintaxe: X2NOME()
Parmetros:
Nenhum
Retorno:
String
Exemplo:
User Function <nome-da-funo>( )
Local cTabela
dbSelectArea(SX2)
dbSetOrder(1)
If dbSeek( SA1 )
cTabela := X2Nome()
EndIf
Return
- 381 Guia de Referncia Rpida
ADVPL Intermedirio
X3CBOX()
A funo X3CBOX() retorna o contedo de um campo tipo combo posicionado no Dicionrio de
Dados (SX3) no idioma corrente.
Sintaxe: X3CBOX()
Parmetros:
Nenhum
Retorno:
String
Exemplo:
User Function <nome-da-funo>( )
Local cTitulo
Local cDescri
Local cCombo
dbSelectArea(SX3)
dbSetOrder(2)
If dbSeek( cCampo )
cTitulo := X3Titulo()
cDescri := X3Descri()
cCombo := X3Cbox()
EndIf
Return
X3DESCRIC()
A funo X3DESCRIC() retorna a descrio de um campo posicionado no Dicionrio de Dados
(SX3) no idioma corrente.
Sintaxe: X3DESCRIC()
Parmetros:
Nenhum
Retorno:
String
Exemplo:
User Function <nome-da-funo>( )
Local cTitulo
Local cDescri
Local cCombo
dbSelectArea(SX3)
dbSetOrder(2)
If dbSeek( cCampo )
cTitulo := X3Titulo()
cDescri := X3Descri()
cCombo := X3Cbox()
EndIf
Return
X3PICTURE()
A funo X3PICTURE() retorna a mscara de um campo contido no Dicionrio de Dados (SX3).
Sintaxe: X3PICTURE(cCampo)
Parmetros:
cCampo
Retorno:
String
Exemplo:
User Function <nome-da-funo>( cCampo )
Local cPicture
cPicture := X3Picture( cCampo )
Return cPicture
X3TITULO()
A funo X3TITULO() retorna o ttulo de um campo posicionado no Dicionrio de Dados (SX3)
no idioma corrente.
Sintaxe: X3TITULO()
Parmetros:
Nenhum
Retorno:
String
Exemplo:
User Function <nome-da-funo>( )
Local cTitulo
dbSelectArea(SX3)
dbSetOrder(2)
If dbSeek( A1_COD )
cTitulo := X3Titulo()
EndIf
Return
X3USO()
A funo X3USO() verifica se o campo atualmente posicionado no Dicionrio de Dados (SX3)
est disponvel para uso.
Parmetros:
cUsado
Modulo
Retorno:
Lgico
Exemplo:
User Function <nome-da-funo>()
Local lUsado := .F.
DbSelectArea(SX3)
DbSetOrder(2)
DbSeek(A1_COD)
If X3Uso( SX3->X3_USADO )
lUsado := .T.
EndIf
Return lUsado
X5DESCRI()
A funo X5DESCRI() retorna a descrio de um item de uma tabela posicionado no Arquivo de
Tabelas (SX5) no idioma corrente.
Sintaxe: X5DESCRI()
Parmetros:
Nenhum
Retorno:
String
Exemplo:
User Function <nome-da-funo>( cFilial, cTabela, cChave )
Local cDescr
dbSelectArea(SX5)
dbSetOrder(1)
If dbSeek( cFilial+cTabela+cChave )
cDescr := X5Descri()
EndIf
Return
X6CONTEUD()
A funo X6CONTEUD() retorna o contedo de um parmetro posicionado no Dicionrio de
Dados (SX6) para o idioma corrente.
Sintaxe: X6CONTEUD()
Parmetros:
.
Nenhum
Retorno:
Indefinido
Exemplo:
User Function <nome-da-funo>( cFilial, cParam )
Local cDescr
Local cConteud
dbSelectArea(SX6)
dbSetOrder(1)
If dbSeek( cFilial+cParm )
cDescr := X6Descric()
cDescr += X6Desc1()
cDescr += X6Desc2()
cConteud := X6Conteud()
EndIf
Return
X6DESCRIC()
A funo X6DESCRI() retorna o contedo da descrio de um parmetro de acordo com o
registro posicionado no Dicionrio de Dados (SX6) no idioma corrente.
Sintaxe: X6DESCRIC()
Parmetros:
.
Nenhum
Retorno:
String
Exemplo:
User Function <nome-da-funo>( cFilial, cParam )
Local cDescr
Local cConteud
dbSelectArea(SX6)
dbSetOrder(1)
If dbSeek( cFilial+cParm )
cDescr := X6Descric()
cDescr += X6Desc1()
cDescr += X6Desc2()
cConteud := X6Conteud()
EndIf
Return
XADESCRIC()
A funo XADESCRI() retorna o contedo da descrio dos folders de acordo com o registro
posicionado no Dicionrio de Dados (SXA) no idioma corrente.
Sintaxe: XADESCRIC()
Parmetros:
Nenhum
Retorno:
String
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.
Sintaxe: XBDESCRI()
Parmetros:
Nenhum
Retorno:
String
Exemplo:
User Function <nome-da-funo>( cAlias )
Local cDescr
dbSelectArea(SXB)
dbSetOrder(1)
If dbSeek( cAlias + 1 )
cDescr := XBDescri()
EndIf
Return
- 388 Guia de Referncia Rpida
ADVPL Intermedirio
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.
Sintaxe: XFILIAL(cAlias)
Parmetros:
cAlias
Retorno:
Caracter
Sintaxe:
Parmetros
oObjetoDLG
cTitulo
nLinIni, nColIni
nLiFim, nColFim
oObjetoRef
UNIDADE
Exemplo:
DEFINE MSDIALOG oDlg TITLE cTitulo FROM 000,000 TO 080,300 PIXEL
ACTIVATE MSDIALOG oDlg CENTERED
MSGET()
Define o componente visual MSGET, o qual utilizado para captura de informaes digitveis
na tela da interface.
Sintaxe:
Parmetros
nLinha, nColuna
VARIAVEL
nLargura,nAltura
UNIDADE
oObjetoRef
cF3
VALID
WHEN
cPicture
Exemplo:
@ 010,050 MSGET cCGC
VALID !Vazio()
SAY()
Define o componente visual SAY, o qual utilizado para exibio de textos em uma tela de
interface.
Sintaxe:
Parmetros
nLinha, nColuna
cTexto
nLargura,nAltura
UNIDADE
oObjetoRef
Exemplo:
@ 010,010 SAY
BUTTON()
Define o componente visual Button, o qual permite a incluso de botes de operao na tela
da interface, os quais sero visualizados somente com um texto simples para sua identificao.
Sintaxe: BUTTON()
Parmetros
nLinha,nColuna
cTexto
nLargura,nAltura
UNIDADE
oObjetoRef
AO
Exemplo:
010, 120 BUTTON Confirmar SIZE 080, 047 PIXEL OF oDlg;
ACTION (nOpca := 1,oDlg:End())
SBUTTON()
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) prdefinido.
Sintaxe: SBUTTON()
Parmetros
nLinha, nColuna
TYPE N
AO
STATUS
oObjetoRet
Exemplo:
DEFINE SBUTTON FROM 020, 120 TYPE 2 ACTION (nOpca := 2,oDlg:End());
ENABLE OF oDlg
CHECKBOX()
Define o componente visual CheckBox, o qual permite a utilizao da uma marca para habilitar
ou no uma opo escolhida, sendo esta marca acompanhada de um texto explicativo. Difere
do RadioMenu pois cada elemento do check nico, mas o Radio permite a utilizao de uma
lista junto com um controle de seleo.
Sintaxe:
Parmetros:
nLinha,nColuna
oCheckBox
VARIAVEL
cTexto
WHEN
UNIDADE
oObjetoRef
nLargura,nAltura
cMensagem
Exemplo:
@ 110,10 CHECKBOX oChk VAR lChk PROMPT "Marca/Desmarca" SIZE 60,007 PIXEL OF oDlg ;
ON CLICK(aEval(aVetor,{|x| x[1]:=lChk}),oLbx:Refresh())
COMBOBOX()
Define o componente visual ComboBox, o qual permite seleo de um item dentro de uma lista
de opes de textos simples no formato de um vetor.
Sintaxe:
Parmetros:
nLinha,nColuna
VARIAVEL
AITENS
nLargura,nAltura
UNIDADE
oObjetoRef
Exemplo:
@ 40, 10 COMBOBOX oCombo VAR cCombo ITEMS aCombo SIZE 180,10 PIXEL OF
oFld:aDialogs[2]
FOLDER()
Define o componente visual Folder, o qual permite a incluso de diversos Dialogs dentro de
uma mesma interface visual. Um Folder pode ser entendido como um array de Dialogs, aonde
cada painel recebe seus componentes e tem seus atributos definidos independentemente dos
demais.
Sintaxe:
Parmetros
nLinha,nColuna
oFolder
oObjetoRef
&cTexto1,,&cTextoX
UNIDADE
nLargura,nAltura
Exemplo:
@ 50,06 FOLDER oFld OF oDlg PROMPT "&Buscas", "&Consultas", "Check-&Up / Botes" PIXEL
SIZE 222,078
RADIO()
Define o componente visual Radio, tambm conhecido como RadioMenu, o qual seleo de
uma opo ou de mltiplas opes atravs de uma marca para os itens exibidos de uma lista.
Difere do componente CheckBox, pois cada elemento de check sempre nico, e o Radio pode
conter um ou mais elementos.
Sintaxe:
Parmetros
nLinha,nColuna
oRadio
nRadio
3D
nLargura,nAltura
<ITEMS PROMPT>
cItem1,cItem2,...,cItemX
oObjetoRef
UNIDADE
CHANGE
CLICK
Exemplo:
aAdd( aRadio, "Disco" )
aAdd( aRadio, "Impressora" )
aAdd( aRadio, "Scanner" )
@ 30, 10 RADIO oRadio VAR nRadio ITEMS aRadio[1],aRadio[2],aRadio[3] SIZE 65,8 ;
PIXEL OF ;
oFld:aDialogs[3] ;
ON CHANGE ;
(Iif(nRadio==1,MsgInfo("Opco 1",cAtencao),;
Iif(nRadio==2,MsgInfo("Opo 2",cAtencao),MsgInfo("Opo 3",cAtencao))))
Interfaces de cadastro
AXCADASTRO()
Sintaxe
Descrio
MBROWSE()
Sintaxe
Descrio
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.
Sintaxe: AXPESQUI()
Parmetros
Nenhum
AXVISUAL()
Funo de visualizao padro das informaes de um registro, no formato Enchoice, conforme
demonstrado no tpico sobre a interface AxCadastro().
Sintaxe: AXVISUAL(cAlias, nReg, nOpc, aAcho, nColMens, cMensagem, cFunc,;
aButtons, lMaximized )
Parmetros
cAlias
nReg
nOpc
aAcho
nColMens
Parmetro no utilizado.
cMensagem
Parmetro no utilizado.
cFunc
aButtons
lMaximized
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.
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
Indica se a janela dever ser ou no maximizada
AXINCLUI()
Funo de incluso padro das informaes de um registro, no formato Enchoice, conforme
demonstrado no tpico sobre a interface AxCadastro().
Sintaxe: AxInclui(cAlias, nReg, nOpc, aAcho, cFunc, aCpos, cTudoOk, lF3,;
cTransact, aButtons, aParam, aAuto, lVirtual, lMaximized)
Parmetros
cAlias
nReg
nOpc
aAcho
cFunc
aCpos
cTudoOk
cTransact
aButtons
aParam
aAuto
lVirtual
lMaximized
AXALTERA()
Funo de alterao padro das informaes de um registro, no formato Enchoice, conforme
demonstrado no tpico sobre a interface AxCadastro().
Sintaxe: AXALTERA(cAlias, nReg, nOpc, aAcho, aCpos, nColMens, cMensagem,;
cTudoOk, cTransact, cFunc, aButtons, aParam, aAuto, lVirtual, lMaximized)
Parmetros
AXDELETA()
Funo de excluso padro das informaes de um registro, no formato Enchoice, conforme
demonstrado no tpico sobre a interface AxCadastro().
Sintaxe: AXDELETA(cAlias, nReg, nOpc, cTransact, aCpos, aButtons, aParam,;
aAuto, lMaximized)
Parmetros
cAlias
nReg
nOpc
cTransact
aCpos
aButtons
aParam
aAuto
lMaximized
Sintaxe: AVISO(cTexto)
Parmetros
cTexto
AVISO()
Parmetros
cTitulo
Ttulo da janela
cTexto
Texto do aviso
aBotoes
nTamanho
Tamanho (1,2 ou 3)
FORMBACTH()
aBotoes
Ttulo da janela
Array simples (vetor) contendo cada uma das linhas de texto que sero
exibidas no corpo da tela.
Array com os botes do tipo SBUTTON(), com a seguinte estrutura:
{nTipo,lEnable,{|| Ao() }}
bValid
nAltura
nLargura
MSGFUNCTIONS()
Sintaxe:
Sintaxe:
Sintaxe:
Sintaxe:
Parmetros
MSGALERT(cTexto, cTitulo)
MSGINFO(cTexto, cTitulo)
MSGSTOP(cTexto, cTitulo)
MSGYESNO(cTexto, cTitulo)
cTexto
cTitulo
MSGALERT
MSGINFO
MSGSTOP
MSGYESNO
Parmetros:
cCampo
nLinha
Retorno:
Indefinido
GDFIELDPOS()
A funo GDFIELDPOS() retorna a posio de um campo especificado em uma gria formada
por um objeto do tipo MsNewGetDados().
Sintaxe: GDFIELDPOS(cCampo)
Parmetros:
cCampo
Retorno:
Numrico
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.
Parmetros:
cCampo
xConteudo
nLinha
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.
Parmetros:
Se verdadeiro (.T.) retorna somente caracteres em maisculos.
lUpper
Retorno:
String
Conjunto de caracteres que definem a marca que dever ser utilizada pela
MarkBrowse durante o processamento corrente.
Exemplo:
Function <nome-da-funo>( )
Local aCampos := {{'CB_OK' ,,''},;
{'CB_USERLIB' ,,'Usurio'},;
{'CB_TABHORA' ,,'Hora'},;
{'CB_DTTAB' ,,'Data'}}
Private cMarca := GetMark()
Private cCadastro := 'Cadastro de Contrato'
Private aRotina := { { 'Pesquisar' , 'AxPesqui' , 0, 1 }}
MarkBrow( 'SCB', 'CB_OK','!CB_USERLIB',aCampos,, cMarca,'MarkAll()',,,,'Mark()' )
Return
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.
Sintaxe: MARKBREFRESH()
Parmetros:
Nenhum
Retorno:
Nenhum
READVAR()
A funo READVAR() retorna o nome da varivel ou campo associoado ao objeto do tipo GET()
atualmente selecionado ou em edio.
Sintaxe: READVAR()
Parmetros:
Nenhum
Retorno:
String