Escolar Documentos
Profissional Documentos
Cultura Documentos
Funes de Ambiente....................................................................................4
1.1. Set Date..................................................................................................4
1.2. Set Deleted.............................................................................................4
1.3. Set Device ..............................................................................................4
1.4. Set Key ...................................................................................................5
2. Funes de Banco de Dados.........................................................................6
2.1. dbUseArea..............................................................................................6
2.2. dbCloseArea...........................................................................................6
2.3. dbSkip.....................................................................................................6
2.4. dbSeek ...................................................................................................7
2.5. dbCreateIndex ........................................................................................7
2.6. dbSetIndex .............................................................................................7
2.7. dbGoTo...................................................................................................7
2.8. dbGoTop.................................................................................................8
2.9. dbGoBottom ...........................................................................................8
2.10.
dbPack ................................................................................................8
2.11.
dbAppend............................................................................................8
2.12.
dbZap..................................................................................................8
2.13.
dbCreate .............................................................................................9
2.14.
dbClearIndex.......................................................................................9
2.15.
dbSetOrder .........................................................................................9
2.16.
dbDelete..............................................................................................9
2.17.
dbCommit..........................................................................................10
2.18.
RecCount ..........................................................................................10
2.19.
Isdirty ................................................................................................10
3. Funes de Interface ...................................................................................11
3.1. Dialog ...................................................................................................11
3.2. Activate Dialog......................................................................................11
3.3. CloseDialog ..........................................................................................11
3.4. Add Menubar ........................................................................................11
3.5. Add Menuitem ......................................................................................12
3.6. Add Folder ............................................................................................12
3.7. Set Active Folder ..................................................................................12
3.8. Say .......................................................................................................13
3.9. Get........................................................................................................13
3.10.
Button................................................................................................14
3.11.
Checkbox ..........................................................................................14
3.12.
Listbox...............................................................................................15
3.13.
Combobox.........................................................................................15
3.14.
@ To .................................................................................................16
3.15.
Browse ..............................................................................................16
3.16.
Set Browse........................................................................................17
1
1. Funes de Ambiente
1.1. Set Date
Objetivo:
Configura o forma de data
SET DATE [TO] <cDateFormat>
Sintaxe:
Parmetros: <cDateFormat> Formato da data a ser utilizado:
AMERICAN -> mm/dd/yy
ANSI -> yy.mm.dd
BRITISH -> dd/mm/yy
FRENCH -> dd/mm/yy
GERMAN -> dd.mm.yy
ITALIAN -> dd-mm-yy
JAPANESE -> yy/mm/dd
USA -> mm-dd-yy
Retorno:
No se aplica
Exemplo:
1.2. Set Deleted
Objetivo:
Ativa ou desativa filtro de registros deletados
SET DELETED <cFiltro>
Sintaxe:
ON
descpnsidera registros
Parmetros: <cFiltro>
deletados
OFF
considera registros
deletados
Retorno:
No se aplica
Exemplo:
1.3. Set Device
Objetivo:
Indica qual a sada dos comandos de tela
SET DEVICE <cDevice>
Sintaxe:
<cDevice>
PRINT
envia comandos para
Parmetros:
impressora
SCREEN
envia comandos para a
tela
Retorno:
No se aplica
Exemplo:
Exemplo:
2.7. dbGoTo
Objetivo:
Sintaxe:
Parmetros:
Retorno:
Exemplo:
Exemplo:
2.9. dbGoBottom
Objetivo:
Sintaxe:
Parmetros:
Retorno:
Exemplo:
2.10.
Objetivo:
Sintaxe:
Parmetros:
Retorno:
dbPack
Apaga os registros com o flag de deletado
dbPack()
No se aplica
No se aplica
Exemplo:
2.11.
Objetivo:
Sintaxe:
Parmetros:
Retorno:
dbAppend
Inclui um registro em branco no final do arquivos de dados
dbAppend()
No se aplica
No se aplica
Exemplo:
2.12.
Objetivo:
Sintaxe:
Parmetros:
Retorno:
dbZap
Apaga todos os registros do arquivos de dados
dbZap()
No se aplica
No se aplica
Exemplo:
dbCreate
Objetivo:
Cria um arquivo de dados
dbCreate(<cArq>, <aStru>, <cRdd>)
Sintaxe:
Nome do arquivo a ser aberto
Parmetros: <cArq>
<aStru>
Array contendo a estrutura do
arquivo
<cRdd>
Driver de criao do arquivo, em
eAdvpl utilizar - "LOCAL"
Retorno:
No se aplica
Exemplo:
2.14.
Objetivo:
Sintaxe:
Parmetros:
Retorno:
dbClearIndex
Fecha todos os indices da rea corrente
dbClearIndex()
No se aplica
No se aplica
Exemplo:
2.15.
Objetivo:
Sintaxe:
Parmetros:
Retorno:
dbSetOrder
Seleciona um ndice para a rea de dados corrente
DbSetOrder()
No se aplica
No se aplica
Exemplo:
2.16.
Objetivo:
Sintaxe:
Parmetros:
Retorno:
dbDelete
Apaga um registro de forma lgica
dbDelete()
No se aplica
No se aplica
Exemplo:
2.17.
Objetivo:
Sintaxe:
Parmetros:
Retorno:
dbCommit
Confirma as alteraes na rea de dados
dbCommit()
No se aplica
No se aplica
Exemplo:
2.18.
Objetivo:
Sintaxe:
Parmetros:
Retorno:
RecCount
Obter o nmero de registros em uma rea de dados
RecCount()
No se aplica
Quantidade de registros na rea de dados corrente
Exemplo:
2.19.
Isdirty
Objetivo:
Sintaxe:
Parmetros:
Retorno:
Exemplo:
If HC5->(IsDirty())
Alert( Registro j foi transmitido )
Else
Alert( Registro com transmisso pendente )
Endif
10
3. Funes de Interface
3.1. Dialog
Objetivo:
Sintaxe:
Exemplo:
3.3. CloseDialog
Objetivo:
Sintaxe:
Parmetros:
Retorno:
Exemplo:
3.4. Add Menubar
Objetivo:
Cria um menu
ADD MENUBAR <oMnu> CAPTION <cCaption> OF <oWnd>
Sintaxe:
<oMnu>
Nome do menu a ser criado
Parmetros:
<cCaption> Texto utilizado no menu
<oWnd>
Janela a qual o menu pertence
Retorno:
No se aplica
Exemplo:
11
12
Retorno:
Exemplo:
3.10.
Button
Objetivo:
Sintaxe:
Checkbox
Objetivo:
Sintaxe:
Retorno:
<uAction>
<nBack>
<nFore>
<oWnd>
No se aplica
Funo
Cor de
Cor de
Janela
Exemplo:
3.12.
Listbox
Objetivo:
Sintaxe:
Combobox
Objetivo:
Sintaxe:
Retorno:
<nBack>
<nFore>
<oWnd>
No se aplica
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
Exemplo:
3.14.
@ To
Objetivo:
Sintaxe:
Browse
Objetivo:
Sintaxe:
Retorno:
<oDlg>
Janela onde ser criada o objeto
No se aplica
Exemplo:
3.16.
Set Browse
Objetivo:
Relaciona um browse a um array
SET BROWSE <oBrw> ARRAY <aArray>
Sintaxe:
Nome do browse a ser relacionado
Parmetros: <oBrw>
<aArray>
Array a ser relacionado
Retorno:
No se aplica
Exemplo:
3.17.
Add Column
Objetivo:
Sintaxe:
17
GridSetCellColor
Objetivo:
Sintaxe:
3.19.
DbBrowse
Objetivo:
Sintaxe:
18
Add DbColumn
Objetivo:
Sintaxe:
Objetivo:
Atribu uma funo de busca ao objeto dbBrowse
SET SEARCH DBBROWSE <oBrw> TO <uAction>
Sintaxe:
Nome do browse a ser relacionado
Parmetros: <oBrw>
<uAction> Funo utilizada para a pesquisa
Retorno:
No se aplica
Exemplo:
3.22.
Set Bitmap
Objetivo:
Atribu um bitmap ao objeto
SET
BITMAP <nBmp> TO <oObj>
Sintaxe:
Imagem a ser atribuda
Parmetros: <nBmp>
<oObj>
Objeto ao qual a imagem ser
associada
Retorno:
No se aplica
Exemplo:
19
Meter
Objetivo:
Sintaxe:
SetMeter()
Objetivo:
Atualiza objetos meter
SetMeter(<Objeto>, <nMeter>)
Sintaxe:
<Objeto>
Objeto meter a ser atualizado
Parmetros:
<nMeter>
Novo contedo atribudo ao
objeto meter.
Retorno:
No se aplica
Exemplo:
3.25.
SetArray()
Objetivo:
Atualiza objetos que utilizam array
SetArray(<Objeto>, <aArray>)
Sintaxe:
Objeto onde ser atribudo o
Parmetros: <Objeto>
array
<aArray>
Novo contedo atribudo ao
objeto.
Retorno:
No se aplica
Exemplo:
20
HideControl()
Esconde o objeto
HideControl(<Objeto>)
<Objeto>
Objeto a ser escondido
No se aplica
Exemplo:
3.27.
Objetivo:
Sintaxe:
Parmetros:
Retorno:
ShowControl()
Exibe o objeto
ShowControl(<Objeto>)
<Objeto>
Objeto a ser exibido
No se aplica
Exemplo:
3.28.
Objetivo:
Sintaxe:
Parmetros:
Retorno:
DisableControl()
Habilita o objeto
DisableControl(<Objeto>)
<Objeto>
Objeto a ser desabilitado
No se aplica
Exemplo:
3.29.
Objetivo:
Sintaxe:
Parmetros:
Retorno:
EnableControl()
Habilita o objeto
EnableControl(<Objeto>)
<Objeto>
Objeto a ser habilitado
No se aplica
Exemplo:
21
SetText()
Objetivo:
Atualiza objeto get
SetText(<Objeto>, <cExpressao>)
Sintaxe:
Objeto onde ser atribudo a
Parmetros: <Objeto>
<cExpressao>
<cExpressao>
Novo contedo atribudo ao
objeto get.
Retorno:
No se aplica
Exemplo:
3.31.
SetFocus
Objetivo:
Atribu o foco da aplicao a um objeto
SetFocus(<Objeto>)
Sintaxe:
<Objeto>
Objeto onde ser atribudo o
Parmetros:
foco
Retorno:
No se aplica
Exemplo:
3.32.
Objetivo:
Sintaxe:
Parmetros:
Retorno:
GridReset()
Atualiza objeto grid
GridReset(<oObjeto>)
<oObjeto>
Objeto Grid
No se aplica
Exemplo:
3.33.
Objetivo:
Sintaxe:
Parmetros:
Retorno:
GridRow()
Obter nmero da linha selecionada em um objeto grid
GridRow(<oObjeto>)
<oObjeto>
Objeto Grid
Nmero da linha selecionada no objeto
Exemplo:
22
GridRows()
Obter nmero de linhas visveis em um objeto grid
GridRows(<oObjeto>)
<oObjeto>
Objeto Grid
Nmero de linhas visiveis no objeto
Exemplo:
3.35.
GridSetRow()
Objetivo:
Selecionar uma linha em um objeto grid
GridSetRow(<oObjeto>, <nLinha>)
Sintaxe:
Objeto Grid
Parmetros: <oObjeto>
<nLinha>
Nmero da linha a ser
selecionada
Retorno:
No se aplica
Exemplo:
3.36.
Objetivo:
Sintaxe:
Parmetros:
Retorno:
GridCol()
Obter nmero da coluna selecionada em um objeto Grid
GridCol(<oObjeto>)
<oObjeto>
Objeto Grid
Nmero da coluna selecionada
Exemplo:
3.37.
Objetivo:
Sintaxe:
Parmetros:
Retorno:
GridLeft ()
Move uma coluna para a esquerda no objeto Grid
GridLeft(<oObjeto>)
<oObjeto>
Objeto Grid a ser movimentado
No se aplica
Exemplo:
3.38.
Objetivo:
Sintaxe:
Parmetros:
Retorno:
Gridright ()
Move uma coluna para a direita no objeto Grid
Gridright (<oObjeto>)
<oObjeto>
Objeto Grid a ser movimentado
No se aplica
23
GetListRows()
Objetivo:
Obter linha visveis de um objeto
GetListRows(<oObjeto>)
Sintaxe:
<oObjeto>
Objeto List a ser verificado o
Parmetros:
nmero de linhas
Retorno:
Nmero de linha visveis do objeto
Exemplo:
3.40.
MoveControl
Objetivo:
Altera a posio de um objeto na tela
MoveControl(<oObj>, <nLin>, <nCol>)
Sintaxe:
Objeto que ser reposicionado
Parmetros: <oObj>
<nLin>
Nova linha de posio do objeto
<nCol>
Nova coluna de posio do objeto
Retorno:
No se aplica
Exemplo:
3.41.
ResizeControl
Objetivo:
Altera a posio de um objeto na tela
ResizeControl(<oObj>, <nWidth>, <nHeight>)
Sintaxe:
Objeto que ser redimensionado
Parmetros: <oObj>
<nWidth>
Nova largura do objeto
<nHeight> Nova altura do objeto
Retorno:
No se aplica
Exemplo:
3.42.
GetObjPos
Objetivo:
Obtm a posio atual de um objeto
MoveControl(<oObj>)
Sintaxe:
Objeto do qual sero retornadas as
Parmetros: <oObj>
coordenadas
Retorno:
Array com as coordenadas do objeto
Exemplo:
24
GetObjSize
Objetivo:
Obtm o tamanho atual de um objeto
GetObjSize (<oObj>)
Sintaxe:
Objeto do qual ser retornado o
Parmetros: <oObj>
tamanho
Retorno:
Array com o tamanho do objeto
Exemplo:
25
4. Funes de Timer
4.1. Define Timer
Objetivo:
Sintaxe:
Exemplo:
4.3. DeactiveTimer (oTimer)
Objetivo:
Desativa um objeto de timer
DEACTIVETIMER(oTimer)
Sintaxe:
Nome do objeto de timer a ser
Parmetros: <oTimer>
desativado
Retorno:
No se aplica
Exemplo:
26
27
28
6. Funes de Alerta
6.1. MsgStop()
Objetivo:
Exibe uma mensagem de erro.
MsgStop(<cExpressao>,<cTitulo>)
Sintaxe:
Mensagem a ser exibida
Parmetros: <cExpressao>
<cTitulo>
Ttulo exibido na janela
Retorno:
No se aplica
Exemplo:
6.2. MsgYesOrNo()
Objetivo:
Exemplo:
6.4. ClearStatus ()
Objetivo:
Sintaxe:
Parmetros:
Retorno:
Exemplo:
ClearStatus()
29
Exemplo:
6.6. MsgAlert()
Objetivo:
Exibe uma mensagem de alerta.
MsgAlert(<cMensagem>,<cTtulo>)
Sintaxe:
Mensagem a ser exibida
Parmetros: <cMensagem>
<cTtulo>
Titulo da janela de mensagem
Retorno:
No se aplica
Exemplo:
30
7. Funes de Array
7.1. AAdd
Objetivo:
Adiciona um elemento no fim do array.
AAdd(<array>, <uValor>)
Sintaxe:
Array onde ser adicionado um
Parmetros: <array>
elemento
<uValor>
Elemento a ser adicionado
Retorno:
No se aplica
Exemplo:
7.2. SortArray ()
Objetivo:
Sintaxe:
Ordernar um array.
SortArray(<Array>,[<elem-inicial>], [<qtde-deelem>], [<ordem>], <coluna>)
Array onde ser feita a busca
Parmetros: <array>
<elem-inicial>
Posio inicial da ordenao,
padro 1
[<qtde-de-elem>] Quantos itens sero ordenados
<ordem>
True (.T.)
Ascendente
False(.F.)
Descendente-Padro
<coluna>
Coluna base para ordenao
Retorno:
Nmero da linha onde a expresso foi encontrada
Exemplo:
7.3. aSize
Objetivo:
Altera o tamanho de um array.
ScanArray(<array>, <nTam>)
Sintaxe:
Array que ter o tamanho
Parmetros: <array>
alterado
<nTam>
Novo tamanho do array
Retorno:
No se aplica
Exemplo:
31
32
8. Funes de Comunicao
8.1. DoSync
Objetivo:
Sintaxe:
Parmetros:
Retorno:
Exemplo:
8.2. SyncDate
Objetivo:
Sintaxe:
Parmetros:
Retorno:
Exemplo:
33
9. Funes de RPC
9.1. Connectserver
Objetivo:
Sintaxe:
Parmetros:
Retorno:
Exemplo:
9.2. Rpcprotheus
Objetivo:
Cria uma conexo com o servidor para uma chamada de RPC
Rpcprotheus(<nCon> , <cFunc> , <cParam>)
Sintaxe:
Nmero da conexo criada
Parmetros: <nCon>
<cFunc>
Funo a ser executada
<cParam>
Parmetro para para a funo <cFunc>
Retorno:
Nmero da conexo criada
Exemplo:
9.3. Disconnectserver
Objetivo:
Sintaxe:
Parmetros:
Retorno:
Exemplo:
34
10.
Funes de String
10.1.
Str
Objetivo:
Converte um valor numrico em uma string
Str(<nVal>, <nTam>, <nDec>)
Sintaxe:
Valor numrico
Parmetros: <nVal>
<nTam>
Tamanho da string a ser retornado
<nDec>
Nmero de casa decimais utilizados na
string
Retorno:
String do valor numrico
Exemplo:
10.2.
Substr
Objetivo:
Extrai parte de uma string
Substr(<cString>, <nStart>, [<nCount>])
Sintaxe:
Parmetros: <cString> String de onde ser extrado uma nova
string
<nStart>
Posio inicial da extrao
<nCount>
Nmero de caracteres a serem
extrados
Retorno:
Parte da <cString>
Exemplo:
10.3.
Objetivo:
Sintaxe:
Parmetros:
Retorno:
AllTrim
Elimina espaos em branco, a direita e a esquerda, de uma string
AllTrim(<cString>)
<cString> String onde sero extrado os espaos
String sem espaoes em branco
Exemplo:
35
Len
Objetivo:
Empty
Objetivo:
11.
36
12.
Miscelnea
12.1.
Keyboard
Objetivo:
Apresenta um teclado para digitao na tela
Keyboard(<nKeybo>, <oObj>)
Sintaxe:
Indica qual teclado ser mostrado.
Parmetros: <nKeybo>
Verificar tabela Teclados
<oObj>
Nome do objeto GET onde ser
mostrado o valor digitado no teclado
Retorno:
String digitado no teclado
Exemplo:
12.2.
SelectDate
Objetivo:
Apresenta um calendrio na tela para seleo de uma data
SelectDate(<cString>, <dData>)
Sintaxe:
<cString>
Ttulo da janela do calendrio
Parmetros:
<dData>
Varivel onde ser armazenado a data
selecionada
Retorno:
Data selecionada no calendrio
Exemplo:
12.3.
Sleep
Objetivo:
Para o processamento da aplicao por um intervalo de tempo
SLEEP(<nInterval>)
Sintaxe:
Parmetros: <nInterval> Intervalo de execuo do timer em
milisegundos
Retorno:
No se aplica
Exemplo:
37
13.
Funes de Impresso
13.1.
Objetivo:
13.2.
Psay
Objetivo:
Envia um texto para impressora
@ <nRow>,<nCol> PSAY <cText>
Sintaxe:
Linha onde o texto ser impresso
Parmetros: <nRow>
<nCol>
Coluna onde o texto ser impresso
<cText>
Texto a ser impresso
38
14.
Anexos
14.1.
Teclado
Teclado Alfanumrico
Teclado Numrico
Teclado de smbolos
14.2.
KEYBOARD_ALPHA
KEYBOARD_NUMBER
KEYBOARD_ACCENT
Calendrio
SELECT_DAYBYDAY
SELECT_DAYBYWEEK
SELECT_DAYBYMONTH
14.3.
Botes de Operao
Seta para cima
VK_UP
Seta para baixo
VK_DOWN
Seta para esquerda
VK_LEFT
Seta para direita
VK_RIGHT
Enter
VK_ENTER
Calendar
VK_1
Address
VK_2
To Do
VK_3
Memo
VK_4
14.4.
14.5.
0
1
2
0
1
2
11
12
37
39
13
516
517
518
519
Smbolos
LEFT_ARROW
RIGHT_ARROW
UP_ARROW
DOWN_ARROW
Chr(3)
Chr(4)
Chr(5)
Chr(6)
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)
Bitmaps
39
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)
40
14.6.
Preto
Azul
Verde
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)
Cores
CLR_BLACK
CLR_BLUE
CLR_GREEN
1
2
3
41
Amarelo
Branco
CLR_CYAN
CLR_RED
CLR_MAGENTA
CLR_BROWN
CLR_GRAY
CLR_HBLUE
CLR_HGREEN
CLR_HCYAN
CLR_HRED
CLR_HMAGENTA
CLR_YELLOW
CLR_HGRAY
CLR_WHITE
4
5
6
7
10
11
12
13
14
15
16
8
17
42