Guia de referência eAdvpl Guia de Referência eADVPL Sumário 1. Funções de Ambiente....................................................................................4 1.1. Set Date..................................................................................................4 1.2. Set Deleted.............................................................................................4 1.3. Set Device ..............................................................................................4 1.4. Set Key ...................................................................................................5 2. Funções 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. Funções 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 Guia de referência eAdvpl 3.17. Add Column ......................................................................................17 3.18. GridSetCellColor ...............................................................................18 3.19. DbBrowse .........................................................................................18 3.20. Add DbColumn..................................................................................19 3.21. Set Search DbBrowse.......................................................................19 3.22. Set Bitmap ........................................................................................19 3.23. Meter.................................................................................................20 3.24. SetMeter() .........................................................................................20 3.25. SetArray()..........................................................................................20 3.26. HideControl().....................................................................................21 3.27. ShowControl() ...................................................................................21 3.28. DisableControl() ................................................................................21 3.29. EnableControl().................................................................................21 3.30. SetText() ...........................................................................................22 3.31. SetFocus...........................................................................................22 3.32. GridReset() .......................................................................................22 3.33. GridRow()..........................................................................................22 3.34. GridRows()........................................................................................23 3.35. GridSetRow() ....................................................................................23 3.36. GridCol() ...........................................................................................23 3.37. GridLeft ()..........................................................................................23 3.38. Gridright ().........................................................................................23 3.39. GetListRows() ...................................................................................24 3.40. MoveControl......................................................................................24 3.41. ResizeControl ...................................................................................24 3.42. GetObjPos ........................................................................................24 3.43. GetObjSize........................................................................................25 4. Funções de Timer........................................................................................26 4.1. Define Timer .........................................................................................26 4.2. ActiveTimer (oTimer) ............................................................................26 4.3. DeactiveTimer (oTimer) ........................................................................26 5. Funções de Bibliotecas (DLL/SO)................................................................27 5.1. Dll Function...........................................................................................27 5.2. Export Function ....................................................................................27 5.3. Open Serial...........................................................................................28 6. Funções de Alerta........................................................................................29 6.1. MsgStop() .............................................................................................29 6.2. MsgYesOrNo()......................................................................................29 6.3. MsgStatus () .........................................................................................29 6.4. ClearStatus () .......................................................................................29 6.5. Alert()....................................................................................................30 6.6. MsgAlert() .............................................................................................30 7. Funções de Array ........................................................................................31 7.1. AAdd.....................................................................................................31 7.2. SortArray () ...........................................................................................31 7.3. aSize.....................................................................................................31 2 Guia de referência eAdvpl 7.4. ScanArray() ..........................................................................................32 8. Funções de Comunicação ...........................................................................33 8.1. DoSync .................................................................................................33 8.2. SyncDate ..............................................................................................33 9. Funções de RPC .........................................................................................34 9.1. Connectserver ......................................................................................34 9.2. Rpcprotheus .........................................................................................34 9.3. Disconnectserver..................................................................................34 10. Funções de String ....................................................................................35 10.1. Str .....................................................................................................35 10.2. Substr................................................................................................35 10.3. AllTrim...............................................................................................35 10.4. Len ....................................................................................................36 10.5. Empty................................................................................................36 11........................................................................................................................36 12. Miscelânea ...............................................................................................37 12.1. Keyboard...........................................................................................37 12.2. SelectDate ........................................................................................37 12.3. Sleep.................................................................................................37 13. Funções de Impressão.............................................................................38 13.1. Set Print Font ....................................................................................38 13.2. Psay ..................................................................................................38 14. Anexos .....................................................................................................39 14.1. Teclado .............................................................................................39 14.2. Calendário.........................................................................................39 14.3. Botões de Operação .........................................................................39 14.4. Símbolos ...........................................................................................39 14.5. Bitmaps .............................................................................................39 14.6. Cores ................................................................................................41 3 Guia de referência eAdvpl 1. Funções de Ambiente 1.1. Set Date Objetivo: Configura o forma de data SET DATE [TO] <cDateFormat> Sintaxe: Parâmetros: <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: Não se aplica Exemplo: 1.2. Set Deleted Objetivo: Ativa ou desativa filtro de registros deletados SET DELETED <cFiltro> Sintaxe: ON descpnsidera registros Parâmetros: <cFiltro> deletados OFF considera registros deletados Retorno: Não se aplica Exemplo: 1.3. Set Device Objetivo: Indica qual a saída dos comandos de tela SET DEVICE <cDevice> Sintaxe: <cDevice> PRINT envia comandos para Parâmetros: impressora SCREEN envia comandos para a tela Retorno: Não se aplica Exemplo: 4 Guia de referência eAdvpl 1.4. Set Key Objetivo: Atribuí uma função a uma tecla SET KEY <nKey> [TO <uAction>] IN <oObj> OBJ <oID> Sintaxe: Tecla que será relacionada a função Parâmetros: <nKey> <uAction> Função executada quando a tecla for pressionada <oObj> Objeto ao qual a tecla será acionada <oID> Nome do objeto Retorno: Não se aplica Exemplo: 5 Guia de referência eAdvpl 2. Funções de Banco de Dados 2.1. dbUseArea Objetivo: Sintaxe: Abre uma área de dados dbUseArea(<lnew>, <cRdd>, <cArq>, <cAlias>, <lshare>, <lReadOnly>) Indica a criação de uma nova área de Parâmetros: <lnew> 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 dados dbCloseArea(<cAlias>) Sintaxe: Alias da área de dados que será Parâmetros: <cAlias> fechada Retorno: Não se aplica Exemplo: 2.3. dbSkip Objetivo: Altera o registro corrente dbSkip(<nReg>) Sintaxe: Número de registros a serem Parâmetros: <nReg> movimentados, o padrão é 1 Retorno: Não se aplica Exemplo: 6 Guia de referência eAdvpl 2.4. dbSeek Objetivo: Faz uma pesquisa na área de dados corrente dbSeek(<cExpr>, <lSoft>, <lLast>) Sintaxe: Expressão a ser pesquisada Parâmetros: <cExpr> <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 corrente dbCreateIndex(<cFile)>, <ckey>, [<lUniq>]) Sintaxe: Nome do arquivo de indice Parâmetros: <cFile> <ckey> Chave do indice que está sendo criado <lUniq> Indica a criação de um único índice, .T. ou .F. Retorno: Não se aplica Exemplo: 2.6. dbSetIndex Objetivo: Sintaxe: Parâmetros: Retorno: Relaciona um arquivo de índice a uma área de dados dbSetIndex(<cFile)>) <cFile> Nome do arquivo de indice Não se aplica Exemplo: 2.7. dbGoTo Objetivo: Sintaxe: Parâmetros: Retorno: Altera o registro corrente dbGoTo(<nRecno>) <nRecno> Número do registro a ser posicionado Não se aplica Exemplo: 7 Guia de referência eAdvpl 2.8. dbGoTop Objetivo: Sintaxe: Parâmetros: Retorno: Altera o registro corrente para o primeiro registro da área dbGoToo() Não se aplica Não se aplica Exemplo: 2.9. dbGoBottom Objetivo: Sintaxe: Parâmetros: Retorno: Altera o registro corrente para o último registro da área dbGoBottom() Não se aplica Não se aplica Exemplo: 2.10. Objetivo: Sintaxe: Parâmetros: Retorno: dbPack Apaga os registros com o flag de deletado dbPack() Não se aplica Não se aplica Exemplo: 2.11. Objetivo: Sintaxe: Parâmetros: Retorno: dbAppend Inclui um registro em branco no final do arquivos de dados dbAppend() Não se aplica Não se aplica Exemplo: 2.12. Objetivo: Sintaxe: Parâmetros: Retorno: dbZap Apaga todos os registros do arquivos de dados dbZap() Não se aplica Não se aplica Exemplo: 8 Guia de referência eAdvpl 2.13. dbCreate Objetivo: Cria um arquivo de dados dbCreate(<cArq>, <aStru>, <cRdd>) Sintaxe: Nome do arquivo a ser aberto Parâmetros: <cArq> <aStru> Array contendo a estrutura do arquivo <cRdd> Driver de criação do arquivo, em eAdvpl utilizar - "LOCAL" Retorno: Não se aplica Exemplo: 2.14. Objetivo: Sintaxe: Parâmetros: Retorno: dbClearIndex Fecha todos os indices da área corrente dbClearIndex() Não se aplica Não se aplica Exemplo: 2.15. Objetivo: Sintaxe: Parâmetros: Retorno: dbSetOrder Seleciona um índice para a área de dados corrente DbSetOrder() Não se aplica Não se aplica Exemplo: 2.16. Objetivo: Sintaxe: Parâmetros: Retorno: dbDelete Apaga um registro de forma lógica dbDelete() Não se aplica Não se aplica Exemplo: 9 Guia de referência eAdvpl 2.17. Objetivo: Sintaxe: Parâmetros: Retorno: dbCommit Confirma as alterações na área de dados dbCommit() Não se aplica Não se aplica Exemplo: 2.18. Objetivo: Sintaxe: Parâmetros: Retorno: RecCount Obter o número de registros em uma área de dados RecCount() Não se aplica Quantidade de registros na área de dados corrente Exemplo: 2.19. Isdirty Objetivo: Sintaxe: Parâmetros: Retorno: Retorna status dos registro posicionado. Isdirty() Não se aplica 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 10 Guia de referência eAdvpl 3. Funções de Interface 3.1. Dialog Objetivo: Sintaxe: Cria uma janela DEFINE DIALOG <oDlg> [TITLE <cTitle>][COLOR <nBack>,<nFore>] Nome da janela a ser criada Parâmetros: <oDlg> <cTitle> Título da janela <nBack> Cor de fundo do objeto meter <nFore> Cor de frente do objeto meter Retorno: Não se aplica Exemplo: 3.2. Activate Dialog Objetivo: Sintaxe: Parâmetros: Retorno: Ativa uma janela ACTIVATE DIALOG <oDlg> <oDlg> Nome da janela a ser criada Não se aplica Exemplo: 3.3. CloseDialog Objetivo: Sintaxe: Parâmetros: Retorno: Fecha uma janela CloseDialog() Não se aplica Não se aplica Exemplo: 3.4. Add Menubar Objetivo: Cria um menu ADD MENUBAR <oMnu> CAPTION <cCaption> OF <oWnd> Sintaxe: <oMnu> Nome do menu a ser criado Parâmetros: <cCaption> Texto utilizado no menu <oWnd> Janela a qual o menu pertence Retorno: Não se aplica Exemplo: 11 Guia de referência eAdvpl 3.5. Add Menuitem Objetivo: Sintaxe: Cria uma janela ADD MENUITEM <oItem> CAPTION <cCaption> [ACTION <uAction>] OF <oMnu> Nome do item de menu Parâmetros: <oItem> <cCaption> Texto do item de menu <uAction> Função a ser executada no item de menu <oMnu> Menu ao qual o item pertence Retorno: Não se aplica Exemplo: 3.6. Add Folder Objetivo: Sintaxe: Cria objeto folder ADD FOLDER <oFld> CAPTION <cCaption> [ON ACTIVATE <uAction>] [ COLOR <nBack>,<nFore> ] OF <oWnd> Nome do objeto Folder Parâmetros: <oFld> <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 folder Retorno: Não se aplica Exemplo: 3.7. Set Active Folder Objetivo: Ativa um folder SET ACTIVE FOLDER <oFld> OF <oWnd> Sintaxe: <oFld> Nome do folder a ser ativado Parâmetros: <oWnd> Janela a qual o folder pertence Retorno: Não se aplica Exemplo: 12 Guia de referência eAdvpl 3.8. Say Objetivo: Sintaxe: Cria objeto say @ <nRow>, <nCol> SAY <oSay> PROMPT <cText> [BOLD] [LARGE] [SYMBOL] [PICTURE <cPicture>] [ COLOR <nBack>,<nFore> ] OF <oWnd> Linha de criação do objeto Parâmetros: <nRow> <nCol> Coluna de criação do objeto <oSay> Nome do objeto <cText> Texto exibido no objeto BOLD Exibe o texto em negrito LARGE Exibe o texto uma fonte maior SYMBOL 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 Retorno: Não se aplica Exemplo: 3.9. Get Objetivo: Sintaxe: Cria objeto get @ <nRow>, <nCol> GET <oGet> VAR <uVar> [MULTILINE][NO UNDERLINE][SIZE <nWidth>,<nHeight> ][RIGHT] [READONLY, NO MODIFY] [VALID <uValid> ] [VSCROLL][PASSWORD][PICTURE <cPicture>] OF <oWnd> Linha de criação do objeto Parâmetros: <nRow> <nCol> Coluna de criação do objeto <oGet> Nome do objeto <uVar> Variável que armazena o conteúdo do get MULTILINE Exibe objeto get com várias linhas NO Inibe as linhas do objeto UNDERLINE <nWidth> Largura do objeto <nHeight> Altura do objeto RIGHT Alinha o texto à direita READONLY, Desabilita a edição do objeto NO MODIFY <uValid> Função de validação do conteúdo do objeto VSCROLL Ativa a barra de rolagem vertical PASSWORD Ativa mascará para senhas 13 Guia de referência eAdvpl Retorno: <cPicture> Picture aplicada ao objeto <oWnd> Janela onde será criada o objeto Não se aplica Exemplo: 3.10. Button Objetivo: Sintaxe: Cria objeto botão @ <nRow>, <nCol> BUTTON <oBtn> CAPTION <cCaption> [SIZE <nWidth>, <nHeight>][ACTION <uAction>] [CANCEL] [SYMBOL][COLOR <nBack>,<nFore>] OF <oWnd> Linha de criação do objeto Parâmetros: <nRow> <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 objeto CANCEL SYMBOL 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 Retorno: Não se aplica Exemplo: 3.11. Checkbox Objetivo: Sintaxe: Cria objeto checkbox @ <nRow>, <nCol> CHECKBOX <oBtn> [VAR <lCheck>] CAPTION <cCaption> [SIZE <nWidth>, <nHeight>] [ACTION <uAction>][COLOR <nBack>,<nFore>] OF <oWnd> Linha de criação do objeto Parâmetros: <nRow> <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 14 Guia de referência eAdvpl Retorno: <uAction> <nBack> <nFore> <oWnd> Não se aplica Função Cor de Cor de Janela executada no clique do objeto fundo do objeto frente do objeto onde será criada o objeto Exemplo: 3.12. Listbox Objetivo: Sintaxe: Cria objeto listbox @ <nRow>, <nCol> LISTBOX <oLbx> [ VAR <nVar>] ITEMS <aItems> [SIZE <nWidth>, <nHeight>] [ACTION <uAction>][COLOR <nBack>,<nFore>] OF <oWnd> Linha de criação do objeto Parâmetros: <nRow> <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 Retorno: Não se aplica Exemplo: 3.13. Combobox Objetivo: Sintaxe: Cria objeto Combobox @ <nRow>, <nCol> COMBOBOX <oCbx> [VAR <nVar>] ITEMS <aItems> [SIZE <nWidth>, <nHeight>] [ACTION <uAction>][COLOR <nBack>,<nFore>] OF <oWnd> Linha de criação do objeto Parâmetros: <nRow> <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 15 Guia de referência eAdvpl <nWidth> <nHeight> <uAction> Retorno: <nBack> <nFore> <oWnd> Não se aplica Largura do objeto Altura do objeto Função executada na seleção de uma opção do objeto Cor de fundo do objeto Cor de frente do objeto Janela onde será criada o objeto Exemplo: 3.14. @ To Objetivo: Sintaxe: Desenha quadro na tela @ <FromRow>, <FromCol> TO <ToRow>,<ToCol> [<oBox>] [CAPTION <cCaption>] [COLOR <nBack>,<nFore>] OF <oWnd> Linha inicial de criação do objeto Parâmetros: <FromRow> <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 Retorno: Não se aplica Exemplo: 3.15. Browse Objetivo: Sintaxe: Cria objeto browse @ <nRow>,<nCol> BROWSE <oBrw> SIZE <nWidth>,<nHeight> ACTION <uAction> [NO SCROLL] [COLOR <nBack>,<nFore>] OF <oDlg> Linha de criação do objeto Parâmetros: <nRow> <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 objeto NO SCROLL Desabilita a rolagem no objeto <nBack> Cor de fundo do objeto <nFore> Cor de frente do objeto 16 Guia de referência eAdvpl Retorno: <oDlg> Janela onde será criada o objeto Não 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 Parâmetros: <oBrw> <aArray> Array a ser relacionado Retorno: Não se aplica Exemplo: 3.17. Add Column Objetivo: Sintaxe: Cria uma coluna no objeto browse ADD COLUMN <oCol> TO [BROWSE] <oBrw> ARRAY ELEMENT <elm> [HEADER <cHead>] [WIDTH <nWidth>[ PIXELS]] [PICTURE <cPicture>][<MARK>] [ALIGN LEFT, RIGHT>] [OPTIONS <aArray>][EDITABLE][VALID <uValid>] Nome do objeto da Coluna Parâmetros: <oCol> <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 coluna MARK Indica se a coluna mostrará uma opção de Mark ALIGN Indica alinhamento da coluna, LEFT (esquerda) ou RIGHT (direita) <aArray> Lista de opções para utilização de um combobox na célula EDITABLE Indica se a coluna poderá ser editada <uValid> Função de validação do valor da coluna, quando editada Retorno: Não se aplica Exemplo: 17 Guia de referência eAdvpl 3.18. GridSetCellColor Objetivo: Sintaxe: Altera a cor de uma célula do Browse GridSetCellColor(<oBrw>,<nRow>,<nCol>,<nBack>, <nFore>) Nome do browse a ser utilizado Parâmetros: <oBrw> <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 Retorno: Não se aplica Exemplo: 3.19. DbBrowse Objetivo: Sintaxe: Cria objeto browse associado a um arquivo de dados @ <nRow>,<nCol> DBBROWSE <oBrw> ALIAS <cAlias> SIZE <nWidth>,<nHeight> [ACTION> <uAction>] [COLOR <nBack>,<nFore>] [BUTTONS <aBtn>] OF <oDlg> Linha de criação do objeto Parâmetros: <nRow> <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 objeto NO 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 do dbbrowse serão habilitados <oDlg> Janela onde será criada o objeto Retorno: Não se aplica Exemplo: 18 Guia de referência eAdvpl 3.20. Add DbColumn Objetivo: Sintaxe: Cria uma coluna no objeto Dbbrowse ADD DBCOLUMN <oCol> TO [DBBROWSE] <oBrw> FIELD <cField> [HEADER <cHead>][WIDTH <nWidth> [PIXELS]] [PICTURE <cPicture>] [ALIGN LEFT,RIGHT>] [EDITABLE>] [VALID <uValid>] <oCol> Nome do objeto da Coluna Parâmetros: <oBrw> Nome do objeto <cField> Nome do campo exibido na coluna <cHead> Título da Coluna <nWidth> Largura da coluna <cPicture> Picture aplicada a coluna ALIGN 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 editada Retorno: Não se aplica Exemplo: 3.21. Set Search DbBrowse Objetivo: Atribuí uma função de busca ao objeto dbBrowse SET SEARCH DBBROWSE <oBrw> TO <uAction> Sintaxe: Nome do browse a ser relacionado Parâmetros: <oBrw> <uAction> Função utilizada para a pesquisa Retorno: Não se aplica Exemplo: 3.22. Set Bitmap Objetivo: Atribuí um bitmap ao objeto SET BITMAP <nBmp> TO <oObj> Sintaxe: Imagem a ser atribuída Parâmetros: <nBmp> <oObj> Objeto ao qual a imagem será associada Retorno: Não se aplica Exemplo: 19 Guia de referência eAdvpl 3.23. Meter Objetivo: Sintaxe: Cria objeto meter @ <nRow>,<nCol> METER <oMtr> [FROM <nFrom> TO <nTo>] [ SIZE <nWidth>,<nHeight>] [ COLOR <nBack>,<nFore> ] OF <oWnd> Linha de criação do objeto Parâmetros: <nRow> <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 meter Retorno: Não se aplica Exemplo: 3.24. SetMeter() Objetivo: Atualiza objetos meter SetMeter(<Objeto>, <nMeter>) Sintaxe: <Objeto> Objeto meter a ser atualizado Parâmetros: <nMeter> Novo conteúdo atribuído ao objeto meter. Retorno: Não se aplica Exemplo: 3.25. SetArray() Objetivo: Atualiza objetos que utilizam array SetArray(<Objeto>, <aArray>) Sintaxe: Objeto onde será atribuído o Parâmetros: <Objeto> array <aArray> Novo conteúdo atribuído ao objeto. Retorno: Não se aplica Exemplo: 20 Guia de referência eAdvpl 3.26. Objetivo: Sintaxe: Parâmetros: Retorno: HideControl() Esconde o objeto HideControl(<Objeto>) <Objeto> Objeto a ser escondido Não se aplica Exemplo: 3.27. Objetivo: Sintaxe: Parâmetros: Retorno: ShowControl() Exibe o objeto ShowControl(<Objeto>) <Objeto> Objeto a ser exibido Não se aplica Exemplo: 3.28. Objetivo: Sintaxe: Parâmetros: Retorno: DisableControl() Habilita o objeto DisableControl(<Objeto>) <Objeto> Objeto a ser desabilitado Não se aplica Exemplo: 3.29. Objetivo: Sintaxe: Parâmetros: Retorno: EnableControl() Habilita o objeto EnableControl(<Objeto>) <Objeto> Objeto a ser habilitado Não se aplica Exemplo: 21 Guia de referência eAdvpl 3.30. SetText() Objetivo: Atualiza objeto get SetText(<Objeto>, <cExpressao>) Sintaxe: Objeto onde será atribuído a Parâmetros: <Objeto> <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 objeto SetFocus(<Objeto>) Sintaxe: <Objeto> Objeto onde será atribuído o Parâmetros: foco Retorno: Não se aplica Exemplo: 3.32. Objetivo: Sintaxe: Parâmetros: Retorno: GridReset() Atualiza objeto grid GridReset(<oObjeto>) <oObjeto> Objeto Grid Não se aplica Exemplo: 3.33. Objetivo: Sintaxe: Parâmetros: Retorno: GridRow() Obter número da linha selecionada em um objeto grid GridRow(<oObjeto>) <oObjeto> Objeto Grid Número da linha selecionada no objeto Exemplo: 22 Guia de referência eAdvpl 3.34. Objetivo: Sintaxe: Parâmetros: Retorno: GridRows() Obter número de linhas visíveis em um objeto grid GridRows(<oObjeto>) <oObjeto> Objeto Grid Número de linhas visiveis no objeto Exemplo: 3.35. GridSetRow() Objetivo: Selecionar uma linha em um objeto grid GridSetRow(<oObjeto>, <nLinha>) Sintaxe: Objeto Grid Parâmetros: <oObjeto> <nLinha> Número da linha a ser selecionada Retorno: Não se aplica Exemplo: 3.36. Objetivo: Sintaxe: Parâmetros: Retorno: GridCol() Obter número da coluna selecionada em um objeto Grid GridCol(<oObjeto>) <oObjeto> Objeto Grid Número da coluna selecionada Exemplo: 3.37. Objetivo: Sintaxe: Parâmetros: Retorno: GridLeft () Move uma coluna para a esquerda no objeto Grid GridLeft(<oObjeto>) <oObjeto> Objeto Grid a ser movimentado Não se aplica Exemplo: 3.38. Objetivo: Sintaxe: Parâmetros: Retorno: Gridright () Move uma coluna para a direita no objeto Grid Gridright (<oObjeto>) <oObjeto> Objeto Grid a ser movimentado Não se aplica 23 Guia de referência eAdvpl Exemplo: 3.39. GetListRows() Objetivo: Obter linha visíveis de um objeto GetListRows(<oObjeto>) Sintaxe: <oObjeto> Objeto List a ser verificado o Parâmetros: número de linhas Retorno: Número de linha visíveis do objeto Exemplo: 3.40. MoveControl Objetivo: Altera a posição de um objeto na tela MoveControl(<oObj>, <nLin>, <nCol>) Sintaxe: Objeto que será reposicionado Parâmetros: <oObj> <nLin> Nova linha de posição do objeto <nCol> Nova coluna de posição do objeto Retorno: Não se aplica Exemplo: 3.41. ResizeControl Objetivo: Altera a posição de um objeto na tela ResizeControl(<oObj>, <nWidth>, <nHeight>) Sintaxe: Objeto que será redimensionado Parâmetros: <oObj> <nWidth> Nova largura do objeto <nHeight> Nova altura do objeto Retorno: Não se aplica Exemplo: 3.42. GetObjPos Objetivo: Obtém a posição atual de um objeto MoveControl(<oObj>) Sintaxe: Objeto do qual serão retornadas as Parâmetros: <oObj> coordenadas Retorno: Array com as coordenadas do objeto Exemplo: 24 Guia de referência eAdvpl 3.43. GetObjSize Objetivo: Obtém o tamanho atual de um objeto GetObjSize (<oObj>) Sintaxe: Objeto do qual será retornado o Parâmetros: <oObj> tamanho Retorno: Array com o tamanho do objeto Exemplo: 25 Guia de referência eAdvpl 4. Funções de Timer 4.1. Define Timer Objetivo: Sintaxe: Cria um objeto de Timer DEFINE TIMER [<oTimer>] [INTERVAL <nInterval>] [ACTION <uAction>] Nome do ObjetoTecla que será Parâmetros: <oTimer> relacionada a função <nInterval> Intervalo de execução do timer em milisegundos <uAction> Função executada a cada <nInterval> milisegundos Retorno: Não se aplica Exemplo: 4.2. ActiveTimer (oTimer) Objetivo: Sintaxe: Parâmetros: Retorno: Ativa um objeto de timer ACTIVETIMER(oTimer) <oTimer> Nome do objeto de timer a ser ativado Não se aplica Exemplo: 4.3. DeactiveTimer (oTimer) Objetivo: Desativa um objeto de timer DEACTIVETIMER(oTimer) Sintaxe: Nome do objeto de timer a ser Parâmetros: <oTimer> desativado Retorno: Não se aplica Exemplo: 26 Guia de referência eAdvpl 5. Funções de Bibliotecas (DLL/SO) 5.1. Dll Function Objetivo: Sintaxe: Declaração de uma função contida na biblioteca DLL ou SO DLL FUNCTION <cImportFuncName> LOCALNAME <cInternalName> PARAMTYPE <CSTD,PASCAL> ([ <uParam1> AS <type1>][,<uParamN> AS <typeN>]) AS <rettype> LIB <DllName> Nome da função na biblioteca Parâmetros: <cImportFuncName> <cInternalName> Nome da função utilizada na aplicação eAdvpl <cParamType> Tipo de passagem de parâmetro utilizado pela biblioteca 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 Retorno: Não se aplica Exemplo: 5.2. Export Function Objetivo: Declara as funções que poderão ser utilizadas na biblioteca, DLL ou SO, gerada pelo eAdvpl EXPORT FUNCTION AS <FuncName>( [ <uParam1> AS Sintaxe: <type1> ][, <uParamN> AS <typeN>] ) RETURNING <rettype> <FuncName> Nome ao qual da função será Parâmetros: exportada na biblioteca <uParam1>.<uParamN> Parâmetros da função <type1>.. <typeN> Tipos dos parâmetros <rettype> Tipo de retorno da função Retorno: Não se aplica Exemplo: 27 Guia de referência eAdvpl 5.3. Open Serial Objetivo: Sintaxe: Abre uma porta serial OPEN SERIAL <nSerial> TO <hHandle> BAUD 9600,19200 BYTESIZE 7,8 PARITY 0,1 STOPBITS 0,1 Parâmetros: <nSerial> Número da porta que será aberta, COM1 -> 1 <hHandle> Variável que armanezará o handle da serial BAUD Velocidade de comunicação: 9600 ou 19200 BYTESIZE Bytesize: 7 ou 8 PARITY Paridade: 0 ou 1 STOPBITS Stopbits: 0 ou 1 Retorno: Não se aplica Exemplo: 28 Guia de referência eAdvpl 6. Funções de Alerta 6.1. MsgStop() Objetivo: Exibe uma mensagem de erro. MsgStop(<cExpressao>,<cTitulo>) Sintaxe: Mensagem a ser exibida Parâmetros: <cExpressao> <cTitulo> Título exibido na janela Retorno: Não se aplica Exemplo: 6.2. MsgYesOrNo() Objetivo: Exibe uma mensagem com opçãoes de respostas “SIM” ou “NÃO”. MsgYesOrNo(<cPergunta>,<cTitulo>) Sintaxe: Mensagem a ser exibida Parâmetros: <cPergunta> <cTitulo> Título exibido na janela True (.T.) SIM Retorno: False(.F.) NÃO Exemplo: 6.3. MsgStatus () Objetivo: Sintaxe: Parâmetros: Retorno: Exibe uma mensagem que independe de uma ação de usuário. MsgStatus(<cExpressao>) <cExpressao> Mensagem a ser exibida Não se aplica Exemplo: 6.4. ClearStatus () Objetivo: Sintaxe: Parâmetros: Retorno: Apaga mensagem criada pela função MsgStatus. ClearStatus() Não se aplica Não se aplica Exemplo: ClearStatus() 29 Guia de referência eAdvpl 6.5. Alert() Objetivo: Sintaxe: Parâmetros: Retorno: Exibe uma mensagem de alerta. Alert(<cMensagem>) <cMensagem> Mensagem a ser exibida Não se aplica Exemplo: 6.6. MsgAlert() Objetivo: Exibe uma mensagem de alerta. MsgAlert(<cMensagem>,<cTítulo>) Sintaxe: Mensagem a ser exibida Parâmetros: <cMensagem> <cTítulo> Titulo da janela de mensagem Retorno: Não se aplica Exemplo: 30 Guia de referência eAdvpl 7. Funções de Array 7.1. AAdd Objetivo: Adiciona um elemento no fim do array. AAdd(<array>, <uValor>) Sintaxe: Array onde será adicionado um Parâmetros: <array> elemento <uValor> Elemento a ser adicionado Retorno: Não 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 Parâmetros: <array> <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. ScanArray(<array>, <nTam>) Sintaxe: Array que terá o tamanho Parâmetros: <array> alterado <nTam> Novo tamanho do array Retorno: Não se aplica Exemplo: 31 Guia de referência eAdvpl 7.4. ScanArray() Objetivo: Sintaxe: Pesquisar um determinado expressão em elementos de um array. ScanArray(<array>, <expressao>, [<inicio>], [<qtd-de-itens>],<coluna>) Array onde será feita a busca Parâmetros: <array> <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 busca Retorno: Número da linha onde a expressão foi encontrada ou 0 (zero) caso não seja encontrada nenhuma ocorrência Exemplo: 32 Guia de referência eAdvpl 8. Funções de Comunicação 8.1. DoSync Objetivo: Sintaxe: Parâmetros: Retorno: Inicia o programa cliente de comunicação DoSync() Não se aplica Não se aplica Exemplo: 8.2. SyncDate Objetivo: Sintaxe: Parâmetros: Retorno: Exemplo: Retorna data do último sincronismo no formato aaaammdd. SyncDate() Não se aplica Retorna a data do último sincronismo 33 Guia de referência eAdvpl 9. Funções de RPC 9.1. Connectserver Objetivo: Sintaxe: Parâmetros: Retorno: Cria uma conexão com o servidor para uma chamada de RPC Connectserver() Não se aplica Número da conexão criada Exemplo: 9.2. Rpcprotheus Objetivo: Cria uma conexão com o servidor para uma chamada de RPC Rpcprotheus(<nCon> , <cFunc> , <cParam>) Sintaxe: Número da conexão criada Parâmetros: <nCon> <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: Sintaxe: Parâmetros: Retorno: Fecha uma conexão com o servidor Disconnectserver(<nCon>) <nCon> Número da conexão Não se aplica Exemplo: 34 Guia de referência eAdvpl 10. Funções de String 10.1. Str Objetivo: Converte um valor numérico em uma string Str(<nVal>, <nTam>, <nDec>) Sintaxe: Valor numérico Parâmetros: <nVal> <nTam> Tamanho da string a ser retornado <nDec> Número de casa decimais utilizados na string Retorno: String do valor numérico Exemplo: 10.2. Substr Objetivo: Extrai parte de uma string Substr(<cString>, <nStart>, [<nCount>]) Sintaxe: 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ídos Retorno: Parte da <cString> Exemplo: 10.3. Objetivo: Sintaxe: Parâmetros: Retorno: AllTrim Elimina espaços em branco, a direita e a esquerda, de uma string AllTrim(<cString>) <cString> String onde serão extraído os espaços String sem espaçoes em branco Exemplo: 35 Guia de referência eAdvpl 10.4. Len Objetivo: Obter a quantiade de caracteres de uma string ou quantidade de elementos de um array AllTrim(<cString> | <aArray>) Sintaxe: Parâmetros: <cString> String onde serão contados os caracteres Array onde serão contados os <aArray> elementos Retorno: Número de caracteres em uma string ou número de elementos de um array Exemplo: 10.5. Empty Objetivo: Obter a quantiade de caracteres de uma string ou quantidade de elementos de um array AllTrim(<cString> | <aArray>) Sintaxe: Parâmetros: <cString> String onde serão contados os caracteres Array onde serão contados os <aArray> elementos Retorno: Número de caracteres em uma string ou número de elementos de um array Exemplo: 11. 36 Guia de referência eAdvpl 12. Miscelânea 12.1. Keyboard Objetivo: Apresenta um teclado para digitação na tela Keyboard(<nKeybo>, <oObj>) Sintaxe: Indica qual teclado será mostrado. Parâmetros: <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 calendário na tela para seleção de uma data SelectDate(<cString>, <dData>) Sintaxe: <cString> Título da janela do calendário Parâmetros: <dData> Variável onde será armazenado a data selecionada Retorno: Data selecionada no calendário Exemplo: 12.3. Sleep Objetivo: Para o processamento da aplicação por um intervalo de tempo SLEEP(<nInterval>) Sintaxe: Parâmetros: <nInterval> Intervalo de execução do timer em milisegundos Retorno: Não se aplica Exemplo: 37 Guia de referência eAdvpl 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 de impressoras disponíveis no mercado, podendo não suportar este comando SET PRINT FONT <nFont> [SIZE <nWidth>,<nHeight>] Sintaxe: [<BOLD>] [<UNDERLINE>] [<ITALIC>] <nFont> Número da fonte a ser utilizada Parâmetros: <nWidth> Largura da fonte <nHeight> Altura da fonte BOLD Indica a utilização de negrito na fonte UNDERLINE Indica a utilização de sublinhado na fonte ITALIC Indica a utilização de itálico na fonte Retorno: Não se aplica Exemplo: 13.2. Psay Objetivo: Envia um texto para impressora @ <nRow>,<nCol> PSAY <cText> Sintaxe: Linha onde o texto será impresso Parâmetros: <nRow> <nCol> Coluna onde o texto será impresso <cText> Texto a ser impresso 38 Guia de referência eAdvpl 14. Anexos 14.1. Teclado Teclado Alfanumérico Teclado Numérico Teclado de símbolos 14.2. KEYBOARD_ALPHA KEYBOARD_NUMBER KEYBOARD_ACCENT Calendário SELECT_DAYBYDAY SELECT_DAYBYWEEK SELECT_DAYBYMONTH 14.3. Botões de Operação 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 Símbolos 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 Guia de referência eAdvpl 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 Guia de referência eAdvpl 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 Guia de referência eAdvpl Ciano Vermellho Magenta Marrom Cinza 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