guia de referencia e advpl

Guia de referência eAdvpl

1

Guia de Referência eADVPL

Sumário

1. Funções de Ambiente....................................................................................41.1. Set Date..................................................................................................41.2. Set Deleted.............................................................................................41.3. Set Device ..............................................................................................41.4. Set Key...................................................................................................5

2. Funções de Banco de Dados.........................................................................62.1. dbUseArea..............................................................................................62.2. dbCloseArea...........................................................................................62.3. dbSkip.....................................................................................................62.4. dbSeek ...................................................................................................72.5. dbCreateIndex........................................................................................72.6. dbSetIndex .............................................................................................72.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. Funções 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


2

3.17. Add Column ......................................................................................173.18. GridSetCellColor ...............................................................................183.19. DbBrowse .........................................................................................183.20. Add DbColumn..................................................................................193.21. Set Search DbBrowse.......................................................................193.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() .......................................................................................223.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. Funções de Timer........................................................................................264.1. Define Timer .........................................................................................264.2. ActiveTimer (oTimer) ............................................................................264.3. DeactiveTimer (oTimer) ........................................................................26

5. Funções de Bibliotecas (DLL/SO)................................................................275.1. Dll Function...........................................................................................275.2. Export Function ....................................................................................275.3. Open Serial...........................................................................................28

6. Funções de Alerta........................................................................................296.1. MsgStop() .............................................................................................296.2. MsgYesOrNo()......................................................................................296.3. MsgStatus () .........................................................................................296.4. ClearStatus () .......................................................................................296.5. Alert()....................................................................................................306.6. MsgAlert() .............................................................................................30

7. Funções de Array ........................................................................................317.1. AAdd.....................................................................................................317.2. SortArray () ...........................................................................................317.3. aSize.....................................................................................................31


3

7.4. ScanArray() ..........................................................................................328. Funções de Comunicação ...........................................................................33

8.1. DoSync.................................................................................................338.2. SyncDate..............................................................................................33

9. Funções de RPC .........................................................................................349.1. Connectserver ......................................................................................349.2. Rpcprotheus .........................................................................................349.3. Disconnectserver..................................................................................34

10. Funções de String ....................................................................................3510.1. Str .....................................................................................................3510.2. Substr................................................................................................3510.3. AllTrim...............................................................................................3510.4. Len....................................................................................................3610.5. Empty................................................................................................36

11........................................................................................................................3612. Miscelânea...............................................................................................37

12.1. Keyboard...........................................................................................3712.2. SelectDate ........................................................................................3712.3. Sleep.................................................................................................37

13. Funções de Impressão.............................................................................3813.1. Set Print Font ....................................................................................3813.2. Psay..................................................................................................38

14. Anexos .....................................................................................................3914.1. Teclado .............................................................................................3914.2. Calendário.........................................................................................3914.3. Botões de Operação .........................................................................3914.4. Símbolos ...........................................................................................3914.5. Bitmaps .............................................................................................3914.6. Cores ................................................................................................41


4

1. Funções de Ambiente

1.1. Set Date

Objetivo: Configura o forma de dataSintaxe: SET DATE [TO] <cDateFormat>Parâmetros: <cDateFormat> 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: Não se aplica

Exemplo:

1.2. Set Deleted

Objetivo: Ativa ou desativa filtro de registros deletadosSintaxe: SET DELETED <cFiltro>Parâmetros: <cFiltro> ON descpnsidera registros

deletadosOFF considera registrosdeletados


Exemplo:

1.3. Set Device

Objetivo: Indica qual a saída dos comandos de telaSintaxe: SET DEVICE <cDevice>Parâmetros: <cDevice> PRINT envia comandos para

impressoraSCREEN envia comandos para atela


Exemplo:


5

1.4. Set Key

Objetivo: Atribuí uma função a uma teclaSintaxe: SET KEY <nKey> [TO <uAction>] IN <oObj> OBJ <oID>Parâmetros: <nKey> Tecla que será relacionada a função

<uAction> Função executada quando a tecla forpressionada

<oObj> Objeto ao qual a tecla será acionada<oID> Nome do objeto


Exemplo:


6

2. Funções de Banco de Dados

2.1. dbUseArea

Objetivo: Abre uma área de dadosSintaxe: dbUseArea(<lnew>, <cRdd>, <cArq>, <cAlias>,

<lshare>, <lReadOnly>)Parâmetros: <lnew> Indica a criação de uma nova área de

dados, .T. ou .F.<cRdd> Driver de abertura do arquivo, em

eAdvpl utilizar - "LOCAL"<cArq> Nome do arquivo a ser aberto<cAlias> Alias a ser utilizado pela área de

dados aberta<lshare> Indica se a área será compartilhada

ou exclusiva, .T. ou .F.<lReadOnly> Indica se a área será apenas para

leitura, .T. ou .F.Retorno: Não se aplica

Exemplo:

2.2. dbCloseArea

Objetivo: Fecha uma área de dadosSintaxe: dbCloseArea(<cAlias>)Parâmetros: <cAlias> Alias da área de dados que será

fechadaRetorno: Não se aplica

Exemplo:

2.3. dbSkip

Objetivo: Altera o registro correnteSintaxe: dbSkip(<nReg>)Parâmetros: <nReg> Número de registros a serem

movimentados, o padrão é 1Retorno: Não se aplica

Exemplo:


7

2.4. dbSeek

Objetivo: Faz uma pesquisa na área de dados correnteSintaxe: dbSeek(<cExpr>, <lSoft>, <lLast>)Parâmetros: <cExpr> Expressão a ser pesquisada

<lSoft> Indica a utilização do softseek<lLast> Pesquisa a última ocorrência da

<cExpr>Retorno: .T. caso a expressão seja encontrada

.F. caso a expressão não seja encontrada

Exemplo:

2.5. dbCreateIndex

Objetivo: Cria um índice para a área correnteSintaxe: dbCreateIndex(<cFile)>, <ckey>, [<lUniq>])Parâmetros: <cFile> Nome do arquivo de indice

<ckey> Chave do indice que está sendocriado

<lUniq> Indica a criação de um único índice,.T. ou .F.


Exemplo:

2.6. dbSetIndex

Objetivo: Relaciona um arquivo de índice a uma área de dadosSintaxe: dbSetIndex(<cFile)>)Parâmetros: <cFile> Nome do arquivo de indiceRetorno: Não se aplica

Exemplo:

2.7. dbGoTo

Objetivo: Altera o registro correnteSintaxe: dbGoTo(<nRecno>)Parâmetros: <nRecno> Número do registro a ser posicionadoRetorno: Não se aplica

Exemplo:


8

2.8. dbGoTop

Objetivo: Altera o registro corrente para o primeiro registro da áreaSintaxe: dbGoToo()Parâmetros: Não se aplicaRetorno: Não se aplica

Exemplo:

2.9. dbGoBottom

Objetivo: Altera o registro corrente para o último registro da áreaSintaxe: dbGoBottom()Parâmetros: Não se aplicaRetorno: Não se aplica

Exemplo:

2.10. dbPack

Objetivo: Apaga os registros com o flag de deletadoSintaxe: dbPack()Parâmetros: Não se aplicaRetorno: Não se aplica

Exemplo:

2.11. dbAppend

Objetivo: Inclui um registro em branco no final do arquivos de dadosSintaxe: dbAppend()Parâmetros: Não se aplicaRetorno: Não se aplica

Exemplo:

2.12. dbZap

Objetivo: Apaga todos os registros do arquivos de dadosSintaxe: dbZap()Parâmetros: Não se aplicaRetorno: Não se aplica

Exemplo:


9

2.13. dbCreate

Objetivo: Cria um arquivo de dadosSintaxe: dbCreate(<cArq>, <aStru>, <cRdd>)Parâmetros: <cArq> Nome do arquivo a ser aberto

<aStru> Array contendo a estrutura doarquivo

<cRdd> Driver de criação do arquivo, emeAdvpl utilizar - "LOCAL"


Exemplo:

2.14. dbClearIndex

Objetivo: Fecha todos os indices da área correnteSintaxe: dbClearIndex()Parâmetros: Não se aplicaRetorno: Não se aplica

Exemplo:

2.15. dbSetOrder

Objetivo: Seleciona um índice para a área de dados correnteSintaxe: DbSetOrder()Parâmetros: Não se aplicaRetorno: Não se aplica

Exemplo:

2.16. dbDelete

Objetivo: Apaga um registro de forma lógicaSintaxe: dbDelete()Parâmetros: Não se aplicaRetorno: Não se aplica

Exemplo:


10

2.17. dbCommit

Objetivo: Confirma as alterações na área de dadosSintaxe: dbCommit()Parâmetros: Não se aplicaRetorno: Não se aplica

Exemplo:

2.18. RecCount

Objetivo: Obter o número de registros em uma área de dadosSintaxe: RecCount()Parâmetros: Não se aplicaRetorno: Quantidade de registros na área de dados corrente

Exemplo:

2.19. Isdirty

Objetivo: Retorna status dos registro posicionado.Sintaxe: Isdirty()Parâmetros: Não se aplicaRetorno: True (.T.) indica que o registro foi incluído ou alterado

False (.F.) indica que o registro não foi incluído ou alterado

Exemplo: If HC5->(IsDirty()) Alert( Registro já foi transmitido )Else Alert( Registro com transmissão pendente )Endif


11

3. Funções de Interface

3.1. Dialog

Objetivo: Cria uma janelaSintaxe: DEFINE DIALOG <oDlg> [TITLE <cTitle>][COLOR

<nBack>,<nFore>]Parâmetros: <oDlg> Nome da janela a ser criada

<cTitle> Título da janela<nBack> Cor de fundo do objeto meter<nFore> Cor de frente do objeto meter


Exemplo:

3.2. Activate Dialog

Objetivo: Ativa uma janelaSintaxe: ACTIVATE DIALOG <oDlg>Parâmetros: <oDlg> Nome da janela a ser criadaRetorno: Não se aplica

Exemplo:

3.3. CloseDialog

Objetivo: Fecha uma janelaSintaxe: CloseDialog()Parâmetros: Não se aplicaRetorno: Não se aplica

Exemplo:

3.4. Add Menubar

Objetivo: Cria um menuSintaxe: ADD MENUBAR <oMnu> CAPTION <cCaption> OF <oWnd>Parâmetros: <oMnu> Nome do menu a ser criado

<cCaption> Texto utilizado no menu<oWnd> Janela a qual o menu pertence


Exemplo:


12

3.5. Add Menuitem

Objetivo: Cria uma janelaSintaxe: ADD MENUITEM <oItem> CAPTION <cCaption> [ACTION

<uAction>] OF <oMnu>Parâmetros: <oItem> Nome do item de menu

<cCaption> Texto do item de menu<uAction> Função a ser executada no item de

menu<oMnu> Menu ao qual o item pertence


Exemplo:

3.6. Add Folder

Objetivo: Cria objeto folderSintaxe: ADD FOLDER <oFld> CAPTION <cCaption> [ON ACTIVATE

<uAction>] [ COLOR <nBack>,<nFore> ] OF <oWnd>Parâmetros: <oFld> Nome do objeto Folder

<cCaption> Texto do folder<uAction> Função a ser executava quando o

folder se tornar ativo<nBack> Cor de fundo do objeto folder<nFore> Cor de frente do objeto folder<oWnd> Janela onde será criada o objeto

folderRetorno: Não se aplica

Exemplo:

3.7. Set Active Folder

Objetivo: Ativa um folderSintaxe: SET ACTIVE FOLDER <oFld> OF <oWnd>Parâmetros: <oFld> Nome do folder a ser ativado

<oWnd> Janela a qual o folder pertenceRetorno: Não se aplica

Exemplo:


13

3.8. Say

Objetivo: Cria objeto saySintaxe: @ <nRow>, <nCol> SAY <oSay> PROMPT <cText> [BOLD]

[LARGE] [SYMBOL] [PICTURE <cPicture>] [ COLOR<nBack>,<nFore> ] OF <oWnd>

Parâmetros: <nRow> Linha de criação do objeto<nCol> Coluna de criação do objeto<oSay> Nome do objeto<cText> Texto exibido no objetoBOLD Exibe o texto em negritoLARGE Exibe o texto uma fonte maiorSYMBOL Utiliza a fonte de símbolos<cPicture> Picture aplicada ao objeto<nBack> Cor de fundo do objeto<nFore> Cor de frente do objeto<oWnd> Janela onde será criada o objeto


Exemplo:

3.9. Get

Objetivo: Cria objeto getSintaxe: @ <nRow>, <nCol> GET <oGet> VAR <uVar>

[MULTILINE][NO UNDERLINE][SIZE <nWidth>,<nHeight>][RIGHT] [READONLY, NO MODIFY] [VALID <uValid> ][VSCROLL][PASSWORD][PICTURE <cPicture>] OF <oWnd>

Parâmetros: <nRow> Linha de criação do objeto<nCol> Coluna de criação do objeto<oGet> Nome do objeto<uVar> Variável que armazena o conteúdo do

getMULTILINE Exibe objeto get com várias linhasNOUNDERLINE

Inibe as linhas do objeto

<nWidth> Largura do objeto<nHeight> Altura do objetoRIGHT Alinha o texto à direitaREADONLY,NO MODIFY

Desabilita a edição do objeto

<uValid> Função de validação do conteúdo doobjeto

VSCROLL Ativa a barra de rolagem verticalPASSWORD Ativa mascará para senhas


14

<cPicture> Picture aplicada ao objeto<oWnd> Janela onde será criada o objeto


Exemplo:

3.10. Button

Objetivo: Cria objeto botãoSintaxe: @ <nRow>, <nCol> BUTTON <oBtn> CAPTION

<cCaption> [SIZE <nWidth>, <nHeight>][ACTION<uAction>] [CANCEL] [SYMBOL][COLOR<nBack>,<nFore>] OF <oWnd>

Parâmetros: <nRow> Linha de criação do objeto<nCol> Coluna de criação do objeto<oBtn> Nome do objeto<cCaption> Texto exibido no botão<nWidth> Largura do objeto<nHeight> Altura do objeto<uAction> Função executada no clique do objetoCANCELSYMBOL Utiliza a fonte de símbolos ou

bitmaps<nBack> Cor de fundo do objeto<nFore> Cor de frente do objeto<oWnd> Janela onde será criada o objeto


Exemplo:

3.11. Checkbox

Objetivo: Cria objeto checkboxSintaxe: @ <nRow>, <nCol> CHECKBOX <oBtn> [VAR <lCheck>]

CAPTION <cCaption> [SIZE <nWidth>, <nHeight>][ACTION <uAction>][COLOR <nBack>,<nFore>] OF<oWnd>

Parâmetros: <nRow> Linha de criação do objeto<nCol> Coluna de criação do objeto<oBtn> Nome do objeto<lCheck> Variável que armazena o conteúdo do

checkbox<cCaption> Texto exibido no checkbox<nWidth> Largura do objeto<nHeight> Altura do objeto


15

<uAction> Função executada no clique do objeto<nBack> Cor de fundo do objeto<nFore> Cor de frente do objeto<oWnd> Janela onde será criada o objeto


Exemplo:

3.12. Listbox

Objetivo: Cria objeto listboxSintaxe: @ <nRow>, <nCol> LISTBOX <oLbx> [ VAR <nVar>]

ITEMS <aItems> [SIZE <nWidth>, <nHeight>][ACTION <uAction>][COLOR <nBack>,<nFore>] OF<oWnd>

Parâmetros: <nRow> Linha de criação do objeto<nCol> Coluna de criação do objeto<oLbx> Nome do objeto<nVar> Variável que armazena a opção

selecionada do list<aItems> Array com os itens exibidos no objeto<nWidth> Largura do objeto<nHeight> Altura do objeto<uAction> Função executada na seleção de uma

opção do objeto<nBack> Cor de fundo do objeto<nFore> Cor de frente do objeto<oWnd> Janela onde será criada o objeto


Exemplo:

3.13. Combobox

Objetivo: Cria objeto ComboboxSintaxe: @ <nRow>, <nCol> COMBOBOX <oCbx> [VAR <nVar>]

ITEMS <aItems> [SIZE <nWidth>, <nHeight>][ACTION <uAction>][COLOR <nBack>,<nFore>] OF<oWnd>

Parâmetros: <nRow> Linha de criação do objeto<nCol> Coluna de criação do objeto<oCbx> Nome do objeto<nVar> Variável que armazena a opção

selecionada do combo<aItems> Array com os itens exibidos no objeto


16

<nWidth> Largura do objeto<nHeight> Altura do objeto<uAction> Função executada na seleção de uma

opção do objeto<nBack> Cor de fundo do objeto<nFore> Cor de frente do objeto<oWnd> Janela onde será criada o objeto


Exemplo:

3.14. @ To

Objetivo: Desenha quadro na telaSintaxe: @ <FromRow>, <FromCol> TO <ToRow>,<ToCol>

[<oBox>] [CAPTION <cCaption>] [COLOR<nBack>,<nFore>] OF <oWnd>

Parâmetros: <FromRow> Linha inicial de criação do objeto<FromCol> Coluna inicial de criação do objeto<ToRow> Linha final de criação do objeto<ToCol> Coluna final de criação do objeto<cCaption> Texto exibido no quadro<nBack> Cor de fundo do objeto<nFore> Cor de frente do objeto<oWnd> Janela onde será criada o objeto


Exemplo:

3.15. Browse

Objetivo: Cria objeto browseSintaxe: @ <nRow>,<nCol> BROWSE <oBrw> SIZE

<nWidth>,<nHeight> ACTION <uAction> [NO SCROLL][COLOR <nBack>,<nFore>] OF <oDlg>

Parâmetros: <nRow> Linha de criação do objeto<nCol> Coluna de criação do objeto<oBrw> Nome do objeto<nWidth> Largura do objeto<nHeight> Altura do objeto<uAction> Função executada na seleção de uma

linha do objetoNO SCROLL Desabilita a rolagem no objeto<nBack> Cor de fundo do objeto<nFore> Cor de frente do objeto


17

<oDlg> Janela onde será criada o objetoRetorno: Não se aplica

Exemplo:

3.16. Set Browse

Objetivo: Relaciona um browse a um arraySintaxe: SET BROWSE <oBrw> ARRAY <aArray>Parâmetros: <oBrw> Nome do browse a ser relacionado

<aArray> Array a ser relacionadoRetorno: Não se aplica

Exemplo:

3.17. Add Column

Objetivo: Cria uma coluna no objeto browseSintaxe: ADD COLUMN <oCol> TO [BROWSE] <oBrw> ARRAY

ELEMENT <elm> [HEADER <cHead>] [WIDTH <nWidth>[PIXELS]] [PICTURE <cPicture>][<MARK>] [ALIGNLEFT, RIGHT>] [OPTIONS <aArray>][EDITABLE][VALID<uValid>]

Parâmetros: <oCol> Nome do objeto da Coluna<oBrw> Nome do objeto<elm> Posição do Array que será exibida na

coluna<cHead> Título da Coluna<nWidth> Largura da coluna<cPicture> Picture aplicada a colunaMARK Indica se a coluna mostrará uma opção

de MarkALIGN Indica alinhamento da coluna, LEFT

(esquerda) ou RIGHT (direita)<aArray> Lista de opções para utilização de um

combobox na célulaEDITABLE Indica se a coluna poderá ser editada<uValid> Função de validação do valor da

coluna, quando editadaRetorno: Não se aplica

Exemplo:


18

3.18. GridSetCellColor

Objetivo: Altera a cor de uma célula do BrowseSintaxe: GridSetCellColor(<oBrw>,<nRow>,<nCol>,<nBack>,

<nFore>)Parâmetros: <oBrw> Nome do browse a ser utilizado

<nRow> Número da linha da célula<nCol> Número da coluna da célula<nBack> Cor de fundo atribuída a célula<nFore> Cor de frente atribuída a célula


Exemplo:

3.19. DbBrowse

Objetivo: Cria objeto browse associado a um arquivo de dadosSintaxe: @ <nRow>,<nCol> DBBROWSE <oBrw> ALIAS <cAlias>

SIZE <nWidth>,<nHeight> [ACTION> <uAction>][COLOR <nBack>,<nFore>] [BUTTONS <aBtn>] OF<oDlg>

Parâmetros: <nRow> Linha de criação do objeto<nCol> Coluna de criação do objeto<oBrw> Nome do objeto<cAlias> Alias associado ao dbbrowse<nWidth> Largura do objeto<nHeight> Altura do objeto<uAction> Função executada na seleção de uma

linha do objetoNO SCROLL Desabilita a rolagem no objeto<nBack> Cor de fundo do objeto<nFore> Cor de frente do objeto<aBtn> Array de 10 posições contendo .T. ou

.F. indicando quais botões dodbbrowse serão habilitados

<oDlg> Janela onde será criada o objetoRetorno: Não se aplica

Exemplo:


19

3.20. Add DbColumn

Objetivo: Cria uma coluna no objeto DbbrowseSintaxe: ADD DBCOLUMN <oCol> TO [DBBROWSE] <oBrw> FIELD

<cField> [HEADER <cHead>][WIDTH <nWidth>[PIXELS]] [PICTURE <cPicture>] [ALIGNLEFT,RIGHT>] [EDITABLE>] [VALID <uValid>]

Parâmetros: <oCol> Nome do objeto da Coluna<oBrw> Nome do objeto<cField> Nome do campo exibido na coluna<cHead> Título da Coluna<nWidth> Largura da coluna<cPicture> Picture aplicada a colunaALIGN Indica alinhamento da coluna, LEFT

(esquerda) ou RIGHT (direita)EDITABLE Indica se a coluna poderá ser editada<uValid> Função de validação do valor da

coluna, quando editadaRetorno: Não se aplica

Exemplo:

3.21. Set Search DbBrowse

Objetivo: Atribuí uma função de busca ao objeto dbBrowseSintaxe: SET SEARCH DBBROWSE <oBrw> TO <uAction>Parâmetros: <oBrw> Nome do browse a ser relacionado

<uAction> Função utilizada para a pesquisaRetorno: Não se aplica

Exemplo:

3.22. Set Bitmap

Objetivo: Atribuí um bitmap ao objetoSintaxe: SET BITMAP <nBmp> TO <oObj>Parâmetros: <nBmp> Imagem a ser atribuída

<oObj> Objeto ao qual a imagem seráassociada


Exemplo:


20

3.23. Meter

Objetivo: Cria objeto meterSintaxe: @ <nRow>,<nCol> METER <oMtr> [FROM <nFrom> TO

<nTo>] [ SIZE <nWidth>,<nHeight>] [ COLOR<nBack>,<nFore> ] OF <oWnd>

Parâmetros: <nRow> Linha de criação do objeto<nCol> Coluna de criação do objeto<oMtr> Nome do objeto meter<nFrom> Valor inicial do objeto meter<nTo> Valor final do objeto meter<nWidth> Largura do objeto meter<nHeight> Altura do objeto meter<nBack> Cor de fundo do objeto meter<nFore> Cor de frente do objeto meter<oWnd> Janela onde será criada o objeto

meterRetorno: Não se aplica

Exemplo:

3.24. SetMeter()

Objetivo: Atualiza objetos meterSintaxe: SetMeter(<Objeto>, <nMeter>)Parâmetros: <Objeto> Objeto meter a ser atualizado

<nMeter> Novo conteúdo atribuído aoobjeto meter.


Exemplo:

3.25. SetArray()

Objetivo: Atualiza objetos que utilizam arraySintaxe: SetArray(<Objeto>, <aArray>)Parâmetros: <Objeto> Objeto onde será atribuído o

array<aArray> Novo conteúdo atribuído ao

objeto.Retorno: Não se aplica

Exemplo:


21

3.26. HideControl()

Objetivo: Esconde o objetoSintaxe: HideControl(<Objeto>)Parâmetros: <Objeto> Objeto a ser escondidoRetorno: Não se aplica

Exemplo:

3.27. ShowControl()

Objetivo: Exibe o objetoSintaxe: ShowControl(<Objeto>)Parâmetros: <Objeto> Objeto a ser exibidoRetorno: Não se aplica

Exemplo:

3.28. DisableControl()

Objetivo: Habilita o objetoSintaxe: DisableControl(<Objeto>)Parâmetros: <Objeto> Objeto a ser desabilitadoRetorno: Não se aplica

Exemplo:

3.29. EnableControl()

Objetivo: Habilita o objetoSintaxe: EnableControl(<Objeto>)Parâmetros: <Objeto> Objeto a ser habilitadoRetorno: Não se aplica

Exemplo:


22

3.30. SetText()

Objetivo: Atualiza objeto getSintaxe: SetText(<Objeto>, <cExpressao>)Parâmetros: <Objeto> Objeto onde será atribuído a

<cExpressao><cExpressao> Novo conteúdo atribuído ao

objeto get.Retorno: Não se aplica

Exemplo:

3.31. SetFocus

Objetivo: Atribuí o foco da aplicação a um objetoSintaxe: SetFocus(<Objeto>)Parâmetros: <Objeto> Objeto onde será atribuído o

focoRetorno: Não se aplica

Exemplo:

3.32. GridReset()

Objetivo: Atualiza objeto gridSintaxe: GridReset(<oObjeto>)Parâmetros: <oObjeto> Objeto GridRetorno: Não se aplica

Exemplo:

3.33. GridRow()

Objetivo: Obter número da linha selecionada em um objeto gridSintaxe: GridRow(<oObjeto>)Parâmetros: <oObjeto> Objeto GridRetorno: Número da linha selecionada no objeto

Exemplo:


23

3.34. GridRows()

Objetivo: Obter número de linhas visíveis em um objeto gridSintaxe: GridRows(<oObjeto>)Parâmetros: <oObjeto> Objeto GridRetorno: Número de linhas visiveis no objeto

Exemplo:

3.35. GridSetRow()

Objetivo: Selecionar uma linha em um objeto gridSintaxe: GridSetRow(<oObjeto>, <nLinha>)Parâmetros: <oObjeto> Objeto Grid

<nLinha> Número da linha a serselecionada


Exemplo:

3.36. GridCol()

Objetivo: Obter número da coluna selecionada em um objeto GridSintaxe: GridCol(<oObjeto>)Parâmetros: <oObjeto> Objeto GridRetorno: Número da coluna selecionada

Exemplo:

3.37. GridLeft ()

Objetivo: Move uma coluna para a esquerda no objeto GridSintaxe: GridLeft(<oObjeto>)Parâmetros: <oObjeto> Objeto Grid a ser movimentadoRetorno: Não se aplica

Exemplo:

3.38. Gridright ()

Objetivo: Move uma coluna para a direita no objeto GridSintaxe: Gridright (<oObjeto>)Parâmetros: <oObjeto> Objeto Grid a ser movimentadoRetorno: Não se aplica


24

Exemplo:

3.39. GetListRows()

Objetivo: Obter linha visíveis de um objetoSintaxe: GetListRows(<oObjeto>)Parâmetros: <oObjeto> Objeto List a ser verificado o

número de linhasRetorno: Número de linha visíveis do objeto

Exemplo:

3.40. MoveControl

Objetivo: Altera a posição de um objeto na telaSintaxe: MoveControl(<oObj>, <nLin>, <nCol>)Parâmetros: <oObj> Objeto que será reposicionado

<nLin> Nova linha de posição do objeto<nCol> Nova coluna de posição do objeto


Exemplo:

3.41. ResizeControl

Objetivo: Altera a posição de um objeto na telaSintaxe: ResizeControl(<oObj>, <nWidth>, <nHeight>)Parâmetros: <oObj> Objeto que será redimensionado

<nWidth> Nova largura do objeto<nHeight> Nova altura do objeto


Exemplo:

3.42. GetObjPos

Objetivo: Obtém a posição atual de um objetoSintaxe: MoveControl(<oObj>)Parâmetros: <oObj> Objeto do qual serão retornadas as

coordenadasRetorno: Array com as coordenadas do objeto

Exemplo:


25

3.43. GetObjSize

Objetivo: Obtém o tamanho atual de um objetoSintaxe: GetObjSize (<oObj>)Parâmetros: <oObj> Objeto do qual será retornado o

tamanhoRetorno: Array com o tamanho do objeto

Exemplo:


26

4. Funções de Timer

4.1. Define Timer

Objetivo: Cria um objeto de TimerSintaxe: DEFINE TIMER [<oTimer>] [INTERVAL <nInterval>]

[ACTION <uAction>]Parâmetros: <oTimer> Nome do ObjetoTecla que será

relacionada a função<nInterval> Intervalo de execução do timer em

milisegundos<uAction> Função executada a cada <nInterval>

milisegundosRetorno: Não se aplica

Exemplo:

4.2. ActiveTimer (oTimer)

Objetivo: Ativa um objeto de timerSintaxe: ACTIVETIMER(oTimer)Parâmetros: <oTimer> Nome do objeto de timer a ser ativadoRetorno: Não se aplica

Exemplo:

4.3. DeactiveTimer (oTimer)

Objetivo: Desativa um objeto de timerSintaxe: DEACTIVETIMER(oTimer)Parâmetros: <oTimer> Nome do objeto de timer a ser

desativadoRetorno: Não se aplica

Exemplo:


27

5. Funções de Bibliotecas (DLL/SO)

5.1. Dll Function

Objetivo: Declaração de uma função contida na biblioteca DLL ou SOSintaxe: DLL FUNCTION <cImportFuncName> LOCALNAME

<cInternalName> PARAMTYPE <CSTD,PASCAL> ([<uParam1> AS <type1>][,<uParamN> AS <typeN>]) AS<rettype> LIB <DllName>

Parâmetros: <cImportFuncName> Nome da função na biblioteca<cInternalName> Nome da função utilizada na

aplicação eAdvpl<cParamType> Tipo de passagem de

parâmetro utilizado pelabiblioteca CSTD ou PASCAL

<uParam1>.<uParamN> Parâmetros da função<type1>.. <typeN> Tipos dos parâmetros<rettype> Tipo de retorno da função<DllName> Nome da biblioteca


Exemplo:

5.2. Export Function

Objetivo: Declara as funções que poderão ser utilizadas na biblioteca, DLLou SO, gerada pelo eAdvpl

Sintaxe: EXPORT FUNCTION AS <FuncName>( [ <uParam1> AS<type1> ][, <uParamN> AS <typeN>] ) RETURNING<rettype>

Parâmetros: <FuncName> Nome ao qual da função seráexportada na biblioteca

<uParam1>.<uParamN> Parâmetros da função<type1>.. <typeN> Tipos dos parâmetros<rettype> Tipo de retorno da função


Exemplo:


28

5.3. Open Serial

Objetivo: Abre uma porta serialSintaxe: OPEN SERIAL <nSerial> TO <hHandle> BAUD

9600,19200 BYTESIZE 7,8 PARITY 0,1 STOPBITS 0,1Parâmetros: <nSerial> Número da porta que será aberta, COM1

-> 1<hHandle> Variável que armanezará o handle da

serialBAUD Velocidade de comunicação: 9600 ou

19200BYTESIZE Bytesize: 7 ou 8PARITY Paridade: 0 ou 1STOPBITS Stopbits: 0 ou 1


Exemplo:


29

6. Funções de Alerta

6.1. MsgStop()

Objetivo: Exibe uma mensagem de erro.Sintaxe: MsgStop(<cExpressao>,<cTitulo>)Parâmetros: <cExpressao> Mensagem a ser exibida

<cTitulo> Título exibido na janelaRetorno: Não se aplica

Exemplo:

6.2. MsgYesOrNo()

Objetivo: Exibe uma mensagem com opçãoes de respostas “SIM” ou“NÃO”.

Sintaxe: MsgYesOrNo(<cPergunta>,<cTitulo>)Parâmetros: <cPergunta> Mensagem a ser exibida

<cTitulo> Título exibido na janelaRetorno: True (.T.) SIM

False(.F.) NÃO

Exemplo:

6.3. MsgStatus ()

Objetivo: Exibe uma mensagem que independe de uma ação de usuário.Sintaxe: MsgStatus(<cExpressao>)Parâmetros: <cExpressao> Mensagem a ser exibidaRetorno: Não se aplica

Exemplo:

6.4. ClearStatus ()

Objetivo: Apaga mensagem criada pela função MsgStatus.Sintaxe: ClearStatus()Parâmetros: Não se aplicaRetorno: Não se aplica

Exemplo: ClearStatus()


30

6.5. Alert()

Objetivo: Exibe uma mensagem de alerta.Sintaxe: Alert(<cMensagem>)Parâmetros: <cMensagem> Mensagem a ser exibidaRetorno: Não se aplica

Exemplo:

6.6. MsgAlert()

Objetivo: Exibe uma mensagem de alerta.Sintaxe: MsgAlert(<cMensagem>,<cTítulo>)Parâmetros: <cMensagem> Mensagem a ser exibida

<cTítulo> Titulo da janela de mensagemRetorno: Não se aplica

Exemplo:


31

7. Funções de Array

7.1. AAdd

Objetivo: Adiciona um elemento no fim do array.Sintaxe: AAdd(<array>, <uValor>)Parâmetros: <array> Array onde será adicionado um

elemento<uValor> Elemento a ser adicionado


Exemplo:

7.2. SortArray ()

Objetivo: Ordernar um array.Sintaxe: SortArray(<Array>,[<elem-inicial>], [<qtde-de-

elem>], [<ordem>], <coluna>)Parâmetros: <array> Array onde será feita a busca

<elem-inicial> Posição inicial da ordenação,padrão 1

[<qtde-de-elem>] Quantos itens serão ordenados<ordem> True (.T.) Ascendente

False(.F.) Descendente-Padrão<coluna> Coluna base para ordenação

Retorno: Número da linha onde a expressão foi encontrada

Exemplo:

7.3. aSize

Objetivo: Altera o tamanho de um array.Sintaxe: ScanArray(<array>, <nTam>)Parâmetros: <array> Array que terá o tamanho

alterado<nTam> Novo tamanho do array


Exemplo:


32

7.4. ScanArray()

Objetivo: Pesquisar um determinado expressão em elementos de um array.Sintaxe: ScanArray(<array>, <expressao>, [<inicio>],

[<qtd-de-itens>],<coluna>)Parâmetros: <array> Array onde será feita a busca

<expressao> Valor a ser procurado[<inicio>] Posição inicial de busca,

padrão 1[<qtd-de-itens>] Número de linhas a ser

pesquisado, padrão todo o array<coluna> Coluna onde será realizada a

buscaRetorno: Número da linha onde a expressão foi encontrada ou 0 (zero)

caso não seja encontrada nenhuma ocorrência

Exemplo:


33

8. Funções de Comunicação

8.1. DoSync

Objetivo: Inicia o programa cliente de comunicaçãoSintaxe: DoSync()Parâmetros: Não se aplicaRetorno: Não se aplica

Exemplo:

8.2. SyncDate

Objetivo: Retorna data do último sincronismo no formato aaaammdd.Sintaxe: SyncDate()Parâmetros: Não se aplicaRetorno: Retorna a data do último sincronismoExemplo:


34

9. Funções de RPC

9.1. Connectserver

Objetivo: Cria uma conexão com o servidor para uma chamada de RPCSintaxe: Connectserver()Parâmetros: Não se aplicaRetorno: Número da conexão criada

Exemplo:

9.2. Rpcprotheus

Objetivo: Cria uma conexão com o servidor para uma chamada de RPCSintaxe: Rpcprotheus(<nCon> , <cFunc> , <cParam>)Parâmetros: <nCon> Número da conexão criada

<cFunc> Função a ser executada<cParam> Parâmetro para para a função <cFunc>

Retorno: Número da conexão criada

Exemplo:

9.3. Disconnectserver

Objetivo: Fecha uma conexão com o servidorSintaxe: Disconnectserver(<nCon>)Parâmetros: <nCon> Número da conexãoRetorno: Não se aplica

Exemplo:


35

10. Funções de String

10.1. Str

Objetivo: Converte um valor numérico em uma stringSintaxe: Str(<nVal>, <nTam>, <nDec>)Parâmetros: <nVal> Valor numérico

<nTam> Tamanho da string a ser retornado<nDec> Número de casa decimais utilizados na

stringRetorno: String do valor numérico

Exemplo:

10.2. Substr

Objetivo: Extrai parte de uma stringSintaxe: Substr(<cString>, <nStart>, [<nCount>])Parâmetros: <cString> String de onde será extraído uma nova

string<nStart> Posição inicial da extração<nCount> Número de caracteres a serem

extraídosRetorno: Parte da <cString>

Exemplo:

10.3. AllTrim

Objetivo: Elimina espaços em branco, a direita e a esquerda, de uma stringSintaxe: AllTrim(<cString>)Parâmetros: <cString> String onde serão extraído os espaçosRetorno: String sem espaçoes em branco

Exemplo:


36

10.4. Len

Objetivo: Obter a quantiade de caracteres de uma string ou quantidade deelementos de um array

Sintaxe: AllTrim(<cString> | <aArray>)Parâmetros: <cString>

<aArray>

String onde serão contados oscaracteresArray onde serão contados oselementos

Retorno: Número de caracteres em uma string ou número de elementos deum array

Exemplo:

10.5. Empty

Objetivo: Obter a quantiade de caracteres de uma string ou quantidade deelementos de um array

Sintaxe: AllTrim(<cString> | <aArray>)Parâmetros: <cString>

<aArray>

String onde serão contados oscaracteresArray onde serão contados oselementos

Retorno: Número de caracteres em uma string ou número de elementos deum array

Exemplo:11.


37

12. Miscelânea

12.1. Keyboard

Objetivo: Apresenta um teclado para digitação na telaSintaxe: Keyboard(<nKeybo>, <oObj>)Parâmetros: <nKeybo> Indica qual teclado será mostrado.

Verificar tabela Teclados<oObj> Nome do objeto GET onde será

mostrado o valor digitado no tecladoRetorno: String digitado no teclado

Exemplo:

12.2. SelectDate

Objetivo: Apresenta um calendário na tela para seleção de uma dataSintaxe: SelectDate(<cString>, <dData>)Parâmetros: <cString> Título da janela do calendário

<dData> Variável onde será armazenado a dataselecionada

Retorno: Data selecionada no calendário

Exemplo:

12.3. Sleep

Objetivo: Para o processamento da aplicação por um intervalo de tempoSintaxe: SLEEP(<nInterval>)Parâmetros: <nInterval> Intervalo de execução do timer em

milisegundosRetorno: Não se aplica

Exemplo:


38

13. Funções de Impressão

13.1. Set Print Font

Objetivo: Modifica a fonte utilizada para impressão.A disponibilidade de utilização de fontes varia entre os modelos deimpressoras disponíveis no mercado, podendo não suportar estecomando

Sintaxe: SET PRINT FONT <nFont> [SIZE <nWidth>,<nHeight>][<BOLD>] [<UNDERLINE>] [<ITALIC>]

Parâmetros: <nFont> Número da fonte a ser utilizada<nWidth> Largura da fonte<nHeight> Altura da fonteBOLD Indica a utilização de negrito na

fonteUNDERLINE Indica a utilização de sublinhado na

fonteITALIC Indica a utilização de itálico na

fonteRetorno: Não se aplica

Exemplo:

13.2. Psay

Objetivo: Envia um texto para impressoraSintaxe: @ <nRow>,<nCol> PSAY <cText>Parâmetros: <nRow> Linha onde o texto será impresso

<nCol> Coluna onde o texto será impresso<cText> Texto a ser impresso


39

14. Anexos

14.1. TecladoTeclado Alfanumérico KEYBOARD_ALPHA 0Teclado Numérico KEYBOARD_NUMBER 1Teclado de símbolos KEYBOARD_ACCENT 2

14.2. CalendárioSELECT_DAYBYDAY 0SELECT_DAYBYWEEK 1SELECT_DAYBYMONTH 2

14.3. Botões de OperaçãoSeta para cima VK_UP 11Seta para baixo VK_DOWN 12Seta 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. SímbolosLEFT_ARROW Chr(3)RIGHT_ARROW Chr(4)UP_ARROW Chr(5)DOWN_ARROW Chr(6)

14.5. BitmapsBTN_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)


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)


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_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_USA Chr(66)

14.6. CoresPreto CLR_BLACK 1Azul CLR_BLUE 2Verde CLR_GREEN 3


42

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

guia de referencia e advpl

Documents