Download - Guia de Refer en CIA eADVPL_001
-
8/6/2019 Guia de Refer en CIA eADVPL_001
1/42
Guia de referncia eAdvpl
1
Guia de Referncia eADVPL
Sumrio
1. Funes de Ambiente....................................................................................4
1.1. Set Date..................................................................................................41.2. Set Deleted.............................................................................................41.3. Set Device ..............................................................................................41.4. Set Key...................................................................................................5
2. Funes de Banco de Dados.........................................................................62.1. dbUseArea..............................................................................................62.2. dbCloseArea...........................................................................................62.3. dbSkip.....................................................................................................62.4. dbSeek ...................................................................................................72.5. dbCreateIndex........................................................................................72.6. dbSetIndex .............................................................................................7
2.7. dbGoTo...................................................................................................72.8. dbGoTop.................................................................................................82.9. dbGoBottom ...........................................................................................82.10. dbPack................................................................................................82.11. dbAppend............................................................................................82.12. dbZap..................................................................................................82.13. dbCreate .............................................................................................92.14. dbClearIndex.......................................................................................92.15. dbSetOrder .........................................................................................92.16. dbDelete..............................................................................................92.17. dbCommit..........................................................................................102.18. RecCount..........................................................................................102.19. Isdirty ................................................................................................10
3. Funes de Interface ...................................................................................113.1. Dialog ...................................................................................................113.2. Activate Dialog......................................................................................113.3. CloseDialog ..........................................................................................113.4. Add Menubar ........................................................................................113.5. Add Menuitem ......................................................................................123.6. Add Folder............................................................................................123.7. Set Active Folder ..................................................................................123.8. Say .......................................................................................................133.9. Get........................................................................................................133.10. Button................................................................................................143.11. Checkbox..........................................................................................143.12. Listbox...............................................................................................153.13. Combobox.........................................................................................153.14. @ To .................................................................................................163.15. Browse ..............................................................................................163.16. Set Browse........................................................................................17
-
8/6/2019 Guia de Refer en CIA eADVPL_001
2/42
Guia de referncia eAdvpl
2
3.17. Add Column ......................................................................................173.18. GridSetCellColor...............................................................................183.19. DbBrowse .........................................................................................183.20. Add DbColumn..................................................................................193.21. Set Search DbBrowse.......................................................................19
3.22. Set Bitmap ........................................................................................193.23. Meter.................................................................................................203.24. SetMeter().........................................................................................203.25. SetArray()..........................................................................................203.26. HideControl().....................................................................................213.27. ShowControl() ...................................................................................213.28. DisableControl() ................................................................................213.29. EnableControl().................................................................................213.30. SetText() ...........................................................................................223.31. SetFocus...........................................................................................223.32. GridReset() .......................................................................................22
3.33. GridRow()..........................................................................................223.34. GridRows()........................................................................................233.35. GridSetRow() ....................................................................................233.36. GridCol() ...........................................................................................233.37. GridLeft ()..........................................................................................233.38. Gridright ().........................................................................................233.39. GetListRows() ...................................................................................243.40. MoveControl......................................................................................243.41. ResizeControl ...................................................................................243.42. GetObjPos ........................................................................................243.43. GetObjSize........................................................................................25
4. Funes de Timer........................................................................................264.1. Define Timer .........................................................................................264.2. ActiveTimer (oTimer) ............................................................................264.3. DeactiveTimer (oTimer) ........................................................................26
5. Funes de Bibliotecas (DLL/SO)................................................................275.1. Dll Function...........................................................................................275.2. Export Function ....................................................................................275.3. Open Serial...........................................................................................28
6. Funes de Alerta........................................................................................296.1. MsgStop() .............................................................................................296.2. MsgYesOrNo()......................................................................................296.3. MsgStatus () .........................................................................................296.4. ClearStatus () .......................................................................................296.5. Alert()....................................................................................................306.6. MsgAlert().............................................................................................30
7. Funes de Array ........................................................................................317.1. AAdd.....................................................................................................317.2. SortArray () ...........................................................................................317.3. aSize.....................................................................................................31
-
8/6/2019 Guia de Refer en CIA eADVPL_001
3/42
Guia de referncia eAdvpl
3
7.4. ScanArray() ..........................................................................................328. Funes de Comunicao...........................................................................33
8.1. DoSync.................................................................................................338.2. SyncDate..............................................................................................33
9. Funes de RPC .........................................................................................34
9.1. Connectserver ......................................................................................349.2. Rpcprotheus .........................................................................................349.3. Disconnectserver..................................................................................34
10. Funes de String ....................................................................................3510.1. Str .....................................................................................................3510.2. Substr................................................................................................3510.3. AllTrim...............................................................................................3510.4. Len....................................................................................................3610.5. Empty................................................................................................36
11........................................................................................................................3612. Miscelnea...............................................................................................37
12.1. Keyboard...........................................................................................3712.2. SelectDate ........................................................................................3712.3. Sleep.................................................................................................37
13. Funes de Impresso.............................................................................3813.1. Set Print Font....................................................................................3813.2. Psay..................................................................................................38
14. Anexos .....................................................................................................3914.1. Teclado.............................................................................................3914.2. Calendrio.........................................................................................3914.3. Botes de Operao .........................................................................3914.4. Smbolos...........................................................................................3914.5. Bitmaps .............................................................................................3914.6. Cores ................................................................................................41
-
8/6/2019 Guia de Refer en CIA eADVPL_001
4/42
Guia de referncia eAdvpl
4
1. Funes de Ambiente
1.1. Set Date
Objetivo: Configura o forma de dataSintaxe: SET DATE [TO] Parmetros: Formato da data a ser utilizado:
AMERICAN -> mm/dd/yyANSI -> yy.mm.ddBRITISH -> dd/mm/yyFRENCH -> dd/mm/yyGERMAN -> dd.mm.yyITALIAN -> dd-mm-yyJAPANESE -> yy/mm/ddUSA -> mm-dd-yy
Retorno: No se aplica
Exemplo:
1.2. Set Deleted
Objetivo: Ativa ou desativa filtro de registros deletadosSintaxe: SET DELETED Parmetros: ON descpnsidera registros
deletadosOFF considera registros
deletadosRetorno: No se aplica
Exemplo:
1.3. Set Device
Objetivo: Indica qual a sada dos comandos de telaSintaxe: SET DEVICE Parmetros: PRINT envia comandos para
impressora
SCREENenvia comandos para a
tela
Retorno: No se aplica
Exemplo:
-
8/6/2019 Guia de Refer en CIA eADVPL_001
5/42
Guia de referncia eAdvpl
5
1.4. Set Key
Objetivo: Atribu uma funo a uma teclaSintaxe: SET KEY [TO ] IN OBJ
Parmetros: Tecla que ser relacionada a funo Funo executada quando a tecla forpressionada
Objeto ao qual a tecla ser acionada Nome do objeto
Retorno: No se aplica
Exemplo:
-
8/6/2019 Guia de Refer en CIA eADVPL_001
6/42
Guia de referncia eAdvpl
6
2. Funes de Banco de Dados
2.1. dbUseArea
Objetivo: Abre uma rea de dados
Sintaxe: dbUseArea(, , , ,, )Parmetros: Indica a criao de uma nova rea de
dados, .T. ou .F. Driver de abertura do arquivo, em
eAdvpl utilizar - "LOCAL" Nome do arquivo a ser aberto
Alias a ser utilizado pela rea dedados aberta
Indica se a rea ser compartilhadaou exclusiva, .T. ou .F.
Indica se a rea ser apenas paraleitura, .T. ou .F.
Retorno: No se aplica
Exemplo:
2.2. dbCloseArea
Objetivo: Fecha uma rea de dadosSintaxe: dbCloseArea()Parmetros: Alias da rea de dados que ser
fechadaRetorno: No se aplica
Exemplo:
2.3. dbSkip
Objetivo: Altera o registro correnteSintaxe: dbSkip()Parmetros: Nmero de registros a serem
movimentados, o padro 1
Retorno: No se aplica
Exemplo:
-
8/6/2019 Guia de Refer en CIA eADVPL_001
7/42
Guia de referncia eAdvpl
7
2.4. dbSeek
Objetivo: Faz uma pesquisa na rea de dados correnteSintaxe: dbSeek(, , )Parmetros: Expresso a ser pesquisada
Indica a utilizao do softseek Pesquisa a ltima ocorrncia da
Retorno: .T. caso a expresso seja encontrada.F. caso a expresso no seja encontrada
Exemplo:
2.5. dbCreateIndex
Objetivo: Cria um ndice para a rea corrente
Sintaxe: dbCreateIndex(, , [])Parmetros: Nome do arquivo de indice Chave do indice que est sendo
criado Indica a criao de um nico ndice,
.T. ou .F.
Retorno: No se aplica
Exemplo:
2.6. dbSetIndex
Objetivo: Relaciona um arquivo de ndice a uma rea de dadosSintaxe: dbSetIndex()Parmetros: Nome do arquivo de indiceRetorno: No se aplica
Exemplo:
2.7. dbGoTo
Objetivo: Altera o registro correnteSintaxe: dbGoTo()Parmetros: Nmero do registro a ser posicionadoRetorno: No se aplica
Exemplo:
-
8/6/2019 Guia de Refer en CIA eADVPL_001
8/42
Guia de referncia eAdvpl
8
2.8. dbGoTop
Objetivo: Altera o registro corrente para o primeiro registro da reaSintaxe: dbGoToo()Parmetros: No se aplica
Retorno: No se aplica
Exemplo:
2.9. dbGoBottom
Objetivo: Altera o registro corrente para o ltimo registro da reaSintaxe: dbGoBottom()Parmetros: No se aplicaRetorno: No se aplica
Exemplo:
2.10. dbPack
Objetivo: Apaga os registros com o flag de deletadoSintaxe: dbPack()Parmetros: No se aplicaRetorno: No se aplica
Exemplo:
2.11. dbAppend
Objetivo: Inclui um registro em branco no final do arquivos de dadosSintaxe: dbAppend()Parmetros: No se aplicaRetorno: No se aplica
Exemplo:
2.12. dbZap
Objetivo: Apaga todos os registros do arquivos de dadosSintaxe: dbZap()Parmetros: No se aplicaRetorno: No se aplica
Exemplo:
-
8/6/2019 Guia de Refer en CIA eADVPL_001
9/42
Guia de referncia eAdvpl
9
2.13. dbCreate
Objetivo: Cria um arquivo de dadosSintaxe: dbCreate(, , )Parmetros: Nome do arquivo a ser aberto
Array contendo a estrutura doarquivo Driver de criao do arquivo, em
eAdvpl utilizar - "LOCAL"
Retorno: No se aplica
Exemplo:
2.14. dbClearIndex
Objetivo: Fecha todos os indices da rea corrente
Sintaxe: dbClearIndex()Parmetros: No se aplicaRetorno: No se aplica
Exemplo:
2.15. dbSetOrder
Objetivo: Seleciona um ndice para a rea de dados correnteSintaxe: DbSetOrder()Parmetros: No se aplica
Retorno: No se aplica
Exemplo:
2.16. dbDelete
Objetivo: Apaga um registro de forma lgicaSintaxe: dbDelete()Parmetros: No se aplicaRetorno: No se aplica
Exemplo:
-
8/6/2019 Guia de Refer en CIA eADVPL_001
10/42
Guia de referncia eAdvpl
10
2.17. dbCommit
Objetivo: Confirma as alteraes na rea de dadosSintaxe: dbCommit()
Parmetros: No se aplicaRetorno: No se aplica
Exemplo:
2.18. RecCount
Objetivo: Obter o nmero de registros em uma rea de dadosSintaxe: RecCount()Parmetros: No se aplicaRetorno: Quantidade de registros na rea de dados corrente
Exemplo:
2.19. Isdirty
Objetivo: Retorna status dos registro posicionado.Sintaxe: Isdirty()Parmetros: No se aplicaRetorno: True (.T.) indica que o registro foi includo ou alterado
False (.F.) indica que o registro no foi includo ou alterado
Exemplo: If HC5->(IsDirty())Alert(Registro j foi transmitido)
ElseAlert(Registro com transmisso pendente)
Endif
-
8/6/2019 Guia de Refer en CIA eADVPL_001
11/42
Guia de referncia eAdvpl
11
3. Funes de Interface
3.1. Dialog
Objetivo: Cria uma janela
Sintaxe: DEFINE DIALOG [TITLE ][COLOR,]Parmetros: Nome da janela a ser criada
Ttulo da janela
Cor de fundo do objeto meter Cor de frente do objeto meter
Retorno: No se aplica
Exemplo:
3.2. Activate Dialog
Objetivo: Ativa uma janelaSintaxe: ACTIVATE DIALOG Parmetros: Nome da janela a ser criadaRetorno: No se aplica
Exemplo:
3.3. CloseDialog
Objetivo: Fecha uma janelaSintaxe: CloseDialog()Parmetros: No se aplicaRetorno: No se aplica
Exemplo:
3.4. Add Menubar
Objetivo: Cria um menuSintaxe: ADD MENUBAR CAPTION OF
Parmetros: Nome do menu a ser criado
Texto utilizado no menu
Janela a qual o menu pertence
Retorno: No se aplica
Exemplo:
-
8/6/2019 Guia de Refer en CIA eADVPL_001
12/42
Guia de referncia eAdvpl
12
3.5. Add Menuitem
Objetivo: Cria uma janelaSintaxe: ADD MENUITEM CAPTION [ACTION
] OF
Parmetros: Nome do item de menu Texto do item de menu Funo a ser executada no item de
menu Menu ao qual o item pertence
Retorno: No se aplica
Exemplo:
3.6. Add Folder
Objetivo: Cria objeto folderSintaxe: ADD FOLDER CAPTION [ON ACTIVATE] [ COLOR , ] OF
Parmetros: Nome do objeto Folder Texto do folder
Funo a ser executava quando ofolder se tornar ativo
Cor de fundo do objeto folder Cor de frente do objeto folder
Janela onde ser criada o objetofolder
Retorno: No se aplica
Exemplo:
3.7. Set Active Folder
Objetivo: Ativa um folderSintaxe: SET ACTIVE FOLDER OF Parmetros: Nome do folder a ser ativado
Janela a qual o folder pertence
Retorno: No se aplica
Exemplo:
-
8/6/2019 Guia de Refer en CIA eADVPL_001
13/42
Guia de referncia eAdvpl
13
3.8. Say
Objetivo: Cria objeto saySintaxe: @ , SAY PROMPT [BOLD]
[LARGE] [SYMBOL] [PICTURE ] [ COLOR
, ] OF Parmetros: Linha de criao do objeto Coluna de criao do objeto
Nome do objeto Texto exibido no objeto
BOLD Exibe o texto em negrito
LARGE Exibe o texto uma fonte maior
SYMBOL Utiliza a fonte de smbolos
Picture aplicada ao objeto Cor de fundo do objeto
Cor de frente do objeto
Janela onde ser criada o objetoRetorno: No se aplica
Exemplo:
3.9. Get
Objetivo: Cria objeto getSintaxe: @ , GET VAR
[MULTILINE][NO UNDERLINE][SIZE ,][RIGHT] [READONLY, NO MODIFY] [VALID ]
[VSCROLL][PASSWORD][PICTURE ] OF Parmetros: Linha de criao do objeto
Coluna de criao do objeto
Nome do objeto Varivel que armazena o contedo do
getMULTILINE Exibe objeto get com vrias linhas
NOUNDERLINE
Inibe as linhas do objeto
Largura do objeto Altura do objeto
RIGHT Alinha o texto direitaREADONLY,NO MODIFY
Desabilita a edio do objeto
Funo de validao do contedo doobjeto
VSCROLL Ativa a barra de rolagem vertical
PASSWORD Ativa mascar para senhas
-
8/6/2019 Guia de Refer en CIA eADVPL_001
14/42
Guia de referncia eAdvpl
14
Picture aplicada ao objeto
Janela onde ser criada o objeto
Retorno: No se aplica
Exemplo:
3.10. Button
Objetivo: Cria objeto botoSintaxe: @ , BUTTON CAPTION
[SIZE , ][ACTION] [CANCEL] [SYMBOL][COLOR,] OF
Parmetros: Linha de criao do objeto Coluna de criao do objeto
Nome do objeto
Texto exibido no boto Largura do objeto
Altura do objeto Funo executada no clique do objeto
CANCELSYMBOL Utiliza a fonte de smbolos ou
bitmaps
Cor de fundo do objeto Cor de frente do objeto
Janela onde ser criada o objeto
Retorno: No se aplica
Exemplo:
3.11. Checkbox
Objetivo: Cria objeto checkboxSintaxe: @ , CHECKBOX [VAR ]
CAPTION [SIZE , ][ACTION ][COLOR ,] OF
Parmetros: Linha de criao do objeto Coluna de criao do objeto Nome do objeto
Varivel que armazena o contedo docheckbox
Texto exibido no checkbox
Largura do objeto Altura do objeto
-
8/6/2019 Guia de Refer en CIA eADVPL_001
15/42
Guia de referncia eAdvpl
15
Funo executada no clique do objeto
Cor de fundo do objeto Cor de frente do objeto
Janela onde ser criada o objeto
Retorno: No se aplica
Exemplo:
3.12. Listbox
Objetivo: Cria objeto listboxSintaxe: @ , LISTBOX [ VAR ]
ITEMS [SIZE , ][ACTION ][COLOR ,] OF
Parmetros: Linha de criao do objeto
Coluna de criao do objeto Nome do objeto
Varivel que armazena a oposelecionada do list
Array com os itens exibidos no objeto
Largura do objeto Altura do objeto
Funo executada na seleo de umaopo do objeto
Cor de fundo do objeto
Cor de frente do objeto
Janela onde ser criada o objetoRetorno: No se aplica
Exemplo:
3.13. Combobox
Objetivo: Cria objeto ComboboxSintaxe: @ , COMBOBOX [VAR ]
ITEMS [SIZE , ][ACTION ][COLOR ,] OF
Parmetros: Linha de criao do objeto
Coluna de criao do objeto
Nome do objeto
Varivel que armazena a oposelecionada do combo
Array com os itens exibidos no objeto
-
8/6/2019 Guia de Refer en CIA eADVPL_001
16/42
Guia de referncia eAdvpl
16
Largura do objeto
Altura do objeto Funo executada na seleo de uma
opo do objeto Cor de fundo do objeto
Cor de frente do objeto Janela onde ser criada o objeto
Retorno: No se aplica
Exemplo:
3.14. @ To
Objetivo: Desenha quadro na telaSintaxe: @ , TO ,
[] [CAPTION ] [COLOR
,] OF Parmetros: Linha inicial de criao do objeto
Coluna inicial de criao do objeto Linha final de criao do objeto
Coluna final de criao do objeto
Texto exibido no quadro
Cor de fundo do objeto
Cor de frente do objeto Janela onde ser criada o objeto
Retorno: No se aplica
Exemplo:
3.15. Browse
Objetivo: Cria objeto browseSintaxe: @ , BROWSE SIZE
, ACTION [NO SCROLL][COLOR ,] OF
Parmetros: Linha de criao do objeto Coluna de criao do objeto
Nome do objeto
Largura do objeto Altura do objeto
Funo executada na seleo de umalinha do objeto
NO SCROLL Desabilita a rolagem no objeto
Cor de fundo do objeto
Cor de frente do objeto
-
8/6/2019 Guia de Refer en CIA eADVPL_001
17/42
Guia de referncia eAdvpl
17
Janela onde ser criada o objeto
Retorno: No se aplica
Exemplo:
3.16. Set Browse
Objetivo: Relaciona um browse a um arraySintaxe: SET BROWSE ARRAY Parmetros: Nome do browse a ser relacionado
Array a ser relacionado
Retorno: No se aplica
Exemplo:
3.17. Add Column
Objetivo: Cria uma coluna no objeto browseSintaxe: ADD COLUMN TO [BROWSE] ARRAY
ELEMENT [HEADER ] [WIDTH [PIXELS]] [PICTURE ][] [ALIGNLEFT, RIGHT>] [OPTIONS ][EDITABLE][VALID]
Parmetros: Nome do objeto da Coluna Nome do objeto
Posio do Array que ser exibida nacoluna
Ttulo da Coluna Largura da coluna
Picture aplicada a coluna
MARK Indica se a coluna mostrar uma opode Mark
ALIGN Indica alinhamento da coluna, LEFT(esquerda) ou RIGHT (direita)
Lista de opes para utilizao de umcombobox na clula
EDITABLE Indica se a coluna poder ser editada Funo de validao do valor da
coluna, quando editadaRetorno: No se aplica
Exemplo:
-
8/6/2019 Guia de Refer en CIA eADVPL_001
18/42
Guia de referncia eAdvpl
18
3.18. GridSetCellColor
Objetivo: Altera a cor de uma clula do BrowseSintaxe: GridSetCellColor(,,,,
)
Parmetros: Nome do browse a ser utilizado Nmero da linha da clula Nmero da coluna da clula
Cor de fundo atribuda a clula Cor de frente atribuda a clula
Retorno: No se aplica
Exemplo:
3.19. DbBrowse
Objetivo: Cria objeto browse associado a um arquivo de dadosSintaxe: @ , DBBROWSE ALIAS
SIZE , [ACTION> ][COLOR ,] [BUTTONS ] OF
Parmetros: Linha de criao do objeto Coluna de criao do objeto
Nome do objeto
Alias associado ao dbbrowse
Largura do objeto
Altura do objeto Funo executada na seleo de uma
linha do objetoNO SCROLL Desabilita a rolagem no objeto
Cor de fundo do objeto
Cor de frente do objeto Array de 10 posies contendo .T. ou
.F. indicando quais botes dodbbrowse sero habilitados
Janela onde ser criada o objeto
Retorno: No se aplica
Exemplo:
-
8/6/2019 Guia de Refer en CIA eADVPL_001
19/42
Guia de referncia eAdvpl
19
3.20. Add DbColumn
Objetivo: Cria uma coluna no objeto DbbrowseSintaxe: ADD DBCOLUMN TO [DBBROWSE] FIELD
[HEADER ][WIDTH
[PIXELS]] [PICTURE ] [ALIGNLEFT,RIGHT>] [EDITABLE>] [VALID ]
Parmetros: Nome do objeto da Coluna Nome do objeto Nome do campo exibido na coluna
Ttulo da Coluna
Largura da coluna Picture aplicada a coluna
ALIGN Indica alinhamento da coluna, LEFT(esquerda) ou RIGHT (direita)
EDITABLE Indica se a coluna poder ser editada
Funo de validao do valor dacoluna, quando editada
Retorno: No se aplica
Exemplo:
3.21. Set Search DbBrowse
Objetivo: Atribu uma funo de busca ao objeto dbBrowseSintaxe: SET SEARCH DBBROWSE TO Parmetros: Nome do browse a ser relacionado
Funo utilizada para a pesquisaRetorno: No se aplica
Exemplo:
3.22. Set Bitmap
Objetivo: Atribu um bitmap ao objetoSintaxe: SET BITMAP TO Parmetros: Imagem a ser atribuda
Objeto ao qual a imagem ser
associadaRetorno: No se aplica
Exemplo:
-
8/6/2019 Guia de Refer en CIA eADVPL_001
20/42
Guia de referncia eAdvpl
20
3.23. Meter
Objetivo: Cria objeto meterSintaxe: @ , METER [FROM TO
] [ SIZE ,] [ COLOR
, ] OF Parmetros: Linha de criao do objeto Coluna de criao do objeto
Nome do objeto meter Valor inicial do objeto meter
Valor final do objeto meter
Largura do objeto meter
Altura do objeto meter
Cor de fundo do objeto meter Cor de frente do objeto meter
Janela onde ser criada o objeto
meterRetorno: No se aplica
Exemplo:
3.24. SetMeter()
Objetivo: Atualiza objetos meterSintaxe: SetMeter(, )Parmetros: Objeto meter a ser atualizado
Novo contedo atribudo ao
objeto meter.Retorno: No se aplica
Exemplo:
3.25. SetArray()
Objetivo: Atualiza objetos que utilizam arraySintaxe: SetArray(, )Parmetros: Objeto onde ser atribudo o
array
Novo contedo atribudo aoobjeto.
Retorno: No se aplica
Exemplo:
-
8/6/2019 Guia de Refer en CIA eADVPL_001
21/42
Guia de referncia eAdvpl
21
3.26. HideControl()
Objetivo: Esconde o objetoSintaxe: HideControl()Parmetros: Objeto a ser escondido
Retorno: No se aplica
Exemplo:
3.27. ShowControl()
Objetivo: Exibe o objetoSintaxe: ShowControl()Parmetros: Objeto a ser exibidoRetorno: No se aplica
Exemplo:
3.28. DisableControl()
Objetivo: Habilita o objetoSintaxe: DisableControl()Parmetros: Objeto a ser desabilitadoRetorno: No se aplica
Exemplo:
3.29. EnableControl()
Objetivo: Habilita o objetoSintaxe: EnableControl()Parmetros: Objeto a ser habilitadoRetorno: No se aplica
Exemplo:
-
8/6/2019 Guia de Refer en CIA eADVPL_001
22/42
Guia de referncia eAdvpl
22
3.30. SetText()
Objetivo: Atualiza objeto getSintaxe: SetText(, )Parmetros: Objeto onde ser atribudo a
Novo contedo atribudo aoobjeto get.
Retorno: No se aplica
Exemplo:
3.31. SetFocus
Objetivo: Atribu o foco da aplicao a um objetoSintaxe: SetFocus()
Parmetros: Objeto onde ser atribudo ofocoRetorno: No se aplica
Exemplo:
3.32. GridReset()
Objetivo: Atualiza objeto gridSintaxe: GridReset()Parmetros: Objeto Grid
Retorno: No se aplica
Exemplo:
3.33. GridRow()
Objetivo: Obter nmero da linha selecionada em um objeto gridSintaxe: GridRow()Parmetros: Objeto GridRetorno: Nmero da linha selecionada no objeto
Exemplo:
-
8/6/2019 Guia de Refer en CIA eADVPL_001
23/42
Guia de referncia eAdvpl
23
3.34. GridRows()
Objetivo: Obter nmero de linhas visveis em um objeto gridSintaxe: GridRows()Parmetros: Objeto Grid
Retorno: Nmero de linhas visiveis no objeto
Exemplo:
3.35. GridSetRow()
Objetivo: Selecionar uma linha em um objeto gridSintaxe: GridSetRow(, )Parmetros: Objeto Grid
Nmero da linha a serselecionada
Retorno: No se aplica
Exemplo:
3.36. GridCol()
Objetivo: Obter nmero da coluna selecionada em um objeto GridSintaxe: GridCol()Parmetros: Objeto GridRetorno: Nmero da coluna selecionada
Exemplo:
3.37. GridLeft ()
Objetivo: Move uma coluna para a esquerda no objeto GridSintaxe: GridLeft()Parmetros: Objeto Grid a ser movimentadoRetorno: No se aplica
Exemplo:
3.38. Gridright ()
Objetivo: Move uma coluna para a direita no objeto GridSintaxe: Gridright ()Parmetros: Objeto Grid a ser movimentadoRetorno: No se aplica
-
8/6/2019 Guia de Refer en CIA eADVPL_001
24/42
Guia de referncia eAdvpl
24
Exemplo:
3.39. GetListRows()
Objetivo: Obter linha visveis de um objeto
Sintaxe: GetListRows()Parmetros: Objeto List a ser verificado onmero de linhas
Retorno: Nmero de linha visveis do objeto
Exemplo:
3.40. MoveControl
Objetivo: Altera a posio de um objeto na telaSintaxe: MoveControl(, , )
Parmetros: Objeto que ser reposicionado Nova linha de posio do objeto Nova coluna de posio do objeto
Retorno: No se aplica
Exemplo:
3.41. ResizeControl
Objetivo: Altera a posio de um objeto na telaSintaxe: ResizeControl(, , )
Parmetros: Objeto que ser redimensionado Nova largura do objeto
Nova altura do objeto
Retorno: No se aplica
Exemplo:
3.42. GetObjPos
Objetivo: Obtm a posio atual de um objetoSintaxe: MoveControl()Parmetros: Objeto do qual sero retornadas as
coordenadas
Retorno: Array com as coordenadas do objeto
Exemplo:
-
8/6/2019 Guia de Refer en CIA eADVPL_001
25/42
Guia de referncia eAdvpl
25
3.43. GetObjSize
Objetivo: Obtm o tamanho atual de um objetoSintaxe: GetObjSize ()Parmetros: Objeto do qual ser retornado o
tamanhoRetorno: Array com o tamanho do objeto
Exemplo:
-
8/6/2019 Guia de Refer en CIA eADVPL_001
26/42
Guia de referncia eAdvpl
26
4. Funes de Timer
4.1. Define Timer
Objetivo: Cria um objeto de Timer
Sintaxe: DEFINE TIMER [] [INTERVAL ][ACTION ]Parmetros: Nome do ObjetoTecla que ser
relacionada a funo Intervalo de execuo do timer em
milisegundos Funo executada a cada
milisegundos
Retorno: No se aplica
Exemplo:
4.2. ActiveTimer (oTimer)
Objetivo: Ativa um objeto de timerSintaxe: ACTIVETIMER(oTimer)Parmetros: Nome do objeto de timer a ser ativadoRetorno: No se aplica
Exemplo:
4.3. DeactiveTimer (oTimer)
Objetivo: Desativa um objeto de timerSintaxe: DEACTIVETIMER(oTimer)Parmetros: Nome do objeto de timer a ser
desativado
Retorno: No se aplica
Exemplo:
-
8/6/2019 Guia de Refer en CIA eADVPL_001
27/42
Guia de referncia eAdvpl
27
5. Funes de Bibliotecas (DLL/SO)
5.1. Dll Function
Objetivo: Declarao de uma funo contida na biblioteca DLL ou SO
Sintaxe: DLL FUNCTION LOCALNAME PARAMTYPE ([ AS ][, AS ]) AS LIB
Parmetros: Nome da funo na biblioteca Nome da funo utilizada na
aplicao eAdvpl Tipo de passagem de
parmetro utilizado pelabiblioteca CSTD ou PASCAL
. Parmetros da funo
.. Tipos dos parmetros Tipo de retorno da funo Nome da biblioteca
Retorno: No se aplica
Exemplo:
5.2. Export Function
Objetivo: Declara as funes que podero ser utilizadas na biblioteca, DLLou SO, gerada pelo eAdvpl
Sintaxe: EXPORT FUNCTION AS ( [ AS ][, AS ] ) RETURNING
Parmetros: Nome ao qual da funo serexportada na biblioteca
. Parmetros da funo.. Tipos dos parmetros
Tipo de retorno da funo
Retorno: No se aplica
Exemplo:
-
8/6/2019 Guia de Refer en CIA eADVPL_001
28/42
Guia de referncia eAdvpl
28
5.3. Open Serial
Objetivo: Abre uma porta serialSintaxe: OPEN SERIAL TO BAUD
9600,19200 BYTESIZE 7,8 PARITY 0,1 STOPBITS 0,1
Parmetros: Nmero da porta que ser aberta, COM1-> 1 Varivel que armanezar o handle da
serialBAUD Velocidade de comunicao: 9600 ou
19200
BYTESIZE Bytesize: 7 ou 8
PARITY Paridade: 0 ou 1STOPBITS Stopbits: 0 ou 1
Retorno: No se aplica
Exemplo:
-
8/6/2019 Guia de Refer en CIA eADVPL_001
29/42
Guia de referncia eAdvpl
29
6. Funes de Alerta
6.1. MsgStop()
Objetivo: Exibe uma mensagem de erro.
Sintaxe: MsgStop(,)Parmetros: Mensagem a ser exibida Ttulo exibido na janela
Retorno: No se aplica
Exemplo:
6.2. MsgYesOrNo()
Objetivo: Exibe uma mensagem com opoes de respostas SIM ouNO.
Sintaxe: MsgYesOrNo(,)Parmetros: Mensagem a ser exibida
Ttulo exibido na janela
Retorno: True (.T.) SIMFalse(.F.) NO
Exemplo:
6.3. MsgStatus ()
Objetivo: Exibe uma mensagem que independe de uma ao de usurio.
Sintaxe: MsgStatus()Parmetros: Mensagem a ser exibidaRetorno: No se aplica
Exemplo:
6.4. ClearStatus ()
Objetivo: Apaga mensagem criada pela funo MsgStatus.Sintaxe: ClearStatus()Parmetros: No se aplicaRetorno: No se aplica
Exemplo: ClearStatus()
-
8/6/2019 Guia de Refer en CIA eADVPL_001
30/42
Guia de referncia eAdvpl
30
6.5. Alert()
Objetivo: Exibe uma mensagem de alerta.Sintaxe: Alert()Parmetros: Mensagem a ser exibida
Retorno: No se aplica
Exemplo:
6.6. MsgAlert()
Objetivo: Exibe uma mensagem de alerta.Sintaxe: MsgAlert(,)Parmetros: Mensagem a ser exibida
Titulo da janela de mensagem
Retorno: No se aplica
Exemplo:
-
8/6/2019 Guia de Refer en CIA eADVPL_001
31/42
Guia de referncia eAdvpl
31
7. Funes de Array
7.1. AAdd
Objetivo: Adiciona um elemento no fim do array.
Sintaxe: AAdd(, )Parmetros: Array onde ser adicionado umelemento
Elemento a ser adicionado
Retorno: No se aplica
Exemplo:
7.2. SortArray ()
Objetivo: Ordernar um array.
Sintaxe: SortArray(,[], [], [], )
Parmetros: Array onde ser feita a busca Posio inicial da ordenao,
padro 1[] Quantos itens sero ordenados
True (.T.) AscendenteFalse(.F.) Descendente-Padro
Coluna base para ordenao
Retorno: Nmero da linha onde a expresso foi encontrada
Exemplo:
7.3. aSize
Objetivo: Altera o tamanho de um array.Sintaxe: ScanArray(, )Parmetros: Array que ter o tamanho
alterado
Novo tamanho do array
Retorno: No se aplica
Exemplo:
-
8/6/2019 Guia de Refer en CIA eADVPL_001
32/42
Guia de referncia eAdvpl
32
7.4. ScanArray()
Objetivo: Pesquisar um determinado expresso em elementos de um array.Sintaxe: ScanArray(, , [],
[],)
Parmetros: Array onde ser feita a busca Valor a ser procurado[] Posio inicial de busca,
padro 1[] Nmero de linhas a ser
pesquisado, padro todo o array
Coluna onde ser realizada abusca
Retorno: Nmero da linha onde a expresso foi encontrada ou 0 (zero)caso no seja encontrada nenhuma ocorrncia
Exemplo:
-
8/6/2019 Guia de Refer en CIA eADVPL_001
33/42
Guia de referncia eAdvpl
33
8. Funes de Comunicao
8.1. DoSync
Objetivo: Inicia o programa cliente de comunicao
Sintaxe: DoSync()Parmetros: No se aplicaRetorno: No se aplica
Exemplo:
8.2. SyncDate
Objetivo: Retorna data do ltimo sincronismo no formato aaaammdd.Sintaxe: SyncDate()Parmetros: No se aplica
Retorno: Retorna a data do ltimo sincronismoExemplo:
-
8/6/2019 Guia de Refer en CIA eADVPL_001
34/42
Guia de referncia eAdvpl
34
9. Funes de RPC
9.1. Connectserver
Objetivo: Cria uma conexo com o servidor para uma chamada de RPC
Sintaxe: Connectserver()Parmetros: No se aplicaRetorno: Nmero da conexo criada
Exemplo:
9.2. Rpcprotheus
Objetivo: Cria uma conexo com o servidor para uma chamada de RPCSintaxe: Rpcprotheus( , , )Parmetros: Nmero da conexo criada
Funo a ser executada Parmetro para para a funo
Retorno: Nmero da conexo criada
Exemplo:
9.3. Disconnectserver
Objetivo: Fecha uma conexo com o servidorSintaxe: Disconnectserver()Parmetros: Nmero da conexoRetorno: No se aplica
Exemplo:
-
8/6/2019 Guia de Refer en CIA eADVPL_001
35/42
Guia de referncia eAdvpl
35
10. Funes de String
10.1. Str
Objetivo: Converte um valor numrico em uma string
Sintaxe: Str(, , )Parmetros: Valor numrico Tamanho da string a ser retornado
Nmero de casa decimais utilizados nastring
Retorno: String do valor numrico
Exemplo:
10.2. Substr
Objetivo: Extrai parte de uma stringSintaxe: Substr(, , [])Parmetros: String de onde ser extrado uma nova
string Posio inicial da extrao Nmero de caracteres a serem
extrados
Retorno: Parte da
Exemplo:
10.3. AllTrim
Objetivo: Elimina espaos em branco, a direita e a esquerda, de uma stringSintaxe: AllTrim()Parmetros: String onde sero extrado os espaosRetorno: String sem espaoes em branco
Exemplo:
-
8/6/2019 Guia de Refer en CIA eADVPL_001
36/42
Guia de referncia eAdvpl
36
10.4. Len
Objetivo: Obter a quantiade de caracteres de uma string ou quantidade deelementos de um array
Sintaxe: AllTrim( | )
Parmetros:
String onde sero contados oscaracteresArray onde sero contados oselementos
Retorno: Nmero de caracteres em uma string ou nmero de elementos deum array
Exemplo:
10.5. Empty
Objetivo: Obter a quantiade de caracteres de uma string ou quantidade deelementos de um arraySintaxe: AllTrim( | )Parmetros:
String onde sero contados oscaracteresArray onde sero contados oselementos
Retorno: Nmero de caracteres em uma string ou nmero de elementos deum array
Exemplo:
11.
-
8/6/2019 Guia de Refer en CIA eADVPL_001
37/42
Guia de referncia eAdvpl
37
12. Miscelnea
12.1. Keyboard
Objetivo: Apresenta um teclado para digitao na tela
Sintaxe: Keyboard(, )Parmetros: Indica qual teclado ser mostrado.Verificar tabela Teclados
Nome do objeto GET onde sermostrado o valor digitado no teclado
Retorno: String digitado no teclado
Exemplo:
12.2. SelectDate
Objetivo: Apresenta um calendrio na tela para seleo de uma dataSintaxe: SelectDate(, )Parmetros: Ttulo da janela do calendrio
Varivel onde ser armazenado a dataselecionada
Retorno: Data selecionada no calendrio
Exemplo:
12.3. Sleep
Objetivo: Para o processamento da aplicao por um intervalo de tempoSintaxe: SLEEP()Parmetros: Intervalo de execuo do timer em
milisegundos
Retorno: No se aplica
Exemplo:
-
8/6/2019 Guia de Refer en CIA eADVPL_001
38/42
Guia de referncia eAdvpl
38
13. Funes de Impresso
13.1. Set Print Font
Objetivo: Modifica a fonte utilizada para impresso.
A disponibilidade de utilizao de fontes varia entre os modelos deimpressoras disponveis no mercado, podendo no suportar estecomando
Sintaxe: SET PRINT FONT [SIZE ,][] [] []
Parmetros: Nmero da fonte a ser utilizada Largura da fonte Altura da fonte
BOLD Indica a utilizao de negrito nafonte
UNDERLINE Indica a utilizao de sublinhado na
fonteITALIC Indica a utilizao de itlico na
fonte
Retorno: No se aplica
Exemplo:
13.2. Psay
Objetivo: Envia um texto para impressora
Sintaxe: @ , PSAY Parmetros: Linha onde o texto ser impresso
Coluna onde o texto ser impresso
Texto a ser impresso
-
8/6/2019 Guia de Refer en CIA eADVPL_001
39/42
Guia de referncia eAdvpl
39
14. Anexos
14.1. TecladoTeclado Alfanumrico KEYBOARD_ALPHA 0
Teclado Numrico KEYBOARD_NUMBER 1Teclado de smbolos KEYBOARD_ACCENT 2
14.2. CalendrioSELECT_DAYBYDAY 0SELECT_DAYBYWEEK 1SELECT_DAYBYMONTH 2
14.3. Botes de OperaoSeta para cima VK_UP 11Seta para baixo VK_DOWN 12
Seta para esquerda VK_LEFT 37Seta para direita VK_RIGHT 39Enter VK_ENTER 13Calendar VK_1 516Address VK_2 517To Do VK_3 518Memo VK_4 519
14.4. SmbolosLEFT_ARROW Chr(3)RIGHT_ARROW Chr(4)UP_ARROW Chr(5)DOWN_ARROW Chr(6)
14.5. Bitmaps
BTN_BITMAP_LEFT Chr(3)
BTN_BITMAP_RIGHT Chr(4)
BTN_BITMAP_UP Chr(5)BTN_BITMAP_DOWN Chr(6)
BTN_BITMAP_TOP Chr(7)
BTN_BITMAP_BOT Chr(8)
BTN_BITMAP_PLUS Chr(9)
-
8/6/2019 Guia de Refer en CIA eADVPL_001
40/42
Guia de referncia eAdvpl
40
BTN_BITMAP_MINUS Chr(16)
BTN_BITMAP_CANCEL Chr(18)
BTN_BITMAP_SEARCH Chr(19)
BTN_BITMAP_EXIT Chr(20)
BTN_BITMAP_APONTA Chr(21)
BTN_BITMAP_BUDGETY Chr(22)
BTN_BITMAP_CALENDAR Chr(23)
BTN_BITMAP_CUSCLI Chr(24)
BTN_BITMAP_GRAFICO Chr(25)
BTN_BITMAP_GRAVAR Chr(26)BTN_BITMAP_HELP Chr(27)
BTN_BITMAP_INFOCLI Chr(28)
BTN_BITMAP_NOVO Chr(29)
BTN_BITMAP_TIMER Chr(30)
BTN_BITMAP_VALOR Chr(31)
BTN_BITMAP_OK Chr(32)
BTN_BITMAP_NOK Chr(33)
BTN_BITMAP_SYNC Chr(34)
BTN_BITMAP_FLAGGREEN Chr(35)
BTN_BITMAP_FLAGRED Chr(36)
BTN_BITMAP_FILTER Chr(37)
BTN_BITMAP_GEOROTA Chr(38)
BTN_BITMAP_EXCLAMA Chr(39)
BTN_BITMAP_LIXO Chr(40)
BTN_BITMAP_LOCK Chr(41)
BTN_BITMAP_PRINTER Chr(42)
-
8/6/2019 Guia de Refer en CIA eADVPL_001
41/42
Guia de referncia eAdvpl
41
BTN_BITMAP_HISTORY Chr(43)
BTN_BITMAP_BRASIL Chr(44)
BTN_BITMAP_CAKE Chr(45)
BTN_BITMAP_CLIP Chr(46)
BTN_BITMAP_CLIPS Chr(47)
BTN_BITMAP_ERROR Chr(48)
BTN_BITMAP_EXCLAMATION Chr(49)
BTN_BITMAP_INFO Chr(51)
BTN_BITMAP_INFO2 Chr(52)
BTN_BITMAP_LAMP Chr(53)BTN_BITMAP_MAIL Chr(54)
BTN_BITMAP_MISC01 Chr(55)
BTN_BITMAP_MISC02 Chr(56)
BTN_BITMAP_MISC03 Chr(57)
BTN_BITMAP_QUESTION Chr(58)
BTN_BITMAP_SPAIN Chr(59)
BTN_BITMAP_STOP Chr(60)
BTN_BITMAP_TOOLS Chr(61)
BTN_BITMAP_TRAFFIC01 Chr(62)
BTN_BITMAP_TRAFFIC02 Chr(63)
BTN_BITMAP_TRAFFIC03 Chr(64)
BTN_BITMAP_TRAFFIC04 Chr(65)
BTN_BITMAP_USA Chr(66)
14.6. CoresPreto CLR_BLACK 1Azul CLR_BLUE 2Verde CLR_GREEN 3
-
8/6/2019 Guia de Refer en CIA eADVPL_001
42/42
Guia de referncia eAdvpl
Ciano CLR_CYAN 4Vermellho CLR_RED 5Magenta CLR_MAGENTA 6Marrom CLR_BROWN 7Cinza CLR_GRAY 10
CLR_HBLUE 11CLR_HGREEN 12CLR_HCYAN 13CLR_HRED 14CLR_HMAGENTA 15
Amarelo CLR_YELLOW 16CLR_HGRAY 8
Branco CLR_WHITE 17