diff --git a/.vscode/.advpl/_binary_class.prw b/.vscode/.advpl/_binary_class.prw new file mode 100644 index 0000000..eba78c5 --- /dev/null +++ b/.vscode/.advpl/_binary_class.prw @@ -0,0 +1,10213 @@ +#include "protheus.ch" +/*/{Protheus.doc} brgetddb +Cria um objeto do tipo grade com registros em linhas e informações em colunas. + +@type binary class + + + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/brgetddb + +/*/ +class brgetddb from MsBrGetDBase +data caliastrb as character +method new() +end class +/*/{Protheus.doc} brgetddb:new +Método construtor da classe. + +@type method + +@return object, Nova instância da classe BrGetDDB + +@param [nrow], numeric, Indica a coordenada vertical superior do objeto. +@param [ncol], numeric, Indica a coordenada horizontal à esquerda do objeto. +@param [nwidth], numeric, Indica a coordenada vertical inferior do objeto. +@param [nheight], numeric, Indica a coordenada horizontal à direita do objeto. +@param [bline], codeblock, Indica o bloco de código da lista de campos. Observação: Este parâmetro é utilizado quando o browse trabalha com array. +@param [aheaders], array, Indica o título dos campos no cabeçalho. +@param [acolsizes], array, Indica a largura das colunas. +@param [ownd], object, Indica a janela ou controle visual onde o objeto será criado. +@param [cfield], character, Indica os campos necessários para o filtro. +@param [uval1], character, Indica o início do intervalo para o filtro. +@param [uval2], character, Indica o fim do intervalo para o filtro. +@param [bchange], codeblock, Indica o bloco de código que será executado quando o estado ou conteúdo do objeto é modificado pela ação sobre o controle visual. +@param [bldblclick], codeblock, Indica o bloco de código que será executado quando clicar duas vezes, com o botão esquerdo do mouse, sobre o objeto. +@param [brclick], codeblock, Indica o bloco de código que será executado quando clicar, com o botão direito do mouse, sobre o objeto. +@param [ofont], object, Indica o objeto do tipo TFont utilizado para definir as características da fonte aplicada na exibição do conteúdo do controle visual. +@param [ocursor], object, Indica o tipo de ponteiro do mouse. +@param [nclrfore], numeric, Indica a cor do texto do componente. +@param [nclrback], numeric, Indica a cor de fundo do componente. +@param [cmsg], character, Indica a mensagem que será apresentada ao posicionar o ponteiro do mouse sobre o objeto. +@param [uparam20], logical, Compatibility parameter. Pass NIL. +@param [calias], character, Alias a ser utilizado como fonte dos registros do componente. No caso da fonte ser um array, deixar vazio. +@param [lpixel], logical, Indica se considera as coordenadas passadas em pixels \(.T.\) ou caracteres \(.F.\). +@param [bwhen], codeblock, Indica o bloco de código que será executado quando a mudança de foco da entrada de dados, no objeto criado, estiver sendo realizada. Se o retorno for verdadeiro \(.T.\), o objeto continua habilitado; caso contrário, falso \(.F.\). +@param [uparam24], logical, Compatibility parameter. Pass NIL. +@param [bvalid], codeblock, Indica o bloco de código de validação que será executado quando o conteúdo do objeto for modificado. Retorna verdadeiro \(.T.\), se o conteúdo é válido; caso contrário, falso \(.F.\). +@param [uparam26], array, Compatibility parameter. Pass NIL. +@param [uparam27], object, Compatibility parameter. Pass NIL. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/new +/*/ +method new(nrow, ncol, nwidth, nheight, bline, aheaders, acolsizes, ownd, cfield, uval1, uval2, bchange, bldblclick, brclick, ofont, ocursor, nclrfore, nclrback, cmsg, uparam20, calias, lpixel, bwhen, uparam24, bvalid, uparam26, uparam27) class brgetddb +return + + +/*/{Protheus.doc} msbrgetdbase +Cria um objeto do tipo grade com registros em linhas e informações em colunas. + +@type binary class + + + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/msbrgetdbase + +/*/ +class msbrgetdbase from TCBrowse +data bdelete as codeblock +data bempty as codeblock +data bmove as codeblock +data bnoaltered as codeblock +data badd as codeblock +data bcustomeditcol as codeblock +method new() +method callrefresh() +method goup() +method godown() +method goleft() +method goright() +method goposition() +method gotop() +method gobottom() +method pageup() +method pagedown() +method recadd() +end class +/*/{Protheus.doc} msbrgetdbase:new +Método construtor da classe. + +@type method + +@return object, Nova instância da classe MsBrGetDBase + +@param [nrow], numeric, Indica a coordenada vertical superior do objeto. +@param [ncol], numeric, Indica a coordenada horizontal à esquerda do objeto. +@param [nwidth], numeric, Indica a coordenada vertical inferior do objeto. +@param [nheight], numeric, Indica a coordenada horizontal à direita do objeto. +@param [bline], codeblock, Indica o bloco de código da lista de campos. Observação: Este parâmetro é utilizado quando o browse trabalha com array. +@param [aheaders], array, Indica o título dos campos no cabeçalho. +@param [acolsizes], array, Indica a largura das colunas. +@param [ownd], object, Indica a janela ou controle visual onde o objeto será criado. +@param [cfield], character, Indica os campos necessários para o filtro. +@param [uval1], character, Indica o início do intervalo para o filtro. +@param [uval2], character, Indica o fim do intervalo para o filtro. +@param [bchange], codeblock, Indica o bloco de código que será executado quando o estado ou conteúdo do objeto é modificado pela ação sobre o controle visual. +@param [bldblclick], codeblock, Indica o bloco de código que será executado quando clicar duas vezes, com o botão esquerdo do mouse, sobre o objeto. +@param [brclick], codeblock, Indica o bloco de código que será executado quando clicar, com o botão direito do mouse, sobre o objeto. +@param [ofont], object, Indica o objeto do tipo TFont utilizado para definir as características da fonte aplicada na exibição do conteúdo do controle visual. +@param [ocursor], object, Indica o tipo de ponteiro do mouse. +@param [nclrfore], numeric, Indica a cor do texto do componente. +@param [nclrback], numeric, Indica a cor de fundo do componente. +@param [cmsg], character, Indica a mensagem que será apresentada ao posicionar o ponteiro do mouse sobre o objeto. +@param [uparam20], logical, Compatibility parameter. Pass NIL. +@param [calias], character, Alias a ser utilizado como fonte dos registros do componente. No caso da fonte ser um array, deixar vazio. +@param [lpixel], logical, Indica se considera as coordenadas passadas em pixels \(.T.\) ou caracteres \(.F.\). +@param [bwhen], codeblock, Indica o bloco de código que será executado quando a mudança de foco da entrada de dados, no objeto criado, estiver sendo realizada. Se o retorno for verdadeiro \(.T.\), o objeto continua habilitado; caso contrário, falso \(.F.\). +@param [uparam24], logical, Compatibility parameter. Pass NIL. +@param [bvalid], codeblock, Indica o bloco de código de validação que será executado quando o conteúdo do objeto for modificado. Retorna verdadeiro \(.T.\), se o conteúdo é válido; caso contrário, falso \(.F.\). +@param [uparam26], array, Compatibility parameter. Pass NIL. +@param [uparam27], object, Compatibility parameter. Pass NIL. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/new +/*/ +method new(nrow, ncol, nwidth, nheight, bline, aheaders, acolsizes, ownd, cfield, uval1, uval2, bchange, bldblclick, brclick, ofont, ocursor, nclrfore, nclrback, cmsg, uparam20, calias, lpixel, bwhen, uparam24, bvalid, uparam26, uparam27) class msbrgetdbase +return +/*/{Protheus.doc} msbrgetdbase:callrefresh +Força a atualização do browse. + +@type method + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/callrefresh +/*/ +method callrefresh() class msbrgetdbase +return +/*/{Protheus.doc} msbrgetdbase:goup +Posiciona o ponteiro do browse uma célula acima de onde está. + +@type method + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/goup +/*/ +method goup() class msbrgetdbase +return +/*/{Protheus.doc} msbrgetdbase:godown +Posiciona o ponteiro do browse uma célula abaixo de onde está.. + +@type method + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/godown +/*/ +method godown() class msbrgetdbase +return +/*/{Protheus.doc} msbrgetdbase:goleft +Posiciona o ponteiro do browse uma célula a esquerda de onde está.. + +@type method + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/goleft +/*/ +method goleft() class msbrgetdbase +return +/*/{Protheus.doc} msbrgetdbase:goright +Posiciona o ponteiro do browse uma célula a direita de onde está.. + +@type method + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/goright +/*/ +method goright() class msbrgetdbase +return +/*/{Protheus.doc} msbrgetdbase:goposition +Posiciona o ponteiro do browse em uma linha específica. + +@type method + +@param [nlin], numeric, Número da linha a ser selecionada pelo cursor. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/goposition +/*/ +method goposition(nlin) class msbrgetdbase +return +/*/{Protheus.doc} msbrgetdbase:gotop +Posiciona o ponteiro do browse na primeira linha. + +@type method + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/gotop +/*/ +method gotop() class msbrgetdbase +return +/*/{Protheus.doc} msbrgetdbase:gobottom +Posiciona o ponteiro do browse na última linha. + +@type method + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/gobottom +/*/ +method gobottom() class msbrgetdbase +return +/*/{Protheus.doc} msbrgetdbase:pageup +Faz o ponteiro do browse saltar um número de linhas para cima. + +@type method + +@param [nlines], numeric, Número de linhas a serem saltadas para cima. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/pageup +/*/ +method pageup(nlines) class msbrgetdbase +return +/*/{Protheus.doc} msbrgetdbase:pagedown +Faz o ponteiro do browse saltar um número de linhas para baixo. + +@type method + +@param [nlines], numeric, Número de linhas a serem saltadas para baixo. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/pagedown +/*/ +method pagedown(nlines) class msbrgetdbase +return +/*/{Protheus.doc} msbrgetdbase:recadd +Executa o codeblock bAdd. + +@type method + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/recadd +/*/ +method recadd() class msbrgetdbase +return + + +/*/{Protheus.doc} mscalend +Cria um objeto do tipo calendário. + +@type binary class + + + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/mscalend + +/*/ +class mscalend from TControl +data bchange as codeblock +data bchangemes as codeblock +data ddiaatu as date +data ddiaini as date +data ddiafim as date +data canmultsel as logical +method new() +method addrestri() +method addr_prev() +method addr_next() +method delrestri() +method delr_prev() +method delr_next() +method delallrestri() +method colorday() +method ctrlrefresh() +end class +/*/{Protheus.doc} mscalend:new +Método construtor da classe. + +@type method + +@return object, Nova instância da classe MsCalend + +@param [nrow], numeric, Indica a coordenada vertical. +@param [ncol], numeric, Indica a coordenada horizontal. +@param [ownd], object, Indica a janela ou controle visual onde o objeto será criado. +@param [lcanmultsel], logical, Indica se habilita \(.T.\) ou desabilita \(.F.\) a seleção de múltiplos dias. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/new +/*/ +method new(nrow, ncol, ownd, lcanmultsel) class mscalend +return +/*/{Protheus.doc} mscalend:addrestri +Adiciona uma data com restrição no calendário. + +@type method + +@param , numeric, Indica a data que será restringida. +@param , numeric, Indica a cor da fonte. +@param [ncorborda], numeric, Indica a cor da borda. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/addrestri +/*/ +method addrestri(ndia, ncorfonte, ncorborda) class mscalend +return +/*/{Protheus.doc} mscalend:addr_prev +Adiciona uma data com restrição no calendário \(?\). + +@type method + +@param , numeric, Indica a data que será restringida. +@param , numeric, Indica a cor da fonte. +@param [ncorborda], numeric, Indica a cor da borda. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/addr_prev +/*/ +method addr_prev(ndia, ncorfonte, ncorborda) class mscalend +return +/*/{Protheus.doc} mscalend:addr_next +Adiciona uma data com restrição no calendário \(?\). + +@type method + +@param , numeric, Indica a data que será restringida. +@param , numeric, Indica a cor da fonte. +@param [ncorborda], numeric, Indica a cor da borda. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/addr_next +/*/ +method addr_next(ndia, ncorfonte, ncorborda) class mscalend +return +/*/{Protheus.doc} mscalend:delrestri +Exclui a restrição de uma determinada data. + +@type method + +@param [ndia], numeric, Indica a data para excluir a restrição. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/delrestri +/*/ +method delrestri(ndia) class mscalend +return +/*/{Protheus.doc} mscalend:delr_prev +Exclui a restrição de uma determinada data \(?\). + +@type method + +@param [ndia], numeric, Indica a data para excluir a restrição. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/delr_prev +/*/ +method delr_prev(ndia) class mscalend +return +/*/{Protheus.doc} mscalend:delr_next +Exclui a restrição de uma determinada data \(?\). + +@type method + +@param [ndia], numeric, Indica a data para excluir a restrição. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/delr_next +/*/ +method delr_next(ndia) class mscalend +return +/*/{Protheus.doc} mscalend:delallrestri +Exclui todas as restrições do calendário. + +@type method + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/delallrestri +/*/ +method delallrestri() class mscalend +return +/*/{Protheus.doc} mscalend:colorday +Define a cor das colunas \(dias da semana\). + +@type method + +@param , numeric, Indica o dia da semana que terá a cor alterada \(1 para domingo, 2 para segunda e assim sucessivamente\). +@param , numeric, Indica a cor da fonte. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/colorday +/*/ +method colorday(ndia, ncorfonte) class mscalend +return +/*/{Protheus.doc} mscalend:ctrlrefresh +Atualiza as informações do calendário. + +@type method + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/ctrlrefresh +/*/ +method ctrlrefresh() class mscalend +return + + +/*/{Protheus.doc} mscalendgrid +Cria um objeto do tipo grade de períodos. + +@type binary class + + + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/mscalendgrid + +/*/ +class mscalendgrid from TControl +data ctopmsg as character +data nlineatu as numeric +data nzoom as numeric +data nintervini as numeric +data nintervfim as numeric +data ntimeunit as numeric +method new() +method add() +method changecolor() +method delete() +method getescala() +method getintervaltime() +method gonext() +method goprev() +method reset() +method setdateini() +method setdefcolor() +method setresolution() +method settimeunit() +method changepos() +method gotointerval() +method setfillalllines() +end class +/*/{Protheus.doc} mscalendgrid:new +Método construtor da classe. + +@type method + +@return object, Nova instância da classe MsCalendGrid + +@param [ownd], object, Indica a janela ou controle visual onde o objeto será criado. +@param [nrow], numeric, Indica a coordenada vertical em pixels ou caracteres. +@param [ncol], numeric, Indica a coordenada horizontal em pixels ou caracteres. +@param [nwidth], numeric, Indica a largura em pixels do objeto. +@param [nheight], numeric, Indica a altura em pixels do objeto. +@param [ddateini], date, Indica a data inicial do calendário. +@param [nresolution], numeric, Indica a resolução que será aplicada na grade do calendário. +@param [bwhen], codeblock, Indica o bloco de código que será executado quando a mudança de foco da entrada de dados, na janela em que o controle foi criado, estiver sendo efetuada. Observação: O bloco de código retornará verdadeiro \(.T.\), se o controle permanecer habilitado; caso contrário, retornará falso \(.F.\). +@param [baction], codeblock, Indica o bloco de código que será executado quando clicar, com o botão esquerdo do mouse, sobre o botão. +@param [ndefcolor], numeric, Indica a cor de fundo da grade. +@param [brclick], codeblock, Indica o bloco de código que será executado quando clicar, com o botão direito do mouse, sobre o objeto. +@param [lfilall], logical, Indica se habilita \(.T.\) ou desabilita \(.F.\) o preenchimento de todo o período. +@param [ntypeunit], numeric, Indica o tipo de grade, 0\(Default\) = Horas e 1 = Dias. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/new +/*/ +method new(ownd, nrow, ncol, nwidth, nheight, ddateini, nresolution, bwhen, baction, ndefcolor, brclick, lfilall, ntypeunit) class mscalendgrid +return +/*/{Protheus.doc} mscalendgrid:add +Adiciona um período na grade. + +@type method + +@param [ccaption], character, Indica o título que será inserido à esquerda da grade. +@param [nlin], numeric, Indica o número da linha que será inserido no item. +@param [ninicial], numeric, Indica a data inicial. +@param [nfinal], numeric, Indica a data final. +@param [ncolor], numeric, Indica a cor que será utilizada para destacar o item. +@param [cdescri], character, Indica a mensagem, do tipo dica de contexto \(tooltip/hint\), que será apresentada ao posicionar o ponteiro do mouse sobre o item. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/add +/*/ +method add(ccaption, nlin, ninicial, nfinal, ncolor, cdescri) class mscalendgrid +return +/*/{Protheus.doc} mscalendgrid:changecolor +Redefine a cor de um determinado intervalo. + +@type method + +@param , numeric, Indica a linha do calendário. +@param , numeric, Indica o intervalo que será redefinido no calendário. +@param , numeric, Indica a cor que será utilizada no intervalo. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/changecolor +/*/ +method changecolor(nlinha, nintervalo, ncor) class mscalendgrid +return +/*/{Protheus.doc} mscalendgrid:delete +Exclui um intervalo do calendário. + +@type method + +@return logical, Retorna um valor lógico que representa falha \(.F\) ou sucesso \(.T.\) na exclusão do intervalo. + +@param , numeric, Indica a linha do calendário. +@param , numeric, Indica o intervalo que será excluído. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/delete +/*/ +method delete(nlinha, nintervalo) class mscalendgrid +return +/*/{Protheus.doc} mscalendgrid:getescala +Retorna um texto informando o intervalo e a quantidade de pixels necessários para exibição do calendário. + +@type method + +@return character, Retorna um texto informando o intervalo e a quantidade de pixels necessários para exibição do calendário. + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/getescala +/*/ +method getescala() class mscalendgrid +return +/*/{Protheus.doc} mscalendgrid:getintervaltime +Retorna o texto definido para o intervalo. + +@type method + +@return character, Retorna o texto que contém informações sobre o intervalo. + +@param , numeric, Indica a linha do calendário. +@param , numeric, Indica o intervalo do calendário. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/getintervaltime +/*/ +method getintervaltime(nlinha, nintervalo) class mscalendgrid +return +/*/{Protheus.doc} mscalendgrid:gonext +Posiciona o ponteiro do mouse no início do próximo intervalo da linha selecionada. + +@type method + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/gonext +/*/ +method gonext() class mscalendgrid +return +/*/{Protheus.doc} mscalendgrid:goprev +Posiciona o ponteiro do mouse no início do intervalo anterior da linha selecionada. + +@type method + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/goprev +/*/ +method goprev() class mscalendgrid +return +/*/{Protheus.doc} mscalendgrid:reset +Limpa todos os intervalos do calendário. + +@type method + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/reset +/*/ +method reset() class mscalendgrid +return +/*/{Protheus.doc} mscalendgrid:setdateini +Define a data inicial do calendário. + +@type method + +@param , date, Indica a data inicial do calendário. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/setdateini +/*/ +method setdateini(ddataini) class mscalendgrid +return +/*/{Protheus.doc} mscalendgrid:setdefcolor +Define a cor de fundo do calendário. + +@type method + +@param , numeric, Indica a cor de fundo do calendário. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/setdefcolor +/*/ +method setdefcolor(ncor) class mscalendgrid +return +/*/{Protheus.doc} mscalendgrid:setresolution +Define a resolução para exibição dos períodos. + +@type method + +@param , numeric, Indica a resolução que será utilizada para exibição dos períodos. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/setresolution +/*/ +method setresolution(nresoluo) class mscalendgrid +return +/*/{Protheus.doc} mscalendgrid:settimeunit +Define o tipo de grade, 0 = Horas e 1 = Dias. + +@type method + +@param , numeric, Define o tipo de grade, 0 = Horas e 1 = Dias +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/settimeunit +/*/ +method settimeunit(ntypeunit) class mscalendgrid +return +/*/{Protheus.doc} mscalendgrid:changepos +Redefine a posição de um determinado intervalo dentro da mesma linha. + +@type method + +@return logical, Retorna um valor lógico que representa falha \(.F\) ou sucesso \(.T.\) na alteração. + +@param , numeric, Indica a linha do calendário. +@param , numeric, Indica o início do intervalo que será redefinido no calendário. +@param , numeric, Indica o novo início do intervalo. +@param , numeric, Indica o novo fim do intervalo. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/changepos +/*/ +method changepos(nlinha, noldintervini, anewintervini, anewintervfim) class mscalendgrid +return +/*/{Protheus.doc} mscalendgrid:gotointerval +Posiciona o cursor no início do intervalo especificado. + +@type method + +@param , numeric, Indica a linha do calendário. +@param , numeric, Indica o início do intervalo que será apontado. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/gotointerval +/*/ +method gotointerval(nlinha, nintervini) class mscalendgrid +return +/*/{Protheus.doc} mscalendgrid:setfillalllines +Indica se habilita \(.T.\) ou desabilita \(.F.\) o preenchimento de todo o período. + +@type method + +@param , logical, Indica se habilita \(.T.\) ou desabilita \(.F.\) o preenchimento de todo o período. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/setfillalllines +/*/ +method setfillalllines(lfilall) class mscalendgrid +return + + +/*/{Protheus.doc} msdialog +Cria uma janela de diálogo, no programa, para entrada de dados do tipo modal. Desta forma, não é permitido que outras janelas recebam dados enquanto esta estiver ativa. + +@type binary class + + + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/msdialog + +/*/ +class msdialog from TDialog +method new() +method create() +end class +/*/{Protheus.doc} msdialog:new +Método construtor da classe. + +@type method + +@return object, Nova instância da classe MsDialog + +@param [ntop], numeric, Indica a coordenada vertical superior em pixels ou caracteres. +@param [nleft], numeric, Indica a coordenada horizontal esquerda em pixels ou caracteres. +@param [nbottom], numeric, Indica a coordenada vertical inferior em pixels ou caracteres. +@param [nright], numeric, Indica a coordenada horizontal direita em pixels ou caracteres. +@param [ccaption], character, Indica o título da janela. +@param [uparam6], character, Compatibilidade. +@param [uparam7], numeric, Compatibilidade. +@param [uparam8], logical, Compatibilidade. +@param [uparam9], variant, Compatibilidade. +@param [nclrtext], numeric, Indica a cor do texto. +@param [nclrback], numeric, Indica a cor de fundo. +@param [uparam12], object, Compatibilidade. +@param [ownd], object, Indica a janela mãe \(principal\) da janela que será criada. O padrão é a janela principal do programa. +@param [lpixel], logical, Indica se considera as coordenadas passadas em pixels \(.T.\) ou caracteres \(.F.\). +@param [uparam15], variant, Compatibilidade. +@param [uparam16], variant, Compatibilidade. +@param [uparam17], variant, Compatibilidade. +@param [ltransparent], logical, Se .T. permitira que a Dialog receba um fundo transparente. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/new +/*/ +method new(ntop, nleft, nbottom, nright, ccaption, uparam6, uparam7, uparam8, uparam9, nclrtext, nclrback, uparam12, ownd, lpixel, uparam15, uparam16, uparam17, ltransparent) class msdialog +return +/*/{Protheus.doc} msdialog:create +Método construtor da classe. + +@type method + +@return object, Nova instância da classe MsDialog + +@param [ownd], object, Indica a janela mãe \(principal\) da janela que será criada. O padrão é a janela principal do programa. +@param [ntop], numeric, Indica a coordenada vertical superior em pixels ou caracteres. +@param [nleft], numeric, Indica a coordenada horizontal esquerda em pixels ou caracteres. +@param [nbottom], numeric, Indica a coordenada vertical inferior em pixels ou caracteres. +@param [nright], numeric, Indica a coordenada horizontal direita em pixels ou caracteres. +@param [ccaption], character, Indica o título da janela. +@param [uparam6], character, Compatibilidade. +@param [uparam7], numeric, Compatibilidade. +@param [uparam8], logical, Compatibilidade. +@param [uparam9], variant, Compatibilidade. +@param [nclrtext], numeric, Indica a cor do texto. +@param [nclrback], numeric, Indica a cor de fundo. +@param [uparam12], object, Compatibilidade. +@param [lpixel], logical, Indica se considera as coordenadas passadas em pixels \(.T.\) ou caracteres \(.F.\). +@param [uparam15], variant, Compatibilidade. +@param [uparam16], variant, Compatibilidade. +@param [uparam17], variant, Compatibilidade. +@param [ltransparent], logical, Se .T. permitira que a Dialog receba um fundo transparente. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/create +/*/ +method create(ownd, ntop, nleft, nbottom, nright, ccaption, uparam6, uparam7, uparam8, uparam9, nclrtext, nclrback, uparam12, lpixel, uparam15, uparam16, uparam17, ltransparent) class msdialog +return + + +/*/{Protheus.doc} msselbr +Cria um objeto do tipo grade com registros em linhas e informações em colunas, com funcionalidades de marcação de linhas. + +@type binary class + + + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/msselbr + +/*/ +class msselbr from TCBrowse +data lcanallmark as codeblock +data lallmark as codeblock +data lhasmark as codeblock +method new() +method ballmark() +method allmark() +end class +/*/{Protheus.doc} msselbr:new +Método construtor da classe. + +@type method + +@return object, Nova instância da classe MsSelBr + +@param [nrow], numeric, Indica a coordenada vertical superior do objeto. +@param [ncol], numeric, Indica a coordenada horizontal à esquerda do objeto. +@param [nwidth], numeric, Indica a coordenada vertical inferior do objeto. +@param [nheight], numeric, Indica a coordenada horizontal à direita do objeto. +@param [bline], codeblock, Indica o bloco de código da lista de campos. Observação: Este parâmetro é utilizado quando o browse trabalha com array. +@param [aheaders], array, Indica o título dos campos no cabeçalho. +@param [acolsizes], array, Indica o tamanho das colunas. +@param [ownd], object, Indica a janela ou controle visual onde o objeto será criado. +@param [cfield], character, Indica os campos necessários para o filtro. +@param [uval1], character, Indica o início do intervalo para o filtro. +@param [uval2], character, Indica o fim do intervalo para o filtro. +@param [bchange], codeblock, Indica o bloco de código que será executado quando o estado ou conteúdo do objeto é modificado pela ação sobre o controle visual. +@param [bldblclick], codeblock, Indica o bloco de código que será executado quando clicar duas vezes, com o botão esquerdo do mouse, sobre o objeto. +@param [brclick], codeblock, Indica o bloco de código que será executado quando clicar, com o botão direito do mouse, sobre o objeto. +@param [ofont], object, Indica o objeto do tipo TFont utilizado para definir as características da fonte aplicada na exibição do conteúdo do controle visual. +@param [ocursor], object, Indica o tipo de ponteiro do mouse. +@param [nclrfore], numeric, Indica a cor do texto do componente. +@param [nclrback], numeric, Indica a cor de fundo do componente. +@param [cmsg], character, Indica a mensagem que será apresentada ao posicionar o ponteiro do mouse sobre o objeto. +@param [uparam20], logical, Compatibility parameter. Pass NIL. +@param [calias], character, Alias a ser utilizado como fonte dos registros do componente. No caso da fonte ser um array, deixar vazio. +@param [lpixel], logical, Indica se considera as coordenadas passadas em pixels \(.T.\) ou caracteres \(.F.\). +@param [bwhen], codeblock, Indica o bloco de código que será executado quando a mudança de foco da entrada de dados, no objeto criado, estiver sendo realizada. Se o retorno for verdadeiro \(.T.\), o objeto continua habilitado; caso contrário, falso \(.F.\). +@param [uparam24], logical, Compatibility parameter. Pass NIL. +@param [bvalid], codeblock, Indica o bloco de código de validação que será executado quando o conteúdo do objeto for modificado. Retorna verdadeiro \(.T.\), se o conteúdo é válido; caso contrário, falso \(.F.\). +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/new +/*/ +method new(nrow, ncol, nwidth, nheight, bline, aheaders, acolsizes, ownd, cfield, uval1, uval2, bchange, bldblclick, brclick, ofont, ocursor, nclrfore, nclrback, cmsg, uparam20, calias, lpixel, bwhen, uparam24, bvalid) class msselbr +return +/*/{Protheus.doc} msselbr:ballmark +Bloco de codigo a ser executado quando usuario clicar no header da coluna 1. Observação: sõ será executado quando o atributo lHasMark está ativado. + +@type method + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/ballmark +/*/ +method ballmark() class msselbr +return +/*/{Protheus.doc} msselbr:allmark +Ativa/desativa a marcação de acordo com o parametro lAllMark. + +@type method + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/allmark +/*/ +method allmark() class msselbr +return + + +/*/{Protheus.doc} msworktime +Cria um objeto do tipo barra de período. + +@type binary class + + + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/msworktime + +/*/ +class msworktime from TControl +data bchange as codeblock +data ntotalmark as numeric +method new() +method getblocks() +method getintertime() +method getvalue() +method setresol() +method setvalue() +end class +/*/{Protheus.doc} msworktime:new +Método construtor da classe. + +@type method + +@return object, Nova instância da classe MsWorkTime + +@param [ownd], object, Indica a janela ou controle visual onde o objeto será criado. +@param [nrow], numeric, Indica a coordenada vertical em pixels ou caracteres. +@param [ncol], numeric, Indica a coordenada horizontal em pixels ou caracteres. +@param [nheight], numeric, Indica a altura em pixels do objeto. +@param [nwidth], numeric, Indica a largura em pixels do objeto. +@param [nresolution], numeric, Indica a resolução que será aplicada na barra de período. +@param [cvalue], character, Indica os intervalos que serão preenchidos. Esses intervalos podem ser utilizados através do método SetValue\(\). +@param [bwhen], codeblock, Indica o bloco de código que será executado quando a mudança de foco da entrada de dados, na janela em que o controle foi criado, estiver sendo efetuada. Observação: O bloco de código retornará verdadeiro \(.T.\), se o controle permanecer habilitado; caso contrário, retornará falso \(.F.\). +@param [bchange], codeblock, Indica o bloco de código que será executado quando o estado ou conteúdo do objeto é modificado pela ação sobre o controle visual. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/new +/*/ +method new(ownd, nrow, ncol, nheight, nwidth, nresolution, cvalue, bwhen, bchange) class msworktime +return +/*/{Protheus.doc} msworktime:getblocks +Retorna o número de blocos selecionados. + +@type method + +@return numeric, Número de blocos selecionados. + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/getblocks +/*/ +method getblocks() class msworktime +return +/*/{Protheus.doc} msworktime:getintertime +Retorna o período selecionado no formato ``. + +@type method + +@return character, Período selecionado no formato "HH:MM:SS". + +@param [nbloco], numeric, Indica o bloco do calendário que deverá retornar o período. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/getintertime +/*/ +method getintertime(nbloco) class msworktime +return +/*/{Protheus.doc} msworktime:getvalue +Retorna os itens selecionados no formato ``. + +@type method + +@return character, Itens selecionados no formato "XX X XX". + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/getvalue +/*/ +method getvalue() class msworktime +return +/*/{Protheus.doc} msworktime:setresol +Método mantido apenas para compatibilidade com versões anteriores. + +@type method + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/setresol +/*/ +method setresol() class msworktime +return +/*/{Protheus.doc} msworktime:setvalue +Define os valores de preenchimento. + +@type method + +@param [cvalor], character, Indica o valor que será definido. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/setvalue +/*/ +method setvalue(cvalor) class msworktime +return + + +/*/{Protheus.doc} sbutton +Cria um objeto do tipo botão. + +@type binary class + + + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/sbutton + +/*/ +class sbutton from TControl +data baction as codeblock +data ntype as numeric +method create() +method new() +method ctrlrefresh() +end class +/*/{Protheus.doc} sbutton:create +Método construtor da classe. + +@type method + +@return object, Nova instância da classe SButton + +@param [ownd], object, Indica a janela ou controle visual onde o botão será criado. +@param [ntop], numeric, Indica a coordenada vertical em pixels ou caracteres. +@param [nleft], numeric, Indica a coordenada horizontal em pixels ou caracteres. +@param [ntype], numeric, Indica a imagem do tipo \(Exemplo: 1=OK e 2=Cancelar\) de botão que será utilizado. Observação: Estas imagens estão carregadas no Smart Client. Para obter o número de cada tipo de botão, consulte a tabela disponível na área "Observações". +@param [baction], codeblock, Indica o bloco de código que será executado quando clicar, com o botão esquerdo do mouse, sobre o botão. +@param [lenable], logical, Indica se habilita\(.T.\)/desabilita\(.F.\) o botão. +@param [cmsg], character, Indica a mensagem, do tipo dica de contexto \(tooltip/hint\), ao posicionar o ponteiro do mouse sobre o botão. +@param [bwhen], codeblock, Indica o bloco de código que será executado quando a mudança de foco da entrada de dados, na janela em que o controle foi criado, estiver sendo efetuada. Observação: O bloco de código retornará verdadeiro \(.T.\), se o controle permanecer habilitado; caso contrário, retornará falso \(.F.\). +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/create +/*/ +method create(ownd, ntop, nleft, ntype, baction, lenable, cmsg, bwhen) class sbutton +return +/*/{Protheus.doc} sbutton:new +Método construtor da classe. + +@type method + +@return object, Nova instância da classe SButton + +@param [ntop], numeric, Indica a coordenada vertical em pixels ou caracteres. +@param [nleft], numeric, Indica a coordenada horizontal em pixels ou caracteres. +@param [ntype], numeric, Indica a imagem do tipo \(Exemplo: 1=OK e 2=Cancelar\) de botão que será utilizado. Observação: Estas imagens estão carregadas no Smart Client. Para obter o número de cada tipo de botão, consulte a tabela disponível na área "Observações". +@param [baction], codeblock, Indica o bloco de código que será executado quando clicar, com o botão esquerdo do mouse, sobre o botão. +@param [ownd], object, Indica a janela ou controle visual onde o botão será criado. +@param [lenable], logical, Indica se habilita\(.T.\)/desabilita\(.F.\) o botão. +@param [cmsg], character, Indica a mensagem, do tipo dica de contexto \(tooltip/hint\), ao posicionar o ponteiro do mouse sobre o botão. +@param [bwhen], codeblock, Indica o bloco de código que será executado quando a mudança de foco da entrada de dados, na janela em que o controle foi criado, estiver sendo efetuada. Observação: O bloco de código retornará verdadeiro \(.T.\), se o controle permanecer habilitado; caso contrário, retornará falso \(.F.\). +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/new +/*/ +method new(ntop, nleft, ntype, baction, ownd, lenable, cmsg, bwhen) class sbutton +return +/*/{Protheus.doc} sbutton:ctrlrefresh +Publicado porém sem implementação. + +@type method + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/ctrlrefresh +/*/ +method ctrlrefresh() class sbutton +return + + +/*/{Protheus.doc} tbar +Barra de botões para a parte superior da interface. + +@type binary class + + + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/tbar + +/*/ +class tbar from TControl +data nbtnwidth as numeric +data nbtnheight as numeric +method new() +method setbuttonalign() +end class +/*/{Protheus.doc} tbar:new +Método construtor da classe. + +@type method + +@return object, Nova instância da classe TBar + +@param [ownd], object, Janela ou controle visual onde o objeto será criado. +@param [nbtnwidth], numeric, Largura dos botões contidos na barra. +@param [nbtnheight], numeric, Altura dos botões contidos na barra. +@param [l3d], logical, O componente terá ou não um aspecto tridimensional \(3D\). +@param [uparam5], character, Compatibility parameter. Pass NIL. +@param [ocursor], object, Objeto do tipo de cursor a ser utilizado no componente. +@param [cresource], character, Recurso a ser utilizado como fundo da barra. +@param [lnoautoadjust], logical, Ajusta ou não automaticamente o tamanho do componente. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/new +/*/ +method new(ownd, nbtnwidth, nbtnheight, l3d, uparam5, ocursor, cresource, lnoautoadjust) class tbar +return +/*/{Protheus.doc} tbar:setbuttonalign +Define o alinhamento dos botões contidos na barra. + +@type method + +@param , numeric, Código do tipo de alinhamento. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/setbuttonalign +/*/ +method setbuttonalign(nval) class tbar +return + + +/*/{Protheus.doc} tbitmap +Exibe uma imagem no objeto. + +@type binary class + + + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/tbitmap + +/*/ +class tbitmap from TControl +data cbmpfile as character +data cresname as character +data lautosize as logical +data lstretch as logical +data ltransparent as logical +method create() +method new() +method load() +method setbmp() +method setempty() +end class +/*/{Protheus.doc} tbitmap:create +Método construtor da classe. + +@type method + +@return object, Nova instância da classe TBitmap + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/create +/*/ +method create() class tbitmap +return +/*/{Protheus.doc} tbitmap:new +Método construtor da classe. + +@type method + +@return object, Nova instância da classe TBitmap + +@param [ntop], numeric, Indica a coordenada vertical em pixels ou caracteres. +@param [nleft], numeric, Indica a coordenada horizontal em pixels ou caracteres. +@param [nwidth], numeric, Indica a largura em pixels. +@param [nheight], numeric, Indica a altura em pixels. +@param [cresname], character, Indica o nome da imagem. +@param [cbmpfile], character, Indica o nome do arquivo. +@param [lnoborder], logical, Indica se desativa \(.T.\) a apresentação da borda. +@param [ownd], object, Indica a janela ou controle visual onde a imagem será criada. +@param [blclicked], codeblock, Indica o bloco de código que será executado quando clicar, com o botão esquerdo do mouse, sobre o objeto. +@param [brclicked], codeblock, Indica o bloco de código que será executado quando clicar, com o botão direito do mouse, sobre o objeto. +@param [lscroll], logical, Indica se habilita \(.T.\)/desabilita \(.F.\) a barra de rolagem. +@param [lstretch], logical, Indica se ativa \(.T.\)/desativa \(.F.\) a extensão da imagem. +@param [ocursor], object, Indica o tipo de ponteiro do mouse. +@param [uparam14], character, Compatibilidade. +@param [uparam15], logical, Compatibilidade. +@param [bwhen], codeblock, Indica o bloco de código que será executado quando a mudança de foco da entrada de dados, na janela em que o controle foi criado, estiver sendo efetuada. Observação: O bloco de código retornará verdadeiro \(.T.\), se o controle permanecer habilitado; caso contrário, retornará falso \(.F.\). +@param [lpixel], logical, Indica se considera as coordenadas passadas em pixels \(.T.\) ou caracteres \(.F.\). +@param [bvalid], codeblock, Indica o bloco de código de validação que será executado quando o conteúdo do objeto for modificado. Retorna verdadeiro \(.T.\), se o conteúdo é válido; caso contrário, falso \(.F.\). +@param [uparam19], logical, Compatibilidade. +@param [uparam20], logical, Compatibilidade. +@param [uparam21], logical, Compatibilidade. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/new +/*/ +method new(ntop, nleft, nwidth, nheight, cresname, cbmpfile, lnoborder, ownd, blclicked, brclicked, lscroll, lstretch, ocursor, uparam14, uparam15, bwhen, lpixel, bvalid, uparam19, uparam20, uparam21) class tbitmap +return +/*/{Protheus.doc} tbitmap:load +Carrega uma imagem do repositório ou do drive local. + +@type method + +@return logical, Retorna, verdadeiro \(.T.\), se a imagem for carregada com sucesso do repositório ou do arquivo físico, caso contrário, retornará falso \(.F.\). + +@param [cresname], character, Nome da imagem do repositorio a ser carregada. +@param [cbmpfile], character, Caminho da imagem no sistema de arquivos local. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/load +/*/ +method load(cresname, cbmpfile) class tbitmap +return +/*/{Protheus.doc} tbitmap:setbmp +Carrega uma imagem do repositório. + +@type method + +@return logical, Retorna, verdadeiro \(.T.\), se a imagem for carregada com sucesso do repositório ou do arquivo físico, caso contrário, retornará falso \(.F.\). + +@param [cresname], character, Nome da imagem do repositorio a ser carregada. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/setbmp +/*/ +method setbmp(cresname) class tbitmap +return +/*/{Protheus.doc} tbitmap:setempty +Limpa a imagem. + +@type method + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/setempty +/*/ +method setempty() class tbitmap +return + + +/*/{Protheus.doc} tbrowsebutton +Botão que não permite foco. + +@type binary class + + + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/tbrowsebutton + +/*/ +class tbrowsebutton from TButton +method new() +end class +/*/{Protheus.doc} tbrowsebutton:new +Método construtor da classe. + +@type method + +@return object, Nova instância da classe TBrowseButton + +@param [nrow], numeric, Indica a coordenada vertical superior do objeto. +@param [ncol], numeric, Indica a coordenada horizontal à esquerda do objeto. +@param [ccaption], character, Texto mostrado no botão. +@param [ownd], object, Janela ou controle visual onde o botão será criado. +@param [baction], codeblock, Codeblock a ser executado quando clicar no botão. +@param [nwidth], numeric, Largura do componente. +@param [nheight], numeric, Altura do componente. +@param [uparam8], numeric, Compatibility parameter. Pass NIL. +@param [ofont], object, Objeto que define a fonte do componente. +@param [uparam10], logical, Compatibility parameter. Pass NIL. +@param [lpixel], logical, Caso .F. as coordenadas serão em caracteres e não em pixels. +@param [uparam12], logical, Compatibility parameter. Pass NIL. +@param [uparam13], character, Compatibility parameter. Pass NIL. +@param [uparam14], logical, Compatibility parameter. Pass NIL. +@param [bwhen], codeblock, Indica o bloco de código que será executado quando a mudança de foco da entrada de dados, na janela em que o controle foi criado, estiver sendo efetuada. Observação: O bloco de código retornará verdadeiro \(.T.\), se o controle permanecer habilitado; caso contrário, retornará falso \(.F.\). +@param [uparam16], codeblock, Compatibility parameter. Pass NIL. +@param [uparam17], logical, Compatibility parameter. Pass NIL. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/new +/*/ +method new(nrow, ncol, ccaption, ownd, baction, nwidth, nheight, uparam8, ofont, uparam10, lpixel, uparam12, uparam13, uparam14, bwhen, uparam16, uparam17) class tbrowsebutton +return + + +/*/{Protheus.doc} tbtnbmp +Componente do tipo botão. + +@type binary class + + + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/tbtnbmp + +/*/ +class tbtnbmp from TControl +data baction as codeblock +method newbar() +method loadbitmaps() +method setpopupmenu() +method sethastext() +end class +/*/{Protheus.doc} tbtnbmp:newbar +Método construtor da classe. + +@type method + +@return object, Nova instância da classe TBtnBmp + +@param [cresname1], character, Nome do recurso que contém a imagem. Este recurso deve estar compilado,no repositório de imagens, para ser utilizado. +@param [uparam2], character, Compatibility parameter. Pass NIL. +@param [uparam3], character, Compatibility parameter. Pass NIL. +@param [uparam4], character, Compatibility parameter. Pass NIL. +@param [cmsg], character, Mensagem de dica de contexto \(tooltip/hint\), ao posicionar o ponteiro do mouse sobre o botão. +@param [baction], codeblock, Bloco de código que será executado quando clicar, com o botão esquerdo do mouse, sobre o botão. +@param [uparam7], logical, Compatibility parameter. Pass NIL. +@param [ownd], object, Janela ou controle visual onde o botão será criado. +@param [uparam9], logical, Compatibility parameter. Pass NIL. +@param [bwhen], codeblock, Indica o bloco de código que será executado quando a mudança de foco da entrada de dados, na janela em que o controle foi criado, estiver sendo efetuada. Observação: O bloco de código retornará verdadeiro \(.T.\) se o controle permanecer habilitado; caso contrário, retornará falso \(.F.\). +@param [ctooltip], character, Indica a mensagem que será apresentada quando o objeto exibir sua dica de contexto \(tooltip\). +@param [uparam12], logical, Compatibility parameter. Pass NIL. +@param [uparam13], codeblock, Compatibility parameter. Pass NIL. +@param [uparam14], character, Compatibility parameter. Pass NIL. +@param [uparam15], numeric, Compatibility parameter. Pass NIL. +@param [cprompt], character, Indica o texto que aparecerá no botão, caso não informado, é utilizado o cToolTip. +@param [ofont], object, Objeto que define a fonte do componente. +@param [uparam18], character, Compatibility parameter. Pass NIL. +@param [uparam19], character, Compatibility parameter. Pass NIL. +@param [uparam20], character, Compatibility parameter. Pass NIL. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/newbar +/*/ +method newbar(cresname1, uparam2, uparam3, uparam4, cmsg, baction, uparam7, ownd, uparam9, bwhen, ctooltip, uparam12, uparam13, uparam14, uparam15, cprompt, ofont, uparam18, uparam19, uparam20) class tbtnbmp +return +/*/{Protheus.doc} tbtnbmp:loadbitmaps +Define a imagem a ser utilizada como botão. + +@type method + +@param [cresname1], character, Nome do recurso que contém a imagem. Este recurso deve estar compilado no repositório para ser utilizado. +@param [uparam2], character, Compatibility parameter. Pass NIL. +@param [uparam3], character, Compatibility parameter. Pass NIL. +@param [uparam4], character, Compatibility parameter. Pass NIL. +@param [uparam5], character, Compatibility parameter. Pass NIL. +@param [uparam6], character, Compatibility parameter. Pass NIL. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/loadbitmaps +/*/ +method loadbitmaps(cresname1, uparam2, uparam3, uparam4, uparam5, uparam6) class tbtnbmp +return +/*/{Protheus.doc} tbtnbmp:setpopupmenu +Define um TMenu estilo popup para quando acionar este componente. + +@type method + +@param [omenu], object, Objeto TMenu a ser utilizado em popup para quando acionar este componente. +@param [nalignment], numeric, Define o alinhamento de abertura do menu, sendo 1 o padrão da esquerda para a direita, e 2 da direita para a esquerda. +@param [lcustom], logical, Se .T. define um leiaute diferenciado para o menu. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/setpopupmenu +/*/ +method setpopupmenu(omenu, nalignment, lcustom) class tbtnbmp +return +/*/{Protheus.doc} tbtnbmp:sethastext +Define se o botão terá texto ou não, só funciona se o tema da aplicação for diferente do padrão. + +@type method + +@param [lval], logical, Se .T. o botão terá texto, caso contrário não terá. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/sethastext +/*/ +method sethastext(lval) class tbtnbmp +return + + +/*/{Protheus.doc} tcalendarevent +Cria um objeto de evento de Calendário. Esta é uma classe de apoio para as funções de calendário da classe TMobile \(addCalendarEvent, findCalendarEvent, getCalendarEvent e viewCalendarEvent\). + +@type binary class + + + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/tcalendarevent + +/*/ +class tcalendarevent from TClassInstance +data ctitle as character +data cdescription as character +data clocation as character +data dstartdate as date +data cstarttime as character +data denddate as date +data cendtime as character +data lallday as logical +method new() +method getcalendarid() +end class +/*/{Protheus.doc} tcalendarevent:new +Método construtor da classe. + +@type method + +@return object, Nova instância da classe TCalendarEvent + +@param [ctitle], character, Titulo do evento. +@param [cdescription], character, Descrição do evento. +@param [clocation], character, Localização do evento. +@param [dstartdate], date, Data inicial do evento. +@param [cstarttime], character, Horário inicial do evento. +@param [denddate], date, Data final do evento. +@param [cendtime], character, Horário final do evento. +@param [lallday], logical, Indica se o evento será o dia inteiro ou não, caso seja .T., os horários de início e fim serão desconsiderados. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/new +/*/ +method new(ctitle, cdescription, clocation, dstartdate, cstarttime, denddate, cendtime, lallday) class tcalendarevent +return +/*/{Protheus.doc} tcalendarevent:getcalendarid +Retorna o ID do calendário \(se a classe for resultado de um getCalendarEvent ou após uma inclusão\). + +@type method + +@return character, Retorna o ID do evento. Se não existir retorna "0". + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/getcalendarid +/*/ +method getcalendarid() class tcalendarevent +return + + +/*/{Protheus.doc} tcbrowse +Cria um objeto do tipo grade. + +@type binary class + + + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/tcbrowse + +/*/ +class tcbrowse from TControl +data aarray as array +data acolbmps as array +data acolsizes as array +data acolumns as array +data aheaders as array +data bbmpname as codeblock +data bdelok as codeblock +data bdrawselect as codeblock +data bgobottom as codeblock +data bgotop as codeblock +data bheaderclick as codeblock +data binrange as codeblock +data bldblclick as codeblock +data bline as codeblock +data blogiclen as codeblock +data bseekchange as codeblock +data bskip as codeblock +data bsuperdel as codeblock +data bvalid as codeblock +data calias as character +data cfield as character +data cordertype as character +data cseek as character +data ladjustcolsize as logical +data lautoedit as logical +data ldisablepaint as logical +data lhitbottom as logical +data lhittop as logical +data lhscroll as logical +data ljustific as logical +data lusedefaultcolors as logical +data lvscroll as logical +data nat as numeric +data ncolorder as numeric +data ncolpos as numeric +data nfreeze as numeric +data nlen as numeric +data nlinhas as numeric +data nrowpos as numeric +data nscrolltype as numeric +data aobfuscatedcols as array +method new() +method nrowcount() +method natcol() +method getcolsizes() +method getbrworder() +method getcellrect() +method getbrowse() +method addcolumn() +method setfilter() +method setarray() +method resetlen() +method skip() +method goup() +method godown() +method gotop() +method gobottom() +method goleft() +method goright() +method pageup() +method pagedown() +method goposition() +method gocolumn() +method drawselect() +method colpos() +method setheaderimage() +method setblkcolor() +method setblkbackcolor() +end class +/*/{Protheus.doc} tcbrowse:new +Método construtor da classe. + +@type method + +@return object, Nova instância da classe TCBrowse + +@param [nrow], numeric, Indica a coordenada vertical. +@param [ncol], numeric, Indica a coordenada horizontal. +@param [nwidth], numeric, Indica a largura em pixels do objeto. +@param [nheight], numeric, Indica a altura em pixels do objeto. +@param [bline], codeblock, Indica o bloco de código da lista de campos. Observação: Esse parâmetro é utilizado somente quando o browse trabalha com array. +@param [aheaders], array, Indica o título dos campos no cabeçalho. +@param [acolsizes], array, Indica a largura das colunas. +@param [ownd], object, Indica o controle visual onde o divisor será criado. +@param [cfield], character, Indica os campos necessários para o filtro. +@param [uvalue1], variant, Indica o início do intervalo para o filtro. +@param [uvalue2], variant, Indica o fim do intervalo para o filtro. +@param [bchange], codeblock, Indica o bloco de código que será executado ao mudar de linha. +@param [bldblclick], codeblock, Indica o bloco de código que será executado quando clicar duas vezes, com o botão esquerdo do mouse, sobre o objeto. +@param [brclick], codeblock, Indica o bloco de código que será executado quando clicar, com o botão direito do mouse, sobre o objeto. +@param [ofont], object, Indica o objeto do tipo TFont utilizado para definir as características da fonte aplicada na exibição do conteúdo do controle visual. +@param [ocursor], object, Indica o tipo de ponteiro do mouse. +@param [nclrfore], numeric, Indica a cor do texto da janela. +@param [nclrback], numeric, Indica a cor de fundo da janela. +@param [cmsg], character, Indica a mensagem ao posicionar o ponteiro do mouse sobre o objeto. +@param [uparam20], logical, Compatibilidade. +@param [calias], character, Indica se o objeto é utilizado com array \(opcional\) ou tabela \(obrigatório\). +@param [lpixel], logical, Indica se considera as coordenadas passadas em pixels \(.T.\) ou caracteres \(.F.\). +@param [bwhen], codeblock, Indica o bloco de código que será executado quando a mudança de foco da entrada de dados, na janela em que o controle foi criado, estiver sendo efetuada. Observação: O bloco de código retornará verdadeiro \(.T.\) se o controle permanecer habilitado; caso contrário, retornará falso \(.F.\). +@param [uparam24], logical, Compatibilidade. +@param [bvalid], codeblock, Indica o bloco de código de validação que será executado quando o conteúdo do objeto for modificado. Retorna verdadeiro \(.T.\), se o conteúdo é válido; caso contrário, falso \(.F.\). +@param [lhscroll], logical, Indica se habilita\(.T.\)/desabilita\(.F.\) a barra de rolagem horizontal. +@param [lvscroll], logical, Indica se habilita\(.T.\)/desabilita\(.F.\) a barra de rolagem vertical. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/new +/*/ +method new(nrow, ncol, nwidth, nheight, bline, aheaders, acolsizes, ownd, cfield, uvalue1, uvalue2, bchange, bldblclick, brclick, ofont, ocursor, nclrfore, nclrback, cmsg, uparam20, calias, lpixel, bwhen, uparam24, bvalid, lhscroll, lvscroll) class tcbrowse +return +/*/{Protheus.doc} tcbrowse:nrowcount +Retorna o número de linhas que estão visíveis no browse. + +@type method + +@return numeric, Retorna o número de linhas que estão visíveis no browse + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/nrowcount +/*/ +method nrowcount() class tcbrowse +return +/*/{Protheus.doc} tcbrowse:natcol +Retorna a coluna em uma determinada posição do browse. + +@type method + +@return numeric, Retorna a coluna na posição desejada. + +@param , numeric, Indica a posição em pixels para pesquisar o número da coluna do browse. +@param [lincludefreeze], logical, Indica se as colunas congeladas serão utilizadas no cálculo +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/natcol +/*/ +method natcol(ncolpix, lincludefreeze) class tcbrowse +return +/*/{Protheus.doc} tcbrowse:getcolsizes +Retorna um array com as larguras das colunas. + +@type method + +@return array, Retorna um array com as larguras das colunas. + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/getcolsizes +/*/ +method getcolsizes() class tcbrowse +return +/*/{Protheus.doc} tcbrowse:getbrworder +Retorna um array com os títulos, definidos pelo usuário, das colunas. + +@type method + +@return array, Retorna um array com os títulos, definidos pelo usuário, das colunas. + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/getbrworder +/*/ +method getbrworder() class tcbrowse +return +/*/{Protheus.doc} tcbrowse:getcellrect +Retorna o retangulo da célula, do browse, no formato da classe TRect. + +@type method + +@return object, Objeto do tipo TRect com as dimensões da célula. + +@param , numeric, Coluna da célula desejada. +@param , numeric, Linha da célula desejada. +@param , object, Objeto do Tipo TRect que receberá os dados de dimensão da célula. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/getcellrect +/*/ +method getcellrect(ncoluna, nlinha, orect) class tcbrowse +return +/*/{Protheus.doc} tcbrowse:getbrowse +Retorna o objeto da classe TCBrowse. + +@type method + +@return object, Retorna o objeto da classe TCBrowse. + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/getbrowse +/*/ +method getbrowse() class tcbrowse +return +/*/{Protheus.doc} tcbrowse:addcolumn +Inclui coluna no browse. + +@type method + +@param , object, Indica o objeto do tipo TCColumn utilizado para incluir coluna no browse. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/addcolumn +/*/ +method addcolumn(ocoluna) class tcbrowse +return +/*/{Protheus.doc} tcbrowse:setfilter +Define o filtro para os registros do browse. + +@type method + +@param , character, Indica o nome do campo que será utilizado para o filtro. +@param [uval1], variant, Indica a expressão inicial do intervalo para o filtro. +@param [uval2], variant, Indica a expressão final do intervalo para o filtro. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/setfilter +/*/ +method setfilter(ccampo, uval1, uval2) class tcbrowse +return +/*/{Protheus.doc} tcbrowse:setarray +Define um array para o browse. + +@type method + +@param , array, Indica o array que contêm os dados para o browse. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/setarray +/*/ +method setarray(adados) class tcbrowse +return +/*/{Protheus.doc} tcbrowse:resetlen +Reinicia o contador de linha do browse. + +@type method + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/resetlen +/*/ +method resetlen() class tcbrowse +return +/*/{Protheus.doc} tcbrowse:skip +Posiciona o ponteiro do mouse "n" linhas para frente. + +@type method + +@return numeric, Retorna o número de linhas que o ponteiro do mouse saltou. + +@param , numeric, Indica o número de linhas que o ponteiro do mouse irá saltar. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/skip +/*/ +method skip(nskip) class tcbrowse +return +/*/{Protheus.doc} tcbrowse:goup +Move o ponteiro do mouse uma célula acima. + +@type method + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/goup +/*/ +method goup() class tcbrowse +return +/*/{Protheus.doc} tcbrowse:godown +Move o ponteiro do mouse uma célula abaixo. + +@type method + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/godown +/*/ +method godown() class tcbrowse +return +/*/{Protheus.doc} tcbrowse:gotop +Move o ponteiro do mouse para a primeira linha do browse. + +@type method + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/gotop +/*/ +method gotop() class tcbrowse +return +/*/{Protheus.doc} tcbrowse:gobottom +Move o ponteiro do mouse para a primeira linha do browse. + +@type method + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/gobottom +/*/ +method gobottom() class tcbrowse +return +/*/{Protheus.doc} tcbrowse:goleft +Move o ponteiro do mouse para a célula adjacente à esquerda. + +@type method + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/goleft +/*/ +method goleft() class tcbrowse +return +/*/{Protheus.doc} tcbrowse:goright +Move o ponteiro do mouse para a célula adjacente à direita. + +@type method + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/goright +/*/ +method goright() class tcbrowse +return +/*/{Protheus.doc} tcbrowse:pageup +Move o ponteiro do mouse para cima, conforme o número de linha configurado. + +@type method + +@param , numeric, Indica o número de linhas que o ponteiro do mouse irá saltar. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/pageup +/*/ +method pageup(nlines) class tcbrowse +return +/*/{Protheus.doc} tcbrowse:pagedown +Move o ponteiro do mouse para baixo, conforme o número de linha configurado. + +@type method + +@param , numeric, Indica o número de linhas que o ponteiro do mouse irá saltar. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/pagedown +/*/ +method pagedown(nlines) class tcbrowse +return +/*/{Protheus.doc} tcbrowse:goposition +Posiciona o ponteiro do mouse na linha desejada. + +@type method + +@param , numeric, Indica a linha para posicionar o ponteiro do mouse. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/goposition +/*/ +method goposition(nlinha) class tcbrowse +return +/*/{Protheus.doc} tcbrowse:gocolumn +Posiciona o cursor na coluna desejada. + +@type method + +@param , numeric, Indica a coluna para posicionar o cursor. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/gocolumn +/*/ +method gocolumn(ncoluna) class tcbrowse +return +/*/{Protheus.doc} tcbrowse:drawselect +Força a atualização do browse. + +@type method + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/drawselect +/*/ +method drawselect() class tcbrowse +return +/*/{Protheus.doc} tcbrowse:colpos +Retorna o número da coluna posicionada. + +@type method + +@return numeric, Retorna o número da coluna posicionada. + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/colpos +/*/ +method colpos() class tcbrowse +return +/*/{Protheus.doc} tcbrowse:setheaderimage +Define uma imagem para o cabeçalho do browse. + +@type method + +@param , numeric, Indica a coluna para inserir a imagem. +@param , character, Indica o nome da imagem no RPO ou o caminho para a mesma, exemplo: `c:/diretorio/imagem.png` +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/setheaderimage +/*/ +method setheaderimage(nrow, cimage) class tcbrowse +return +/*/{Protheus.doc} tcbrowse:setblkcolor +Define a cor da fonte das colunas. + +@type method + +@param , codeblock, Indica o bloco de código que permite tratar a cor da fonte da coluna. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/setblkcolor +/*/ +method setblkcolor(bcolor) class tcbrowse +return +/*/{Protheus.doc} tcbrowse:setblkbackcolor +Define a cor de fundo das colunas. + +@type method + +@param , codeblock, Indica o bloco de código que permite tratar a cor de fundo da coluna. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/setblkbackcolor +/*/ +method setblkbackcolor(bcolor) class tcbrowse +return + + +/*/{Protheus.doc} tccolumn +Cria um objeto do tipo coluna para ser utilizada no browse do sistema, como por exemplo: TCBrowse e BrGetDDb. + +@type binary class + + + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/tccolumn + +/*/ +class tccolumn from TClassInstance +data bdata as codeblock +data bvalid as codeblock +data cheading as character +data cpicture as character +data ledit as logical +data cerror as character +data corder as character +data cmsg as character +data bclrfore as character +data bclrback as character +data forecolor as character +data backcolor as character +data lbitmap as logical +data lnolite as logical +data nalign as numeric +data nwidth as numeric +method new() +end class +/*/{Protheus.doc} tccolumn:new +Método construtor da classe. + +@type method + +@return object, Nova instância da classe TCColumn + +@param , character, Indica o título da coluna. +@param , codeblock, Indica o bloco de código que contém o campo da tabela que será apresentado no browse. +@param [cpicture], character, Indica a picture necessária para edição da coluna. +@param [uparam4], variant, Compatibilidade. +@param [uparam5], variant, Compatibilidade. +@param [calinhamento], character, Indica o tipo de alinhamento da coluna. Sendo: Left \(à esquerda\), Center \(centralizada\) ou Right \(à direita\). +@param [nlargura], numeric, Indica a largura da coluna. +@param [lbitmap], logical, Indica se, verdadeiro \(.T.\), a coluna é uma imagem; caso contrário, falso \(.F.\) \(conteúdo padrão\). +@param [ledit], logical, Compatibilidade. +@param [uparam10], variant, Compatibilidade. +@param [bvalid], codeblock, Indica o bloco de código de validação que será executado quando o conteúdo do objeto for modificado. Retorna verdadeiro \(.T.\), se o conteúdo é válido; caso contrário, falso \(.F.\). +@param [uparam12], variant, Compatibilidade. +@param [uparam13], variant, Compatibilidade. +@param [uparam14], variant, Compatibilidade. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/new +/*/ +method new(ctitulo, bdata, cpicture, uparam4, uparam5, calinhamento, nlargura, lbitmap, ledit, uparam10, bvalid, uparam12, uparam13, uparam14) class tccolumn +return + + +/*/{Protheus.doc} tcheckbox +Cria um objeto do tipo caixa de seleção \(CheckBox\). + +@type binary class + + + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/tcheckbox + +/*/ +class tcheckbox from TControl +method new() +method create() +method ctrlrefresh() +end class +/*/{Protheus.doc} tcheckbox:new +Método construtor da classe. + +@type method + +@return object, Nova instância da classe TCheckBox + +@param [nrow], numeric, Indica a coordenada vertical. +@param [ncol], numeric, Indica a coordenada horizontal. +@param [ccaption], character, Indica o título do objeto. +@param [bsetget], codeblock, Indica o bloco de código que será executado na mudança do item selecionado. O bloco de código é responsável pela mudança do valor, da variável lógica, que indica o item selecionado. +@param [odlg], object, Indica a janela ou controle visual onde o objeto será criado. +@param [nwidth], numeric, Indica a largura do objeto. +@param [nheight], numeric, Indica a altura do objeto. É estipulada uma altura padrão para o objeto de 21 pixels, somente sendo possível sua alteração através da aplicação de estilo, utilizando o método SetCss, devidamente documentado no TDN. +@param [uparam8], numeric, Compatibilidade. +@param [blclicked], codeblock, Indica o bloco de código que será executado quando clicar, com o botão esquerdo do mouse, sobre o objeto. +@param [ofont], object, Indica o objeto do tipo TFont utilizado para definir as características da fonte aplicada na exibição do conteúdo do controle visual. +@param [bvalid], codeblock, Indica o bloco de código de validação que será executado quando o conteúdo do objeto for modificado. Retorna verdadeiro \(.T.\), se o conteúdo é válido; caso contrário, falso \(.F.\). +@param [nclrtext], numeric, Indica a cor do texto da janela. +@param [nclrpane], numeric, Indica a cor de fundo da janela. +@param [uparam14], logical, Compatibilidade. +@param [lpixel], logical, Indica se considera as coordenadas passadas em pixels \(.T.\) ou caracteres \(.F.\). +@param [cmsg], character, Indica a mensagem, do tipo dica de contexto \(tooltip/hint\), que será apresentada ao posicionar o ponteiro do mouse sobre o objeto. +@param [uparam17], logical, Compatibilidade. +@param [bwhen], codeblock, Indica o bloco de código que será executado quando a mudança de foco da entrada de dados, na janela em que o controle foi criado, estiver sendo efetuada. Observação: O bloco de código retornará verdadeiro \(.T.\), se o controle permanecer habilitado; caso contrário, retornará falso \(.F.\). +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/new +/*/ +method new(nrow, ncol, ccaption, bsetget, odlg, nwidth, nheight, uparam8, blclicked, ofont, bvalid, nclrtext, nclrpane, uparam14, lpixel, cmsg, uparam17, bwhen) class tcheckbox +return +/*/{Protheus.doc} tcheckbox:create +Método construtor da classe. + +@type method + +@return object, Nova instância da classe TCheckBox + +@param [ownd], object, Indica a janela ou controle visual onde o objeto será criado. +@param [bsetget], codeblock, Indica o bloco de código que será executado na mudança do item selecionado. O bloco de código é responsável pela mudança do valor, da variável lógica, que indica o item selecionado. +@param [nrow], numeric, Indica a coordenada vertical. +@param [ncol], numeric, Indica a coordenada horizontal. +@param [ccaption], character, Indica o título do objeto. +@param [nwidth], numeric, Indica a largura do objeto. +@param [nheight], numeric, Indica a altura do objeto. É estipulada uma altura padrão para o objeto de 21pixels, somente sendo possível sua alteração através da aplicação de estilo, utilizando o método SetCss, devidamente documentado no TDN. +@param [uparam8], numeric, Compatibilidade. +@param [bchange], codeblock, Indica o bloco de código que será executado quando o estado ou conteúdo do objeto é modificado pela ação sobre o controle visual. +@param [ofont], object, Indica o objeto do tipo TFont utilizado para definir as características da fonte aplicada na exibição do conteúdo do controle visual. +@param [bvalid], codeblock, Indica o bloco de código de validação que será executado quando o conteúdo do objeto for modificado. Retorna verdadeiro \(.T.\), se o conteúdo é válido; caso contrário, falso \(.F.\). +@param [nclrfore], numeric, Indica a cor do texto da janela. +@param [nclrback], numeric, Indica a cor de fundo da janela. +@param [uparam14], logical, Compatibilidade. +@param [lpixel], logical, Indica se considera as coordenadas passadas em pixels \(.T.\) ou caracteres \(.F.\). +@param [cmsg], character, Indica a mensagem, do tipo dica de contexto \(tooltip/hint\), que será apresentada ao posicionar o ponteiro do mouse sobre o objeto. +@param [uparam17], logical, Compatibilidade. +@param [bwhen], codeblock, Indica o bloco de código que será executado quando a mudança de foco da entrada de dados, na janela em que o controle foi criado, estiver sendo efetuada. Observação: O bloco de código retornará verdadeiro \(.T.\), se o controle permanecer habilitado; caso contrário, retornará falso \(.F.\). +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/create +/*/ +method create(ownd, bsetget, nrow, ncol, ccaption, nwidth, nheight, uparam8, bchange, ofont, bvalid, nclrfore, nclrback, uparam14, lpixel, cmsg, uparam17, bwhen) class tcheckbox +return +/*/{Protheus.doc} tcheckbox:ctrlrefresh +Atualiza as informações do objeto. + +@type method + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/ctrlrefresh +/*/ +method ctrlrefresh() class tcheckbox +return + + +/*/{Protheus.doc} tcolortriangle +Cria um objeto do tipo paleta de cores. + +@type binary class + + + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/tcolortriangle + +/*/ +class tcolortriangle from TControl +method create() +method new() +method retcolor() +method setcolor() +method setcolorini() +method setsizetriangle() +end class +/*/{Protheus.doc} tcolortriangle:create +Método construtor da classe. + +@type method + +@return object, Nova instância da classe TColorTriangle + +@param [ownd], object, Indica a janela ou controle visual onde a paleta de cores será criada. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/create +/*/ +method create(ownd) class tcolortriangle +return +/*/{Protheus.doc} tcolortriangle:new +Método construtor da classe. + +@type method + +@return object, Nova instância da classe TColorTriangle + +@param [nrow], numeric, Indica a coordenada vertical em pixels ou caracteres. +@param [ncol], numeric, Indica a coordenada horizontal em pixels ou caracteres. +@param [ownd], object, Indica a janela ou controle visual onde a paleta de cores será criada. +@param [nwidth], numeric, Indica a largura da paleta de cores em pixels. +@param [nheight], numeric, Indica a altura da paleta de cores em pixels. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/new +/*/ +method new(nrow, ncol, ownd, nwidth, nheight) class tcolortriangle +return +/*/{Protheus.doc} tcolortriangle:retcolor +Retorna uma representação numérica do RGB \(Red, Green e Blue\) da cor. + +@type method + +@return numeric, Representação numérica do RGB \(Red, Green e Blue\) da cor, gerada através de um algoritmo próprio, que pode ser validada com seu nome definido no colors.ch. + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/retcolor +/*/ +method retcolor() class tcolortriangle +return +/*/{Protheus.doc} tcolortriangle:setcolor +Define o RGB \(Red, Green e Blue\) da cor que será utilizada. + +@type method + +@param [ncolor], numeric, Indica a representação numérica do RGB \(Red, Green e Blue\) da cor que será definida. O número pode ser utilizado com sua versão textual definida no colors.ch. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/setcolor +/*/ +method setcolor(ncolor) class tcolortriangle +return +/*/{Protheus.doc} tcolortriangle:setcolorini +Define a cor RGB \(Red, Green e Blue\) inicial. + +@type method + +@param [ncolor], numeric, Indica a representação numérica do RGB \(Red, Green e Blue\) da cor inicial. O número pode ser utilizado com sua versão textual definida no colors.ch. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/setcolorini +/*/ +method setcolorini(ncolor) class tcolortriangle +return +/*/{Protheus.doc} tcolortriangle:setsizetriangle +Define o tamanho do triângulo de configuração. + +@type method + +@param , numeric, Indica a largura do objeto. +@param , numeric, Indica a altura do objeto. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/setsizetriangle +/*/ +method setsizetriangle(nwidth, nheight) class tcolortriangle +return + + +/*/{Protheus.doc} tcombobox +Cria um objeto do tipo caixa de seleção \(ComboBox\). Este controle permite a entrada de dados de múltipla escolha através dos itens definidos em uma lista vertical. Essa lista pode ser acessada ao pressionar a tecla F4 ou pelo botão à direita do controle. + +@type binary class + + + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/tcombobox + +/*/ +class tcombobox from TControl +data aitems as array +data nat as numeric +data lobfuscate as logical +data leditable as logical +method new() +method create() +method select() +method setitems() +method setheight() +end class +/*/{Protheus.doc} tcombobox:new +Método construtor da classe. + +@type method + +@return object, Nova instância da classe TComboBox + +@param [nrow], numeric, Indica a coordenada vertical em pixels ou caracteres. +@param [ncol], numeric, Indica a coordenada horizontal em pixels ou caracteres. +@param [bsetget], codeblock, Indica o bloco de código, no formato `{|u| if( Pcount( )>0, := u, ) }`, que será executado para atualizar a variável \(essa variável deve ser do tipo caracter\). Desta forma, se a lista for seqüencial, o controle atualizará com o conteúdo do item selecionado, se for indexada, será atualizada com o valor do índice do item selecionado. +@param [aitems], array, Indica uma lista de itens e caracteres que serão apresentados. Essa lista pode ter os seguintes formatos: Seqüencial `(Exemplo: {"item1","item2",...,"itemN"})` ou Indexada `(Exemplo: {"a=item1","b=item2",...,"n=itemN"})`. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/new +/*/ +method new(nrow, ncol, bsetget, aitems) class tcombobox +return +/*/{Protheus.doc} tcombobox:create +Método construtor da classe. + +@type method + +@return object, Nova instância da classe TComboBox + +@param [ownd], object, Indica a janela ou controle visual onde o objeto será criado. +@param [bsetget], codeblock, Indica o bloco de código, no formato `{|u| if( Pcount( )>0, := u, ) }`, que será executado para atualizar a variável \(essa variável deve ser do tipo caracter\). Desta forma, se a lista for seqüencial, o controle atualizará com o conteúdo do item selecionado, se for indexada, será atualizada com o valor do índice do item selecionado. +@param [nrow], numeric, Indica a coordenada vertical em pixels ou caracteres. +@param [ncol], numeric, Indica a coordenada horizontal em pixels ou caracteres. +@param [aitems], array, Indica uma lista de itens e caracteres que serão apresentados. Essa lista pode ter os seguintes formatos: Seqüencial `(Exemplo: {"item1","item2",...,"itemN"})` ou Indexada `(Exemplo: {"a=item1","b=item2",...,"n=itemN"})`. +@param [nwidth], numeric, Indica a largura em pixels do objeto. +@param [nheight], numeric, Indica a altura em pixels do objeto. +@param [uparam7], numeric, Compatibilidade. +@param [bchange], codeblock, Indica o bloco de código que será executado quando o item selecionado é alterado. +@param [bvalid], codeblock, Indica o bloco de código de validação que será executado quando o conteúdo do objeto for modificado. Retorna verdadeiro \(.T.\), se o conteúdo é válido; caso contrário, falso \(.F.\). +@param [nclrtext], numeric, Indica a cor de texto do objeto. +@param [nclrback], numeric, Indica a cor de fundo do objeto. +@param [lpixel], logical, Indica se considera as coordenadas passadas em pixels \(.T.\) ou caracteres \(.F.\). +@param [ofont], object, Indica o objeto do tipo TFont utilizado para definir as características da fonte aplicada na exibição do conteúdo do controle visual. +@param [uparam15], character, Compatibilidade. +@param [uparam16], logical, Compatibilidade. +@param [bwhen], codeblock, Indica o bloco de código que será executado quando a mudança de foco da entrada de dados, na janela em que o controle foi criado, estiver sendo efetuada. Observação: O bloco de código retornará verdadeiro \(.T.\), se o controle permanecer habilitado; caso contrário, retornará falso \(.F.\). +@param [uparam18], logical, Compatibilidade. +@param [uparam19], array, Compatibilidade. +@param [uparam20], codeblock, Compatibilidade. +@param [uparam21], character, Compatibilidade. +@param [creadvar], character, Indica o nome da variável, configurada no parâmetro bSetGet, que será manipulada pelo objeto. Além disso, esse parâmetro será o retorno da função ReadVar\(\). +@param [clabeltext], character, indica o texto que será apresentado na Label. +@param [nlabelpos], numeric, Indica a posição da label, sendo 1=Topo e 2=Esquerda +@param [olabelfont], object, Indica o objeto, do tipo TFont, que será utilizado para definir as características da fonte aplicada na exibição da label. +@param [nlabelcolor], numeric, Indica a cor do texto da Label. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/create +/*/ +method create(ownd, bsetget, nrow, ncol, aitems, nwidth, nheight, uparam7, bchange, bvalid, nclrtext, nclrback, lpixel, ofont, uparam15, uparam16, bwhen, uparam18, uparam19, uparam20, uparam21, creadvar, clabeltext, nlabelpos, olabelfont, nlabelcolor) class tcombobox +return +/*/{Protheus.doc} tcombobox:select +Altera o item selecionado, da caixa de seleção, e executa o bloco de código `` definido para o objeto. + +@type method + +@param [nitem], numeric, Indica a posição do item que será selecionado. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/select +/*/ +method select(nitem) class tcombobox +return +/*/{Protheus.doc} tcombobox:setitems +Altera os itens da caixa de seleção \(ComboBox\). + +@type method + +@param , array, Indica o array que contêm novos itens para a caixa de seleção \(ComboBox\). +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/setitems +/*/ +method setitems(aitens) class tcombobox +return +/*/{Protheus.doc} tcombobox:setheight +Altera a altura do componente. + +@type method + +@param , numeric, Altura do componente. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/setheight +/*/ +method setheight(nheight) class tcombobox +return + + +/*/{Protheus.doc} tcontrol +Classe abstrata herdada por todos os componentes visuais. + +@type binary class + + + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/tcontrol + +/*/ +class tcontrol from TSrvObject +data bchange as codeblock +data bsetget as codeblock +data lmodified as logical +data loutget as logical +data lreadonly as logical +data lvisiblecontrol as logical +data lcrypto as logical +data align as numeric +data nparent as numeric +method click() +method nextcontrol() +method setpopup() +method setaccname() +method setfocus() +method varput() +method setnextfocus() +method setpreviousfocus() +end class +/*/{Protheus.doc} tcontrol:click +Dispara o evento, configurado no bloco de código \*bLClicked\* do objeto. + +@type method + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/click +/*/ +method click() class tcontrol +return +/*/{Protheus.doc} tcontrol:nextcontrol +Retorna o próximo objeto da lista que permite foco. + +@type method + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/nextcontrol +/*/ +method nextcontrol() class tcontrol +return +/*/{Protheus.doc} tcontrol:setpopup +Define um menu do tipo popup para os componentes visuais. + +@type method + +@param , object, Objeto do tipo TMenu. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/setpopup +/*/ +method setpopup(omenu) class tcontrol +return +/*/{Protheus.doc} tcontrol:setaccname +Configura o identificador do objeto de interface para integração do TOTVS Smart Client com ferramentas de acessibilidade compatíveis com o Microsoft Active Accessibility \(MSAA\). + +@type method + +@param , character, Indica o identificador do controle, caracter, obrigatório. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/setaccname +/*/ +method setaccname(cidentificado) class tcontrol +return +/*/{Protheus.doc} tcontrol:setfocus +Altera o foco da entrada de dados para o objeto. + +@type method + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/setfocus +/*/ +method setfocus() class tcontrol +return +/*/{Protheus.doc} tcontrol:varput +Atualiza o valor do objeto. + +@type method + +@param , variant, Indica o texto do objeto. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/varput +/*/ +method varput(uvalue) class tcontrol +return +/*/{Protheus.doc} tcontrol:setnextfocus +Altera o próximo componente a receber o foco da entrada de dados \(ao pressionar a tecla TAB por exemplo\). + +@type method + +@param , object, Objeto do tipo TControl que será o próximo a receber o foco. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/setnextfocus +/*/ +method setnextfocus(oobj) class tcontrol +return +/*/{Protheus.doc} tcontrol:setpreviousfocus +Altera o componente anterior a receber o foco da entrada de dados \(ao pressionar as teclas de atalho Shift + TAB por exemplo\). + +@type method + +@param , object, Objeto do tipo TControl que será o componente anterior a receber o foco. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/setpreviousfocus +/*/ +method setpreviousfocus(oobj) class tcontrol +return + + +/*/{Protheus.doc} tdialog +Cria uma janela de diálogo, no programa, para entrada de dados não modal. Desta forma, é permitido que outras janelas recebam dados enquanto esta estiver ativa. + +@type binary class + + + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/tdialog + +/*/ +class tdialog from TWindow +data nresult as numeric +data bfocuschange as codeblock +data bwindowstate as codeblock +data lmaximized as logical +method new() +method setminimumsize() +method updategets() +method activate() +method end() +method hasfocus() +method windowstate() +end class +/*/{Protheus.doc} tdialog:new +Método construtor da classe. + +@type method + +@return object, Nova instância da classe TDialog + +@param [ntop], numeric, Indica a coordenada vertical superior em pixels ou caracteres. +@param [nleft], numeric, Indica a coordenada horizontal esquerda em pixels ou caracteres. +@param [nbottom], numeric, Indica a coordenada vertical inferior em pixels ou caracteres. +@param [nright], numeric, Indica a coordenada horizontal direita em pixels ou caracteres. +@param [ccaption], character, Indica o título da janela. +@param [uparam6], variant, Compatibilidade. +@param [uparam7], variant, Compatibilidade. +@param [uparam8], variant, Compatibilidade. +@param [uparam9], variant, Compatibilidade. +@param [nclrtext], numeric, Indica a cor do texto. +@param [nclrback], numeric, Indica a cor de fundo. +@param [uparam12], variant, Compatibilidade. +@param [ownd], object, Indica a janela mãe \(principal\) da janela que será criada. O padrão é a janela principal do programa. +@param [lpixel], logical, Indica se considera as coordenadas passadas em pixels \(.T.\) ou caracteres \(.F.\). +@param [uparam15], variant, Compatibilidade. +@param [uparam16], variant, Compatibilidade. +@param [uparam17], variant, Compatibilidade. +@param [nwidth], numeric, Indica a largura da janela em pixels. +@param [nheight], numeric, Indica a altura da janela em pixels. +@param [ltransparent], logical, Se .T. permitira que a Dialog receba um fundo transparente. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/new +/*/ +method new(ntop, nleft, nbottom, nright, ccaption, uparam6, uparam7, uparam8, uparam9, nclrtext, nclrback, uparam12, ownd, lpixel, uparam15, uparam16, uparam17, nwidth, nheight, ltransparent) class tdialog +return +/*/{Protheus.doc} tdialog:setminimumsize +Define o tamanho mínimo da janela. + +@type method + +@param [nwidth], numeric, Indica a largura mínima. +@param [nheight], numeric, Indica a altura mínima. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/setminimumsize +/*/ +method setminimumsize(nwidth, nheight) class tdialog +return +/*/{Protheus.doc} tdialog:updategets +Sem implementação. + +@type method + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/updategets +/*/ +method updategets() class tdialog +return +/*/{Protheus.doc} tdialog:activate +Apresenta o diálogo. + +@type method + +@param [uparam1], variant, Compatibilidade. +@param [uparam2], variant, Compatibilidade. +@param [uparam3], variant, Compatibilidade. +@param [lcentered], logical, Indica se a janela será \(.T.\) ou não \(.F.\) centralizada. O padrão é falso \(.F.\). +@param [bvalid], codeblock, Indica se o conteúdo do diálogo é válido. Se o retorno for falso \(.F.\), o diálogo não será fechado quando a finalização for solicitada. +@param [uparam6], variant, Compatibilidade. +@param [binit], codeblock, Indica o bloco de código que será executado quando o diálogo iniciar a exibição. +@param [uparam8], variant, Compatibilidade. +@param [uparam9], variant, Compatibilidade. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/activate +/*/ +method activate(uparam1, uparam2, uparam3, lcentered, bvalid, uparam6, binit, uparam8, uparam9) class tdialog +return +/*/{Protheus.doc} tdialog:end +Finaliza o diálogo. + +@type method + +@return logical, Retorna verdadeiro \(.T.\) se finalizar o diálogo, caso contrário, retorna falso \(.F.\). + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/end +/*/ +method end() class tdialog +return +/*/{Protheus.doc} tdialog:hasfocus +Indica se o componente esta em foco. + +@type method + +@return logical, Retorna, verdadeiro \(.T.\), se o componente está em foco, caso contrário, falso \(.F.\). + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/hasfocus +/*/ +method hasfocus() class tdialog +return +/*/{Protheus.doc} tdialog:windowstate +Indica o estado atual do componente. + +@type method + +@return numeric, Retorna um número inteiro indicando o estado atual do componente. Sendo: 0=Restaurado, 1=Minimizado e 2=Maximizado. + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/windowstate +/*/ +method windowstate() class tdialog +return + + +/*/{Protheus.doc} tdrawer +Abre e manipula imagens com extensões BMP \(Bitmap\), JPG \(Joint Photographic Group\) e PNG \(Portable Network Graphics\). + +@type binary class + + + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/tdrawer + +/*/ +class tdrawer from TControl +data blclicked as codeblock +data brclicked as codeblock +method new() +method create() +method addtext() +method clearimage() +method crop() +method openimage() +method paste() +method resizeimage() +method saveimage() +method setcolors() +method setfonttext() +method settype() +method undo() +method setpenwidth() +end class +/*/{Protheus.doc} tdrawer:new +Método construtor da classe. + +@type method + +@return object, Nova instância da classe TDrawer + +@param [nrow], numeric, Indica a coordenada vertical. +@param [ncol], numeric, Indica a coordenada horizontal. +@param [odlg], object, Indica a janela ou controle visual onde o objeto será criado. +@param [nwidth], numeric, Indica a largura em pixels do objeto. +@param [nheight], numeric, Indica a altura em pixels do objeto. +@param [cfilename], character, Indica o nome do arquivo que será aberto. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/new +/*/ +method new(nrow, ncol, odlg, nwidth, nheight, cfilename) class tdrawer +return +/*/{Protheus.doc} tdrawer:create +Método construtor da classe. + +@type method + +@return object, Nova instância da classe TDrawer + +@param [odlg], object, Indica a janela ou controle visual onde o objeto será criado. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/create +/*/ +method create(odlg) class tdrawer +return +/*/{Protheus.doc} tdrawer:addtext +Inclui um texto em uma determinada posição da imagem. + +@type method + +@param [ntop], numeric, Indica a posição do texto em relação ao topo. +@param [nleft], numeric, Indica a posição do texto à esquerda +@param [ctexto], numeric, Indica o texto que será incluído. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/addtext +/*/ +method addtext(ntop, nleft, ctexto) class tdrawer +return +/*/{Protheus.doc} tdrawer:clearimage +Limpa o conteúdo da imagem. + +@type method + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/clearimage +/*/ +method clearimage() class tdrawer +return +/*/{Protheus.doc} tdrawer:crop +Mantém apenas o trecho selecionado da imagem. + +@type method + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/crop +/*/ +method crop() class tdrawer +return +/*/{Protheus.doc} tdrawer:openimage +Abre imagem com extensão BMP \(Bitmap\), JPG \(Joint Photographic Group\) e PNG \(Portable Network Graphics\). + +@type method + +@param [cimagem], character, Indica o diretório e o nome do arquivo que será aberto. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/openimage +/*/ +method openimage(cimagem) class tdrawer +return +/*/{Protheus.doc} tdrawer:paste +Copia o conteúdo da memória para a figura, desde que esse conteúdo seja uma imagem. + +@type method + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/paste +/*/ +method paste() class tdrawer +return +/*/{Protheus.doc} tdrawer:resizeimage +Redimensiona a imagem. + +@type method + +@param [nlargura], numeric, Indica a largura da imagem. +@param [naltura], numeric, Indica a altura da imagem. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/resizeimage +/*/ +method resizeimage(nlargura, naltura) class tdrawer +return +/*/{Protheus.doc} tdrawer:saveimage +Salva uma imagem. + +@type method + +@param [cnomeimagem], character, Indica o diretório e o nome do arquivo. +@param [cextensao], character, Indica a extensão \(BMP, JPG e PNG\) do arquivo. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/saveimage +/*/ +method saveimage(cnomeimagem, cextensao) class tdrawer +return +/*/{Protheus.doc} tdrawer:setcolors +Define a cor da linha e do fundo. + +@type method + +@param , numeric, Indica a cor da linha. +@param , numeric, Indica a cor de fundo. Observação: Caso esse parâmetro seja definido com -1, o fundo ficará transparente. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/setcolors +/*/ +method setcolors(ncorlinha, ncorfundo) class tdrawer +return +/*/{Protheus.doc} tdrawer:setfonttext +Define a fonte do texto. + +@type method + +@return logical, Retorna verdadeiro \(.T.\), se a fonte selecionada estiver correta; caso contrário, retornará falso \(.F.\). + +@param , object, Indica o objeto do tipo TFont utilizado para definir as características da fonte aplicada na exibição do conteúdo do controle visual. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/setfonttext +/*/ +method setfonttext(ofont) class tdrawer +return +/*/{Protheus.doc} tdrawer:settype +Define o tipo de formato \(Shape\) da imagem. + +@type method + +@param [nshape], numeric, Indica o tipo do formato \(Shape\) da imagem, sendo: 0=Seleção \(Marca um traço da imagem para que possa ser recortada pelo método Crop\), 1=Traço, 2=Traço livre, 3=Círculo, 4=Retângulo e 5=Retângulo com bordas arredondadas. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/settype +/*/ +method settype(nshape) class tdrawer +return +/*/{Protheus.doc} tdrawer:undo +Defaz a última ação realizada na imagem. + +@type method + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/undo +/*/ +method undo() class tdrawer +return +/*/{Protheus.doc} tdrawer:setpenwidth +Indica a espessura da linha a ser desenhada. + +@type method + +@param [nwidth], numeric, Indica a espessura da linha a ser desenhada. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/setpenwidth +/*/ +method setpenwidth(nwidth) class tdrawer +return + + +/*/{Protheus.doc} tflowlayout +Herda as características de um TPanel e acrescenta a funcionalidade de responsividade aos componentes nele inseridos, mantendo a altura e largura de cada um, porém reposicionando-os dinamicamente de acordo com o espaço disponível no layout. + +@type binary class + + + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/tflowlayout + +/*/ +class tflowlayout from TPanel +method new() +method addinlayout() +end class +/*/{Protheus.doc} tflowlayout:new +Método construtor da classe. + +@type method + +@return object, Nova instância da classe TFlowLayout + +@param [ownd], object, Indica a janela ou controle visual onde o objeto será criado. +@param [nalign], numeric, Indica o alinhamento do objeto \(container TFlowLayout\) no espaço disponibilizado pelo seu objeto pai. +@param [nwidth], numeric, Indica a largura em pontos do objeto. +@param [nheight], numeric, Indica a altura em pontos do objeto. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/new +/*/ +method new(ownd, nalign, nwidth, nheight) class tflowlayout +return +/*/{Protheus.doc} tflowlayout:addinlayout +Insere um componente no layout. + +@type method + +@param , object, Indica o componente que será inserido no layout. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/addinlayout +/*/ +method addinlayout(ocontrol) class tflowlayout +return + + +/*/{Protheus.doc} tfolder +Cria um objeto para exibir pastas. + +@type binary class + + + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/tfolder + +/*/ +class tfolder from TControl +data adialogs as array +data aprompts as array +data bsetoption as codeblock +data noption as numeric +method new() +method additem() +method aenable() +method hidepage() +method setoption() +method getcaption() +method showpage() +end class +/*/{Protheus.doc} tfolder:new +Método construtor da classe. + +@type method + +@return object, Nova instância da classe TFolder + +@param [ntop], numeric, Indica a coordenada vertical em pixels ou caracteres. +@param [nleft], numeric, Indica a coordenada horizontal em pixels ou caracteres. +@param [aprompts], array, Indica o título das pastas. +@param [adialogs], array, Indica o nome do diálogo. +@param [ownd], object, Indica a janela ou controle visual onde o objeto será criado. +@param [noption], numeric, Indica a pasta selecionada. +@param [nclrfore], numeric, Indica a cor de frente da pasta. +@param [nclrback], numeric, Indica a cor de fundo da pasta. +@param [lpixel], logical, Indica se considera as coordenadas passadas em pixels \(.T.\) ou caracteres \(.F.\). +@param [uparam10], logical, Compatibilidade +@param [nwidth], numeric, Indica a largura em pixels do objeto. +@param [nheight], numeric, Indica a altura em pixels do objeto. +@param [cmsg], character, Indica a mensagem, do tipo dica de contexto \(tooltip/hint\), que será apresentada ao posicionar o ponteiro do mouse sobre o objeto. +@param [uparam14], logical, Compatibilidade +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/new +/*/ +method new(ntop, nleft, aprompts, adialogs, ownd, noption, nclrfore, nclrback, lpixel, uparam10, nwidth, nheight, cmsg, uparam14) class tfolder +return +/*/{Protheus.doc} tfolder:additem +Inclui uma pasta. + +@type method + +@param [citem], character, Indica a título da pasta. +@param [lvisible], logical, Indica se a pasta está \(.T.\) ou não \(.F.\) visível. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/additem +/*/ +method additem(citem, lvisible) class tfolder +return +/*/{Protheus.doc} tfolder:aenable +Habilita/Desabilita uma pasta. + +@type method + +@return logical, Retorna verdadeiro \(.T.\) se o processo ocorrer com sucesso; caso contrário, retornará falso \(.F.\). + +@param [nitem], numeric, Indica a pasta que será habilitada/desabilitada. +@param [lenable], logical, Indica se habilita\(.T.\)/desabilita\(.F.\) a pasta. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/aenable +/*/ +method aenable(nitem, lenable) class tfolder +return +/*/{Protheus.doc} tfolder:hidepage +Oculta uma pasta. + +@type method + +@param , numeric, Indica a pasta que será oculta. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/hidepage +/*/ +method hidepage(nitem) class tfolder +return +/*/{Protheus.doc} tfolder:setoption +Seleciona a pasta desejada. + +@type method + +@param [noption], numeric, Indica a pasta que será selecionada. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/setoption +/*/ +method setoption(noption) class tfolder +return +/*/{Protheus.doc} tfolder:getcaption +Retorna a descrição da aba ativa da Folder + +@type method + +@return character, Retorna a descrição da aba ativa. + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/getcaption +/*/ +method getcaption() class tfolder +return +/*/{Protheus.doc} tfolder:showpage +Apresenta uma pasta. + +@type method + +@param , numeric, Indica a pasta que será apresentada. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/showpage +/*/ +method showpage(nitem) class tfolder +return + + +/*/{Protheus.doc} tfont +Cria um objeto para alterar as características da fonte utilizada em outros controles visuais. + +@type binary class + + + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/tfont + +/*/ +class tfont from TFontAbs +data cname as character +data nwidth as numeric +data nheight as numeric +data bold as logical +data italic as logical +data underline as logical +method new() +end class +/*/{Protheus.doc} tfont:new +Método construtor da classe. + +@type method + +@return object, Nova instância da classe TFont + +@param [cname], character, Indica o nome da fonte que será utilizada. +@param [upar2], numeric, Compatibilidade. +@param [nheight], numeric, Indica o tamanho da fonte. +@param [upar4], logical, Compatibilidade. +@param [lbold], logical, Indica se habilita\(.T.\)/desabilita\(.F.\) o estilo negrito. +@param [upar6], numeric, Compatibilidade. +@param [upar7], logical, Compatibilidade. +@param [upar8], numeric, Compatibilidade. +@param [upar9], logical, Compatibilidade. +@param [lunderline], logical, Indica se habilita\(.T.\)/desabilita\(.F.\) o estilo sublinhado. +@param [litalic], logical, Indica se habilita\(.T.\)/desabilita\(.F.\) o estilo itálico. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/new +/*/ +method new(cname, upar2, nheight, upar4, lbold, upar6, upar7, upar8, upar9, lunderline, litalic) class tfont +return + + +/*/{Protheus.doc} tftpclient +Classe destinada a comunicação com servidores de FTP \(File Transfer Protocol\). + +@type binary class + + + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/tftpclient + +/*/ +class tftpclient +data ntransfertype as numeric +data ntransfermode as numeric +data nconnecttimeout as numeric +data ntransferstruct as numeric +data bfirewallmode as logical +data ndataport as numeric +data ncontrolport as numeric +data ndirinfo as numeric +data ndirinfocount as numeric +data cerrorstring as character +data busesipconnection as logical +method new() +method getlastresponse() +method ftpconnect() +method close() +method directory() +method sendfile() +method receivefile() +method renamefile() +method resumereceivefile() +method deletefile() +method getcurdir() +method chdir() +method cdup() +method mkdir() +method rmdir() +method noop() +method getdirentry() +method gethelp() +method quote() +method getmlcount() +method getmlline() +method settype() +method gettype() +end class +/*/{Protheus.doc} tftpclient:new +Cria uma nova instância da classe TFtpClient. + +@type method + +@return object, Nova instância da classe tFtpClient + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/new +/*/ +method new() class tftpclient +return +/*/{Protheus.doc} tftpclient:getlastresponse +Retorna a resposta do último comando executado no servidor remoto. + +@type method + +@return character, String com a resposta do último comando que foi executado no servidor. + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/getlastresponse +/*/ +method getlastresponse() class tftpclient +return +/*/{Protheus.doc} tftpclient:ftpconnect +Estabelece uma conexão com um servidor de FTP \( File Transfer Protocol \) . + +@type method + +@return numeric, Retorna 0 em caso de uma conexão bem sucedida. Caso contrário retorna um código de erro. + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/ftpconnect +/*/ +method ftpconnect() class tftpclient +return +/*/{Protheus.doc} tftpclient:close +Termina uma conexão estabelecida com um servidor. + +@type method + +@return numeric, Retorna sempre 0. + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/close +/*/ +method close() class tftpclient +return +/*/{Protheus.doc} tftpclient:directory +Semelhante a função Directory, lista os arquivos e diretórios do diretório corrente. + +@type method + +@return array, Retorna um array de subarrays, sendo que cada subarray contém informações sobre cada arquivo que atenda o parâmetro **cMask**. + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/directory +/*/ +method directory() class tftpclient +return +/*/{Protheus.doc} tftpclient:sendfile +Trasfere um arquivo da máquina local para o servidor remoto. + +@type method + +@return numeric, Retorna 0 em caso de sucesso. Caso contrário retorna um código de erro. + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/sendfile +/*/ +method sendfile() class tftpclient +return +/*/{Protheus.doc} tftpclient:receivefile +Trasfere um arquivo do servidor remoto para a máquina local. + +@type method + +@return numeric, Retorna 0 em caso de sucesso. Caso contrário retorna um código de erro. + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/receivefile +/*/ +method receivefile() class tftpclient +return +/*/{Protheus.doc} tftpclient:renamefile +Renomeia um arquivo hospedado no servidor remoto. + +@type method + +@return numeric, Retorna 0 em caso de sucesso. Caso contrário retorna um código de erro. + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/renamefile +/*/ +method renamefile() class tftpclient +return +/*/{Protheus.doc} tftpclient:resumereceivefile +Retoma a trasferência de um arquivo do servidor remoto para a máquina local. + +@type method + +@return numeric, Retorna 0 em caso de sucesso. Caso contrário retorna um código de erro. + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/resumereceivefile +/*/ +method resumereceivefile() class tftpclient +return +/*/{Protheus.doc} tftpclient:deletefile +Deleta um arquivo hospedado no servidor remoto. + +@type method + +@return numeric, Retorna 0 em caso de sucesso. Caso contrário retorna um código de erro. + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/deletefile +/*/ +method deletefile() class tftpclient +return +/*/{Protheus.doc} tftpclient:getcurdir +Devolve o nome do diretório atual no servidor FTP conectado. + +@type method + +@return numeric, Retorna 0 em caso de sucesso. Caso contrário retorna um código de erro. + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/getcurdir +/*/ +method getcurdir() class tftpclient +return +/*/{Protheus.doc} tftpclient:chdir +Muda o diretório corrente do servidor remoto. + +@type method + +@return numeric, Retorna 0 em caso de sucesso. Caso contrário retorna um código de erro. + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/chdir +/*/ +method chdir() class tftpclient +return +/*/{Protheus.doc} tftpclient:cdup +Muda o diretório corrente do servidor remoto para um imediatamente anterior. Correspondente a "cd .." em ambientes Linux. + +@type method + +@return numeric, Retorna 0 em caso de sucesso. Caso contrário retorna um código de erro. + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/cdup +/*/ +method cdup() class tftpclient +return +/*/{Protheus.doc} tftpclient:mkdir +Cria um diretório no servidor remoto. + +@type method + +@return numeric, Retorna 0 em caso de sucesso. Caso contrário retorna um código de erro. + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/mkdir +/*/ +method mkdir() class tftpclient +return +/*/{Protheus.doc} tftpclient:rmdir +Apaga um diretório no servidor remoto. + +@type method + +@return numeric, Retorna 0 em caso de sucesso. Caso contrário retorna um código de erro. + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/rmdir +/*/ +method rmdir() class tftpclient +return +/*/{Protheus.doc} tftpclient:noop +Executa uma operação No-op. + +@type method + +@return numeric, Retorna 0 em caso de sucesso. Caso contrário retorna um código de erro. + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/noop +/*/ +method noop() class tftpclient +return +/*/{Protheus.doc} tftpclient:getdirentry +Devolve o nome de um item de um diretório baseado em um índice. + +@type method + +@return numeric, Retorna 0 em caso de sucesso. Caso contrário retorna um código de erro. + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/getdirentry +/*/ +method getdirentry() class tftpclient +return +/*/{Protheus.doc} tftpclient:gethelp +Obtem informação de ajuda do servidor remoto. + +@type method + +@return numeric, Retorna 0 em caso de sucesso. Caso contrário retorna um código de erro. + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/gethelp +/*/ +method gethelp() class tftpclient +return +/*/{Protheus.doc} tftpclient:quote +Envia um comando customizado para o servidor. + +@type method + +@return numeric, Retorna 0 em caso de sucesso. Caso contrário retorna um código de erro. + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/quote +/*/ +method quote() class tftpclient +return +/*/{Protheus.doc} tftpclient:getmlcount +Retorna a quantidade de linhas do buffer de resposta. + +@type method + +@return numeric, Número de linhas do buffer de resposta do server. + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/getmlcount +/*/ +method getmlcount() class tftpclient +return +/*/{Protheus.doc} tftpclient:getmlline +Retorna a linha especificada do buffer de resposta do server. + +@type method + +@return character, String com o conteúdo correspondente a linha passada como parâmetro do buffer de resposta do servidor. + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/getmlline +/*/ +method getmlline() class tftpclient +return +/*/{Protheus.doc} tftpclient:settype +Seta o tipo de transferência que será usado na recepção e envio de arquivos. + +@type method + +@return numeric, Retorna 0 em caso de sucesso. Caso contrário retorna um código de erro. + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/settype +/*/ +method settype() class tftpclient +return +/*/{Protheus.doc} tftpclient:gettype +Obtém o tipo de transferência que está setada com o servidor. + +@type method + +@return numeric, Retorna o tipo da transferência. + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/gettype +/*/ +method gettype() class tftpclient +return + + +/*/{Protheus.doc} tget +Cria um objeto para entrada de dados editáveis. Esta classe permite armazenar ou alterar o conteúdo de uma variável através da digitação. No entanto, o conteúdo da variável será alterado quando o objeto perder o foco de edição para outro objeto. + +@type binary class + + + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/tget + +/*/ +class tget from TControl +data buffer as character +data pictvar as character +data picture as character +data ctext as character +data lpassword as logical +data cplacehold as character +data lobfuscate as logical +data cretf3 as character +data oget as object +data pos as numeric +data exitdirection as numeric +data lcalendario as logical +data lallwaysupdateserver as logical +data aconvkeys as array +method create() +method new() +method ctrlrefresh() +method selectall() +method setcontentalign() +method assign() +method updatebuffer() +method setpos() +method insert() +method ctext() +method jumptonextctrl() +method sethasbutton() +method setnobutton() +method setconvkey() +end class +/*/{Protheus.doc} tget:create +Método construtor da classe. + +@type method + +@return object, Nova instância da classe TGet + +@param [bsetget], codeblock, Indica o bloco de código, no formato \{\|u\| if\( Pcount\( \)>0, := u, \) \}, que será executado para atualizar a variável \(essa variável deve ser do tipo caracter\). Desta forma, se a lista for sequencial, o controle atualizará com o conteúdo do item selecionado, se for indexada, será atualizada com o valor do índice do item selecionado. +@param [nrow], numeric, Indica a coordenada vertical em pixels ou caracteres. +@param [ncol], numeric, Indica a coordenada horizontal em pixels ou caracteres. +@param [nwidth], numeric, Indica a largura em pixels do objeto. +@param [nheight], numeric, Indica a altura em pixels do objeto. +@param [cpict], character, Indica a máscara de formatação do conteúdo que será apresentada. Verificar [Tabela de Pictures de Formatação](https://tdn.totvs.com/pages/releaseview.action?pageId=22479526) +@param [bvalid], codeblock, Indica o bloco de código de validação, que será executado quando este objeto estiver em foco, e o operador tentar mover o foco para outro componente da interface. Caso o bloco executado retorne .T., será permitida a mudança de foco. Caso o bloco executado retorne .F., não será permitido a remoção do foco do componente. +@param [nclrfore], numeric, Indica a cor do texto do objeto. +@param [nclrback], numeric, Indica a cor de fundo do objeto. +@param [ofont], object, Indica o objeto, do tipo [TFont](TFont), que será utilizado para definir as características da fonte aplicada na exibição do conteúdo do controle visual. +@param [uparam12], logical, Compatibilidade +@param [uparam13], object, Compatibilidade +@param [lpixel], logical, Indica se considera as coordenadas passadas em pixels \(.T.\) ou caracteres \(.F.\). +@param [uparam15], character, Compatibilidade +@param [uparam16], logical, Compatibilidade +@param [bwhen], codeblock, Indica o bloco de código que será executado quando a mudança de foco da entrada de dados no objeto criado estiver sendo realizada. Se o retorno for verdadeiro \(.T.\), o objeto continua habilitado; caso contrário, falso \(.F.\). +@param [uparam18], logical, Compatibilidade +@param [uparam19], logical, Compatibilidade +@param [bchange], codeblock, Indica o bloco de código que será executado quando o estado ou conteúdo do objeto é modificado pela ação sobre o controle visual. +@param [lreadonly], logical, Indica se o objeto pode ser editado. +@param [lpassword], logical, Indica se, verdadeiro \(.T.\), o objeto apresentará asterisco \(\*\) para entrada de dados de senha; caso contrário, falso \(.F.\). +@param [uparam23], character, Compatibilidade +@param [creadvar], character, Indica o nome da variável, configurada no parâmetro bSetGet, que será manipulada pelo objeto. Além disso, esse parâmetro será o retorno da função ReadVar\(\). +@param [uparam25], character, Compatibilidade +@param [uparam26], character, Compatibilidade +@param [uparam27], logical, Compatibilidade +@param [lhasbutton], logical, Se definido .T. indica que deve ser aplicado o botão para seleção de Data ou Calculadora. +@param [uparam29], logical, Compatibilidade +@param [uparam30], logical, Compatibilidade +@param [clabeltext], character, indica o texto que será apresentado na Label. +@param [nlabelpos], numeric, Indica a posição da label, sendo 1=Topo e 2=Esquerda +@param [olabelfont], object, Indica o objeto, do tipo [TFont](TFont), que será utilizado para definir as características da fonte aplicada na exibição da label. +@param [nlabelcolor], numeric, Indica a cor do texto da Label. +@param [cplacehold], character, Define o texto a ser utilizado como place holder, ou seja, o texto que ficará escrito em cor mais opaca quando nenhuma informação tiver sido digitada no campo. \(disponível em builds superiores a 7.00.121227P\) +@param [lpicturepriority], logical, Quando .T. define que a quantidade de caracteres permitidos no TGet será baseada no tamanho da máscara \(Picture\) definida, mesmo que isto exceda a quantidade de caracteres definida na variável bSetGet, até mesmo se ela for vazia \(essa variável deve ser do tipo caracter\). Além disso este parâmetro ativa o controle dos espaços em branco, não incluindo na variável bSetGet os espaços inseridos automaticamente pela Picture. Ou seja, o TGet retornará somente os espaços em branco efetivamente digitados pelo usuário ou aqueles espaços que já foram inicializados na variável bSetGet. Disponível somente a partir da build 7.00.170117A. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/create +/*/ +method create(bsetget, nrow, ncol, nwidth, nheight, cpict, bvalid, nclrfore, nclrback, ofont, uparam12, uparam13, lpixel, uparam15, uparam16, bwhen, uparam18, uparam19, bchange, lreadonly, lpassword, uparam23, creadvar, uparam25, uparam26, uparam27, lhasbutton, uparam29, uparam30, clabeltext, nlabelpos, olabelfont, nlabelcolor, cplacehold, lpicturepriority) class tget +return +/*/{Protheus.doc} tget:new +Método construtor da classe. + +@type method + +@return object, Nova instância da classe TGet + +@param [ncol], numeric, Indica a coordenada horizontal em pixels ou caracteres. +@param [bsetget], codeblock, Indica o bloco de código, no formato \{\|u\| if\( Pcount\( \)>0, := u, \) \}, que será executado para atualizar a variável \(essa variável deve ser do tipo caracter\). Desta forma, se a lista for sequencial, o controle atualizará com o conteúdo do item selecionado, se for indexada, será atualizada com o valor do índice do item selecionado. +@param [ownd], object, Indica a janela ou controle visual onde o objeto será criado. +@param [nwidth], numeric, Indica a largura em pixels do objeto. +@param [nheight], numeric, Indica a altura em pixels do objeto. +@param [cpict], character, Indica a máscara de formatação do conteúdo que será apresentada. Verificar [Tabela de Pictures de Formatação](https://tdn.totvs.com/pages/releaseview.action?pageId=22479526) +@param [bvalid], codeblock, Indica o bloco de código de validação que será executado quando o conteúdo do objeto for modificado. Retorna verdadeiro \(.T.\), se o conteúdo é válido; caso contrário, falso \(.F.\). +@param [nclrfore], numeric, Indica a cor do texto do objeto. +@param [nclrback], numeric, Indica a cor de fundo do objeto. +@param [ofont], object, Indica o objeto, do tipo [TFont](TFont), que será utilizado para definir as características da fonte aplicada na exibição do conteúdo do controle visual. +@param [uparam12], logical, Compatibilidade +@param [uparam13], object, Compatibilidade +@param [lpixel], logical, Indica se considera as coordenadas passadas em pixels \(.T.\) ou caracteres \(.F.\). +@param [uparam15], character, Compatibilidade +@param [uparam16], logical, Compatibilidade +@param [bwhen], codeblock, Indica o bloco de código que será executado quando a mudança de foco da entrada de dados no objeto criado estiver sendo realizada. Se o retorno for verdadeiro \(.T.\), o objeto continua habilitado; caso contrário, falso \(.F.\). +@param [uparam18], logical, Compatibilidade +@param [uparam19], logical, Compatibilidade +@param [bchange], codeblock, Indica o bloco de código que será executado quando o estado ou conteúdo do objeto é modificado pela ação sobre o controle visual. +@param [lreadonly], logical, Indica se o objeto pode ser editado. +@param [lpassword], logical, Indica se, verdadeiro \(.T.\), o objeto apresentará asterisco \(\*\) para entrada de dados de senha; caso contrário, falso \(.F.\). +@param [uparam23], character, Compatibilidade +@param [creadvar], character, Indica o nome da variável, configurada no parâmetro bSetGet, que será manipulada pelo objeto. Além disso, esse parâmetro será o retorno da função ReadVar\(\). +@param [uparam25], character, Compatibilidade +@param [uparam26], character, Compatibilidade +@param [uparam27], logical, Compatibilidade +@param [lhasbutton], logical, Indica se, verdadeiro \(.T.\), o uso dos botões padrão, como calendário e calculadora. +@param [lnobutton], logical, Oculta o botão F3 \(HasButton\). +@param [uparam30], logical, Compatibilidade +@param [clabeltext], character, indica o texto que será apresentado na Label. +@param [nlabelpos], numeric, Indica a posição da label, sendo 1=Topo e 2=Esquerda +@param [olabelfont], object, Indica o objeto, do tipo [TFont](TFont), que será utilizado para definir as características da fonte aplicada na exibição da label. +@param [nlabelcolor], numeric, Indica a cor do texto da Label. +@param [cplacehold], character, Define o texto a ser utilizado como place holder, ou seja, o texto que ficará escrito em cor mais opaca quando nenhuma informação tiver sido digitada no campo. \(disponível em builds superiores a 7.00.121227P\) +@param [lpicturepriority], logical, Quando .T. define que a quantidade de caracteres permitidos no TGet será baseada no tamanho da máscara \(Picture\) definida, mesmo que isto exceda a quantidade de caracteres definida na variável bSetGet, até mesmo se ela for vazia \(essa variável deve ser do tipo caracter\). Além disso este parâmetro ativa o controle dos espaços em branco, não incluindo na variável bSetGet os espaços inseridos automaticamente pela Picture. Ou seja, o TGet retornará somente os espaços em branco efetivamente digitados pelo usuário ou aqueles espaços que já foram inicializados na variável bSetGet. Disponível somente a partir da build 7.00.170117A. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/new +/*/ +method new(ncol, bsetget, ownd, nwidth, nheight, cpict, bvalid, nclrfore, nclrback, ofont, uparam12, uparam13, lpixel, uparam15, uparam16, bwhen, uparam18, uparam19, bchange, lreadonly, lpassword, uparam23, creadvar, uparam25, uparam26, uparam27, lhasbutton, lnobutton, uparam30, clabeltext, nlabelpos, olabelfont, nlabelcolor, cplacehold, lpicturepriority) class tget +return +/*/{Protheus.doc} tget:ctrlrefresh +Força a atualização do objeto. + +@type method + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/ctrlrefresh +/*/ +method ctrlrefresh() class tget +return +/*/{Protheus.doc} tget:selectall +Seleciona todo o conteúdo da Get. + +@type method + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/selectall +/*/ +method selectall() class tget +return +/*/{Protheus.doc} tget:setcontentalign +Alinha o conteúdo interno do objeto. + +@type method + +@param , numeric, Indica o tipo de alinhamento. Para informações dos tipos disponíveis, consulte a área Observações. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/setcontentalign +/*/ +method setcontentalign(nalign) class tget +return +/*/{Protheus.doc} tget:assign +Compatibilidade. + +@type method + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/assign +/*/ +method assign() class tget +return +/*/{Protheus.doc} tget:updatebuffer +Compatibilidade. + +@type method + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/updatebuffer +/*/ +method updatebuffer() class tget +return +/*/{Protheus.doc} tget:setpos +Compatibilidade. + +@type method + +@param [nstart], numeric, Compatibilidade. +@param [nend], numeric, Compatibilidade. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/setpos +/*/ +method setpos(nstart, nend) class tget +return +/*/{Protheus.doc} tget:insert +Compatibilidade. + +@type method + +@param [cstring], character, Compatibilidade. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/insert +/*/ +method insert(cstring) class tget +return +/*/{Protheus.doc} tget:ctext +Compatibilidade. + +@type method + +@param [cval], character, Compatibilidade. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/ctext +/*/ +method ctext(cval) class tget +return +/*/{Protheus.doc} tget:jumptonextctrl +Compatibilidade. + +@type method + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/jumptonextctrl +/*/ +method jumptonextctrl() class tget +return +/*/{Protheus.doc} tget:sethasbutton +Compatibilidade. + +@type method + +@param [lval], logical, Compatibilidade. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/sethasbutton +/*/ +method sethasbutton(lval) class tget +return +/*/{Protheus.doc} tget:setnobutton +Compatibilidade. + +@type method + +@param [lval], logical, Compatibilidade. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/setnobutton +/*/ +method setnobutton(lval) class tget +return +/*/{Protheus.doc} tget:setconvkey +Compatibilidade. + +@type method + +@param [adados], array, Compatibilidade. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/setconvkey +/*/ +method setconvkey(adados) class tget +return + + +/*/{Protheus.doc} tgrid +Exibe os dados organizados em uma tabela. + +@type binary class + + + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/tgrid + +/*/ +class tgrid from TControl +data bcursormove as codeblock +data bcolumnchanged as codeblock +data browleftclick as codeblock +data bgridinfo as codeblock +data bkeyblock as codeblock +data nfreeze as numeric +data ninterval as numeric +data lshowgrid as logical +data nhscroll as numeric +data lcolsresizable as logical +data lcolsmovable as logical +data aobfuscatedcols as array +method new() +method addcolumn() +method clearrows() +method colorder() +method colpos() +method getcellrect() +method getvisiblerows() +method removecolumn() +method scrolllines() +method setheaderclick() +method setrowcolor() +method setrowdata() +method setrowheight() +method setselectedrow() +method setselectionmode() +method setheaderimage() +method gocolumn() +method setkeyvalue() +method setcolumncolor() +method getcolumnssize() +method setcolumnsize() +method setcolumnfont() +method getcursorpos() +end class +/*/{Protheus.doc} tgrid:new +Método construtor da classe. + +@type method + +@return object, Nova instância da classe TGrid + +@param , object, Indica a janela ou componente parent onde o objeto será criado. +@param [nrow], numeric, Indica a coordenada vertical em pixels. +@param [ncol], numeric, Indica a coordenada horizontal em pixels. +@param [nwidth], numeric, Indica a largura em pixels do objeto. +@param [nheight], numeric, Indica a altura em pixels do objeto. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/new +/*/ +method new(oparent, nrow, ncol, nwidth, nheight) class tgrid +return +/*/{Protheus.doc} tgrid:addcolumn +Adiciona colunas no objeto. + +@type method + +@param , numeric, Indica o ID de identificação da coluna que será criada. +@param , character, Indica o título da coluna. +@param , numeric, Indica a largura inicial da coluna em pixels. +@param , numeric, Indica o alinhamento do texto na coluna. Para informações das opções disponíveis, consulte a área Observações. +@param [lheaderfollowsdataalign], logical, Indica se o alinhamento do texto do cabeçalho seguirá o mesmo alinhamento do texto na coluna. Este parâmetro está disponível somente em builds superiores a 7.00.120420A. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/addcolumn +/*/ +method addcolumn(nid, ccaption, nwidth, nalign, lheaderfollowsdataalign) class tgrid +return +/*/{Protheus.doc} tgrid:clearrows +Apaga todas as linhas visíveis do objeto. + +@type method + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/clearrows +/*/ +method clearrows() class tgrid +return +/*/{Protheus.doc} tgrid:colorder +Preenche o array do objeto com as colunas representadas no componente. + +@type method + +@param , array, Indica o número de posições inteiras que representará a ordem das colunas que constam no componente. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/colorder +/*/ +method colorder(adata) class tgrid +return +/*/{Protheus.doc} tgrid:colpos +Retorna a coluna selecionada. + +@type method + +@return numeric, Índice da coluna selecionada. + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/colpos +/*/ +method colpos() class tgrid +return +/*/{Protheus.doc} tgrid:getcellrect +Preenche um array com as propriedades \(Top, Left, Right e Bottom\) do formato da célula selecionada. + +@type method + +@param , array, Indica um array com as propriedades \(Top, Left, Right e Bottom\) do formato da célula selecionada. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/getcellrect +/*/ +method getcellrect(aret) class tgrid +return +/*/{Protheus.doc} tgrid:getvisiblerows +Retorna o número de linhas visíveis no Grid. + +@type method + +@return numeric, Número de linhas visíveis no Grid. + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/getvisiblerows +/*/ +method getvisiblerows() class tgrid +return +/*/{Protheus.doc} tgrid:removecolumn +Remove a coluna do objeto. + +@type method + +@param , numeric, Indica o ID de identificação da coluna criada através do método AddColumn\(\). +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/removecolumn +/*/ +method removecolumn(nid) class tgrid +return +/*/{Protheus.doc} tgrid:scrolllines +Movimenta as linhas de exibição, do objeto, para cima ou para baixo. + +@type method + +@param , numeric, Indica o número de linhas que serão movimentadas. Para mais detalhes, consulte a área Observações. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/scrolllines +/*/ +method scrolllines(nlines) class tgrid +return +/*/{Protheus.doc} tgrid:setheaderclick +Determina o bloco de código que será executado ao clicar no header da coluna do grid. + +@type method + +@param , codeblock, Indica o bloco de código que será executado ao clicar no header da coluna do grid. Para mais detalhes, consulte a área Observações. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/setheaderclick +/*/ +method setheaderclick(bblock) class tgrid +return +/*/{Protheus.doc} tgrid:setrowcolor +Determina a cor exibida em uma linha visível do browse com as propriedades \(nLinha, nColorBack, nColorFore\). + +@type method + +@param [nlinha], numeric, Indica a linha visível do browse. +@param [ncolorback], numeric, Indica a RGB da cor de fundo. +@param [ncolorfore], numeric, Indica a RGB da cor do texto. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/setrowcolor +/*/ +method setrowcolor(nlinha, ncolorback, ncolorfore) class tgrid +return +/*/{Protheus.doc} tgrid:setrowdata +Confgura os dados que serão apresentados em determinada linha do objeto. + +@type method + +@param , numeric, Indica a linha visual que será atualizada. +@param , codeblock, Indica o bloco de código responsável pela geração dos dados que serão apresentados. Para mais detalhes, consulte a área Observações. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/setrowdata +/*/ +method setrowdata(nrow, bdata) class tgrid +return +/*/{Protheus.doc} tgrid:setrowheight +Configura a altura de cada linha do grid. + +@type method + +@param [nval], numeric, Indica a altura em pixels. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/setrowheight +/*/ +method setrowheight(nval) class tgrid +return +/*/{Protheus.doc} tgrid:setselectedrow +Posiciona na linha selecionada do objeto. + +@type method + +@param [nrow], numeric, Indica a linha que será selecionada. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/setselectedrow +/*/ +method setselectedrow(nrow) class tgrid +return +/*/{Protheus.doc} tgrid:setselectionmode +Indica o tipo \(linha ou célula\) de navegação no componente. + +@type method + +@param , numeric, Indica o tipo \(0=linha ou 1=célula\) de navegação no componente. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/setselectionmode +/*/ +method setselectionmode(nselmode) class tgrid +return +/*/{Protheus.doc} tgrid:setheaderimage +Coloca uma imagem em um header criado previamente. + +@type method + +@param , numeric, Número da coluna a ser aplicada a imagem. +@param , character, Nome do resource da imagem. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/setheaderimage +/*/ +method setheaderimage(ncol, cimage) class tgrid +return +/*/{Protheus.doc} tgrid:gocolumn +Posiciona o cursor em uma coluna específica. + +@type method + +@param , numeric, Número da coluna a ser posicionado o cursor. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/gocolumn +/*/ +method gocolumn(ncol) class tgrid +return +/*/{Protheus.doc} tgrid:setkeyvalue +Adiciona ou remove uma tecla modificadora. + +@type method + +@param , numeric, Código ASCII da tecla. +@param , numeric, Código para se irá adicionar \(1\) ou remover \(0\) a tecla da lista de modificadores. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/setkeyvalue +/*/ +method setkeyvalue(nkey, naddorremove) class tgrid +return +/*/{Protheus.doc} tgrid:setcolumncolor +Define a cor de fundo e do texto de uma coluna. + +@type method + +@param [ncol], numeric, Número da coluna a ser modificada \(a ordem começa do 0, sendo então necessário subtrair 1 do número da coluna\). Caso nenhuma coluna seja informada, limpa as informações sobre cores de fundo e texto de todas as colunas. +@param [nclrback], numeric, Cor de fundo. Caso não seja informada, irá para a cor padrão. +@param [nclrfore], numeric, Cor do texto. Caso não seja informada irá para a cor padrão. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/setcolumncolor +/*/ +method setcolumncolor(ncol, nclrback, nclrfore) class tgrid +return +/*/{Protheus.doc} tgrid:getcolumnssize +Retorna o tamanho das colunas em pixels. + +@type method + +@return array, Retorna um array com os tamanhos das colunas, sendo cada posição o tamanho da largura de uma coluna em pixels, seguindo a ordem das colunas. + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/getcolumnssize +/*/ +method getcolumnssize() class tgrid +return +/*/{Protheus.doc} tgrid:setcolumnsize +Define o tamanho da largura de uma coluna em pixels. + +@type method + +@param , numeric, Número \(índice\) da coluna começando por 0. +@param , numeric, Tamanho em pixels da largura da coluna a ser alterada. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/setcolumnsize +/*/ +method setcolumnsize(ncol, nsize) class tgrid +return +/*/{Protheus.doc} tgrid:setcolumnfont +Define a fonte de texto de uma coluna específica. + +@type method + +@param , numeric, Índice da coluna \(iniciando em 1\). +@param , object, Indica o objeto do tipo [TFont](TFont) utilizado para definir as características da fonte aplicada na exibição do texto das linhas da coluna especificada. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/setcolumnfont +/*/ +method setcolumnfont(ncol, ofont) class tgrid +return +/*/{Protheus.doc} tgrid:getcursorpos +Retorna a linha e coluna onde o cursor está atualmente posicionado. + +@type method + +@return array, Array contendo o número da linha \(posição 1\) e coluna \(posição 2\). + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/getcursorpos +/*/ +method getcursorpos() class tgrid +return + + +/*/{Protheus.doc} tgridlayout +Herda as características de um TPanel e acrescenta a funcionalidade de responsividade aos componentes nele inseridos, isto é, tais componentes se adaptam automaticamente ao tamanho do layout disponível, reajustando-se dinamicamente a largura e/ou altura de acordo com o espaço disponível. Os componentes são inseridos em um layout em formato de grid, dispostos em linhas e colunas. + +@type binary class + + + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/tgridlayout + +/*/ +class tgridlayout from TPanel +method new() +method addinlayout() +method addspacer() +end class +/*/{Protheus.doc} tgridlayout:new +Método construtor da classe. + +@type method + +@return object, Nova instância da classe TGridLayout + +@param [ownd], object, Indica a janela ou controle visual onde o objeto será criado. +@param [nalign], numeric, Indica o alinhamento do objeto \(container TGridLayout\) no espaço disponibilizado pelo seu objeto pai. +@param [nwidth], numeric, Indica a largura em pontos do objeto. +@param [nheight], numeric, Indica a altura em pontos do objeto. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/new +/*/ +method new(ownd, nalign, nwidth, nheight) class tgridlayout +return +/*/{Protheus.doc} tgridlayout:addinlayout +Insere um componente no layout. + +@type method + +@param , object, Indica o componente que será inserido no layout. +@param [nrow], numeric, Especifica em qual linha do grid o componente será inserido. +@param [ncolumn], numeric, Especifica em qual coluna do grid o componente será inserido. +@param [nrowspan], numeric, Especifica quantas linhas serão mescladas. +@param [ncolumnspan], numeric, Especifica quantas colunas serão mescladas. +@param [nalign], numeric, Especifica o alinhamento horizontal e/ou vertical do componente dentro de seu espaço no Layout. Um valor horizontal pode ser combinado a um vertical, por exemplo: LAYOUT_ALIGN_HCENTER + LAYOUT_ALIGN_TOP. Consulte a área de observações para conhecer as opções disponíveis. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/addinlayout +/*/ +method addinlayout(ocontrol, nrow, ncolumn, nrowspan, ncolumnspan, nalign) class tgridlayout +return +/*/{Protheus.doc} tgridlayout:addspacer +Insere um espaçador no layout. + +@type method + +@param [nrow], numeric, Representa a linha do grid onde será inserido um espaçador. +@param [ncolumn], numeric, Representa a coluna do grid onde será inserido um espaçador. +@param [nspacefactor], numeric, Especifica um fator que representa sua proporcionalidade em relação a outros espaçadores inseridos no mesmo layout. Um fator maior que zero é suficiente, caso seja o único espaçador no Layout. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/addspacer +/*/ +method addspacer(nrow, ncolumn, nspacefactor) class tgridlayout +return + + +/*/{Protheus.doc} tgroup +Cria um objeto do tipo painel, com borda e título, para que outros possam ser agrupados ou classificados. + +@type binary class + + + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/tgroup + +/*/ +class tgroup from TControl +method new() +method create() +end class +/*/{Protheus.doc} tgroup:new +Método construtor da classe. + +@type method + +@return object, Nova instância da classe TGroup + +@param [ntop], numeric, Indica a coordenada vertical superior em pixels ou caracteres. +@param [nleft], numeric, Indica a coordenada horizontal à esquerda em pixels ou caracteres. +@param [nbottom], numeric, Indica a coordenada vertical inferior em pixels ou caracteres. +@param [nright], numeric, Indica a coordenada horizontal à direita em pixels ou caracteres. +@param [ccaption], character, Indica o título do grupo. +@param [ownd], object, Indica a janela ou controle visual onde o objeto será criado. +@param [nclrtext], numeric, Indica a cor do texto. +@param [nclrpane], numeric, Indica a cor de fundo. +@param [lpixel], logical, Indica se considera as coordenadas passadas em pixels \(.T.\) ou caracteres \(.F.\). +@param [uparam10], logical, Compatibilidade. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/new +/*/ +method new(ntop, nleft, nbottom, nright, ccaption, ownd, nclrtext, nclrpane, lpixel, uparam10) class tgroup +return +/*/{Protheus.doc} tgroup:create +Método construtor da classe. + +@type method + +@return object, Nova instância da classe TGroup + +@param [ownd], object, Indica a janela ou controle visual onde o objeto será criado. +@param [ntop], numeric, Indica a coordenada vertical superior em pixels ou caracteres. +@param [nleft], numeric, Indica a coordenada horizontal à esquerda em pixels ou caracteres. +@param [nbottom], numeric, Indica a coordenada vertical inferior em pixels ou caracteres. +@param [nright], numeric, Indica a coordenada horizontal à direita em pixels ou caracteres. +@param [clabel], character, Indica o título do grupo. +@param [nclrtext], numeric, Indica a cor do texto. +@param [nclrpane], numeric, Indica a cor de fundo. +@param [lpixel], logical, Indica se considera as coordenadas passadas em pixels \(.T.\) ou caracteres \(.F.\). +@param [uparam10], logical, Compatibilidade. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/create +/*/ +method create(ownd, ntop, nleft, nbottom, nright, clabel, nclrtext, nclrpane, lpixel, uparam10) class tgroup +return + + +/*/{Protheus.doc} thashmap +Cria um HashMap para acessar elementos em uma lista, a chave de busca dos elementos pode ser Numérica, de Caracteres ou de Datas, os valores armazenados podem ser de qualquer tipo. + +@type binary class + + + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/thashmap + +/*/ +class thashmap +data nstatus as numeric +method new() +method set() +method get() +method del() +method list() +method clean() +end class +/*/{Protheus.doc} thashmap:new +Cria um objeto da Classe HashMap. + +@type method + +@return object, Nova instância da classe tHashMap + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/new +/*/ +method new() class thashmap +return +/*/{Protheus.doc} thashmap:set +Atualiza o valor correspondente a chave. + +@type method + +@return logical, Verdadeiro \(.T.\) se executou corretamente e Falso \(.F\) se houve erro + +@param , variant, Chave de armazenamento do valor +@param , variant, Valor a ser armazenado na chave +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/set +/*/ +method set(ykey, xval) class thashmap +return +/*/{Protheus.doc} thashmap:get +Obtém o valor armazenado correspondente a chave. + +@type method + +@return logical, Retorna verdadeiro \(.T.\) se achar a chave, ou falso \(.F.\) se não achar. + +@param , variant, Chave de armazenamento do valor +@param <@aval>, array, Retorna o valor armazenado na chave +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/get +/*/ +method get(ykey, aval) class thashmap +return +/*/{Protheus.doc} thashmap:del +Remove o valor armazenado correspondente a chave + +@type method + +@return logical, Verdadeiro \(.T.\) se deletou o valor e Falso \(.F\) se não encontrou + +@param , variant, Chave de armazenamento do valor +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/del +/*/ +method del(ykey) class thashmap +return +/*/{Protheus.doc} thashmap:list +Lista todos os elementos do objeto HashMap em um array. + +@type method + +@return logical, Verdadeiro \(.T.\) se conseguiu listar todos os elementos ou Falso \(.F.\) caso contrário + +@param <@aelem>, array, Array para retorno da lista dos elementos do HashMap +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/list +/*/ +method list(aelem) class thashmap +return +/*/{Protheus.doc} thashmap:clean +Limpa todos os dados alocados no HashMap + +@type method + +@return logical, Verdadeiro \(.T.\) se limpou todos os dados ou falso \(.F.\) se houve algum erro + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/clean +/*/ +method clean() class thashmap +return + + +/*/{Protheus.doc} thbutton +Cria um objeto do tipo botão com aparência de hiperlink \(como em um navegar de Internet\). Desta forma, esse objeto terá os mesmos eventos e ações da classe TButton. + +@type binary class + + + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/thbutton + +/*/ +class thbutton from TControl +method new() +end class +/*/{Protheus.doc} thbutton:new +Método construtor da classe. + +@type method + +@return object, Nova instância da classe THButton + +@param [nrow], numeric, Indica a coordenada vertical em pixels ou caracteres. +@param [ncol], numeric, Indica a coordenada horizontal em pixels ou caracteres. +@param [ccaption], character, Indica o título do botão. +@param [ownd], object, Indica a janela ou controle visual onde o botão será criado. +@param [blclicked], codeblock, Indica o bloco de código que será executado quando clicar, com o botão esquerdo do mouse, sobre o botão. +@param [nwidth], numeric, Indica a largura em pixels do botão. +@param [nheight], numeric, Indica a altura em pixels do botão. +@param [ofont], object, Indica o objeto do tipo TFont utilizado para definir as características da fonte aplicada na exibição do título do botão. +@param [bwhen], codeblock, Indica o bloco de código que será executado quando a mudança de foco da entrada de dados, na janela em que o controle foi criado, estiver sendo efetuada. Observação: O bloco de código retornará verdadeiro \(.T.\), se o controle permanecer habilitado; caso contrário, retornará falso \(.F.\). +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/new +/*/ +method new(nrow, ncol, ccaption, ownd, blclicked, nwidth, nheight, ofont, bwhen) class thbutton +return + + +/*/{Protheus.doc} tibrowser +Cria um objeto do tipo página de internet. + +@type binary class + + + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/tibrowser + +/*/ +class tibrowser from TControl +method new() +method navigate() +method gohome() +method print() +end class +/*/{Protheus.doc} tibrowser:new +Método construtor da classe. + +@type method + +@return object, Nova instância da classe TIBrowser + +@param [nrow], numeric, Indica a coordenada vertical em pixels ou caracteres. +@param [ncol], numeric, Indica a coordenada horizontal em pixels ou caracteres. +@param [nwidth], numeric, Indica a largura em pixels do objeto. +@param [nheight], numeric, Indica a altura em pixels do objeto. +@param [ninitlink], character, Indica a URL Uniform Resource Locator da página de internet. +@param [ownd], object, Indica a janela ou controle visual onde o objeto será criado. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/new +/*/ +method new(nrow, ncol, nwidth, nheight, ninitlink, ownd) class tibrowser +return +/*/{Protheus.doc} tibrowser:navigate +Direciona para uma nova página Web. + +@type method + +@param [curl], character, Indica a URL Uniform Resource Locator da página Web. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/navigate +/*/ +method navigate(curl) class tibrowser +return +/*/{Protheus.doc} tibrowser:gohome +Direciona para a página \(URL - Uniform Resource Locator\) configurada na construção do objeto. + +@type method + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/gohome +/*/ +method gohome() class tibrowser +return +/*/{Protheus.doc} tibrowser:print +Abre uma janela para impressão da página. + +@type method + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/print +/*/ +method print() class tibrowser +return + + +/*/{Protheus.doc} tlinearlayout +Herda as características de um TPanel e acrescenta a funcionalidade de responsividade aos componentes nele inseridos, isto é, tais componentes se adaptam automaticamente ao tamanho do layout disponível, reajustando-se dinamicamente a largura e/ou altura de acordo com o espaço disponível. Os componentes são inseridos linearmente na horizontal ou na vertical dependendo da configuração. + +@type binary class + + + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/tlinearlayout + +/*/ +class tlinearlayout from TPanel +data ndirection as numeric +method new() +method addinlayout() +method addspacer() +end class +/*/{Protheus.doc} tlinearlayout:new +Método construtor da classe. + +@type method + +@return object, Nova instância da classe TLinearLayout + +@param [ownd], object, Indica a janela ou controle visual onde o objeto será criado. +@param [ndirection], numeric, Indica a direção linear na qual os componentes serão dispostos no layout. Consulte a área de observações para conhecer as opções disponíveis. +@param [nalign], numeric, Indica o alinhamento do objeto \(container TAlignLayout\) no espaço disponibilizado pelo seu objeto pai. +@param [nwidth], numeric, Indica a largura em pontos do objeto. +@param [nheight], numeric, Indica a altura em pontos do objeto. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/new +/*/ +method new(ownd, ndirection, nalign, nwidth, nheight) class tlinearlayout +return +/*/{Protheus.doc} tlinearlayout:addinlayout +Insere um componente no layout. + +@type method + +@param , object, Indica o componente que será inserido no layout. +@param [nalign], numeric, Especifica o alinhamento horizontal e/ou vertical do componente dentro de seu espaço no Layout. Um valor horizontal pode ser combinado a um vertical, por exemplo: LAYOUT_ALIGN_HCENTER + LAYOUT_ALIGN_TOP. Consulte a área de observações para conhecer as opções disponíveis. +@param [nspacerfactor], numeric, Especifica o fator de redimensionamento do componente \(respeitando sua política\) dentro do layout. Para maior legibilidade, pode ser usado um valor que represente a porcentagem. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/addinlayout +/*/ +method addinlayout(ocontrol, nalign, nspacerfactor) class tlinearlayout +return +/*/{Protheus.doc} tlinearlayout:addspacer +Insere um espaçador no layout. + +@type method + +@param [nindex], numeric, Representa o indice da lista de componentes do layout onde será inserido um espaçador. +@param [nspacefactor], numeric, Especifica um fator que representa sua proporcionalidade em relação a outros espaçadores inseridos no mesmo layout. É desnecessário quando o layout possuir somente um espaçador. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/addspacer +/*/ +method addspacer(nindex, nspacefactor) class tlinearlayout +return + + +/*/{Protheus.doc} tlistbox +Cria um objeto do tipo lista de itens com barra de rolagem. + +@type binary class + + + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/tlistbox + +/*/ +class tlistbox from TControl +data aitems as array +data nat as numeric +method create() +method new() +method change() +method del() +method getpos() +method getseltext() +method gobottom() +method gotop() +method insert() +method len() +method modify() +method reset() +method select() +method setarray() +method setitems() +method add() +method set() +end class +/*/{Protheus.doc} tlistbox:create +Método construtor da classe. + +@type method + +@return object, Nova instância da classe TListBox + +@param [ownd], object, Indica a janela ou controle visual onde o objeto será criado. +@param [nrow], numeric, Indica a coordenada vertical em pixels ou caracteres. +@param [ncol], numeric, Indica a coordenada horizontal em pixels ou caracteres. +@param [bsetget], codeblock, Indica o bloco de código, no formato \{\|u\| if\( Pcount\( \)>0, := u, \) \}, que será executado para atualizar a variável \(essa variável deve ser do tipo caracter\). Desta forma, se a lista for seqüencial, o controle atualizará com o conteúdo do item selecionado, se for indexada, será atualizada com o valor do índice do item selecionado. +@param [aitems], array, Indica uma lista de itens e caracteres que serão apresentados. Essa lista pode ter os seguintes formatos: Seqüencial \(Exemplo: \{"item1","item2",...,"itemN"\}\) ou Indexada \(Exemplo: \{"a=item1","b=item2",...,"n=itemN"\}\). +@param [nwidth], numeric, Indica a largura em pixels do objeto. +@param [nheight], numeric, Indica a altura em pixels do objeto. +@param [bchange], codeblock, Indica o bloco de código que será executado quando o estado ou conteúdo do objeto é modificado pela ação sobre o controle visual. +@param [bvalid], codeblock, Indica o bloco de código de validação que será executado quando o conteúdo do objeto for modificado. Retorna verdadeiro \(.T.\), se o conteúdo é válido; caso contrário, falso \(.F.\). +@param [uparam10], object, Compatibility parameter. Pass NIL. +@param [uparam11], object, Compatibility parameter. Pass NIL. +@param [lpixel], logical, Indica se considera as coordenadas passadas em pixels \(.T.\) ou caracteres \(.F.\). +@param [uparam13], logical, Compatibility parameter. Pass NIL. +@param [bldblclick], codeblock, Indica o bloco de código que será executado quando clicar duas vezes, com o botão esquerdo do mouse, sobre o objeto. +@param [ofont], object, Indica o objeto do tipo TFont utilizado para definir as características da fonte aplicada na exibição do conteúdo do controle visual. +@param [uparam16], character, Compatibility parameter. Pass NIL. +@param [uparam17], logical, Compatibility parameter. Pass NIL. +@param [bwhen], codeblock, Indica o bloco de código que será executado quando a mudança de foco da entrada de dados, na janela em que o controle foi criado, estiver sendo efetuada. Observação: O bloco de código retornará verdadeiro \(.T.\) se o controle permanecer habilitado; caso contrário, retornará falso \(.F.\). +@param [uparam19], array, Compatibility parameter. Pass NIL. +@param [uparam20], codeblock, Compatibility parameter. Pass NIL. +@param [uparam21], logical, Compatibility parameter. Pass NIL. +@param [uparam22], logical, Compatibility parameter. Pass NIL. +@param [brclicked], codeblock, Indica o bloco de código que será executado quando clicar, com o botão direito do mouse, sobre o objeto. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/create +/*/ +method create(ownd, nrow, ncol, bsetget, aitems, nwidth, nheight, bchange, bvalid, uparam10, uparam11, lpixel, uparam13, bldblclick, ofont, uparam16, uparam17, bwhen, uparam19, uparam20, uparam21, uparam22, brclicked) class tlistbox +return +/*/{Protheus.doc} tlistbox:new +Método construtor da classe. + +@type method + +@return object, Nova instância da classe TListBox + +@param , numeric, Indica a coordenada vertical em pixels ou caracteres. +@param , numeric, Indica a coordenada horizontal em pixels ou caracteres. +@param [bsetget], codeblock, Indica o bloco de código, no formato \{\|u\| if\( Pcount\( \)>0, := u, \) \}, que será executado para atualizar a variável \(essa variável deve ser do tipo caracter\). Desta forma, se a lista for seqüencial, o controle atualizará com o conteúdo do item selecionado, se for indexada, será atualizada com o valor do índice do item selecionado. +@param [aitems], array, Indica uma lista de itens e caracteres que serão apresentados. Essa lista pode ter os seguintes formatos: Seqüencial \(Exemplo: \{"item1","item2",...,"itemN"\}\) ou Indexada \(Exemplo: \{"a=item1","b=item2",...,"n=itemN"\}\). +@param [nwidth], numeric, Indica a largura em pixels do objeto. +@param [nheight], numeric, Indica a altura em pixels do objeto. +@param [bchange], codeblock, Indica o bloco de código que será executado quando o estado ou conteúdo do objeto é modificado pela ação sobre o controle visual. +@param [ownd], object, Indica a janela ou controle visual onde o objeto será criado. +@param [bvalid], codeblock, Indica o bloco de código de validação que será executado quando o conteúdo do objeto for modificado. Retorna verdadeiro \(.T.\), se o conteúdo é válido; caso contrário, falso \(.F.\). +@param [uparam10], object, Compatibility parameter. Pass NIL. +@param [uparam11], object, Compatibility parameter. Pass NIL. +@param [lpixel], logical, Indica se considera as coordenadas passadas em pixels \(.T.\) ou caracteres \(.F.\). +@param [uparam13], logical, Compatibility parameter. Pass NIL. +@param [bldblclick], codeblock, Indica o bloco de código que será executado quando clicar duas vezes, com o botão esquerdo do mouse, sobre o objeto. +@param [ofont], object, Indica o objeto do tipo TFont utilizado para definir as características da fonte aplicada na exibição do conteúdo do controle visual. +@param [uparam16], character, Compatibility parameter. Pass NIL. +@param [uparam17], logical, Compatibility parameter. Pass NIL. +@param [bwhen], codeblock, Indica o bloco de código que será executado quando a mudança de foco da entrada de dados, no objeto criado, estiver sendo realizada. Se o retorno for verdadeiro \(.T.\), o objeto continua habilitado; caso contrário, falso \(.F.\). +@param [uparam19], array, Compatibility parameter. Pass NIL. +@param [uparam20], codeblock, Compatibility parameter. Pass NIL. +@param [uparam21], logical, Compatibility parameter. Pass NIL. +@param [uparam22], logical, Compatibility parameter. Pass NIL. +@param [brclicked], codeblock, Indica o bloco de código que será executado quando clicar, com o botão direito do mouse, sobre o objeto. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/new +/*/ +method new(nrow, ncol, bsetget, aitems, nwidth, nheight, bchange, ownd, bvalid, uparam10, uparam11, lpixel, uparam13, bldblclick, ofont, uparam16, uparam17, bwhen, uparam19, uparam20, uparam21, uparam22, brclicked) class tlistbox +return +/*/{Protheus.doc} tlistbox:change +Executa o bloco de código configurado no parâmetro bChange, ao mudar de linha. + +@type method + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/change +/*/ +method change() class tlistbox +return +/*/{Protheus.doc} tlistbox:del +Exclui um item. + +@type method + +@param [npos], numeric, Indica a posição do item que será excluído. Observação: Essa posição deve ser maior que 0 e menor ou igual que o número de itens. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/del +/*/ +method del(npos) class tlistbox +return +/*/{Protheus.doc} tlistbox:getpos +Retorna a posição do item selecionado na lista. + +@type method + +@return numeric, Retorna a posição do item selecionado. + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/getpos +/*/ +method getpos() class tlistbox +return +/*/{Protheus.doc} tlistbox:getseltext +Retorna o texto do item selecionado na lista. + +@type method + +@return character, Retorna a posição do item selecionado. + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/getseltext +/*/ +method getseltext() class tlistbox +return +/*/{Protheus.doc} tlistbox:gobottom +Posiciona no último item da lista. + +@type method + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/gobottom +/*/ +method gobottom() class tlistbox +return +/*/{Protheus.doc} tlistbox:gotop +Posiciona no primeiro item da lista. + +@type method + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/gotop +/*/ +method gotop() class tlistbox +return +/*/{Protheus.doc} tlistbox:insert +Insere um novo item. + +@type method + +@param [ctext], character, Indica o texto do item que será inserido. +@param [npos], numeric, Indica a posição do novo item, deslocando o item \(anterior\) daquela posição para baixo. Obs.: É necessário que exista um item naquela posição para inserir outro em seu lugar. Se este parâmetro não for passado, o item será inserido na posição do item que está selecionado. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/insert +/*/ +method insert(ctext, npos) class tlistbox +return +/*/{Protheus.doc} tlistbox:len +Retorna o número de itens. + +@type method + +@return numeric, Retorna o número de itens. + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/len +/*/ +method len() class tlistbox +return +/*/{Protheus.doc} tlistbox:modify +Altera o texto do item. + +@type method + +@param [ctext], character, Indica o novo texto do item. +@param [npos], numeric, Indica a posição do item que terá seu texto alterado. Observação: A posição deve ser maior que 0 e menor ou igual que o número de itens. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/modify +/*/ +method modify(ctext, npos) class tlistbox +return +/*/{Protheus.doc} tlistbox:reset +Limpa todos os itens da ListBox. + +@type method + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/reset +/*/ +method reset() class tlistbox +return +/*/{Protheus.doc} tlistbox:select +Força a seleção de um item. + +@type method + +@param , numeric, Indica a posição do item que será selecionado +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/select +/*/ +method select(nitem) class tlistbox +return +/*/{Protheus.doc} tlistbox:setarray +Define o vetor de itens para a lista. Caso exista uma definição anterior ela será substituida. + +@type method + +@param , array, Indica um array, no formato texto, com os itens para a lista. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/setarray +/*/ +method setarray(avetor) class tlistbox +return +/*/{Protheus.doc} tlistbox:setitems +Define o array de itens para a lista. Caso exista uma definição anterior ela será substituida. + +@type method + +@param , array, Indica o array, no formato texto, com os itens para a lista. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/setitems +/*/ +method setitems(avetor) class tlistbox +return +/*/{Protheus.doc} tlistbox:add +Adiciona um novo item. + +@type method + +@param [ctext], character, Indica o texto do item que será adicionado. +@param [npos], numeric, Indica a posição do novo item, deslocando o item \(anterior\) daquela posição para baixo. Obs.: Diferente do método Insert, não é necessário que exista um item naquela posição para inserir outro em seu lugar. Se este parâmetro não for passado, o item será inserido no final da lista. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/add +/*/ +method add(ctext, npos) class tlistbox +return +/*/{Protheus.doc} tlistbox:set +Força a seleção de um item. + +@type method + +@param [ctext], character, Indica o texto do item que será selecionado. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/set +/*/ +method set(ctext) class tlistbox +return + + +/*/{Protheus.doc} tmailmanager +A classe TMailManager realiza a comunicação com o servidor de e-mail. + +@type binary class + + + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/tmailmanager + +/*/ +class tmailmanager +method new() +method popconnect() +method popdisconnect() +method getnummsgs() +method deletemsg() +method init() +method smtpconnect() +method smtpdisconnect() +method geterrorstring() +method setpoptimeout() +method setsmtptimeout() +method getsmtptimeout() +method sendmail() +method imapconnect() +method imapdisconnect() +method getfolderlist() +method changefolder() +method deletefolder() +method createfolder() +method renamefolder() +method getmsgheader() +method getmsgbody() +method movemsg() +method copymsg() +method getfolder() +method setmsgflag() +method setfoldersubscribe() +method purge() +method smtpauth() +method imapstore() +method getuser() +method startgetallmsgheader() +method endgetallmsgheader() +method setuserealid() +method setusetls() +method setusessl() +end class +/*/{Protheus.doc} tmailmanager:new +Cria uma nova instância da classe TMailManager. + +@type method + +@return object, Nova instância da classe TMailManager + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/new +/*/ +method new() class tmailmanager +return +/*/{Protheus.doc} tmailmanager:popconnect +Conecta com o servidor POP - Post Office Protocol. + +@type method + +@return numeric, Retorna 0 \(zero\) quando a operação é completada com sucesso. Caso contrário, retornará um código de erro. + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/popconnect +/*/ +method popconnect() class tmailmanager +return +/*/{Protheus.doc} tmailmanager:popdisconnect +Encerra a conexão com o servidor POP - Post Office Protocol. + +@type method + +@return numeric, Retorna 0 \(zero\) ao encerrar a conexão com sucesso. Caso contrário, será retornado um código de erro. + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/popdisconnect +/*/ +method popdisconnect() class tmailmanager +return +/*/{Protheus.doc} tmailmanager:getnummsgs +Obtém o número de mensagens existentes no servidor de e-mail. + +@type method + +@return numeric, Retorna 0 \(zero\) se a execução for realizada com sucesso. Caso contrário, será retornado o código de erro ocorrido. + +@param <@nnummsg>, variant, Indica o número de mensagens que estão no servidor. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/getnummsgs +/*/ +method getnummsgs(nnummsg) class tmailmanager +return +/*/{Protheus.doc} tmailmanager:deletemsg +Exclui uma mensagem do servidor de e-mail. + +@type method + +@return numeric, Retorna 0 \(zero\) se encontrar e excluir a mensagem. Caso contrário, será retornado o código de erro ocorrido. + +@param , numeric, Indica o número da mensagem que será excluéda. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/deletemsg +/*/ +method deletemsg(nmsg) class tmailmanager +return +/*/{Protheus.doc} tmailmanager:init +Define as configurações da classe TMailManager para realizar uma conexão com o servidor de e-mail. + +@type method + +@return numeric, Retorna sempre 0 \(zero\). Exceto quando for utilizado o protocolo MAPI e o servidor não estiver rodando em plataforma Windows, o retorno será -1. + +@param , character, Indica o endereço ou alias do servidor de e-mail IMAP/POP/MAPI. +@param , character, Indica o endereço ou alias do servidor de e-mail SMTP. +@param , character, Indica a conta de e-mail do usuário no servidor de e-mail. +@param , character, Indica a senha do usuário no servidor de e-mail. +@param [nmailport], numeric, Indica a porta de comunicação para conexão IMAP/POP/MAPI. +@param [nsmtpport], numeric, Indica o Indica a porta de comunicação para conexão SMTP \(Padrão 25\). +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/init +/*/ +method init(cmailserver, csmtpserver, caccount, cpassword, nmailport, nsmtpport) class tmailmanager +return +/*/{Protheus.doc} tmailmanager:smtpconnect +Conecta com o servidor SMTP - Simple Mail Transfer Protocol. + +@type method + +@return numeric, Retorna 0 \(zero\) quando a operação é completada com sucesso. Caso contrário, retornará um código de erro. + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/smtpconnect +/*/ +method smtpconnect() class tmailmanager +return +/*/{Protheus.doc} tmailmanager:smtpdisconnect +Finaliza a conexão entre a aplicação e o servidor SMTP - Simple Mail Transfer Protocol. + +@type method + +@return numeric, Retorna 0 \(zero\) ao encerrar a conexão com sucesso. Caso contrário, retornará um código de erro. + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/smtpdisconnect +/*/ +method smtpdisconnect() class tmailmanager +return +/*/{Protheus.doc} tmailmanager:geterrorstring +Obtém a descrição do código de erro informado. + +@type method + +@return character, Retorna uma string com a descrição do código de erro informado. + +@param , numeric, Indica o código numérico do erro. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/geterrorstring +/*/ +method geterrorstring(nerror) class tmailmanager +return +/*/{Protheus.doc} tmailmanager:setpoptimeout +Define o tempo de espera para uma conexão estabelecida com o servidor POP - Post Office Protocol. + +@type method + +@return numeric, Retorna 0 \(zero\) se o tempo de espera for definido com sucesso. Caso contrário, será retornado um código de erro. + +@param , numeric, Indica o tempo de espera em segundos. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/setpoptimeout +/*/ +method setpoptimeout(ntimeout) class tmailmanager +return +/*/{Protheus.doc} tmailmanager:setsmtptimeout +Define o tempo de espera para uma conexão estabelecida com o servidor SMTP - Simple Mail Transfer Protocol. + +@type method + +@return numeric, Retorna 0 \(zero\) se o tempo de espera for definido com sucesso. Caso contrário, será retornado um código de erro. + +@param , numeric, Indica o tempo de espera em segundos. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/setsmtptimeout +/*/ +method setsmtptimeout(ntimeout) class tmailmanager +return +/*/{Protheus.doc} tmailmanager:getsmtptimeout +Obtém o tempo de espera para uma conexão estabelecida com o servidor SMTP - Simple Mail Transfer Protocol. + +@type method + +@return numeric, Retorna o tempo de espera em segundos. + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/getsmtptimeout +/*/ +method getsmtptimeout() class tmailmanager +return +/*/{Protheus.doc} tmailmanager:sendmail +Envia e-mail através do protocolo SMTP - Simple Mail Transfer Protocol ou MAPI. + +@type method + +@return numeric, Retorna 0 \(zero\) se o e-mail for enviado com sucesso. Caso contrário, retornará um código de erro. + +@param , character, Indica o endereço de uma conta de e-mail \(remetente\) para representar o e-mail enviado. Exemplo: usuário@provedor.com.br. +@param , character, Indica o endereço de uma conta de e-mail que será utilizada para enviar o respectivo e-mail. +@param [csubject], character, Indica o assunto do e-mail. Caso não seja especificado, o assunto será enviado em branco. +@param [cbody], character, Indica o conteúdo da mensagem que será enviada. +@param [ccc], character, Indica o endereço de e-mail, na seção Com Cópia \(CC\), que receberá a mensagem. +@param [cbcc], character, Indica o endereço de e-mail, na seção Cópia Oculta, que receberá a mensagem. +@param [aattach], array, Indica um array de caracteres com o caminho do arquivo que será anexado no e-mail +@param , numeric, Indica a quantidade de arquivos que serão anexados no e-mail, no caso a quantidade de elementos do array. +@param [npriority], numeric, Indica a prioridade da mensagem. Caso não seja preenchido, a prioridade será normal. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/sendmail +/*/ +method sendmail(cfrom, cto, csubject, cbody, ccc, cbcc, aattach, nnumattach, npriority) class tmailmanager +return +/*/{Protheus.doc} tmailmanager:imapconnect +Realiza a conexão com o servidor IMAP - Internet Message Access Protocol. + +@type method + +@return numeric, Retorna 0 \(zero\) se realizar a conexão com o servidor IMAP. Caso contrário, retornará um código de erro. + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/imapconnect +/*/ +method imapconnect() class tmailmanager +return +/*/{Protheus.doc} tmailmanager:imapdisconnect +Encerra a conexão entre a aplicação e o servidor IMAP - Internet Message Access Protocol. + +@type method + +@return numeric, Retorna 0 \(zero\) se finalizar a conexão com o servidor IMAP. Caso contrário, retornará um código de erro. + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/imapdisconnect +/*/ +method imapdisconnect() class tmailmanager +return +/*/{Protheus.doc} tmailmanager:getfolderlist +Obtém todas as pastas assinadas de uma conta de e-mail, através do servidor IMAP. + +@type method + +@return array, Retorna um array com todas as pastas assinadas de uma conta de e-mail, com as seguintes informações: nome, status, número de mensagens existentes, número de mensagens lidas e número de mensagens não lidas. + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/getfolderlist +/*/ +method getfolderlist() class tmailmanager +return +/*/{Protheus.doc} tmailmanager:changefolder +Permite trocar de pasta, no servidor IMAP, informando uma nova pasta. + +@type method + +@return logical, Retorna verdadeiro \(.T.\), se a pasta informada for válida \(existir\) para realizar a troca de pasta. Caso contrário, retorna falso \(.F.\). + +@param , character, Indica o nome da pasta desejada no servidor. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/changefolder +/*/ +method changefolder(cfolder) class tmailmanager +return +/*/{Protheus.doc} tmailmanager:deletefolder +Exclui uma pasta do servidor IMAP. + +@type method + +@return logical, Retorna verdadeiro \(.T.\), se a pasta for excluéda com sucesso. Caso contrário, retorna falso \(.F.\). + +@param , character, Indica o nome da pasta que será excluéda. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/deletefolder +/*/ +method deletefolder(cfolder) class tmailmanager +return +/*/{Protheus.doc} tmailmanager:createfolder +Cria uma nova pasta de mensagens no servidor IMAP. + +@type method + +@return logical, Retorna verdadeiro \(.T.\), se a pasta for criada com sucesso. Caso contrário, retorna falso \(.F.\). + +@param , character, Indica o nome da pasta que será criada. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/createfolder +/*/ +method createfolder(cfolder) class tmailmanager +return +/*/{Protheus.doc} tmailmanager:renamefolder +Altera o nome da pasta no servidor IMAP. + +@type method + +@return logical, Retorna verdadeiro \(.T.\), se alterar o nome da pasta. Caso contrário, retorna falso \(.F.\). + +@param , character, Indica o nome atual da pasta no servidor IMAP. +@param , character, Indica o novo nome da pasta. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/renamefolder +/*/ +method renamefolder(ccurfolder, cnewfolder) class tmailmanager +return +/*/{Protheus.doc} tmailmanager:getmsgheader +Obtém o cabeçalho da mensagem, retornando os campos que foram incluédos na mensagem. + +@type method + +@return array, Retorna um array com os campos do cabeçalho da mensagem. Em caso de erro, retorna nulo. + +@param , numeric, Indica o número da mensagem na pasta do servidor de e-mail IMAP. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/getmsgheader +/*/ +method getmsgheader(nmsg) class tmailmanager +return +/*/{Protheus.doc} tmailmanager:getmsgbody +Obtém o corpo da mensagem através do servidor IMAP. + +@type method + +@return array, Retorna um array com as informações da mensagem. + +@param , numeric, Indica o número sequencial da mensagem que deseja obter. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/getmsgbody +/*/ +method getmsgbody(nmsg) class tmailmanager +return +/*/{Protheus.doc} tmailmanager:movemsg +Move uma mensagem da pasta em uso, do servidor IMAP, para outra pasta contida na conta de e-mail. + +@type method + +@return logical, Retorna verdadeiro \(.T.\) caso tenha sido movida a mensagem com sucesso. Caso contrário, retornará falso \(.F.\). + +@param , numeric, Indica o número sequencial da mensagem que deseja obter. +@param , character, Indica o nome da pasta que armazenará a mensagem. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/movemsg +/*/ +method movemsg(nmsg, cfolder) class tmailmanager +return +/*/{Protheus.doc} tmailmanager:copymsg +Copia uma mensagem da pasta corrente, do servidor IMAP, para outra pasta ou a mesma. + +@type method + +@return logical, Retorna verdadeiro \(.T.\) se realizar a copia da mensagem para a pasta informada. Caso contrário, retorna falso \(.F.\). + +@param , numeric, Indica o número sequencial da mensagem no servidor IMAP. +@param , character, Indica o nome da pasta, do servidor IMAP, para qual a mensagem será transferida. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/copymsg +/*/ +method copymsg(nmsg, cfolder) class tmailmanager +return +/*/{Protheus.doc} tmailmanager:getfolder +Obtém o nome da pasta atual no servidor IMAP. + +@type method + +@return character, Retorna uma string com o nome da pasta em uso pela aplicação. + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/getfolder +/*/ +method getfolder() class tmailmanager +return +/*/{Protheus.doc} tmailmanager:setmsgflag +Define o status de uma determinada mensagem no servidor IMAP. + +@type method + +@return logical, Retorna verdadeiro \(.T.\) se a mensagem for posicionada corretamente. Caso contrário, retorna falso \(.F.\). + +@param , numeric, Indica o número sequencial da mensagem que deseja obter. +@param , character, Indica o novo status da mensagem, sendo: A=Answered, F=Flagged, D=Deleted, S=Seen, R=Draft, C=Recent, P=Special. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/setmsgflag +/*/ +method setmsgflag(nmsg, cflag) class tmailmanager +return +/*/{Protheus.doc} tmailmanager:setfoldersubscribe +Define uma determinada pasta, do servidor IMAP, assinada. Desta forma, a pasta ficará visével, na caixa de correio, e suas mensagens serão baixadas. + +@type method + +@return logical, Retorna verdadeiro \(.T.\) se a operação for realizada com sucesso. Caso contrário, retorna falso \(.F.\). + +@param , character, Indica o nome da pasta que será ou não assinada \(subscribe\). +@param , logical, Indica se a pasta será assinada \(.T.\) ou não \(.F.\). +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/setfoldersubscribe +/*/ +method setfoldersubscribe(cfolder, lsign) class tmailmanager +return +/*/{Protheus.doc} tmailmanager:purge +Remove permanentemente todas as mensagens contidas na caixa de e-mail e pasta informada, que contenham a flag definidas. + +@type method + +@return logical, Retorna verdadeiro \(.T.\) se a operação for realizada com sucesso. Caso contrário, retorna falso \(.F.\). + +@param , character, Indica o nome da pasta que será realizado o purge. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/purge +/*/ +method purge(cfolder) class tmailmanager +return +/*/{Protheus.doc} tmailmanager:smtpauth +Realiza a autenticação no servidor SMTP - Simple Mail Transfer Protocol - para envio de mensagens. + +@type method + +@return numeric, Retorna 0 \(zero\) em caso de sucesso. Caso contrário, retornará um código de erro. + +@param , character, Indica o usuário no qual será feita a autenticação. +@param , character, Indica a senha do usuário para autenticação. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/smtpauth +/*/ +method smtpauth(cuser, cpass) class tmailmanager +return +/*/{Protheus.doc} tmailmanager:imapstore +Armazena uma mensagem em alguma pasta do servidor IMAP. + +@type method + +@return numeric, Retorna 0 \(zero\) em caso de sucesso. Caso contrário, retornará um código de erro. + +@param , character, Indica o nome da pasta que armazenará a mensagem. +@param , object, Indica um objeto, da classe TMailMessage, que contém informações da mensagem que será armazenada. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/imapstore +/*/ +method imapstore(cfolder, omsg) class tmailmanager +return +/*/{Protheus.doc} tmailmanager:getuser +Obtém o nome do usuário de e-mail, informado nos métodos de inicialização ou autenticação. + +@type method + +@return character, Retorna o nome da conta de e-mail em uso. + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/getuser +/*/ +method getuser() class tmailmanager +return +/*/{Protheus.doc} tmailmanager:startgetallmsgheader +Inicia o processo para adquirir todos os cabeçalhos \(headers\) e mensagens de uma determinada pasta. + +@type method + +@return logical, Retorna verdadeiro \(.T.\), se iniciar o processo para adquirir os cabeçalhos e mensagens. Caso contrário, retorna falso \(.F.\). + +@param , character, Indica a pasta, no servidor de e-mail, em que serão adquiridos os cabeçalhos das mensagens. +@param , array, Indica as informações que serão retornadas nos cabeçalhos das mensagens. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/startgetallmsgheader +/*/ +method startgetallmsgheader(cfolder, aheader) class tmailmanager +return +/*/{Protheus.doc} tmailmanager:endgetallmsgheader +Obtém o cabeçalho de todas as mensagens existentes no servidor IMAP. + +@type method + +@return logical, Retorna verdadeiro \(.T.\) quando o servidor IMAP terminar o envio do cabeçalho da mensagem. Caso contrário, retorna falso \(.F.\). + +@param <@aheader>, array, Indica o vetor que será utilizado como referência para retornar o cabeçalho da mensagem. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/endgetallmsgheader +/*/ +method endgetallmsgheader(aheader) class tmailmanager +return +/*/{Protheus.doc} tmailmanager:setuserealid +Define o tipo de identificação, no servidor IMAP, para utilização do ID único da mensagem para a busca de mensagens. + +@type method + +@param , logical, Indica se será utilizado o ID real da mensagem \(.T.\) ou será utilizado o número da mensagem \(.F.\). +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/setuserealid +/*/ +method setuserealid(lopt) class tmailmanager +return +/*/{Protheus.doc} tmailmanager:setusetls +Define no envio de e-mail o uso de STARTTLS durante o protocolo de comunicação. + +@type method + +@param , logical, Indica se será utilizará a comunicação segura através de SSL/TLS \(.T.\) ou não \(.F.\). +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/setusetls +/*/ +method setusetls(ltls) class tmailmanager +return +/*/{Protheus.doc} tmailmanager:setusessl +Define o envio de e-mail utilizando uma comunicação segura através do SSL - Secure Sockets Layer. + +@type method + +@param , logical, Indica se será utilizará a comunicação segura através de SSL \(.T.\) ou não \(.F.\). +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/setusessl +/*/ +method setusessl(lssl) class tmailmanager +return + + +/*/{Protheus.doc} tmailmessage +A classe TMailMessage representa uma mensagem de e-mail. Através dela é possível obter todas informações sobre a mensagem carregada e realizar diversas operações, como envio e recebimento de e-mail. + +TMailMessage possui todos atributos possíveis a uma mensagem de e-mail e podemos utilizar seus métodos para inserir arquivos, documentos e outras mensagens como anexo da mensagem atual. + +@type binary class + + + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/tmailmessage + +/*/ +class tmailmessage +data cfrom as character +data cto as character +data ccc as character +data cbcc as character +data csubject as character +data cbody as character +data creplyto as character +data cmessageid as character +data cdate as character +data cnewsgroups as character +data creferences as character +data cxref as character +data cxnewsreader as character +data cxmailer as character +data nxpriority as numeric +data cnotification as character +data lsigned as logical +method new() +method receive() +method send() +method clear() +method attachfile() +method attach() +method attachfullpath() +method addatthtag() +method tostr() +method fromstr() +method addcustomheader() +method getcustomheader() +method getattachcount() +method getattachinfo() +method getattach() +method saveattach() +method save() +method load() +method msgbodytype() +method msgbodyencode() +method setconfirmread() +method receive2() +method send2() +end class +/*/{Protheus.doc} tmailmessage:new +Cria uma nova instância da classe TMailMessage. + +@type method + +@return object, Nova instância da classe TMailMessage + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/new +/*/ +method new() class tmailmessage +return +/*/{Protheus.doc} tmailmessage:receive +Recebe uma nova mensagem do servidor populando o objeto da mensagem. + +@type method + +@return numeric, Retorna 0 \(zero\) quando o e-mail for recebido com sucesso. Caso contrário, retorna outro valor. + +@param , object, Indica o objeto do servidor de e-mail, criado através da classe TMailManager. +@param , numeric, Indica o número da mensagem que será criada, recebido através do método TMailManager:GetNumMsgs. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/receive +/*/ +method receive(oserver, nmsg) class tmailmessage +return +/*/{Protheus.doc} tmailmessage:send +Envia um e-mail, de acordo com os dados passados pelo objeto da classe TMailManager por parâmetro, para o método. + +@type method + +@return numeric, Retorna 0 \(zero\) quando o e-mail for enviado com sucesso. Caso contrário, retorna outro valor. + +@param , object, Indica o objeto do servidor de e-mail, criado através da classe TMailManager. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/send +/*/ +method send(oserver) class tmailmessage +return +/*/{Protheus.doc} tmailmessage:clear +Limpa o conteúdo do objeto. Desta forma, é possível receber várias mensagens no mesmo objeto, apenas limpando o seu conteúdo antes. + +@type method + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/clear +/*/ +method clear() class tmailmessage +return +/*/{Protheus.doc} tmailmessage:attachfile +Anexa um arquivo ao objeto de e-mail. + +@type method + +@return numeric, Em caso de sucesso, retorna o índice do arquivo anexado, iniciando em 0 \(zero\). Em caso de erro, retorna -1. + +@param , character, Indica o nome do arquivo, a partir do rootpath, a ser anexado no e-mail. +@param [nparam2], numeric, Parâmetro de compatiblidade. Passar Nil \(nulo\). +@param [cparam3], character, Parâmetro de compatiblidade. Passar Nil \(nulo\). +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/attachfile +/*/ +method attachfile(cfile, nparam2, cparam3) class tmailmessage +return +/*/{Protheus.doc} tmailmessage:attach +Anexa o conteúdo de um arquivo ao objeto de e-mail. + +@type method + +@return numeric, Em caso de sucesso, retorna o índice do arquivo anexado, iniciando em 0 \(zero\). Em caso de erro, retorna -1. + +@param , character, Indica o conteúdo do arquivo a ser anexado no e-mail. +@param , character, Parâmetro de compatiblidade. Passar string vazia \(""\). +@param , numeric, Parâmetro de compatiblidade. Passar 0. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/attach +/*/ +method attach(ccontent, cparam2, nparam3) class tmailmessage +return +/*/{Protheus.doc} tmailmessage:attachfullpath +Anexa um arquivo ao objeto de e-mail. + +@type method + +@return numeric, Em caso de sucesso, retorna o índice do arquivo anexado, iniciando em 0 \(zero\). Em caso de erro, retorna -1. + +@param , character, Indica o nome do arquivo, com o caminho completo, a ser anexado no e-mail. +@param [nparam2], numeric, Parâmetro de compatiblidade. Passar Nil \(nulo\). +@param [cparam3], character, Parâmetro de compatiblidade. Passar Nil \(nulo\). +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/attachfullpath +/*/ +method attachfullpath(cfile, nparam2, cparam3) class tmailmessage +return +/*/{Protheus.doc} tmailmessage:addatthtag +Permite definir um header ao último arquivo anexado na mensagem a ser enviada. + +@type method + +@return numeric, Retorna o índice do header adicionado na lista caso existe algum anexo. Caso não tenha anexos, retorna -1. + +@param , character, Indica os dados que se deseja informar para o último arquivo anexado. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/addatthtag +/*/ +method addatthtag(ctag) class tmailmessage +return +/*/{Protheus.doc} tmailmessage:tostr +Converte um objeto da classe TMailMessage para uma string. + +@type method + +@return character, String com o objeto de e-mail. + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/tostr +/*/ +method tostr() class tmailmessage +return +/*/{Protheus.doc} tmailmessage:fromstr +Carrega um e-mail a partir de uma string para um objeto da classe TMailMessage. + +@type method + +@param , character, Obejto da classe TMailMessage convertido para string. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/fromstr +/*/ +method fromstr(cstr) class tmailmessage +return +/*/{Protheus.doc} tmailmessage:addcustomheader +Adiciona um header personalizado à mensagem. + +@type method + +@param , character, Nome do header que será adicionado à mensagem. +@param , character, Valor do header que será adicionado à mensagem. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/addcustomheader +/*/ +method addcustomheader(cname, cvalue) class tmailmessage +return +/*/{Protheus.doc} tmailmessage:getcustomheader +Devolve o valor de um header da mensagem. + +@type method + +@return character, Valor do header que está na mensagem. + +@param , character, Nome do header que está na mensagem. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/getcustomheader +/*/ +method getcustomheader(cname) class tmailmessage +return +/*/{Protheus.doc} tmailmessage:getattachcount +Informa quantidade de arquivos anexados a mensagem. + +@type method + +@return numeric, Retorna o número de anexos da mensagem. + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/getattachcount +/*/ +method getattachcount() class tmailmessage +return +/*/{Protheus.doc} tmailmessage:getattachinfo +Apresenta informações de um anexo de uma mensagem. + +@type method + +@return array, Retorna Nil \(nulo\) caso não encontre o anexo. Caso encontre, retorna um vetor com informações do anexo. + +@param , numeric, Indica o número da mensagem que deseja verificar. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/getattachinfo +/*/ +method getattachinfo(nmsg) class tmailmessage +return +/*/{Protheus.doc} tmailmessage:getattach +Permite obter o conteúdo do arquivo atachado e retornar esse conteúdo através de uma string. + +@type method + +@return character, Retorna uma string \(cadeia de caracteres\) contendo o conteúdo do arquivo anexado na mensagem. + +@param , numeric, Indica o ID \(número de identificação da mensagem\) que se deseja obter informações. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/getattach +/*/ +method getattach(cnummsg) class tmailmessage +return +/*/{Protheus.doc} tmailmessage:saveattach +Salva um arquivo anexo a mensagem em disco. + +@type method + +@return logical, Retorna verdadeiro \(.T.\) caso consiga salvar o anexo com sucesso. Falso \(.F.\) caso contrário. + +@param , numeric, Índice do anexo iniciando em 1. +@param , character, Caminho com o nome do arquivo que será gravado. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/saveattach +/*/ +method saveattach(nindex, cpath) class tmailmessage +return +/*/{Protheus.doc} tmailmessage:save +Salva uma mensagem de e-mail em disco. + +@type method + +@param , character, Indica o arquivo no disco a partir do RootPath do servidor. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/save +/*/ +method save(cfilepath) class tmailmessage +return +/*/{Protheus.doc} tmailmessage:load +Carrega um e-mail salvo em disco para um objeto da classe TMailMessage. + +@type method + +@param , character, Indica o arquivo no disco a partir do RootPath do servidor. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/load +/*/ +method load(cfile) class tmailmessage +return +/*/{Protheus.doc} tmailmessage:msgbodytype +Permite definir o tipo do corpo do e-mail. + +@type method + +@param , character, Indica o valor do tipo do corpo do e-mail que será definido. Valor padrão: text/html. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/msgbodytype +/*/ +method msgbodytype(cvalue) class tmailmessage +return +/*/{Protheus.doc} tmailmessage:msgbodyencode +Define a codificação do corpo do e-mail. + +@type method + +@param , numeric, Valor da codificação do corpo do e-mail. Valores aceitos: 0 \(UUEncode\) e 1 \(MIME\). +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/msgbodyencode +/*/ +method msgbodyencode(nvalue) class tmailmessage +return +/*/{Protheus.doc} tmailmessage:setconfirmread +Define se a mensagem enviada terá confirmação de leitura. + +@type method + +@param , logical, Indica se haverá confirmação de leitura ou não. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/setconfirmread +/*/ +method setconfirmread(lread) class tmailmessage +return +/*/{Protheus.doc} tmailmessage:receive2 +Recebe uma nova mensagem do servidor populando o objeto da mensagem. + +@type method + +@return numeric, Retorna 0 \(zero\) quando o e-mail for recebido com sucesso. Caso contrário, retorna outro valor. + +@param , object, Indica o objeto do servidor de e-mail, criado através da classe TMailMng. +@param , numeric, Indica o número da mensagem que será criada, recebido através do método TMailMng:GetNumMsgs. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/receive2 +/*/ +method receive2(oserver, nmsg) class tmailmessage +return +/*/{Protheus.doc} tmailmessage:send2 +Envia um e-mail, de acordo com os dados passados pelo objeto da classe TMailMng por parâmetro, para o método. + +@type method + +@return numeric, Retorna 0 \(zero\) quando o e-mail for enviado com sucesso&$ caso contrário, retorna outro valor. + +@param , object, Indica o objeto do servidor de e-mail, criado através da classe TMailMng. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/send2 +/*/ +method send2(oserver) class tmailmessage +return + + +/*/{Protheus.doc} tmailmng +A classe TMailMng vem como substituição à classe TMailManager, realizando a comunicação com o servidor de e-mail, e possuindo maior flexibilidade de configuração e maior suporte de protocolos. + +@type binary class + + + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/tmailmng + +/*/ +class tmailmng +data lverbose as logical +data nprotocol as numeric +data nsrvssl as numeric +data nsmtpssl as numeric +data cuser as character +data cpass as character +data lsrvretryssl as logical +data csrvaddr as character +data nsrvport as numeric +data nsrvtimeout as numeric +data lsmtpretryssl as logical +data csmtpaddr as character +data nsmtpport as numeric +data nsmtptimeout as numeric +data csmtplocalhost as character +data lauthlogin as logical +data lauthntlm as logical +data lauthplain as logical +data lextendsmtp as logical +data lkeepmsg as logical +data lconnected as logical +data lsmtpconnected as logical +data ccurrentfolder as character +data luserealid as logical +data ltryencode as logical +method new() +method connect() +method disconnect() +method smtpconnect() +method smtpdisconnect() +method smtpauth() +method getnummsgs() +method deletemsg() +method geterrorstring() +method createfolder() +method changefolder() +method deletefolder() +method getfolderlist() +method getallfolderlist() +method renamefolder() +method setfoldersubscribe() +method getmsgbody() +method getmsgheader() +method startgetallmsgheader() +method endgetallmsgheader() +method copymsg() +method movemsg() +method setmsgflags() +method purge() +method imapstore() +end class +/*/{Protheus.doc} tmailmng:new +Cria uma nova instância da classe TMailMng. + +@type method + +@return object, Nova instância da classe TMailMng + +@param , numeric, Indica o protocolo que será utilizado para recepção de emails. +@param [nserverssl], numeric, Indica a versão de protocolo seguro que será utilizada para o recebimento de emails. +@param [nsmtpssl], numeric, Indica a versão de protocolo seguro que será utilizada para o envio de emails. +@param [loldtls], logical, Indica se utilizará o protocolo SSL v3 para conexão TLS para SMTP. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/new +/*/ +method new(nprotocol, nserverssl, nsmtpssl, loldtls) class tmailmng +return +/*/{Protheus.doc} tmailmng:connect +Conecta com o servidor de recebimento de emails. + +@type method + +@return numeric, Retorna 0 \(zero\) quando a operação é completada com sucesso; caso contrário, retornará um código de erro. + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/connect +/*/ +method connect() class tmailmng +return +/*/{Protheus.doc} tmailmng:disconnect +Disconecta do servidor de recebimento de emails. + +@type method + +@return numeric, Retorna 0 \(zero\) quando a operação é completada com sucesso; caso contrário, retornará um código de erro. + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/disconnect +/*/ +method disconnect() class tmailmng +return +/*/{Protheus.doc} tmailmng:smtpconnect +Conecta com o servidor SMTP, para envio de emails. + +@type method + +@return numeric, Retorna 0 \(zero\) quando a operação é completada com sucesso; caso contrário, retornará um código de erro. + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/smtpconnect +/*/ +method smtpconnect() class tmailmng +return +/*/{Protheus.doc} tmailmng:smtpdisconnect +Disconecta do servidor SMTP, de envio de emails. + +@type method + +@return numeric, Retorna 0 \(zero\) quando a operação é completada com sucesso; caso contrário, retornará um código de erro. + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/smtpdisconnect +/*/ +method smtpdisconnect() class tmailmng +return +/*/{Protheus.doc} tmailmng:smtpauth +Realiza a autenticação no servidor SMTP. + +@type method + +@return numeric, Retorna 0 \(zero\) quando a operação é completada com sucesso; caso contrário, retornará um código de erro. + +@param , character, Indica o nome de usuário que será utilizado para autenticação. +@param , character, Indica a senha do usuário para autenticação. +@param [cpopaddress], character, Indica o endereço do servidor POP3 para autenticação. +@param [cpopport], character, Indica a porta para o servidor POP3 para autenticação. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/smtpauth +/*/ +method smtpauth(cuser, cpass, cpopaddress, cpopport) class tmailmng +return +/*/{Protheus.doc} tmailmng:getnummsgs +Obtém o número de mensagens existentes no servidor de e-mail. + +@type method + +@return numeric, Retorna 0 \(zero\) quando a operação é completada com sucesso; caso contrário, retornará um código de erro. + +@param <@nnummsg>, numeric, Indica o número de mensagens que estão no servidor. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/getnummsgs +/*/ +method getnummsgs(nnummsg) class tmailmng +return +/*/{Protheus.doc} tmailmng:deletemsg +Exclui uma mensagem do servidor de e-mail. + +@type method + +@return numeric, Retorna 0 \(zero\) quando a operação é completada com sucesso; caso contrário, retornará um código de erro. + +@param , numeric, Indica o número da mensagem que será excluída. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/deletemsg +/*/ +method deletemsg(nmsg) class tmailmng +return +/*/{Protheus.doc} tmailmng:geterrorstring +Obtém a descrição do código de erro informado. + +@type method + +@return character, Retorna uma string com a descrição do código de erro informado. + +@param , numeric, Indica o código numérico do erro. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/geterrorstring +/*/ +method geterrorstring(nerror) class tmailmng +return +/*/{Protheus.doc} tmailmng:createfolder +Cria uma nova pasta de mensagens no servidor IMAP. + +@type method + +@return numeric, Retorna 0 \(zero\) quando a operação é completada com sucesso; caso contrário, retornará um código de erro. + +@param , character, Indica o nome da pasta que será criada. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/createfolder +/*/ +method createfolder(cfolder) class tmailmng +return +/*/{Protheus.doc} tmailmng:changefolder +Permite trocar de pasta, no servidor IMAP, informando uma nova pasta. + +@type method + +@return numeric, Retorna 0 \(zero\) quando a operação é completada com sucesso; caso contrário, retornará um código de erro. + +@param , character, Indica o nome da pasta desejada no servidor. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/changefolder +/*/ +method changefolder(cfolder) class tmailmng +return +/*/{Protheus.doc} tmailmng:deletefolder +Exclui uma pasta do servidor IMAP. + +@type method + +@return numeric, Retorna 0 \(zero\) quando a operação é completada com sucesso; caso contrário, retornará um código de erro. + +@param , character, Indica o nome da pasta que será excluída. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/deletefolder +/*/ +method deletefolder(cfolder) class tmailmng +return +/*/{Protheus.doc} tmailmng:getfolderlist +Obtém todas as pastas assinadas de uma conta de e-mail, através do servidor IMAP. + +@type method + +@return array, Retorna um array com todas as pastas assinadas de uma conta de e-mail, com as seguintes informações: nome, status, número de mensagens existentes, número de mensagens lidas e número de mensagens não lidas. + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/getfolderlist +/*/ +method getfolderlist() class tmailmng +return +/*/{Protheus.doc} tmailmng:getallfolderlist +Obtém todas as pastas \(Assinadas/Não assinadas\) de uma conta de email do servidor IMAP. + +@type method + +@return array, Retorna um array com todas as pastas \(Assinadas/Não assinadas\) de uma conta de e-mail, com as seguintes informações: nome, status, número de mensagens existentes, número de mensagens lidas e número de mensagens não lidas. + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/getallfolderlist +/*/ +method getallfolderlist() class tmailmng +return +/*/{Protheus.doc} tmailmng:renamefolder +Altera o nome da pasta no servidor IMAP. + +@type method + +@return numeric, Retorna 0 \(zero\) quando a operação é completada com sucesso; caso contrário, retornará um código de erro. + +@param , character, Indica o nome atual da pasta no servidor IMAP. +@param , character, Indica o novo nome da pasta. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/renamefolder +/*/ +method renamefolder(ccurfolder, cnewfolder) class tmailmng +return +/*/{Protheus.doc} tmailmng:setfoldersubscribe +Define uma determinada pasta, do servidor IMAP, assinada. Desta forma, a pasta ficará visível, na caixa de correio, e suas mensagens serão baixadas. + +@type method + +@return numeric, Retorna 0 \(zero\) quando a operação é completada com sucesso; caso contrário, retornará um código de erro. + +@param , character, Indica o nome da pasta que será ou não assinada \(subscribe\). +@param , logical, Indica se a pasta será assinada \(.T.\) ou não \(.F.\). +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/setfoldersubscribe +/*/ +method setfoldersubscribe(cfolder, lsign) class tmailmng +return +/*/{Protheus.doc} tmailmng:getmsgbody +Obtém o corpo da mensagem através do servidor IMAP. + +@type method + +@return array, Retorna um array com as informações da mensagem. + +@param , numeric, Indica o número sequencial da mensagem que deseja obter. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/getmsgbody +/*/ +method getmsgbody(nmsg) class tmailmng +return +/*/{Protheus.doc} tmailmng:getmsgheader +Obtém o cabeçalho da mensagem, retornando os campos que foram incluídos na mensagem. + +@type method + +@return array, Retorna um array com os campos do cabeçalho da mensagem. Em caso de erro, retorna nulo. + +@param , numeric, Indica o número da mensagem na pasta do servidor de e-mail IMAP. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/getmsgheader +/*/ +method getmsgheader(nmsg) class tmailmng +return +/*/{Protheus.doc} tmailmng:startgetallmsgheader +Inicia o processo para adquirir todos os cabeçalhos \(headers\) e mensagens de uma determinada pasta. + +@type method + +@return numeric, Retorna 0 \(zero\) quando a operação é completada com sucesso; caso contrário, retornará um código de erro. + +@param , character, Indica a pasta, no servidor de e-mail, em que serão adquiridos os cabeçalhos das mensagens. +@param , array, Indica as informações que serão retornadas nos cabeçalhos das mensagens. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/startgetallmsgheader +/*/ +method startgetallmsgheader(cfolder, aheader) class tmailmng +return +/*/{Protheus.doc} tmailmng:endgetallmsgheader +Obtém o cabeçalho de todas as mensagens existentes no servidor IMAP. + +@type method + +@return logical, Retorna verdadeiro \(.T.\) quando o servidor IMAP terminar o envio do cabeçalho da mensagem; caso contrário, retorna falso \(.F.\). + +@param <@aheader>, array, Indica o vetor que será utilizado como referência para retornar o cabeçalho da mensagem. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/endgetallmsgheader +/*/ +method endgetallmsgheader(aheader) class tmailmng +return +/*/{Protheus.doc} tmailmng:copymsg +Copia uma mensagem da pasta corrente, do servidor IMAP, para outra pasta ou a mesma. + +@type method + +@return numeric, Retorna 0 \(zero\) quando a operação é completada com sucesso; caso contrário, retornará um código de erro. + +@param , numeric, Indica o número sequencial da mensagem no servidor IMAP. +@param , character, Indica o nome da pasta, do servidor IMAP, para qual a mensagem será transferida. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/copymsg +/*/ +method copymsg(nmsg, cfolder) class tmailmng +return +/*/{Protheus.doc} tmailmng:movemsg +Move uma mensagem da pasta em uso, do servidor IMAP, para outra pasta contida na conta de e-mail. + +@type method + +@return numeric, Retorna 0 \(zero\) quando a operação é completada com sucesso; caso contrário, retornará um código de erro. + +@param , numeric, Indica o número sequencial da mensagem no servidor IMAP. +@param , character, Indica o nome da pasta que armazenará a mensagem. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/movemsg +/*/ +method movemsg(nmsg, cfolder) class tmailmng +return +/*/{Protheus.doc} tmailmng:setmsgflags +Define o status de uma determinada mensagem no servidor IMAP. + +@type method + +@return numeric, Retorna 0 \(zero\) quando a operação é completada com sucesso; caso contrário, retornará um código de erro. + +@param , numeric, Indica o número sequencial da mensagem no servidor IMAP. +@param , character, Indica o novo status da mensagem. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/setmsgflags +/*/ +method setmsgflags(nmsg, cflag) class tmailmng +return +/*/{Protheus.doc} tmailmng:purge +Remove permanentemente na pasta informada todas as mensagens que contenham a flag `` definidas. + +@type method + +@return numeric, Retorna 0 \(zero\) quando a operação é completada com sucesso; caso contrário, retornará um código de erro. + +@param , character, Indica o nome da pasta que será realizado o purge. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/purge +/*/ +method purge(cfolder) class tmailmng +return +/*/{Protheus.doc} tmailmng:imapstore +Armazena uma mensagem em alguma pasta do servidor IMAP. + +@type method + +@return numeric, Retorna 0 \(zero\) quando a operação é completada com sucesso; caso contrário, retornará um código de erro. + +@param , object, Indica um objeto da classe TMailMessage que contém informações da mensagem que será armazenada. +@param , character, Indica o nome da pasta que armazenará a mensagem. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/imapstore +/*/ +method imapstore(omsg, cfolder) class tmailmng +return + + +/*/{Protheus.doc} tmediaplayer +Cria um objeto para reprodução de vídeos e áudios. + +@type binary class + + + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/tmediaplayer + +/*/ +class tmediaplayer from TControl +data nvolume as numeric +data nplaycount as numeric +method new() +method play() +method stop() +method pause() +method openfile() +method setvolume() +method setshowbar() +method setmute() +end class +/*/{Protheus.doc} tmediaplayer:new +Método construtor da classe. + +@type method + +@return object, Nova instância da classe TMediaPlayer + +@param [nrow], numeric, Indica a coordenada vertical em pixels ou caracteres. +@param [ncol], numeric, Indica a coordenada horizontal em pixels ou caracteres. +@param [nwidth], numeric, Indica a largura em pixels do objeto. +@param [nheight], numeric, Indica a altura em pixels do objeto. +@param [ownd], object, Indica a janela ou controle visual onde o objeto será criado. +@param [cfile], character, Indica o nome do arquivo de mídia\(MP4 ou MP3\), que caso preenchido iniciara automaticamente a reprodução . +@param [nvolume], numeric, Indica o volume de audio, de 0 a 100. +@param [lshowbar], logical, Se .T. indica que será exibida a barra de comandos do próprio Windows Media Player®. +@param [nplaycount], numeric, Indica a quantidade de vezes que a mídia será reproduzida. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/new +/*/ +method new(nrow, ncol, nwidth, nheight, ownd, cfile, nvolume, lshowbar, nplaycount) class tmediaplayer +return +/*/{Protheus.doc} tmediaplayer:play +Inicia reprodução. + +@type method + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/play +/*/ +method play() class tmediaplayer +return +/*/{Protheus.doc} tmediaplayer:stop +Para a reprodução. + +@type method + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/stop +/*/ +method stop() class tmediaplayer +return +/*/{Protheus.doc} tmediaplayer:pause +Pausa a reprodução. + +@type method + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/pause +/*/ +method pause() class tmediaplayer +return +/*/{Protheus.doc} tmediaplayer:openfile +Abre e inicia a reprodução de um arquivo de mídia. + +@type method + +@param [cfile], character, Indica o nome do arquivo de mídia\(MP4 ou MP3\), que caso preenchido iniciara automaticamente a reprodução. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/openfile +/*/ +method openfile(cfile) class tmediaplayer +return +/*/{Protheus.doc} tmediaplayer:setvolume +Ajusta a altura do volume de áudio. + +@type method + +@param , numeric, Indica o volume de audio, de 0 a 100 +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/setvolume +/*/ +method setvolume(nvolume) class tmediaplayer +return +/*/{Protheus.doc} tmediaplayer:setshowbar +Habilita a exibição da barra de ferramentas do Windows Media Player®. + +@type method + +@param , logical, Se .T. indica que será exibida a barra de comandos do próprio Windows Media Player® +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/setshowbar +/*/ +method setshowbar(showbar) class tmediaplayer +return +/*/{Protheus.doc} tmediaplayer:setmute +Liga e desliga a opção silencio \(mute\). + +@type method + +@param , logical, Se .T. habilita a opção silencio \(mute\) +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/setmute +/*/ +method setmute(mute) class tmediaplayer +return + + +/*/{Protheus.doc} tmenu +Cria um objeto do tipo menu. + +@type binary class + + + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/tmenu + +/*/ +class tmenu from TControl +method new() +method add() +method removeitem() +method reset() +method setimagename() +end class +/*/{Protheus.doc} tmenu:new +Método construtor da classe. + +@type method + +@return object, Nova instância da classe TMenu + +@param [ntop], numeric, Indica a coordenada vertical em pixels. +@param [nleft], numeric, Indica a coordenada horizontal em pixels. +@param [nheight], numeric, Indica a altura em pixels do objeto. +@param [nwidth], numeric, Indica a largura em pixels do objeto. +@param [lpopup], logical, Indica se o objeto será Pop-up. +@param [cbmpname], character, Indica o nome da imagem que será utilizada no menu. +@param [ownd], object, Indica a janela ou controle visual onde o objeto será criado. +@param [nclrnoselect], numeric, Indica o nome da cor que será utilizada quando o item não é selecionado. +@param [nclrselect], numeric, Indica o nome da cor que será utilizada quando o item é selecionado. +@param [carrowupnosel], character, Indica a imagem seta para cima quando o item não é selecionado. +@param [carrowupsel], character, Indica a imagem seta para cima quando o item é selecionado. +@param [carrowdownnosel], character, Indica a imagem seta para baixo quando o item não é selecionado. +@param [carrowdownsel], character, Indica a imagem seta para baixo quando o item é selecionado. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/new +/*/ +method new(ntop, nleft, nheight, nwidth, lpopup, cbmpname, ownd, nclrnoselect, nclrselect, carrowupnosel, carrowupsel, carrowdownnosel, carrowdownsel) class tmenu +return +/*/{Protheus.doc} tmenu:add +Inclui item e subitem ao menu. + +@type method + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/add +/*/ +method add() class tmenu +return +/*/{Protheus.doc} tmenu:removeitem +Remove um item do menu. + +@type method + +@param , object, Indica o objeto do tipo TMenuItem que será removido. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/removeitem +/*/ +method removeitem(omenu) class tmenu +return +/*/{Protheus.doc} tmenu:reset +Exclui os itens do menu. + +@type method + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/reset +/*/ +method reset() class tmenu +return +/*/{Protheus.doc} tmenu:setimagename +Define a imagem de fundo do menu. + +@type method + +@param [cimage], character, Indica o nome da imagem de fundo do menu. Observação: Antes de definir uma imagem para o objeto, é necessário que a mesma esteja compilada no repositório. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/setimagename +/*/ +method setimagename(cimage) class tmenu +return + + +/*/{Protheus.doc} tmenubar +Cria um objeto do tipo barra de menu. + +@type binary class + + + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/tmenubar + +/*/ +class tmenubar from TControl +method new() +method additem() +method addmenuitem() +method reset() +method setdefaultup() +end class +/*/{Protheus.doc} tmenubar:new +Método construtor da classe. + +@type method + +@return object, Nova instância da classe TMenuBar + +@param [ownd], object, Indica a janela ou controle visual onde o objeto será criado. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/new +/*/ +method new(ownd) class tmenubar +return +/*/{Protheus.doc} tmenubar:additem +Inclui um novo item ao menu. + +@type method + +@param [ctitulo], character, Indica o título do item no menu superior. +@param [omenu], object, Indica o objeto do tipo TMenu que será executado na solicitação do menu superior. +@param [lmenu], logical, Lógico Indica se, verdadeiro \(.T.\), o item incluído será um item de menu; caso contrário, falso \(.F.\) +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/additem +/*/ +method additem(ctitulo, omenu, lmenu) class tmenubar +return +/*/{Protheus.doc} tmenubar:addmenuitem +Inclui um novo item ao menu da barra superior. + +@type method + +@param [ctitulo], character, Indica o título do item no menu superior. +@param [omenu], object, Indica o objeto do tipo TMenu utilizado para incluir um menu. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/addmenuitem +/*/ +method addmenuitem(ctitulo, omenu) class tmenubar +return +/*/{Protheus.doc} tmenubar:reset +Exclui todas as opções do menu. + +@type method + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/reset +/*/ +method reset() class tmenubar +return +/*/{Protheus.doc} tmenubar:setdefaultup +Direciona o menu para cima. + +@type method + +@param [isdefup], logical, Indica se habilita \(.T.\)/desabilita\(.F.\) a apresentação do menu para cima. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/setdefaultup +/*/ +method setdefaultup(isdefup) class tmenubar +return + + +/*/{Protheus.doc} tmenuitem +Cria um objeto do tipo menu/item de menu. + +@type binary class + + + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/tmenuitem + +/*/ +class tmenuitem from TControl +data aitems as array +data baction as codeblock +data lchecked as logical +data omenu as object +data lselected as logical +method new() +method new2() +method add() +method addseparator() +method setactive() +end class +/*/{Protheus.doc} tmenuitem:new +Método Inicia uma nova instância da classe TMenuItem. + +@type method + +@return object, Nova instância da classe TMenuItem + +@param , object, Indica o controle visual onde o objeto será criado. +@param [ctitle], character, Indica o texto do item. +@param [cparam3], character, Compatibilidade. +@param [lparam4], logical, Compatibilidade. +@param [lactive], logical, Indica se, verdadeiro \(.T.\), o item está ativo; caso contrário, falso \(.F.\). +@param [baction], codeblock, Indica o bloco de código que será executado quando clicar, com o botão esquerdo do mouse, sobre o objeto. +@param [cparam7], character, Compatibilidade. +@param [cresname], character, Indica a imagem, do repositório, que será apresentada quando o ponteiro do mouse não estiver posicionado sobre o item. +@param [nparam9], numeric, Compatibilidade. +@param [cparam10], character, Compatibilidade. +@param [lparam11], logical, Compatibilidade. +@param [nparam12], numeric, Compatibilidade. +@param [bparam13], codeblock, Compatibilidade. +@param [lparam14], logical, Compatibilidade. +@param [lpopup], logical, Indica se, verdadeiro \(.T.\), o item faz parte de um popup; caso contrário, falso \(.F.\). +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/new +/*/ +method new(oparent, ctitle, cparam3, lparam4, lactive, baction, cparam7, cresname, nparam9, cparam10, lparam11, nparam12, bparam13, lparam14, lpopup) class tmenuitem +return +/*/{Protheus.doc} tmenuitem:new2 +Método Inicia uma nova instância da classe TMenuItem. + +@type method + +@return object, Nova instância da classe TMenuItem + +@param [oparent], object, Indica a janela ou controle visual onde o objeto será criado. +@param [ctitle], character, Indica o texto do item. +@param [cparam3], character, Compatibilidade. +@param [lactive], logical, Indica se, verdadeiro \(.T.\), o item está ativo; caso contrário, falso \(.F.\). +@param [baction], codeblock, Indica o bloco de código que será executado quando clicar, com o botão esquerdo do mouse, sobre o objeto. +@param [cresname], character, Indica a imagem, do repositório, que será apresentada quando o ponteiro do mouse não estiver posicionado sobre o item. +@param [creshover], character, Indica a imagem, do repositório, que será apresentada quando o ponteiro do mouse estiver posicionado sobre o item. +@param [nclrnoselect], numeric, Indica a cor do item que não está selecionado. +@param [nclrselect], numeric, Indica a cor do item quando selecionado. +@param [carrowrightnosel], character, Indica a imagem do repositório, no formato de seta para a direita, que será apresentada quando o item estiver fechado e não selecionado. Observação: Essa imagem é apresentada quando o item contém subitens. +@param [carrowrightsel], character, Indica a imagem do repositório, no formato de seta para a direita, que será apresentada quando o item estiver fechado e selecionado. Observação: Essa imagem é apresentada quando o item contém subitens. +@param [carrowdownnosel], character, Indica a imagem do repositório, no formato de seta para baixo, que será apresentada quando o item estiver aberto e não selecionado. Observação: Essa imagem é apresentada quando o item contém subitens. +@param [carrowdownsel], character, Indica a imagem do repositório, no formato de seta para baixo, que será apresentada quando o item estiver aberto e selecionado. Observação: Essa imagem é apresentada quando o item contém subitens. +@param [cresselected], character, Nome do resource a ser usado como fundo quando o item for selecionado \(clicado\). Disponível apenas em build superior a 7.00.121227P. +@param [cresseldetail], character, Nome do resource a ser usado como detalhe \(canto esquerdo ou direito\) do item quando estiver selecionado \(clicado\). O resource pode conter transparência para não sobrepor totalmente o resource de fundo. Disponível apenas em build superior a 7.00.121227P. +@param [nposseldetail], numeric, Código da posição em que o resource de detalhe quando selecionado ficará, sendo 0 para esquerda e 1 para direita. Disponível apenas em build superior a 7.00.121227P. +@param [lselected], logical, Indica se este item já vira selecionado por padrão. Disponível apenas em build superior a 7.00.121227P. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/new2 +/*/ +method new2(oparent, ctitle, cparam3, lactive, baction, cresname, creshover, nclrnoselect, nclrselect, carrowrightnosel, carrowrightsel, carrowdownnosel, carrowdownsel, cresselected, cresseldetail, nposseldetail, lselected) class tmenuitem +return +/*/{Protheus.doc} tmenuitem:add +Adiciona um subitem ao menu. + +@type method + +@param [omenu], object, Indica o objeto do tipo TMenuItem utilizado para incluir um item ou subitem de menu. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/add +/*/ +method add(omenu) class tmenuitem +return +/*/{Protheus.doc} tmenuitem:addseparator +Adiciona um separador no menu. + +@type method + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/addseparator +/*/ +method addseparator() class tmenuitem +return +/*/{Protheus.doc} tmenuitem:setactive +Ativa a opção do menu com o clique do mouse. + +@type method + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/setactive +/*/ +method setactive() class tmenuitem +return + + +/*/{Protheus.doc} tmobile +TMobile é uma classe utilitária que agrupa métodos focados na plataforma móvel TOTVS \| FatClient Embarcado e promove as integrações com aplicativos ou com o hardware do dispositivo móvel. + +@type binary class + + + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/tmobile + +/*/ +class tmobile +data bscreenorientationchanged as codeblock +data bgeocoordinateupdate as codeblock +data bnotificationtapped as codeblock +data bonpause as codeblock +data bonresume as codeblock +method new() +method takepicture() +method barcode() +method getpairedbluetoothdevices() +method getscreenorientation() +method setscreenorientation() +method getgeocoordinate() +method enablegeocoordinateupdate() +method opensettings() +method testdevice() +method createnotification() +method gettemppath() +method vibrate() +method readaccelerometer() +method addcontact() +method findcontact() +method findcalendarevent() +method getcalendarevent() +method viewcalendarevent() +method addcalendarevent() +end class +/*/{Protheus.doc} tmobile:new +Método construtor da classe. + +@type method + +@return object, Nova instância da classe TMobile + +@param [ownd], object, Indica a janela ou controle visual que responderá como pai do controle. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/new +/*/ +method new(ownd) class tmobile +return +/*/{Protheus.doc} tmobile:takepicture +Inicia o aplicativo da câmera e permite que uma foto seja registrada e gravada em um arquivo. + +@type method + +@return character, Retorna uma string contendo o caminho do arquivo da foto registrada. Uma string vazia será retornada se a operação falhar ou for cancelada pela usuário. + +@param [nscaletowidth], numeric, Se for informado algum valor maior que 0 \(zero\), altera a largura da imagem final mantendo a proporção. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/takepicture +/*/ +method takepicture(nscaletowidth) class tmobile +return +/*/{Protheus.doc} tmobile:barcode +Efetua a leitura de código de barras. + +@type method + +@return array, Retorna um array de duas posições do tipo caractere onde a primeira posição contém o valor decodificado do código de barras e a segunda posição contém o nome do tipo de código de barras lido \(por exemplo: UPC_A, EAN_8, QR_CODE, etc\). Se o usuário pressionar o botão voltar do dispositivo, nenhum código será lido e as duas posições do array estarão vazias. + +@param [cbartype], character, Restringe os tipos de códigos de barras que poderão ser lidos \(consulte a área de observações abaixo para conhecer os valores possíveis para este parâmetro\). +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/barcode +/*/ +method barcode(cbartype) class tmobile +return +/*/{Protheus.doc} tmobile:getpairedbluetoothdevices +Obtém uma lista contendo nomes e endereços dos dispositivos Bluetooth pareados + +@type method + +@return array, Retorna um array de duas dimensões, isto é, cada elemento do array é um outro array de duas posições do tipo caractere contendo em sua primeira posição o nome, e em sua segunda posição o endereço no formato 00:00:00:00:00:00 que é único e exclusivo para cada dispositivo Bluetooth. As duas posições estarão vazias caso nenhum dispositivo esteja pareado ou a interface Bluetooth esteja disativada. + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/getpairedbluetoothdevices +/*/ +method getpairedbluetoothdevices() class tmobile +return +/*/{Protheus.doc} tmobile:getscreenorientation +Obtém a orientação da tela do dispositivo. + +@type method + +@return numeric, Retorna um valor numérico que representa a orientação da tela do dispositivo. Consulte a área de observações abaixo para conhecer os valores possíveis para o retorno. + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/getscreenorientation +/*/ +method getscreenorientation() class tmobile +return +/*/{Protheus.doc} tmobile:setscreenorientation +Especifica a orientação da tela de um dispositivo móvel. + +@type method + +@param [norientation], numeric, Valor correspondente a orientação desejada. Consulte a área de observações abaixo para conhecer os valores possíveis para este parâmetro. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/setscreenorientation +/*/ +method setscreenorientation(norientation) class tmobile +return +/*/{Protheus.doc} tmobile:getgeocoordinate +Obtém a mais recente coordenada de geolocalização disponibilizada pelo dispositivo móvel. + +@type method + +@return character, Retorna uma cadeia de caracteres contendo as coordenadas em latitude e longitude no formato escolhido. + +@param [nformat], numeric, Valor correspondente ao formato da coordenada desejado. Consulte a área de observações abaixo para conhecer os valores possíveis para este parâmetro. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/getgeocoordinate +/*/ +method getgeocoordinate(nformat) class tmobile +return +/*/{Protheus.doc} tmobile:enablegeocoordinateupdate +Habilita, desabilita e também parametriza o recebimento de coordenadas de geolocalização através do bloco de código bGeoCoordinateUpdate. + +@type method + +@return character, Retorna uma cadeia de caracteres contendo as coordenadas em latitude e longitude no formato escolhido. + +@param [ninterval], numeric, Indica o tempo de intervalo mínimo em milissegundos entre as notificações de atualizações de coordenadas do dispositivo móvel ao bloco de código bGeoCoordinateUpdate. O valor 0 indica que o dispositivo móvel deve notificar o bloco de código bGeoCoordinateUpdate imediatamente e sempre que houver atualizações de coordenadas de geolocalização \(isso pode elevar o uso da bateria\). O valor -1 desativa a notificação de atualizações de coordenadas por parte do dispositivo móvel. +@param [nformat], numeric, Valor correspondente ao formato desejado da coordenada. Consulte a área de observações abaixo para conhecer os valores possíveis para este parâmetro. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/enablegeocoordinateupdate +/*/ +method enablegeocoordinateupdate(ninterval, nformat) class tmobile +return +/*/{Protheus.doc} tmobile:opensettings +Abre e mostra ao usuário do dispositivo móvel o menu de configurações da funcionalidade especificada. + +@type method + +@param [nsettings], numeric, Identificação do menu de configurações. Consulte a área de observações abaixo para conhecer os valores possíveis para este parâmetro. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/opensettings +/*/ +method opensettings(nsettings) class tmobile +return +/*/{Protheus.doc} tmobile:testdevice +Realiza um teste para verificar se a funcionalidade desejada está presente e ativada no dispositivo móvel. + +@type method + +@return logical, Retorna um valor lógico que se verdadeiro \(.T.\) indica que o componente/funcionalidade está presente e habilitado no dispositivo móvel. É importante destacar que um retorno falso \(.F.\) nesta função pode significar que a funcionalidade está desativada ou que até mesmo não está presente no dispostivo móvel \(por exemplo um tablet sem suporte a NFC\). + +@param [ncomponent], numeric, Identificação do componente ou funcionalidade. Consulte a área de observações abaixo para conhecer os valores possíveis para este parâmetro. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/testdevice +/*/ +method testdevice(ncomponent) class tmobile +return +/*/{Protheus.doc} tmobile:createnotification +Dispara uma notificação no dispositivo móvel. + +@type method + +@param , numeric, Identificador único da notificação que será disparada. Com este identificador torna-se possível identificar qual notificação foi tocada na tela do dispositivo móvel \(veja a documentação do bloco de código [bNotificationTapped](bNotificationTapped) que retorna este identificador\). Use um valor maior que zero. +@param , character, Título da notificação que será disparada. +@param , character, Mensagem da notificação que será disparada. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/createnotification +/*/ +method createnotification(nnotificationid, ctitle, cmessage) class tmobile +return +/*/{Protheus.doc} tmobile:gettemppath +Retorna o caminho do diretório temporário. + +@type method + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/gettemppath +/*/ +method gettemppath() class tmobile +return +/*/{Protheus.doc} tmobile:vibrate +Faz o dispositivo vibrar. + +@type method + +@param [*nmilliseconds], numeric, Tempo de duração da vibração em milissegundos \(\*disponível apenas para Android\). +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/vibrate +/*/ +method vibrate(*nmilliseconds) class tmobile +return +/*/{Protheus.doc} tmobile:readaccelerometer +Efetua uma leitura no sensor acelerômetro do dispositivo móvel. + +@type method + +@return array, Retorna um array com três posições númericas no formato double \(decimal de ponto flutuante\) onde cada posição representa a aceleração de um eixo na ordem X, Y e Z e os valores são representados em metros por segundo ao quadrado \(m/s²\). + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/readaccelerometer +/*/ +method readaccelerometer() class tmobile +return +/*/{Protheus.doc} tmobile:addcontact +Chama a interface de adicionar um contato, com informações previamente preenchidas e fornecidas pelo ADVPL. + +@type method + +@return character, Retorna o identificador único do contato fornecido pelo SO do dispositivo. + +@param , object, Instância da classe TMobileContact com quaisquer informações previamente preenchidas do contato. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/addcontact +/*/ +method addcontact(ocontact) class tmobile +return +/*/{Protheus.doc} tmobile:findcontact +Procura nos contatos do dispositivo por um filtro específico. + +@type method + +@return array, Array contendo instâncias da classe TMobileContact para cada contato encontrado. + +@param , character, Texto a ser usado na busca. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/findcontact +/*/ +method findcontact(cfilter) class tmobile +return +/*/{Protheus.doc} tmobile:findcalendarevent +Procura eventos no calendário do dispositivo por um período. + +@type method + +@return array, Array contendo os Ids dos eventos do calendário encontrados + +@param , date, Data de início da pesquisa. +@param , date, Data final da pesquisa. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/findcalendarevent +/*/ +method findcalendarevent(dinidate, denddate) class tmobile +return +/*/{Protheus.doc} tmobile:getcalendarevent +Retorna informações de um evento do calendário específico. + +@type method + +@return array, Instância da classe TCalendarEvent contendo as informações do evento. + +@param , character, Identificador do calendário. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/getcalendarevent +/*/ +method getcalendarevent(cid) class tmobile +return +/*/{Protheus.doc} tmobile:viewcalendarevent +Utiliza o API do sistema \(Android/IOS\) para mostrar o evento. + +@type method + +@return logical, Retorna .T. se achou o evento e .F. se o evento não existe \(ou não foi possível acessar\). + +@param , character, Identificador do calendário. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/viewcalendarevent +/*/ +method viewcalendarevent(cid) class tmobile +return +/*/{Protheus.doc} tmobile:addcalendarevent +Utiliza o API do sistema \(Android/IOS\) para adicionar um evento ao calendário do dispositivo. + +@type method + +@return character, Retorna o ID do evento criado. Se o usuário cancelou a criação do evento, retorna um ID "0". + +@param , object, Instância da classe TCalendarEvent com os dados que devem ser inseridos no calendário. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/addcalendarevent +/*/ +method addcalendarevent(ocalev) class tmobile +return + + +/*/{Protheus.doc} tmobilecontact +A classe TMobileContact serve para lidar com as informações de contatos pessoas, seja para adicionar um contato ao dispositivo ou para buscar contatos no dispositivo. + +@type binary class + + + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/tmobilecontact + +/*/ +class tmobilecontact +data ccompany as character +data cjobtitle as character +data cname as character +data cnote as character +data aemails as array +data aphones as array +data apostals as array +method new() +end class +/*/{Protheus.doc} tmobilecontact:new +Método construtor da classe. + +@type method + +@return object, Nova instância da classe TMobileContact + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/new +/*/ +method new() class tmobilecontact +return + + +/*/{Protheus.doc} tmobilecontactemail +Classe para conter as informações sobre um endereço de e-mail de um contato qualquer. + +@type binary class + + + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/tmobilecontactemail + +/*/ +class tmobilecontactemail +data ntype as numeric +data caddress as character +method new() +method new2() +end class +/*/{Protheus.doc} tmobilecontactemail:new +Método construtor da classe. + +@type method + +@return object, Nova instância da classe TMobileContactEmail + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/new +/*/ +method new() class tmobilecontactemail +return +/*/{Protheus.doc} tmobilecontactemail:new2 +Método construtor da classe que já popula as informações básicas. + +@type method + +@return object, Nova instância da classe TMobileContactEmail + +@param , numeric, Tipo do e-mail. +@param , character, Endereço do e-mail. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/new2 +/*/ +method new2(ntype, caddress) class tmobilecontactemail +return + + +/*/{Protheus.doc} tmobilecontactphone +Classe para conter as informações sobre um número de telefone de um contato qualquer. + +@type binary class + + + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/tmobilecontactphone + +/*/ +class tmobilecontactphone +data ntype as numeric +data cnumber as character +method new() +method new2() +end class +/*/{Protheus.doc} tmobilecontactphone:new +Método construtor da classe. + +@type method + +@return object, Nova instância da classe TMobileContactPhone + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/new +/*/ +method new() class tmobilecontactphone +return +/*/{Protheus.doc} tmobilecontactphone:new2 +Método construtor da classe que já popula as informações básicas. + +@type method + +@return object, Nova instância da classe TMobileContactPhone + +@param , numeric, Tipo do telefone. +@param , character, Número do telefone. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/new2 +/*/ +method new2(ntype, cnumber) class tmobilecontactphone +return + + +/*/{Protheus.doc} tmobilecontactpostal +Classe para conter as informações sobre o endereço de um contato qualquer. + +@type binary class + + + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/tmobilecontactpostal + +/*/ +class tmobilecontactpostal +data ntype as numeric +data caddress as character +method new() +method new2() +end class +/*/{Protheus.doc} tmobilecontactpostal:new +Método construtor da classe. + +@type method + +@return object, Nova instância da classe TMobileContactPostal + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/new +/*/ +method new() class tmobilecontactpostal +return +/*/{Protheus.doc} tmobilecontactpostal:new2 +Método construtor da classe que já popula as informações básicas. + +@type method + +@return object, Nova instância da classe TMobileContactPostal + +@param , numeric, Tipo do endereço. +@param , character, Endereço. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/new2 +/*/ +method new2(ntype, caddress) class tmobilecontactpostal +return + + +/*/{Protheus.doc} tmsgbar +Cria um objeto do tipo barra de status. + +@type binary class + + + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/tmsgbar + +/*/ +class tmsgbar from TControl +data aitem as array +data cmsgdef as character +method new() +method setmsg() +end class +/*/{Protheus.doc} tmsgbar:new +Método construtor da classe. + +@type method + +@return object, Nova instância da classe TMsgBar + +@param [ownd], object, Indica a janela ou controle visual onde objeto será criado. +@param [cprompt], character, Indica a descrição que será apresentada na barra de status. +@param [uparam3], logical, Compatibilidade. +@param [uparam4], logical, Compatibilidade. +@param [uparam5], logical, Compatibilidade. +@param [uparam6], logical, Compatibilidade. +@param [nclrfore], numeric, Indica a cor da fonte que será utilizada na barra. +@param [uparam8], numeric, Compatibilidade. +@param [ofont], object, Indica o objeto do tipo TFont utilizado para definir as características da fonte aplicada para exibir o conteúdo do controle visual. +@param [uparam10], logical, Compatibilidade. +@param [cimagename], character, Indica a imagem que será incluída na lateral esquerda. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/new +/*/ +method new(ownd, cprompt, uparam3, uparam4, uparam5, uparam6, nclrfore, uparam8, ofont, uparam10, cimagename) class tmsgbar +return +/*/{Protheus.doc} tmsgbar:setmsg +Altera a descrição da barra de status. + +@type method + +@param [ctext], character, Indica o texto que será incluído na barra de status. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/setmsg +/*/ +method setmsg(ctext) class tmsgbar +return + + +/*/{Protheus.doc} tmsgitem +Cria um objeto do tipo subitem da barra de status. + +@type binary class + + + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/tmsgitem + +/*/ +class tmsgitem from TControl +data baction as codeblock +data nsize as numeric +data omsgbar as object +method new() +method settext() +end class +/*/{Protheus.doc} tmsgitem:new +Método construtor da classe. + +@type method + +@return object, Nova instância da classe TMsgItem + +@param [omsgbar], object, Indica o objeto do tipo TMsgBar utilizado para criar um controle visual do tipo rodapé. +@param [cmsg], character, Indica o texto do item. +@param [nsize], numeric, Indica a largura do item. +@param [ofont], object, Indica o objeto do tipo TFont utilizado para definir as características da fonte aplicada na exibição do conteúdo do controle visual. +@param [nclrtext], numeric, Indica a cor do texto do item. +@param [uparam6], numeric, Compatibilidade. +@param [ladd], logical, Indica se, verdadeiro \(.T.\), o item é incluído; caso contrário, falso \(.F.\). +@param [baction], codeblock, Indica o bloco de código que será executado quando clicar, com o botão esquerdo do mouse, sobre o botão. +@param [cresource], character, Indica o nome do recurso que contém a imagem. Este recurso deve estar compilado,no repositório de imagens, para ser utilizado. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/new +/*/ +method new(omsgbar, cmsg, nsize, ofont, nclrtext, uparam6, ladd, baction, cresource) class tmsgitem +return +/*/{Protheus.doc} tmsgitem:settext +Define o texto do item. + +@type method + +@param , character, Indica o texto para o item. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/settext +/*/ +method settext(ctexto) class tmsgitem +return + + +/*/{Protheus.doc} tmsprinterspool +Componente que mostra um preview de um relatório normalmente para impressão. + +@type binary class + + + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/tmsprinterspool + +/*/ +class tmsprinterspool from TControl +data lportrait as logical +data lcasesensitive as logical +data ctexthighlight as character +data nzoom as numeric +data bscrollclick as codeblock +method new() +method settextpage() +method setpageinfo() +end class +/*/{Protheus.doc} tmsprinterspool:new +Método construtor da classe. + +@type method + +@return object, Nova instância da classe TMSPrinterSpool + +@param [nrow], numeric, Linha em que o componente visual deverá ser desenhado. +@param [ncol], numeric, Coluna em que o componente visual deverá ser desenhado. +@param [nwidth], numeric, Largura do componente visual. +@param [nheight], numeric, Altura do componente visual. +@param , object, Componente visual pai. +@param , character, Texto a ser apresentado no preview. +@param [lportrait], logical, Define se a orientação do documento será retrato \(.T.\) ou paisagem \(.F.\). +@param , character, Tamanho do documento \("P" para pequeno, "M" para médio, "G" para grande\). +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/new +/*/ +method new(nrow, ncol, nwidth, nheight, ownd, ctextpage, lportrait, crelsize) class tmsprinterspool +return +/*/{Protheus.doc} tmsprinterspool:settextpage +Define o texto do relatório. + +@type method + +@param , character, Texto do relatório. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/settextpage +/*/ +method settextpage(ctextpage) class tmsprinterspool +return +/*/{Protheus.doc} tmsprinterspool:setpageinfo +Define o tamanho do relatório e a orientação das páginas. + +@type method + +@param , character, Tamanho do relatório sendo "P" pequeno, "M" médio e "G" grande. +@param [lsetportrait], logical, Orientação das páginas sendo .T. retrato e .F. paisagem. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/setpageinfo +/*/ +method setpageinfo(crelsize, lsetportrait) class tmsprinterspool +return + + +/*/{Protheus.doc} tmultibtn +Cria um objeto do tipo múltiplos botões. + +@type binary class + + + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/tmultibtn + +/*/ +class tmultibtn from TControl +data baction as codeblock +method new() +method addbutton() +method setfonts() +end class +/*/{Protheus.doc} tmultibtn:new +Método construtor da classe. + +@type method + +@return object, Nova instância da classe TMultiBtn + +@param [nrow], numeric, Indica a coordenada vertical em pixels ou caracteres. +@param [ncol], numeric, Indica a coordenada horizontal em pixels ou caracteres. +@param [ownd], object, Indica a janela ou controle visual onde o botão será criado. +@param [baction], codeblock, Indica o bloco de código que será executado quando clicar, com o botão esquerdo do mouse, sobre o botão. +@param [nwidth], numeric, Indica a largura em pixels do objeto. +@param [nheight], numeric, Indica a altura em pixels do objeto. +@param [cimgname], character, Indica o nome da imagem que será inserida ao lado esquerdo do componente. +@param [nori], numeric, Indica a coordenada \(vertical/horizontal\) do botão na janela. +@param [cmsg], character, Indica a mensagem, do tipo dica de contexto \(tooltip/hint\), ao posicionar o ponteiro do mouse sobre o botão. +@param [nbtnperline], numeric, Indica a quantidade de botões por linha. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/new +/*/ +method new(nrow, ncol, ownd, baction, nwidth, nheight, cimgname, nori, cmsg, nbtnperline) class tmultibtn +return +/*/{Protheus.doc} tmultibtn:addbutton +Adiciona um botão. + +@type method + +@param [onovobotao], object, Indica o botão que será criado. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/addbutton +/*/ +method addbutton(onovobotao) class tmultibtn +return +/*/{Protheus.doc} tmultibtn:setfonts +Adiciona um botão. + +@type method + +@param [cfontetitulo], character, Indica o nome da fonte que será utilizada no título. +@param [nsizetitulo], numeric, Indica o tamanho da fonte no título. +@param [cfontebotoes], character, Indica o nome da fonte que será utilizada nos botões. +@param [nsizebotoes], numeric, Indica o tamanho da fonte no botão. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/setfonts +/*/ +method setfonts(cfontetitulo, nsizetitulo, cfontebotoes, nsizebotoes) class tmultibtn +return + + +/*/{Protheus.doc} tmultiget +Cria um objeto do tipo campo memo. + +@type binary class + + + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/tmultiget + +/*/ +class tmultiget from TControl +data npos as numeric +data lobfuscate as logical +method new() +method create() +method enablevscroll() +method appendtext() +method goend() +method gotop() +method goto() +end class +/*/{Protheus.doc} tmultiget:new +Método construtor da classe. + +@type method + +@return object, Nova instância da classe TMultiGet + +@param [nrow], numeric, Indica a coordenada vertical em pixels ou caracteres. +@param [ncol], numeric, Indica a coordenada horizontal em pixels ou caracteres. +@param [bsetget], codeblock, Indica o bloco de código, no formato \{\|u\| if\( Pcount\( \)>0, := u, \) \}, que será executado para atualizar a variável \(essa variável deve ser do tipo caracter\). Desta forma, se a lista for sequencial, o controle atualizará com o conteúdo do item selecionado, se for indexada, será atualizada com o valor do índice do item selecionado. +@param [ownd], object, Indica a janela ou controle visual onde o objeto será criado. +@param [nwidth], numeric, Indica a largura em pixels do objeto. +@param [nheight], numeric, Indica a altura em pixels do objeto. +@param [ofont], object, Indica o objeto do tipo TFont utilizado para definir as características da fonte aplicada na exibição do conteúdo do controle visual. +@param [uparam8], logical, Compatibility parameter. Pass NIL. +@param [uparam9], numeric, Compatibility parameter. Pass NIL. +@param [uparam10], numeric, Compatibility parameter. Pass NIL. +@param [uparam11], object, Compatibility parameter. Pass NIL. +@param [lpixel], logical, Indica se considera as coordenadas passadas em pixels \(.T.\) ou caracteres \(.F.\). +@param [uparam13], character, Compatibility parameter. Pass NIL. +@param [uparam14], logical, Compatibility parameter. Pass NIL. +@param [bwhen], codeblock, Indica o bloco de código que será executado quando a mudança de foco da entrada de dados, na janela em que o controle foi criado, estiver sendo efetuada. Observação: O bloco de código retornará verdadeiro \(.T.\) se o controle permanecer habilitado; caso contrário, retornará falso \(.F.\). +@param [uparam16], logical, Compatibility parameter. Pass NIL. +@param [uparam17], logical, Compatibility parameter. Pass NIL. +@param [lreadonly], logical, Indica se o conteúdo da variável associada ao objeto permanecerá apenas para leitura +@param [bvalid], codeblock, Indica o bloco de código de validação que será executado quando o conteúdo do objeto for modificado. Retorna verdadeiro \(.T.\), se o conteúdo é válido; caso contrário, falso \(.F.\). +@param [uparam20], codeblock, Compatibility parameter. Pass NIL. +@param [uparam21], logical, Compatibility parameter. Pass NIL. +@param [lnoborder], logical, Indica se habilita\(.T.\)/desabilita\(.F.\) a apresentação da borda no objeto. +@param [lvscroll], logical, Indica se habilita\(.T.\)/desabilita\(.F.\) a barra de rolagem vertical. Obs.: O valor default é Desabilitado. +@param [clabeltext], character, Indica o texto que será apresentado na Label. +@param [nlabelpos], numeric, Indica a posição da label, sendo 1=Topo e 2=Esquerda +@param [olabelfont], object, Indica o objeto, do tipo TFont, que será utilizado para definir as características da fonte aplicada na exibição da label. +@param [nlabelcolor], numeric, Indica a cor do texto da Label. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/new +/*/ +method new(nrow, ncol, bsetget, ownd, nwidth, nheight, ofont, uparam8, uparam9, uparam10, uparam11, lpixel, uparam13, uparam14, bwhen, uparam16, uparam17, lreadonly, bvalid, uparam20, uparam21, lnoborder, lvscroll, clabeltext, nlabelpos, olabelfont, nlabelcolor) class tmultiget +return +/*/{Protheus.doc} tmultiget:create +Método construtor da classe. + +@type method + +@return object, Nova instância da classe TMultiGet + +@param [ownd], object, Indica a janela ou controle visual onde o objeto será criado. +@param [bsetget], codeblock, Indica o bloco de código, no formato \{\|u\| if\( Pcount\( \)>0, := u, \) \}, que será executado para atualizar a variável \(essa variável deve ser do tipo caracter\). Desta forma, se a lista for sequencial, o controle atualizará com o conteúdo do item selecionado, se for indexada, será atualizada com o valor do índice do item selecionado. +@param [nrow], numeric, Indica a coordenada vertical em pixels ou caracteres. +@param [ncol], numeric, Indica a coordenada horizontal em pixels ou caracteres. +@param [nwidth], numeric, Indica a largura em pixels do objeto. +@param [nheight], numeric, Indica a altura em pixels do objeto. +@param [ofont], object, Indica o objeto do tipo TFont utilizado para definir as características da fonte aplicada na exibição do conteúdo do controle visual. +@param [uparam8], logical, Compatibility parameter. Pass NIL. +@param [uparam9], numeric, Compatibility parameter. Pass NIL. +@param [uparam10], numeric, Compatibility parameter. Pass NIL. +@param [uparam11], character, Compatibility parameter. Pass NIL. +@param [lpixel], logical, Indica se considera as coordenadas passadas em pixels \(.T.\) ou caracteres \(.F.\). +@param [uparam13], character, Compatibility parameter. Pass NIL. +@param [uparam14], logical, Compatibility parameter. Pass NIL. +@param [bwhen], codeblock, Indica o bloco de código que será executado quando a mudança de foco da entrada de dados, na janela em que o controle foi criado, estiver sendo efetuada. Observação: O bloco de código retornará verdadeiro \(.T.\) se o controle permanecer habilitado; caso contrário, retornará falso \(.F.\). +@param [uparam16], logical, Compatibility parameter. Pass NIL. +@param [uparam17], logical, Compatibility parameter. Pass NIL. +@param [lreadonly], logical, Indica se o conteúdo da variável associada ao objeto permanecerá apenas para leitura. +@param [bvalid], codeblock, Indica o bloco de código de validação que será executado quando o conteúdo do objeto for modificado. Retorna verdadeiro \(.T.\), se o conteúdo é válido; caso contrário, falso \(.F.\). +@param [uparam20], codeblock, Compatibility parameter. Pass NIL. +@param [uparam21], logical, Compatibility parameter. Pass NIL. +@param [lnoborder], logical, Indica se habilita\(.T.\)/desabilita\(.F.\) a apresentação da borda no objeto. +@param [lvscroll], logical, Indica se habilita\(.T.\)/desabilita\(.F.\) a barra de rolagem vertical. O valor default é Desabilitado. +@param [clabeltext], character, indica o texto que será apresentado na Label. +@param [nlabelpos], numeric, Indica a posição da label, sendo 1=Topo e 2=Esquerda +@param [olabelfont], object, Indica o objeto, do tipo TFont, que será utilizado para definir as características da fonte aplicada na exibição da label. +@param [nlabelcolor], numeric, Indica a cor do texto da Label. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/create +/*/ +method create(ownd, bsetget, nrow, ncol, nwidth, nheight, ofont, uparam8, uparam9, uparam10, uparam11, lpixel, uparam13, uparam14, bwhen, uparam16, uparam17, lreadonly, bvalid, uparam20, uparam21, lnoborder, lvscroll, clabeltext, nlabelpos, olabelfont, nlabelcolor) class tmultiget +return +/*/{Protheus.doc} tmultiget:enablevscroll +Habilita/desabilita a barra de rolagem vertical. + +@type method + +@param [lenable], logical, Indica se habilita\(.T.\)/desabilita\(.F.\) a barra de rolagem vertical. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/enablevscroll +/*/ +method enablevscroll(lenable) class tmultiget +return +/*/{Protheus.doc} tmultiget:appendtext +Adiciona um texto no fim do texto já existente. + +@type method + +@param [ctext], character, Indica o texto que será incluído +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/appendtext +/*/ +method appendtext(ctext) class tmultiget +return +/*/{Protheus.doc} tmultiget:goend +Posiciona o cursor no fim do texto. + +@type method + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/goend +/*/ +method goend() class tmultiget +return +/*/{Protheus.doc} tmultiget:gotop +Posiciona o cursor no início do texto. + +@type method + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/gotop +/*/ +method gotop() class tmultiget +return +/*/{Protheus.doc} tmultiget:goto +Posiciona o cursor no início da linha especificada. + +@type method + +@param , numeric, Indica a linha em que o cursor será posicionado. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/goto +/*/ +method goto(nline) class tmultiget +return + + +/*/{Protheus.doc} tolecontainer +Cria um objeto do tipo botão vinculado a um objeto OLE \(Object Linking and Embedding\). + +@type binary class + + + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/tolecontainer + +/*/ +class tolecontainer from TControl +method new() +method openfromfile() +method doverbdefault() +end class +/*/{Protheus.doc} tolecontainer:new +Método construtor da classe. + +@type method + +@return object, Nova instância da classe TOleContainer + +@param [nrow], numeric, Indica a coordenada vertical em pixels ou caracteres. +@param [ncol], numeric, Indica a coordenada horizontal em pixels ou caracteres. +@param [nwidth], numeric, Indica a largura em pixels do objeto. +@param [nheight], numeric, Indica a altura em pixels do objeto. +@param [ownd], object, Indica a janela ou controle visual onde o objeto será criado. +@param [lautoactivate], logical, Compatibilidade. +@param [cfilename], character, Indica o diretório e arquivo OLE que será aberto. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/new +/*/ +method new(nrow, ncol, nwidth, nheight, ownd, lautoactivate, cfilename) class tolecontainer +return +/*/{Protheus.doc} tolecontainer:openfromfile +Abre arquivo do tipo OLE \(Object Linking and Embedding\). + +@type method + +@return logical, Retorna verdadeiro \(.T.\) se o processo ocorrer com sucesso; caso contrário, retornará falso \(.F.\). + +@param [cfilename], character, Indica o caminho para o arquivo OLE que será aberto. +@param [lasicon], logical, Indica se o objeto OLE será ícone. +@param [lallowinplace], logical, Indica se a abertura do arquivo será local ou não \(dependendo do arquivo OLE poderá exibir as barras de ferramentas do aplicativo editor\). +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/openfromfile +/*/ +method openfromfile(cfilename, lasicon, lallowinplace) class tolecontainer +return +/*/{Protheus.doc} tolecontainer:doverbdefault +Chama o método padrão do objeto OLE \(Object Linking and Embedding\) utilizado. + +@type method + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/doverbdefault +/*/ +method doverbdefault() class tolecontainer +return + + +/*/{Protheus.doc} tpaintpanel +Cria um objeto do tipo painel que permite adicionar subpainéis e shapes. + +@type binary class + + + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/tpaintpanel + +/*/ +class tpaintpanel from TControl +data blclicked as codeblock +data bldblclick as codeblock +data brclicked as codeblock +data frameatu as numeric +data shapeatu as numeric +data leftold as numeric +data leftatu as numeric +data topold as numeric +data topatu as numeric +method new() +method addshape() +method clearall() +method addcommand() +method insertblinker() +method deleteblinker() +method setblinker() +method deleteitem() +method setcandeform() +method setcanmove() +method setgradient() +method setimagesize() +method setposition() +method setreleasebutton() +method setscale() +method settooltip() +method settransparent() +method savetopng() +method setvisible() +method setpopup() +end class +/*/{Protheus.doc} tpaintpanel:new +Método construtor da classe. + +@type method + +@return object, Nova instância da classe TPaintPanel + +@param [nrow], numeric, Indica a coordenada vertical em pixels. +@param [ncol], numeric, Indica a coordenada horizontal em pixels. +@param [nwidth], numeric, Indica a largura em pixels do objeto. +@param [nheight], numeric, Indica a altura em pixels do objeto. +@param [lcentered], logical, Indica se, verdadeiro \(.T.\), apresenta o texto de título no centro do objeto; caso contrário, falso \(.F.\). +@param [lright], logical, Indica se, verdadeiro \(.T.\), posiciona o objeto à direita. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/new +/*/ +method new(nrow, ncol, nwidth, nheight, lcentered, lright) class tpaintpanel +return +/*/{Protheus.doc} tpaintpanel:addshape +Adiciona um container ou um shape ao painel. + +@type method + +@param , character, Indica o texto que contém o construtor. Para mais informações, consulte a área Observações.. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/addshape +/*/ +method addshape(ctextparser) class tpaintpanel +return +/*/{Protheus.doc} tpaintpanel:clearall +Limpa todos os shapes do painel. + +@type method + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/clearall +/*/ +method clearall() class tpaintpanel +return +/*/{Protheus.doc} tpaintpanel:addcommand +Executa um comando referente ao comportamento do TPaintPanel. + +@type method + +@param , numeric, Indica o comando que deverá ser executado. Para mais informações, consulte a área Observações. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/addcommand +/*/ +method addcommand(ccommand) class tpaintpanel +return +/*/{Protheus.doc} tpaintpanel:insertblinker +Inclui um shape na lista que define os objetos que devem piscar quando o método SetBlinker\(\) for configurado. + +@type method + +@param , numeric, Indica o ID \(número de identificação\) do shape que será excluído. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/insertblinker +/*/ +method insertblinker(nid) class tpaintpanel +return +/*/{Protheus.doc} tpaintpanel:deleteblinker +Exclui um shape da lista que define os objetos que devem piscar quando o método SetBlinker\(\) for configurado. + +@type method + +@param , numeric, Indica o ID \(número de identificação\) do shape. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/deleteblinker +/*/ +method deleteblinker(nid) class tpaintpanel +return +/*/{Protheus.doc} tpaintpanel:setblinker +Define o tempo, em milisegundos, que os shapes da lista deverão piscar. + +@type method + +@param , numeric, Indica o tempo, em milisegundos, que o shape deverá piscar. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/setblinker +/*/ +method setblinker(ntimer) class tpaintpanel +return +/*/{Protheus.doc} tpaintpanel:deleteitem +Exclui um shape da lista. + +@type method + +@param , numeric, Indica o ID \(número de identificação\) do shape que será excluído. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/deleteitem +/*/ +method deleteitem(nid) class tpaintpanel +return +/*/{Protheus.doc} tpaintpanel:setcandeform +Define se o shape pode ou não ser movido dentro do seu próprio container. + +@type method + +@param , numeric, Indica o ID \(número de identificação\) do shape que será movido. +@param , logical, Indica se, verdadeiro \(.T.\), o shape pode ser movido dentro do seu próprio container; caso contrário, falso \(.F.\). +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/setcandeform +/*/ +method setcandeform(cid, lcandeform) class tpaintpanel +return +/*/{Protheus.doc} tpaintpanel:setcanmove +Define se o shape pode ou não ser movido. + +@type method + +@param , numeric, Indica o ID \(número de identificação\) do shape que será movido. +@param , logical, Indica se, verdadeiro \(.T.\), o shape pode ser movido; caso contrário, falso \(.F.\). +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/setcanmove +/*/ +method setcanmove(cid, lcandeform) class tpaintpanel +return +/*/{Protheus.doc} tpaintpanel:setgradient +Define o gradient do shape. + +@type method + +@param , numeric, Indica o ID \(número de identificação\) do shape. +@param , logical, Indica se, verdadeiro \(.T.\), o gradient será aplicado quando o shape estiver com o ponteiro do mouse posicionado; caso contrário, falso \(.F.\). +@param , character, Indica o texto do gradient. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/setgradient +/*/ +method setgradient(nid, lhover, cgradient) class tpaintpanel +return +/*/{Protheus.doc} tpaintpanel:setimagesize +Altera as dimensões de uma shape do tipo 8 \(imagem\). + +@type method + +@param , character, Indica o ID \(número de identificação\) do shape que será movido. +@param , numeric, Largura para redimensionamento do shape. +@param , numeric, Altura para redimensionamento do shape. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/setimagesize +/*/ +method setimagesize(cid, nwidth, nheight) class tpaintpanel +return +/*/{Protheus.doc} tpaintpanel:setposition +Define a posição do container ou do shape. + +@type method + +@param , numeric, Indica o ID do objeto que será movido. +@param , numeric, Indica a nova posição à esquerda do objeto. +@param , numeric, Indica a altura em pixels do objeto. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/setposition +/*/ +method setposition(nid, nleft, ntop) class tpaintpanel +return +/*/{Protheus.doc} tpaintpanel:setreleasebutton +SetReleaseButtonDefine se o bloco de código blClicked do Shape, será disparado no release do botão do mouse, mesmo estando este dentro no mesmo Container de origem do click do mouse. + +@type method + +@param , logical, Se Verdadeiro, define que o bloco de código blClicked do Shape, será disparado no release do botão do mouse, mesmo estando este dentro no mesmo Container de origem do click do mouse. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/setreleasebutton +/*/ +method setreleasebutton(isreleasebutton) class tpaintpanel +return +/*/{Protheus.doc} tpaintpanel:setscale +Define a escala\(zoom\) de para visualização do painel principal. + +@type method + +@param , numeric, Escala para visualização sendo que 1 define visualização de 100%.É possível utilizar valores fracionados, como 0.4 ou 3.7, por exemplo. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/setscale +/*/ +method setscale(nscale) class tpaintpanel +return +/*/{Protheus.doc} tpaintpanel:settooltip +Define a dica de contexto \(tooltip/hint\) do shape. + +@type method + +@param , numeric, Indica o ID \(número de identificação\) do shape. +@param , character, Indica a nova mensagem, do tipo dica de contexto \(tooltip/hint\), do shape +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/settooltip +/*/ +method settooltip(nid, ctext) class tpaintpanel +return +/*/{Protheus.doc} tpaintpanel:settransparent +Define, para o método SaveToPNG, se o fundo da imagem será salvo transparente. + +@type method + +@param , logical, Se verdadeiro, define que o fundo da imagem será salvo transparente, através do método SaveToPNG. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/settransparent +/*/ +method settransparent(istransparent) class tpaintpanel +return +/*/{Protheus.doc} tpaintpanel:savetopng +Salva o conteúdo do painel como imagem no formato PNG \(Portable Network Graphics\). + +@type method + +@param , numeric, Indica a posição à esquerda onde a imagem será salva. +@param , numeric, Indica a posição ao topo onde a imagem será salva. +@param , numeric, Indica a comprimento, a partir da esquerda, que a imagem será salva. +@param , numeric, Indica a altura, a partir do topo, que a imagem será salva. +@param , character, Indica o nome do arquivo que será salvo. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/savetopng +/*/ +method savetopng(nleft, ntop, nwidth, nheight, cfiletarget) class tpaintpanel +return +/*/{Protheus.doc} tpaintpanel:setvisible +Define se o objeto \(container ou shape\) será visível. + +@type method + +@param [nid], numeric, Indica o ID do objeto que será visível/invisível. +@param [lisvisible], logical, Indica se o objeto é visível \(.T.\) ou invisível \(.F.\). +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/setvisible +/*/ +method setvisible(nid, lisvisible) class tpaintpanel +return +/*/{Protheus.doc} tpaintpanel:setpopup +Define um menu do tipo popup. + +@type method + +@param , object, Objeto do tipo TMenu. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/setpopup +/*/ +method setpopup(omenu) class tpaintpanel +return + + +/*/{Protheus.doc} tpanel +Cria um objeto do tipo painel estático. Além disso, permite criar outros controles visuais com objetivo de organizar ou agrupar outros componentes visuais. + +@type binary class + + + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/tpanel + +/*/ +class tpanel from TControl +method create() +method new() +end class +/*/{Protheus.doc} tpanel:create +Método construtor da classe. + +@type method + +@return object, Nova instância da classe TPanel + +@param [ownd], object, Indica a janela ou controle visual onde o objeto será criado. +@param [nrow], numeric, Indica a coordenada vertical em pixels ou caracteres. +@param [ncol], numeric, Indica a coordenada horizontal em pixels ou caracteres. +@param [ctext], character, Indica o texto que será apresentado ao fundo do objeto. +@param [ofont], object, Indica o objeto do tipo TFont utilizado para definir as características da fonte aplicada na exibição do conteúdo do controle visual. +@param [lcentered], logical, Indica se, verdadeiro \(.T.\), apresenta o texto do título no centro do objeto; caso contrário, falso \(.F.\). +@param [uparam7], logical, Compatibilidade. +@param [nclrtext], numeric, Indica a cor do texto do objeto. +@param [nclrback], numeric, Indica a cor de fundo do objeto. +@param [nwidth], numeric, Indica a largura em pontos do objeto. +@param [nheight], numeric, Indica a altura em pontos do objeto. +@param [llowered], logical, Indica se, verdadeiro \(.T.\), apresenta o painel rebaixado em relação ao objeto de fundo; caso contrário, falso \(.F.\). +@param [lraised], logical, Indica se, verdadeiro \(.T.\), apresenta a borda do objeto rebaixada em relação ao objeto de fundo; caso contrário, falso \(.F.\). +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/create +/*/ +method create(ownd, nrow, ncol, ctext, ofont, lcentered, uparam7, nclrtext, nclrback, nwidth, nheight, llowered, lraised) class tpanel +return +/*/{Protheus.doc} tpanel:new +Método construtor da classe. + +@type method + +@return object, Nova instância da classe TPanel + +@param [nrow], numeric, Indica a coordenada vertical em pixels ou caracteres. +@param [ncol], numeric, Indica a coordenada horizontal em pixels ou caracteres. +@param [ctext], character, Indica o texto que será apresentado ao fundo do objeto. +@param [ownd], object, Indica a janela ou controle visual onde o objeto será criado. +@param [ofont], object, Indica o objeto do tipo TFont utilizado para definir as características da fonte aplicada na exibição do conteúdo do controle visual. +@param [lcentered], logical, Indica se, verdadeiro \(.T.\), apresenta o texto do título no centro do objeto; caso contrário, falso \(.F.\). +@param [uparam7], logical, Compatibilidade. +@param [nclrtext], numeric, Indica a cor do texto do objeto. +@param [nclrback], numeric, Indica a cor de fundo do objeto. +@param [nwidth], numeric, Indica a largura em pontos do objeto. +@param [nheight], numeric, Indica a altura em pontos do objeto. +@param [llowered], logical, Indica se, verdadeiro \(.T.\), apresenta o painel rebaixado em relação ao objeto de fundo; caso contrário, falso \(.F.\). +@param [lraised], logical, Indica se, verdadeiro \(.T.\), apresenta a borda do objeto rebaixada em relação ao objeto de fundo; caso contrário, falso \(.F.\). +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/new +/*/ +method new(nrow, ncol, ctext, ownd, ofont, lcentered, uparam7, nclrtext, nclrback, nwidth, nheight, llowered, lraised) class tpanel +return + + +/*/{Protheus.doc} tpanelcss +Cria um objeto do tipo painel que permite receber CSS \(Cascading Style Sheet\). + +@type binary class + + + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/tpanelcss + +/*/ +class tpanelcss from TControl +method new() +end class +/*/{Protheus.doc} tpanelcss:new +Método construtor da classe. + +@type method + +@return object, Nova instância da classe TPanelCss + +@param [nrow], numeric, Indica a coordenada vertical em pixels ou caracteres. +@param [ncol], numeric, Indica a coordenada horizontal em pixels ou caracteres. +@param [uparam3], character, Compatibility parameter. Pass NIL. +@param [ownd], object, Indica a janela ou controle visual onde o objeto será criado. +@param [uparam5], object, Compatibility parameter. Pass NIL. +@param [uparam6], logical, Compatibility parameter. Pass NIL. +@param [uparam7], logical, Compatibility parameter. Pass NIL. +@param [uparam8], numeric, Compatibility parameter. Pass NIL. +@param [uparam9], numeric, Compatibility parameter. Pass NIL. +@param [nwidth], numeric, Indica a largura em pixels do objeto. +@param [nheight], numeric, Indica a altura em pixels do objeto. +@param [uparam12], numeric, Compatibility parameter. Pass NIL. +@param [uparam13], numeric, Compatibility parameter. Pass NIL. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/new +/*/ +method new(nrow, ncol, uparam3, ownd, uparam5, uparam6, uparam7, uparam8, uparam9, nwidth, nheight, uparam12, uparam13) class tpanelcss +return + + +/*/{Protheus.doc} tradmenu +Cria um objeto do tipo Radio Button \(elemento de seleção de única escolha\). + +@type binary class + + + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/tradmenu + +/*/ +class tradmenu from TControl +data aitems as array +data bchange as codeblock +data bsetget as codeblock +data bvalid as codeblock +data bwhen as codeblock +data lhoriz as logical +method new() +method create() +method disable() +method enable() +method enableitem() +method setoptions() +end class +/*/{Protheus.doc} tradmenu:new +Método construtor da classe. + +@type method + +@return object, Nova instância da classe TRadMenu + +@param [nrow], numeric, Indica a coordenada vertical. +@param [ncol], numeric, Indica a coordenada horizontal. +@param [aitems], array, Indica o array que contêm os itens no formato texto. +@param [bsetget], codeblock, Indica o bloco de código que será executado na mudança do item selecionado. O bloco de código é responsável pela mudança do valor, da variável numérica, que indica o item selecionado. +@param [ownd], object, Indica a janela ou controle visual onde o objeto será criado. +@param [uparam6], variant, Compatibilidade. +@param [bchange], codeblock, Indica o bloco de código que será executado quando o estado ou conteúdo do objeto é modificado pela ação sobre o controle visual. +@param [nclrtext], numeric, Indica a cor do texto da janela. +@param [nclrpane], numeric, Indica a cor de fundo da janela. +@param [cmsg], character, Indica a mensagem, do tipo dica de contexto \(tooltip/hint\), que será apresentada ao posicionar o ponteiro do mouse sobre o objeto. +@param [uparam11], logical, Compatibilidade. +@param [bwhen], codeblock, Indica o bloco de código que será executado quando a mudança de foco da entrada de dados, na janela em que o controle foi criado, estiver sendo efetuada. Observação: O bloco de código retornará verdadeiro \(.T.\), se o controle permanecer habilitado; caso contrário, retornará falso \(.F.\). +@param [nwidth], numeric, Indica a largura em pixels do objeto. +@param [nheight], numeric, Indica a altura em pixels do objeto. +@param [bvalid], codeblock, Compatibilidade. +@param [uparam16], logical, Compatibilidade. +@param [uparam17], logical, Compatibilidade. +@param [lpixel], logical, Indica se considera as coordenadas passadas em pixels \(.T.\) ou caracteres \(.F.\). +@param [lhoriz], logical, Indica se o menu deverá ser montado na horizontal \(.T.\) ao invés do padrão na vertical \(.F.\). \(disponível em builds superiores a 7.00.121227P\) +@param [lautoheight], logical, Se verdadeiro \(.T.\) indica que a altura do objeto será aplicada automaticamente \(valor padrão\). Caso contrário \(.F.\) a altura respeitará o valor indicado no parâmetro nHeight do construtor. Disponível somente a partir da build 7.00.170117A - 17.2.1.2. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/new +/*/ +method new(nrow, ncol, aitems, bsetget, ownd, uparam6, bchange, nclrtext, nclrpane, cmsg, uparam11, bwhen, nwidth, nheight, bvalid, uparam16, uparam17, lpixel, lhoriz, lautoheight) class tradmenu +return +/*/{Protheus.doc} tradmenu:create +Método construtor da classe. + +@type method + +@return object, Nova instância da classe TRadMenu + +@param [ownd], object, Indica a janela ou controle visual onde o objeto será criado. +@param [bsetget], codeblock, Indica o bloco de código que será executado na mudança do item selecionado. O bloco de código é responsável pela mudança do valor, da variável numérica, que indica o item selecionado. +@param [nrow], numeric, Indica a coordenada vertical. +@param [ncol], numeric, Indica a coordenada horizontal. +@param [aitems], array, Indica o array que contêm os itens no formato texto. +@param [uparam6], variant, Compatibilidade. +@param [bchange], codeblock, Indica o bloco de código que será executado quando o estado ou conteúdo do objeto é modificado pela ação sobre o controle visual. +@param [nclrtext], numeric, Indica a cor do texto da janela. +@param [nclrpane], numeric, Indica a cor de fundo da janela. +@param [cmsg], character, Indica a mensagem, do tipo dica de contexto \(tooltip/hint\), ao posicionar o ponteiro do mouse sobre o botão. +@param [uparam11], logical, Compatibilidade. +@param [bwhen], codeblock, Indica o bloco de código que será executado quando a mudança de foco da entrada de dados, na janela em que o controle foi criado, estiver sendo efetuada. Observação: O bloco de código retornará verdadeiro \(.T.\), se o controle permanecer habilitado; caso contrário, retornará falso \(.F.\). +@param [nwidth], numeric, Indica a largura em pixels do objeto. +@param [nheight], numeric, Indica a altura em pixels do objeto. +@param [uparam15], codeblock, Compatibilidade. +@param [uparam16], logical, Compatibilidade. +@param [uparam17], logical, Compatibilidade. +@param [lpixel], logical, Indica se considera as coordenadas passadas em pixels \(.T.\) ou caracteres \(.F.\). +@param [lhoriz], logical, Indica se o menu deverá ser montado na horizontal \(.T.\) ao invés do padrão na vertical \(.F.\). \(disponível em builds superiores a 7.00.121227P\) +@param [lautoheight], logical, Se verdadeiro \(.T.\) indica que a altura do objeto será aplicada automaticamente \(valor padrão\). Caso contrário \(.F.\) a altura respeitará o valor indicado no parâmetro nHeight do construtor. Disponível somente a partir da build 7.00.170117A - 17.2.1.2. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/create +/*/ +method create(ownd, bsetget, nrow, ncol, aitems, uparam6, bchange, nclrtext, nclrpane, cmsg, uparam11, bwhen, nwidth, nheight, uparam15, uparam16, uparam17, lpixel, lhoriz, lautoheight) class tradmenu +return +/*/{Protheus.doc} tradmenu:disable +Desabilita um item. + +@type method + +@param [nitem], numeric, Indica o item que será desabilitado. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/disable +/*/ +method disable(nitem) class tradmenu +return +/*/{Protheus.doc} tradmenu:enable +Habilita um item. + +@type method + +@param [nitem], numeric, Indica o item que será habilitado. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/enable +/*/ +method enable(nitem) class tradmenu +return +/*/{Protheus.doc} tradmenu:enableitem +Habilita/Desabilita um item. + +@type method + +@param [nitem], numeric, Indica o item que terá seu status alterado. +@param [lstatus], logical, Indica o status \(.T. - Habilita ou .F. - Desabilita\) que será atribuído ao item. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/enableitem +/*/ +method enableitem(nitem, lstatus) class tradmenu +return +/*/{Protheus.doc} tradmenu:setoptions +Seleciona um item. + +@type method + +@param [nitem], numeric, Indica o item que será selecionado. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/setoptions +/*/ +method setoptions(nitem) class tradmenu +return + + +/*/{Protheus.doc} tsay +Cria um objeto do tipo label. Desta forma, o objeto apresentará o conteúdo do texto estático sobre uma janela ou controle visual. + +@type binary class + + + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/tsay + +/*/ +class tsay from TControl +data ltransparent as logical +data lwordwrap as logical +method new() +method create() +method ctrlrefresh() +method settext() +method settextalign() +method setpopup() +end class +/*/{Protheus.doc} tsay:new +Método construtor da classe. + +@type method + +@return object, Nova instância da classe TSay + +@param [nrow], numeric, Indica a coordenada vertical em pixels ou caracteres. +@param [ncol], numeric, Indica a coordenada horizontal em pixels ou caracteres. +@param [btext], codeblock, Indica o bloco de código que será executado para retornar e apresentar uma string. +@param [ownd], object, Indica a janela ou controle visual onde o objeto será criado. +@param [cpicture], character, Indica a máscara de formatação, do conteúdo, que será apresentada. Verificar [Tabela de Pictures de Formatação](Tabela de Pictures de Formatação). +@param [ofont], object, Indica o objeto do tipo TFont utilizado para definir as características da fonte aplicada na exibição do conteúdo do controle visual. +@param [uparam7], logical, Compatibilidade. +@param [uparam8], logical, Compatibilidade. +@param [uparam9], logical, Compatibilidade. +@param [lpixels], logical, Indica se considera as coordenadas passadas em pixels \(.T.\) ou caracteres \(.F.\). +@param [nclrtext], numeric, Indica a cor do texto do objeto. +@param [nclrback], numeric, Indica a cor de fundo do objeto. +@param [nwidth], numeric, Indica a largura em pixels do objeto. +@param [nheight], numeric, Indica a altura em pixels do objeto. +@param [uparam15], logical, Compatibilidade. +@param [uparam16], logical, Compatibilidade. +@param [uparam17], logical, Compatibilidade. +@param [uparam18], logical, Compatibilidade. +@param [uparam19], logical, Compatibilidade. +@param [lhtml], logical, Indica se, verdadeiro \(.T.\), habilita a visualização do texto no formato HTML; caso contrário, falso \(.F.\). +@param [ntxtalghor], numeric, Alinhamento horizontal do texto \(Consulte tabela na página do método SetTextAlign\). Disponível a partir da versão 17.3.0.0. +@param [ntxtalgver], numeric, Alinhamento vertical do texto \(Consulte tabela na página do método SetTextAlign\). Disponível a partir da versão 17.3.0.0. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/new +/*/ +method new(nrow, ncol, btext, ownd, cpicture, ofont, uparam7, uparam8, uparam9, lpixels, nclrtext, nclrback, nwidth, nheight, uparam15, uparam16, uparam17, uparam18, uparam19, lhtml, ntxtalghor, ntxtalgver) class tsay +return +/*/{Protheus.doc} tsay:create +Método construtor da classe. + +@type method + +@return object, Nova instância da classe TSay + +@param [ownd], object, Indica a janela ou controle visual onde o objeto será criado. +@param [btext], codeblock, Indica o bloco de código que será executado para retornar e apresentar uma string. +@param [nrow], numeric, Indica a coordenada vertical em pixels ou caracteres. +@param [ncol], numeric, Indica a coordenada horizontal em pixels ou caracteres. +@param [cpicture], character, Indica a máscara de formatação, do conteúdo, que será apresentada. Verificar [Tabela de Pictures de Formatação](Tabela de Pictures de Formatação). +@param [ofont], object, Indica o objeto do tipo TFont utilizado para definir as características da fonte aplicada na exibição do conteúdo do controle visual. +@param [uparam7], logical, Compatibilidade. +@param [uparam8], logical, Compatibilidade. +@param [uparam9], logical, Compatibilidade. +@param [lpixels], logical, Indica se considera as coordenadas passadas em pixels \(.T.\) ou caracteres \(.F.\). +@param [nclrtext], numeric, Indica a cor do texto do objeto. +@param [nclrback], numeric, Indica a cor de fundo do objeto. +@param [nwidth], numeric, Indica a largura em pixels do objeto. +@param [nheight], numeric, Indica a altura em pixels do objeto. +@param [uparam15], logical, Compatibilidade. +@param [uparam16], logical, Compatibilidade. +@param [uparam17], logical, Compatibilidade. +@param [uparam18], logical, Compatibilidade. +@param [uparam19], logical, Compatibilidade. +@param [uparam20], logical, Compatibilidade. +@param [ntxtalghor], numeric, Alinhamento horizontal do texto \(Consulte tabela na página do método SetTextAlign\). Disponível a partir da versão 17.3.0.0. +@param [ntxtalgver], numeric, Alinhamento vertical do texto \(Consulte tabela na página do método SetTextAlign\). Disponível a partir da versão 17.3.0.0. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/create +/*/ +method create(ownd, btext, nrow, ncol, cpicture, ofont, uparam7, uparam8, uparam9, lpixels, nclrtext, nclrback, nwidth, nheight, uparam15, uparam16, uparam17, uparam18, uparam19, uparam20, ntxtalghor, ntxtalgver) class tsay +return +/*/{Protheus.doc} tsay:ctrlrefresh +Força a atualização do objeto. + +@type method + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/ctrlrefresh +/*/ +method ctrlrefresh() class tsay +return +/*/{Protheus.doc} tsay:settext +Altera o texto que será apresentado pelo objeto. + +@type method + +@param [xval], character, Indica o texto que será apresentado. Observação: O tipo de dado desse parâmetro pode ser: Caracter, Numérico e Data. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/settext +/*/ +method settext(xval) class tsay +return +/*/{Protheus.doc} tsay:settextalign +Define o alinhamento horizontal e vertical do texto dentro do alcance do campo. + +@type method + +@param , numeric, Tipo de alinhamento horizontal. +@param , numeric, Tipo de alinhamento vertical. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/settextalign +/*/ +method settextalign(nhoriz, nvert) class tsay +return +/*/{Protheus.doc} tsay:setpopup +Define um menu do tipo popup. + +@type method + +@param , object, Objeto do tipo TMenu. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/setpopup +/*/ +method setpopup(omenu) class tsay +return + + +/*/{Protheus.doc} tscrollarea +Cria um objeto do tipo painel com barra de rolagem \(Scroll\). + +@type binary class + + + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/tscrollarea + +/*/ +class tscrollarea from TControl +data ltracking as logical +method new() +method setframe() +end class +/*/{Protheus.doc} tscrollarea:new +Método construtor da classe. + +@type method + +@return object, Nova instância da classe TScrollArea + +@param [ownd], object, Indica a janela ou controle visual onde o objeto será criado. +@param [ntop], numeric, Indica a coordenada vertical em pixels. +@param [nleft], numeric, Indica a coordenada horizontal em pixels. +@param [nheight], numeric, Indica a altura em pixels do objeto. +@param [nwidth], numeric, Indica a largura em pixels do objeto. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/new +/*/ +method new(ownd, ntop, nleft, nheight, nwidth) class tscrollarea +return +/*/{Protheus.doc} tscrollarea:setframe +Define o objeto que será apresentado na área. + +@type method + +@param [o], object, Indica o objeto que será apresentado na área. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/setframe +/*/ +method setframe(o) class tscrollarea +return + + +/*/{Protheus.doc} tscrollbox +Cria um objeto do tipo painel com barra de rolagem \(Scroll\). + +@type binary class + + + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/tscrollbox + +/*/ +class tscrollbox from TControl +method new() +method create() +method reset() +end class +/*/{Protheus.doc} tscrollbox:new +Método construtor da classe. + +@type method + +@return object, Nova instância da classe TScrollBox + +@param [ownd], object, Indica a janela ou controle visual onde o objeto será criado. +@param [ntop], numeric, Indica a coordenada vertical em pixels. +@param [nleft], numeric, Indica a coordenada horizontal em pixels. +@param [nheight], numeric, Indica a altura em pixels do objeto. +@param [nwidth], numeric, Indica a largura em pixels do objeto. +@param [lvertical], logical, Indica se verdadeiro \(.T.\) a barra de rolagem vertical será apresentada, caso contrário falso \(.F.\). +@param [lhorizontal], logical, Indica se verdadeiro \(.T.\) a barra de rolagem horizontal será apresentada, caso contrário falso \(.F.\). +@param [lborder], logical, Indica se verdadeiro \(.T.\) a borda do objeto será apresentada, caso contrário falso \(.F.\). +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/new +/*/ +method new(ownd, ntop, nleft, nheight, nwidth, lvertical, lhorizontal, lborder) class tscrollbox +return +/*/{Protheus.doc} tscrollbox:create +Método construtor da classe. + +@type method + +@return object, Nova instância da classe TScrollBox + +@param [ownd], object, Indica a janela ou controle visual onde o objeto será criado. +@param [ntop], numeric, Indica a coordenada vertical em pixels. +@param [nleft], numeric, Indica a coordenada horizontal em pixels. +@param [nheight], numeric, Indica a altura em pixels do objeto. +@param [nwidth], numeric, Indica a largura em pixels do objeto. +@param [lvertical], logical, Indica se verdadeiro \(.T.\) a barra de rolagem vertical será apresentada, caso contrário falso \(.F.\). +@param [lhorizontal], logical, Indica se verdadeiro \(.T.\) a barra de rolagem horizontal será apresentada, caso contrário falso \(.F.\). +@param [lborder], logical, Indica se verdadeiro \(.T.\) a borda do objeto será apresentada, caso contrário falso \(.F.\). +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/create +/*/ +method create(ownd, ntop, nleft, nheight, nwidth, lvertical, lhorizontal, lborder) class tscrollbox +return +/*/{Protheus.doc} tscrollbox:reset +Retorna a barra de rolagem para a posição inicial à esquerda e ao topo. + +@type method + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/reset +/*/ +method reset() class tscrollbox +return + + +/*/{Protheus.doc} tsimpleeditor +Cria um objeto do tipo editor de texto simples. + +@type binary class + + + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/tsimpleeditor + +/*/ +class tsimpleeditor from TControl +data bchanged as codeblock +data bgetkey as codeblock +data lobfuscate as logical +method create() +method new() +method load() +method rettext() +method rettextsel() +method textalign() +method textbold() +method textfamily() +method textcolor() +method textformat() +method textitalic() +method textsize() +method textstatus() +method textstyle() +method gotop() +method goend() +method goto() +method textunderline() +method savetopdf() +method setmaxtextlength() +method setwordwrap() +end class +/*/{Protheus.doc} tsimpleeditor:create +Método construtor da classe. + +@type method + +@return object, Nova instância da classe TSimpleEditor + +@param [ownd], object, Indica a janela ou controle visual onde o objeto será criado. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/create +/*/ +method create(ownd) class tsimpleeditor +return +/*/{Protheus.doc} tsimpleeditor:new +Método construtor da classe. + +@type method + +@return object, Nova instância da classe TSimpleEditor + +@param [nrow], numeric, Indica a coordenada vertical em pixels ou caracteres. +@param [ncol], numeric, Indica a coordenada horizontal em pixels ou caracteres. +@param [ownd], object, Indica a janela ou controle visual onde o objeto será criado. +@param [nwidth], numeric, Indica a largura em pixels do objeto. +@param [nheight], numeric, Indica a altura em pixels do objeto. +@param [ctext], character, Indica o texto que será apresentado na inicialização do objeto. +@param [lreadonly], logical, Indica se, verdadeiro \(.T.\), o texto não pode ser editado; caso contrário, falso \(.F.\). +@param [bsetget], codeblock, Indica o bloco de código, no formato \{\|u\| if\( Pcount\( \)>0, := u, \) \}, que será executado para atualizar a variável \(essa variável deve ser do tipo caracter\). Desta forma, se a lista for sequencial, o controle atualizará com o conteúdo do item selecionado, se for indexada, será atualizada com o valor do índice do item selecionado. +@param [ofont], object, Indica o objeto do tipo [TFont](TFont) que será utilizado para definir as características da fonte aplicada na exibição do conteúdo do controle visual. +@param [lpixel], logical, Indica se considera as coordenadas passadas em pixels \(.T.\) ou caracteres \(.F.\). +@param [bwhen], codeblock, Indica o bloco de código que será executado quando a mudança de foco da entrada de dados, na janela em que o controle foi criado, estiver sendo efetuada. Observação: O bloco de código retornará verdadeiro \(.T.\) se o controle permanecer habilitado; caso contrário, retornará falso \(.F.\). +@param [bvalid], codeblock, Indica o bloco de código de validação que será executado quando o conteúdo do objeto for modificado. Retorna verdadeiro \(.T.\), se o conteúdo é válido; caso contrário, falso \(.F.\). +@param [clabeltext], character, indica o texto que será apresentado na Label. +@param [nlabelpos], numeric, Indica a posição da label, sendo 1=Topo e 2=Esquerda +@param [olabelfont], object, Indica o objeto, do tipo [TFont](TFont), que será utilizado para definir as características da fonte aplicada na exibição da label. +@param [nlabelcolor], numeric, Indica a cor do texto da Label. +@param [bchanged], codeblock, Indica o bloco de código que será disparado no método Load e no Recortar \(CTRL+X\) e Colar \(CTRL+V\). Parâmetro disponível em builds superiores à 131227A. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/new +/*/ +method new(nrow, ncol, ownd, nwidth, nheight, ctext, lreadonly, bsetget, ofont, lpixel, bwhen, bvalid, clabeltext, nlabelpos, olabelfont, nlabelcolor, bchanged) class tsimpleeditor +return +/*/{Protheus.doc} tsimpleeditor:load +Carrega um texto para o editor. + +@type method + +@param [ctexto], character, Indica o texto que inicializará o editor. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/load +/*/ +method load(ctexto) class tsimpleeditor +return +/*/{Protheus.doc} tsimpleeditor:rettext +Retorna uma string com o conteúdo do editor. + +@type method + +@return character, String contendo o conteúdo do editor. + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/rettext +/*/ +method rettext() class tsimpleeditor +return +/*/{Protheus.doc} tsimpleeditor:rettextsel +Retorna uma string com o conteúdo selecionado do editor. + +@type method + +@return character, Retorna uma string com o conteúdo selecionado do editor. + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/rettextsel +/*/ +method rettextsel() class tsimpleeditor +return +/*/{Protheus.doc} tsimpleeditor:textalign +Define o tipo de alinhamento do texto. + +@type method + +@param [nalign], numeric, Indica o tipo de alinhamento do texto, sendo: 1-À esquerda, 2-À direita, 3-Centralizado e 4-Justificado. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/textalign +/*/ +method textalign(nalign) class tsimpleeditor +return +/*/{Protheus.doc} tsimpleeditor:textbold +Aplica o estilo negrito no texto. + +@type method + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/textbold +/*/ +method textbold() class tsimpleeditor +return +/*/{Protheus.doc} tsimpleeditor:textfamily +Aplica um tipo de fonte no texto. + +@type method + +@param [cfamily], character, Indica o nome da fonte que será utilizada na seção do texto. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/textfamily +/*/ +method textfamily(cfamily) class tsimpleeditor +return +/*/{Protheus.doc} tsimpleeditor:textcolor +Aplica uma cor no texto. + +@type method + +@param , numeric, Indica a cor do texto. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/textcolor +/*/ +method textcolor(ncolor) class tsimpleeditor +return +/*/{Protheus.doc} tsimpleeditor:textformat +Define o formato do texto. + +@type method + +@param [nformat], numeric, Indica o formato do texto, sendo: 1 = Html e 2 = Plain Text. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/textformat +/*/ +method textformat(nformat) class tsimpleeditor +return +/*/{Protheus.doc} tsimpleeditor:textitalic +Aplica o estilo itálico no texto. + +@type method + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/textitalic +/*/ +method textitalic() class tsimpleeditor +return +/*/{Protheus.doc} tsimpleeditor:textsize +Aplica o tamanho da fonte no texto. + +@type method + +@param [nsize], numeric, Indica o tamanho da fonte que será utilizada na seção do texto. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/textsize +/*/ +method textsize(nsize) class tsimpleeditor +return +/*/{Protheus.doc} tsimpleeditor:textstatus +Retorna um array com as propriedades do texto posicionado. + +@type method + +@return array, Retorna um array com as propriedades do texto. Consulte tabela da área de observações. + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/textstatus +/*/ +method textstatus() class tsimpleeditor +return +/*/{Protheus.doc} tsimpleeditor:textstyle +Define o estilo do parágrafo. + +@type method + +@param [nstyle], numeric, Indica o estilo do parágrafo que será utilizado na seção do texto. Consulte tabela na área de observações para conhecer os valores possíveis. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/textstyle +/*/ +method textstyle(nstyle) class tsimpleeditor +return +/*/{Protheus.doc} tsimpleeditor:gotop +Posiciona o cursor no início do texto. + +@type method + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/gotop +/*/ +method gotop() class tsimpleeditor +return +/*/{Protheus.doc} tsimpleeditor:goend +Posiciona o cursor no fim do texto. + +@type method + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/goend +/*/ +method goend() class tsimpleeditor +return +/*/{Protheus.doc} tsimpleeditor:goto +Posiciona o cursor no início da linha especificada. + +@type method + +@param , numeric, Indica a linha em que o cursor será posicionado. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/goto +/*/ +method goto(nline) class tsimpleeditor +return +/*/{Protheus.doc} tsimpleeditor:textunderline +Aplica o estilo sublinhado no texto. + +@type method + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/textunderline +/*/ +method textunderline() class tsimpleeditor +return +/*/{Protheus.doc} tsimpleeditor:savetopdf +Salva o conteúdo do editor em um arquivo PDF. + +@type method + +@param , character, Indica o caminho e nome do arquivo PDF para salvamento. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/savetopdf +/*/ +method savetopdf(cpdffile) class tsimpleeditor +return +/*/{Protheus.doc} tsimpleeditor:setmaxtextlength +Limita a quantidade de caracteres aceitos no componente. + +@type method + +@param , numeric, Indica a quantidade de caracteres aceitos no componente. Se for informado o valor -1, o limite será desativado. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/setmaxtextlength +/*/ +method setmaxtextlength(nlimit) class tsimpleeditor +return +/*/{Protheus.doc} tsimpleeditor:setwordwrap +Desativa ou ativa a quebra automática de linha no editor. + +@type method + +@param , logical, Indica se desativa \(.F.\) ou ativa \(.T.\) a quebra automática de linha. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/setwordwrap +/*/ +method setwordwrap(lenable) class tsimpleeditor +return + + +/*/{Protheus.doc} tslider +Cria um objeto do tipo botão deslizante. + +@type binary class + + + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/tslider + +/*/ +class tslider from TControl +data bchange as codeblock +method create() +method new() +method setrange() +method setmarks() +method setinterval() +method setvalue() +method setstep() +method setorient() +end class +/*/{Protheus.doc} tslider:create +Método construtor da classe. + +@type method + +@return object, Nova instância da classe TSlider + +@param [ownd], object, Indica a janela ou controle visual onde o objeto será criado. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/create +/*/ +method create(ownd) class tslider +return +/*/{Protheus.doc} tslider:new +Método construtor da classe. + +@type method + +@return object, Nova instância da classe TSlider + +@param [nrow], numeric, Indica a coordenada vertical em pixels. +@param [ncol], numeric, Indica a coordenada horizontal em pixels. +@param [ownd], object, Indica a janela ou controle visual onde o objeto será criado. +@param [bchange], codeblock, Indica o bloco de código que será executado quando o estado ou conteúdo do objeto é modificado pela ação sobre o controle visual. +@param [nwidth], numeric, Indica a largura em pixels do objeto. +@param [nheight], numeric, Indica a altura em pixels do objeto. +@param [cmsg], character, Indica a mensagem, do tipo dica de contexto \(tooltip/hint\), ao posicionar o ponteiro do mouse sobre o botão. +@param [bwhen], codeblock, Indica o bloco de código que será executado quando a mudança de foco da entrada de dados, na janela em que o controle foi criado, estiver sendo efetuada. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/new +/*/ +method new(nrow, ncol, ownd, bchange, nwidth, nheight, cmsg, bwhen) class tslider +return +/*/{Protheus.doc} tslider:setrange +Especifica os valores \(de/até\) da faixa do botão. + +@type method + +@param [nmin], numeric, Indica o valor mínimo do botão. +@param [nmax], numeric, Indica o valor máximo do botão. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/setrange +/*/ +method setrange(nmin, nmax) class tslider +return +/*/{Protheus.doc} tslider:setmarks +Especifica o tipo de marcação do botão. + +@type method + +@param [nmark], numeric, Indica o tipo de marcação do botão, sendo: 0=Botão com identificação Padrão/Default, 1=Botão com indicação para cima, 2=Botão com indicação para baixo e 3=Botão com indicação para cima/baixo. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/setmarks +/*/ +method setmarks(nmark) class tslider +return +/*/{Protheus.doc} tslider:setinterval +Especifica a distância entre os marcadores. + +@type method + +@param [ninterval], numeric, Indica o valor de intervalo entre os marcadores. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/setinterval +/*/ +method setinterval(ninterval) class tslider +return +/*/{Protheus.doc} tslider:setvalue +Especifica um valor para o botão. + +@type method + +@param [nval], numeric, Indica o valor do botão. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/setvalue +/*/ +method setvalue(nval) class tslider +return +/*/{Protheus.doc} tslider:setstep +Especifica o valor de etapa do botão. + +@type method + +@param [nstep], numeric, Indica o valor de etapa do botão. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/setstep +/*/ +method setstep(nstep) class tslider +return +/*/{Protheus.doc} tslider:setorient +Especifica a coordenada \(horizontal/vertical\) do botão. + +@type method + +@param [norient], numeric, Indica a coordenada \(horizontal/vertical\) do botão, sendo: 0=Horizontal e 1=Vertical. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/setorient +/*/ +method setorient(norient) class tslider +return + + +/*/{Protheus.doc} tsocketclient +Estabelece uma conexão client de socket do tipo TCP genérica.Através desta classe, é possível enviar e receber dados por meio de um socket genérico e utilizar como base para implementação de protocolo não suportado pela aplicação. + +@type binary class + + + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/tsocketclient + +/*/ +class tsocketclient +method new() +method connect() +method geterror() +method isconnected() +method send() +method receive() +method reset() +method closeconnection() +end class +/*/{Protheus.doc} tsocketclient:new +Cria o objeto TSocketClient sem conexão ativa. + +@type method + +@return object, Nova instância da classe TSocketClient + +@param [lclient], logical, Indica se o client de socket será criado do lado do Client \(.T.\) ou do lado do AppServer \(.F.\). O padrão é \(.F.\) AppServer. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/new +/*/ +method new(lclient) class tsocketclient +return +/*/{Protheus.doc} tsocketclient:connect +Estabelece uma conexão TCP genérica \(socket\). + +@type method + +@return numeric, Retorna 0 \(zero\) se conectar com sucesso; caso contrário, a conexão falhou. + +@param , numeric, Indica o número da porta onde a conexão será realizada. +@param , character, Indica o número IP ou nome do servidor onde a conexão será realizada. +@param , numeric, Indica o número em milissegundos onde o método deve esperar para conectar. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/connect +/*/ +method connect(nport, caddress, ntimeout) class tsocketclient +return +/*/{Protheus.doc} tsocketclient:geterror +Permite recuperar um código e uma string correspondendo à ultima ocorrência do Socket client registrada em caso de falha. + +@type method + +@return numeric, Retorna o código do último erro ocorrido. + +@param <@cdesc>, character, Retorna um código e uma string que corresponde à última ocorrência de SocketClient registrada em caso de falha. Caso não haja nenhuma falha registrada, a função retorna 0 \(zero\). +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/geterror +/*/ +method geterror(cdesc) class tsocketclient +return +/*/{Protheus.doc} tsocketclient:isconnected +Retorna se o socket está conectado ou não + +@type method + +@return codeblock, Retorna verdadeiro \(.T.\) caso conectado. Caso contrário retorna \(.F.\). + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/isconnected +/*/ +method isconnected() class tsocketclient +return +/*/{Protheus.doc} tsocketclient:send +Transmite o buffer pela conexão TCP genérica ativa. + +@type method + +@return numeric, Retorna o número de bytes transmitidos. Caso o número seja diferente do tamanho especificado, no parâmetro cBuffer, algum erro aconteceu. + +@param , character, Indica a buffer que contém os dados que serão transmitidos pela conexão. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/send +/*/ +method send(cdata) class tsocketclient +return +/*/{Protheus.doc} tsocketclient:receive +Recebe qualquer tipo de dado pela conexão ativa do objeto. + +@type method + +@return numeric, Retorna a quantidade de bytes recebidos. Caso ocorra algum erro, a quantidade recebida será menor que zero. + +@param <@cbuffer>, variant, Indica o buffer que contém os dados a serem recebidos. +@param , numeric, o tempo em milissegundos, que o método receive aguarda, para receber algum dado pela conexão. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/receive +/*/ +method receive(cbuffer, indica) class tsocketclient +return +/*/{Protheus.doc} tsocketclient:reset +Encerra a conexão sem avisar o outro lado. + +@type method + +@return numeric, Retorna 0 em caso de sucesso. Caso contrário retorna um código de erro. + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/reset +/*/ +method reset() class tsocketclient +return +/*/{Protheus.doc} tsocketclient:closeconnection +Encerra a conexão TCP genérica \(socket\) do objeto corrente. + +@type method + +@return numeric, Retorna 0 em caso de uma conexão bem sucedida. Caso contrário retorna um código de erro. + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/closeconnection +/*/ +method closeconnection() class tsocketclient +return + + +/*/{Protheus.doc} tspinbox +Cria um objeto do tipo caixa de seleção, cujo os itens são definidos a partir de um intervalo numérico. + +@type binary class + + + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/tspinbox + +/*/ +class tspinbox from TControl +data bchange as codeblock +method create() +method new() +method setrange() +method setvalue() +method setstep() +method setwrap() +end class +/*/{Protheus.doc} tspinbox:create +Método construtor da classe. + +@type method + +@return object, Nova instância da classe TSpinBox + +@param [ownd], object, Indica a janela ou controle visual onde objeto será criado. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/create +/*/ +method create(ownd) class tspinbox +return +/*/{Protheus.doc} tspinbox:new +Método construtor da classe. + +@type method + +@return object, Nova instância da classe TSpinBox + +@param [nrow], numeric, Indica a coordenada vertical em pixels. +@param [ncol], numeric, Indica a coordenada horizontal em pixels. +@param [ownd], object, Indica a janela ou controle visual onde o objeto será criado. +@param [bchange], codeblock, Indica o bloco de código que será executado quando o estado ou conteúdo do objeto é modificado pela ação sobre o controle visual. +@param [nwidth], numeric, Indica a largura em pixels do objeto. +@param [nheight], numeric, Indica a altura em pixels do objeto. +@param [cmsg], character, Indica a mensagem do tipo dica de contexto \(tooltip/hint\) ao posicionar o ponteiro do mouse sobre o botão. +@param [bwhen], codeblock, Indica o bloco de código que será executado quando a mudança de foco da entrada de dados, na janela em que o controle foi criado, estiver sendo efetuada. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/new +/*/ +method new(nrow, ncol, ownd, bchange, nwidth, nheight, cmsg, bwhen) class tspinbox +return +/*/{Protheus.doc} tspinbox:setrange +Especifica os valores \(de/até\) da faixa do botão. + +@type method + +@param [nmin], numeric, Indica o valor mínimo do botão. +@param [nmax], numeric, Indica o valor máximo do botão. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/setrange +/*/ +method setrange(nmin, nmax) class tspinbox +return +/*/{Protheus.doc} tspinbox:setvalue +Especifica um valor para o botão. + +@type method + +@param [nval], numeric, Indica o valor do botão. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/setvalue +/*/ +method setvalue(nval) class tspinbox +return +/*/{Protheus.doc} tspinbox:setstep +Especifica o valor de etapa do botão. + +@type method + +@param [nstep], numeric, Indica o valor de etapa do botão. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/setstep +/*/ +method setstep(nstep) class tspinbox +return +/*/{Protheus.doc} tspinbox:setwrap +Especifica se a caixa de giro é circular. + +@type method + +@param [lwrap], logical, Se habilita\(.T.\), Quando o número chegar ao valor máximo\(50\) espeficicado por `( oSpinBox:SetRange(0,50) )` irá levá-lo ao mínimo\(0\) e vica versa. Ao setar /desabilita\(.F.\), o valor não entra em giro circular. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/setwrap +/*/ +method setwrap(lwrap) class tspinbox +return + + +/*/{Protheus.doc} tsplitter +Cria um objeto do tipo barra de divisão. + +@type binary class + + + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/tsplitter + +/*/ +class tsplitter from TControl +method new() +method create() +method setorient() +method setchildcollapse() +method setcollapse() +method movetolast() +method movetofirst() +method setopaqueresize() +method setresizemode() +end class +/*/{Protheus.doc} tsplitter:new +Método construtor da classe. + +@type method + +@return object, Nova instância da classe TSplitter + +@param [nrow], numeric, Indica a coordenada vertical em pixels ou caracteres. +@param [ncol], numeric, Indica a coordenada horizontal em pixels ou caracteres. +@param [ownd], object, Indica a janela ou controle visual onde o objeto será criado. +@param [nwidth], numeric, Indica a largura em pixels do objeto. +@param [nheight], numeric, Indica a altura em pixels do objeto. +@param [norientation], numeric, Indica a posição que a barra de divisão será criada, sendo 0 = Horizontal e 1 = Vertical. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/new +/*/ +method new(nrow, ncol, ownd, nwidth, nheight, norientation) class tsplitter +return +/*/{Protheus.doc} tsplitter:create +Método construtor da classe. + +@type method + +@return object, Nova instância da classe TSplitter + +@param [ownd], object, Indica a janela ou controle visual onde objeto será criado. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/create +/*/ +method create(ownd) class tsplitter +return +/*/{Protheus.doc} tsplitter:setorient +Especifica a posição \(horizontal ou vertical\) do objeto. + +@type method + +@param [norient], numeric, Indica a posição do objeto, sendo 0 = Horizontal e 1 = Vertical. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/setorient +/*/ +method setorient(norient) class tsplitter +return +/*/{Protheus.doc} tsplitter:setchildcollapse +Define se os elementos serão fechados \(Collapsibles\). + +@type method + +@param [lcoll], logical, Indica se habilita\(.T.\)/desabilita\(.F.\) a opção de fechar \(Collapsibles\) os elementos. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/setchildcollapse +/*/ +method setchildcollapse(lcoll) class tsplitter +return +/*/{Protheus.doc} tsplitter:setcollapse +Define qual objeto será fechado \(Collapsible\). + +@type method + +@param [oobj], object, Indica o objeto que será fechado \(Collapsed\). +@param [lcoll], logical, Indica se habilita\(.T.\)/desabilita\(.F.\) a opção de fechar. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/setcollapse +/*/ +method setcollapse(oobj, lcoll) class tsplitter +return +/*/{Protheus.doc} tsplitter:movetolast +Define qual objeto será o último das divisões. + +@type method + +@param [oobj], object, Indica qual objeto será o último da divisão. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/movetolast +/*/ +method movetolast(oobj) class tsplitter +return +/*/{Protheus.doc} tsplitter:movetofirst +Define qual objeto será o primeiro das divisões. + +@type method + +@param [oobj], object, Indica qual objeto será o primeiro da divisão. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/movetofirst +/*/ +method movetofirst(oobj) class tsplitter +return +/*/{Protheus.doc} tsplitter:setopaqueresize +Define se o redimensionamento \(resize\) será opaco. + +@type method + +@param [lopaq], logical, Indica se habilita\(.T.\)/desabilita\(.F.\) o redimensionamento opaco. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/setopaqueresize +/*/ +method setopaqueresize(lopaq) class tsplitter +return +/*/{Protheus.doc} tsplitter:setresizemode +Define a maneira de redimensionar \(resize\) o objeto. + +@type method + +@param [oobj], object, Indica o objeto que será redimensionado. +@param [nmode], numeric, Indica a maneira que o objeto será redimensionado, sendo: 0 = Stretch, 1 = KeepSize, 2 = FollowSizeHint e 3 = Auto. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/setresizemode +/*/ +method setresizemode(oobj, nmode) class tsplitter +return + + +/*/{Protheus.doc} tsrvobject +Classe abstrata herdada por todos os componentes visuais. + +@type binary class + + + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/tsrvobject + +/*/ +class tsrvobject +data acontrols as array +data bgotfocus as codeblock +data bhelp as codeblock +data blclicked as codeblock +data bldblclick as codeblock +data blostfocus as codeblock +data brclicked as codeblock +data bvalid as codeblock +data bwhen as codeblock +data ccaption as character +data cmsg as character +data cname as character +data creadvar as character +data ctooltip as character +data lactive as logical +data lcangotfocus as logical +data lvisible as logical +data nbottom as numeric +data nclientheight as numeric +data nclientwidth as numeric +data nclrpane as numeric +data nclrtext as numeric +data nheight as numeric +data nleft as numeric +data nright as numeric +data ntop as numeric +data nwidth as numeric +data nwnd as numeric +data cargo as object +data ocursor as object +data ofont as object +data oparent as object +data ownd as object +method classname() +method coorsupdate() +method disable() +method enable() +method freechildren() +method getclientrect() +method getfont() +method setfont() +method gettext() +method hide() +method show() +method hwhandle() +method move() +method owner() +method refresh() +method saveasbmp() +method setcolor() +method setcoors() +method setcss() +method setdisable() +method setenable() +method setfocus() +method settext() +method setupdatesenabled() +end class +/*/{Protheus.doc} tsrvobject:classname +Retorna o nome da classe. + +@type method + +@return character, Nome da classe + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/classname +/*/ +method classname() class tsrvobject +return +/*/{Protheus.doc} tsrvobject:coorsupdate +Atualiza informação no AppServer do posicionamento \(vertical superior, horizontal esquerda, vertical inferior e horizontal direita\) do objeto. + +@type method + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/coorsupdate +/*/ +method coorsupdate() class tsrvobject +return +/*/{Protheus.doc} tsrvobject:disable +Desabilita o objeto + +@type method + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/disable +/*/ +method disable() class tsrvobject +return +/*/{Protheus.doc} tsrvobject:enable +Habilita o objeto + +@type method + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/enable +/*/ +method enable() class tsrvobject +return +/*/{Protheus.doc} tsrvobject:freechildren +Elimina/Libera todos os objetos da classe onde este método é chamado. + +@type method + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/freechildren +/*/ +method freechildren() class tsrvobject +return +/*/{Protheus.doc} tsrvobject:getclientrect +Retorna as coordenadas de posicionamento e dimensão \(vertical superior, horizontal à esquerda, vertical inferior e horizontal à direita\) do objeto + +@type method + +@return array, Retorna um array com as coordenadas de posicionamento e dimensão \(vertical superior, horizontal esquerda, vertical inferior e horizontal direita\) do objeto. + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/getclientrect +/*/ +method getclientrect() class tsrvobject +return +/*/{Protheus.doc} tsrvobject:getfont +Retorna a fonte do objeto. + +@type method + +@return object, Fonte do Objeto + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/getfont +/*/ +method getfont() class tsrvobject +return +/*/{Protheus.doc} tsrvobject:setfont +Define a fonte do objeto. + +@type method + +@param , object, Indica o objeto do tipo TFont utilizado para definir as características da fonte aplicada na exibição do conteúdo do controle visual. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/setfont +/*/ +method setfont(ofont) class tsrvobject +return +/*/{Protheus.doc} tsrvobject:gettext +Retorna o título do objeto contido na propriedade cCaption. + +@type method + +@return character, Título do objeto. + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/gettext +/*/ +method gettext() class tsrvobject +return +/*/{Protheus.doc} tsrvobject:hide +Torna o objeto invisível. + +@type method + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/hide +/*/ +method hide() class tsrvobject +return +/*/{Protheus.doc} tsrvobject:show +Torna o objeto visível. + +@type method + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/show +/*/ +method show() class tsrvobject +return +/*/{Protheus.doc} tsrvobject:hwhandle +Retorna o handle do objeto. + +@type method + +@return numeric, Retorna o handle do objeto. + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/hwhandle +/*/ +method hwhandle() class tsrvobject +return +/*/{Protheus.doc} tsrvobject:move +Move o objeto. + +@type method + +@param , numeric, Indica a posição ao topo. +@param , numeric, Indica a posição a esquerda. +@param , numeric, Indica a largura. +@param , numeric, Indica a altura. +@param [uparam5], logical, Compatibility parameter. Pass NIL. +@param [lrealcoords], logical, Indica se as bordas do objeto serão consideradas no cálculo de movimentação. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/move +/*/ +method move(ntop, nleft, nwidth, nheight, uparam5, lrealcoords) class tsrvobject +return +/*/{Protheus.doc} tsrvobject:owner +Retorna o objeto do tipo tWindow ou tDialog utilizado na criação desta classe. + +@type method + +@return object, Retorna o objeto do tipo tWindow ou tDialog onde este foi criado. + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/owner +/*/ +method owner() class tsrvobject +return +/*/{Protheus.doc} tsrvobject:refresh +Atualiza as propriedades do objeto no TOTVS Smart Client. + +@type method + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/refresh +/*/ +method refresh() class tsrvobject +return +/*/{Protheus.doc} tsrvobject:saveasbmp +Salva uma cópia do objeto no formato Bitmap \(\*.BMP\). + +@type method + +@return logical, Retorna verdadeiro \(.T.\), se a imagem for salva com sucesso; caso contrário, retorna falso \(.F.\). + +@param , character, Indica o caminho do arquivo no client. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/saveasbmp +/*/ +method saveasbmp(cfile) class tsrvobject +return +/*/{Protheus.doc} tsrvobject:setcolor +Define as cores do objeto. + +@type method + +@param , numeric, Indica a cor da fonte. +@param , numeric, Indica a cor de fundo do objeto. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/setcolor +/*/ +method setcolor(nclrfore, nclrback) class tsrvobject +return +/*/{Protheus.doc} tsrvobject:setcoors +Define as coordenadas \(à esquerda, ao topo, largura e altura\) do objeto utilizando a classe TRect. + +@type method + +@param , object, Indica o objeto do tipo TRect é utilizado para definir as coordenadas. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/setcoors +/*/ +method setcoors(orect) class tsrvobject +return +/*/{Protheus.doc} tsrvobject:setcss +Aplica estilo no objeto utilizando o CSS \(Cascading Style Sheets\) + +@type method + +@param , character, Indica o texto com formato CSS para o objeto. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/setcss +/*/ +method setcss(ccss) class tsrvobject +return +/*/{Protheus.doc} tsrvobject:setdisable +Habilita ou desabilita o objeto. + +@type method + +@param , logical, Indica se o habilita \(.F.\) ou desabilita \(.T.\) o objeto. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/setdisable +/*/ +method setdisable(lenable) class tsrvobject +return +/*/{Protheus.doc} tsrvobject:setenable +Habilita ou desabilita o objeto. + +@type method + +@param , logical, Indica se o habilita \(.T.\) ou desabilita \(.F.\) o objeto. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/setenable +/*/ +method setenable(lenable) class tsrvobject +return +/*/{Protheus.doc} tsrvobject:setfocus +Altera o foco da entrada de dados para o objeto. + +@type method + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/setfocus +/*/ +method setfocus() class tsrvobject +return +/*/{Protheus.doc} tsrvobject:settext +Define o texto do objeto. + +@type method + +@param , character, Indica o texto do objeto. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/settext +/*/ +method settext(ctexto) class tsrvobject +return +/*/{Protheus.doc} tsrvobject:setupdatesenabled +Habilita ou desabilita a atualização de pintura do objeto. + +@type method + +@param , logical, Indica se habilita \(.T.\) ou desabilita \(.F.\) a atualização do objeto. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/setupdatesenabled +/*/ +method setupdatesenabled(lenable) class tsrvobject +return + + +/*/{Protheus.doc} ttabs +Cria um objeto do tipo aba. + +@type binary class + + + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/ttabs + +/*/ +class ttabs from TControl +data baction as codeblock +data noption as numeric +data aprompts as object +method new() +method moveopt() +method additem() +method delitem() +method setoption() +method settabs() +end class +/*/{Protheus.doc} ttabs:new +Método construtor da classe. + +@type method + +@return object, Nova instância da classe TTabs + +@param [ntop], numeric, Indica a coordenada vertical em pixels ou caracteres. +@param [nleft], numeric, Indica a coordenada horizontal em pixels ou caracteres. +@param [aprompts], object, Indica o array, no formato texto, que contêm as descrições das abas. +@param [baction], codeblock, Indica o bloco de código que será executado quando mudar de aba. +@param [ownd], object, Indica a janela ou controle visual onde objeto será criado. +@param [noption], numeric, Indica a aba que será selecionada. +@param [nclrfore], numeric, Indica a cor de frente do objeto. +@param [uparam8], numeric, Compatibility parameter. Pass NIL. +@param [lpixel], logical, Indica se considera as coordenadas passadas em pixels \(.T.\) ou caracteres \(.F.\). +@param [uparam10], logical, Compatibility parameter. Pass NIL. +@param [nwidth], numeric, Indica a largura em pixels do objeto. +@param [nheight], numeric, Indica a altura em pixels do objeto. +@param [cmsg], character, Indica a mensagem, do tipo dica de contexto \(tooltip/hint\), que será apresentada ao posicionar o ponteiro do mouse sobre o objeto. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/new +/*/ +method new(ntop, nleft, aprompts, baction, ownd, noption, nclrfore, uparam8, lpixel, uparam10, nwidth, nheight, cmsg) class ttabs +return +/*/{Protheus.doc} ttabs:moveopt +Move o conteúdo de uma aba para outra e exclui a de origem. + +@type method + +@param [nabaorigem], numeric, Indica a aba que terá seu conteúdo movido e será excluída. +@param [nabadestino], numeric, Indica a aba que receberá o conteúdo da aba excluída. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/moveopt +/*/ +method moveopt(nabaorigem, nabadestino) class ttabs +return +/*/{Protheus.doc} ttabs:additem +Adiciona uma aba. + +@type method + +@param [ctitulo], character, Indica o título da aba que será adicionada. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/additem +/*/ +method additem(ctitulo) class ttabs +return +/*/{Protheus.doc} ttabs:delitem +Exclui uma aba. + +@type method + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/delitem +/*/ +method delitem() class ttabs +return +/*/{Protheus.doc} ttabs:setoption +Seleciona uma aba. + +@type method + +@param [nnraba], numeric, Indica o número da aba que será selecionada. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/setoption +/*/ +method setoption(nnraba) class ttabs +return +/*/{Protheus.doc} ttabs:settabs +Inclui um novo array no formato texto, com novas abas. + +@type method + +@param , object, Indica um array no formato texto, com as novas abas. +@param , numeric, Indica o número da aba que será apresentada. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/settabs +/*/ +method settabs(aabas, nopt) class ttabs +return + + +/*/{Protheus.doc} ttimer +Cria um objeto que executa um bloco de código respeitando o temporizador, atrelado a um componente da interface visual. + +@type binary class + + + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/ttimer + +/*/ +class ttimer from TSrvObject +data baction as codeblock +data lactive as logical +data ninterval as numeric +data lliveany as logical +method new() +method activate() +method deactivate() +end class +/*/{Protheus.doc} ttimer:new +Método construtor da classe. + +@type method + +@return object, Nova instância da classe TTimer + +@param [ninterval], numeric, Indica o intervalo em milissegundos para disparar o bloco de código \(\*\). +@param [baction], codeblock, Indica o bloco de código que será executado a cada intervalo definido \(\*\*\). +@param [ownd], object, Indica a janela ou controle visual onde o divisor será criado \(\*\*\*\). +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/new +/*/ +method new(ninterval, baction, ownd) class ttimer +return +/*/{Protheus.doc} ttimer:activate +Inicia a execução do timer. + +@type method + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/activate +/*/ +method activate() class ttimer +return +/*/{Protheus.doc} ttimer:deactivate +Suspende a execução do timer. + +@type method + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/deactivate +/*/ +method deactivate() class ttimer +return + + +/*/{Protheus.doc} ttoolbox +Cria um objeto do tipo caixa de ferramenta, cujo objetivo é agrupar diferentes tipos de objetos. + +@type binary class + + + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/ttoolbox + +/*/ +class ttoolbox from TControl +data bchangegrp as codeblock +method create() +method new() +method addgroup() +method removegroup() +method setcurrentgroup() +end class +/*/{Protheus.doc} ttoolbox:create +Método construtor da classe. + +@type method + +@return object, Nova instância da classe TToolBox + +@param [ownd], object, Indica a janela ou controle visual onde o objeto será criado. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/create +/*/ +method create(ownd) class ttoolbox +return +/*/{Protheus.doc} ttoolbox:new +Método construtor da classe. + +@type method + +@return object, Nova instância da classe TToolBox + +@param [nrow], numeric, Indica a coordenada vertical em pixels ou caracteres. +@param [ncol], numeric, Indica a coordenada horizontal em pixels ou caracteres. +@param [ownd], object, Indica a janela ou controle visual onde o objeto será criado. +@param [nwidth], numeric, Indica a largura em pixels do objeto. +@param [nheight], numeric, Indica a altura em pixels do objeto. +@param [ofont], object, Indica o objeto do tipo TFont utilizado para definir as características da fonte aplicada na exibição do conteúdo do controle visual. +@param [cmsg], character, Indica a mensagem do tipo dica de contexto \(tooltip/hint\), que será apresentada ao posicionar o ponteiro do mouse sobre o objeto. +@param [bwhen], codeblock, Indica o bloco de código que será executado, quando a mudança de foco da entrada de dados no objeto criado estiver sendo realizada. Se o retorno for verdadeiro \(.T.\) o objeto continua habilitado, caso contrário falso \(.F.\). +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/new +/*/ +method new(nrow, ncol, ownd, nwidth, nheight, ofont, cmsg, bwhen) class ttoolbox +return +/*/{Protheus.doc} ttoolbox:addgroup +Adiciona um grupo. + +@type method + +@param [oobj], object, Indica o objeto \(pai\) que será adicionado no grupo. +@param [cname], character, Indica a descrição do grupo. +@param [oicon], object, Indica o ícone que representará o grupo. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/addgroup +/*/ +method addgroup(oobj, cname, oicon) class ttoolbox +return +/*/{Protheus.doc} ttoolbox:removegroup +Exclui o grupo. + +@type method + +@param [oobj], object, Indica qual objeto \(pai\) será excluído do grupo. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/removegroup +/*/ +method removegroup(oobj) class ttoolbox +return +/*/{Protheus.doc} ttoolbox:setcurrentgroup +Define o grupo corrente. + +@type method + +@param [oobj], object, Indica qual objeto \(pai\) será posicionado. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/setcurrentgroup +/*/ +method setcurrentgroup(oobj) class ttoolbox +return + + +/*/{Protheus.doc} ttree +Cria um objeto do tipo árvore de itens. + +@type binary class + + + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/ttree + +/*/ +class ttree from TControl +data currentnodeid as character +data ncolumns as numeric +data nflags as numeric +data bpromptchanged as codeblock +data bdragnode as codeblock +data bvalidnodes as codeblock +method new() +method beginupdate() +method ptaddnodes() +method ptsendnodes() +method ptaddarraynodes() +method ptsendtree() +method endupdate() +method ptgetprompt() +method ptgetnodecount() +method ptgetnivel() +method ptcollapse() +method ptgototonode() +method ptdeletecurrentnode() +method ptchangeprompt() +method ptchangebmp() +method setscroll() +method ptreset() +method setflags() +method setcolwidth() +method setcolsalign() +end class +/*/{Protheus.doc} ttree:new +Método construtor da classe. + +@type method + +@return object, Nova instância da classe TTree + +@param [ntop], numeric, Indica a coordenada vertical superior do objeto. +@param [nleft], numeric, Indica a coordenada horizontal à esquerda do objeto. +@param [nbottom], numeric, Indica a coordenada vertical inferior do objeto. +@param [nright], numeric, Indica a coordenada horizontal à direita do objeto. +@param [ownd], object, Indica a janela ou controle visual onde o objeto será criado. +@param [bchange], codeblock, Indica o bloco de código que será executado quando o estado ou conteúdo do objeto é modificado pela ação sobre o controle visual. +@param [brclick], codeblock, Indica o bloco de código que será executado quando clicar com o botão direito do mouse sobre o objeto. +@param [cheaders], character, Indica o texto que será exibido no\(s\) cabeçalho\(s\), também definindo a quantidade de colunas que a árvore conterá. Para mais de uma coluna utilize valores separados por ponto e vírgula. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/new +/*/ +method new(ntop, nleft, nbottom, nright, ownd, bchange, brclick, cheaders) class ttree +return +/*/{Protheus.doc} ttree:beginupdate +Prepara a árvore para receber os itens. + +@type method + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/beginupdate +/*/ +method beginupdate() class ttree +return +/*/{Protheus.doc} ttree:ptaddnodes +Adiciona um item no buffer para posteriormente ser enviado à árvore. + +@type method + +@param , character, Nível do item. +@param , character, ID que identificará este item. +@param , character, Compatibilidade. Configure sempre com aspas "". +@param , character, Descrição que será apresentada no item. Para mais de uma coluna utilize valores separados por ponto e vírgula.\* +@param , character, Imagem quando o item da árvore estiver fechado. +@param , character, Imagem quando o item da árvore estiver aberto. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/ptaddnodes +/*/ +method ptaddnodes(cnivel, ciditem, cparam3, cprompt, cfile1, cfile2) class ttree +return +/*/{Protheus.doc} ttree:ptsendnodes +Envia um array pré-definido de itens juntamente com um possível buffer já carregado anteriormente para a árvore. + +@type method + +@param [anodes], array, Indica o array pré-definido com informações para criar a árvore. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/ptsendnodes +/*/ +method ptsendnodes(anodes) class ttree +return +/*/{Protheus.doc} ttree:ptaddarraynodes +Adiciona um array pré-definido de itens no buffer para posteriormente ser enviado à árvore. + +@type method + +@param , array, Indica o array pré-definido com informações para criar a árvore. Para mais informações referente ao formato do array, consulte a área Observações abaixo. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/ptaddarraynodes +/*/ +method ptaddarraynodes(anodes) class ttree +return +/*/{Protheus.doc} ttree:ptsendtree +Envia um array pré-definido de itens juntamente com um possível buffer já carregado anteriormente para a árvore. + +@type method + +@param , array, Indica o array pré-definido com informações para criar a árvore. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/ptsendtree +/*/ +method ptsendtree(anodes) class ttree +return +/*/{Protheus.doc} ttree:endupdate +Encerra a criação dos itens. + +@type method + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/endupdate +/*/ +method endupdate() class ttree +return +/*/{Protheus.doc} ttree:ptgetprompt +Retorna a descrição do item selecionado. + +@type method + +@return character, Retorna a descrição do item selecionado. + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/ptgetprompt +/*/ +method ptgetprompt() class ttree +return +/*/{Protheus.doc} ttree:ptgetnodecount +Retorna o número de itens na árvore. + +@type method + +@return numeric, Retorna o número de itens na árvore. + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/ptgetnodecount +/*/ +method ptgetnodecount() class ttree +return +/*/{Protheus.doc} ttree:ptgetnivel +Retorna o nível do item selecionado. + +@type method + +@return numeric, Retorna o nível do item selecionado, sendo que um item raiz será nível 1, seus filhos nível 2 e assim sucessivamente. + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/ptgetnivel +/*/ +method ptgetnivel() class ttree +return +/*/{Protheus.doc} ttree:ptcollapse +Contrai o item selecionado ocultando seus subitens. + +@type method + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/ptcollapse +/*/ +method ptcollapse() class ttree +return +/*/{Protheus.doc} ttree:ptgototonode +Localiza e seleciona um determinado item. + +@type method + +@param , character, ID que identifica o item a ser localizado e selecionado. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/ptgototonode +/*/ +method ptgototonode(ciditem) class ttree +return +/*/{Protheus.doc} ttree:ptdeletecurrentnode +Exclui o item selecionado e, consequentemente, todos os seus subitens. + +@type method + +@return character, Retorna o ID que identifica o novo item selecionado automaticamente após exclusão. + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/ptdeletecurrentnode +/*/ +method ptdeletecurrentnode() class ttree +return +/*/{Protheus.doc} ttree:ptchangeprompt +Altera a descrição de um item da árvore. + +@type method + +@param , character, Indica a nova descrição do item. Para mais de uma coluna utilize valores separados por ponto e vírgula.\* +@param , character, Indica a chave de identificação do item na árvore. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/ptchangeprompt +/*/ +method ptchangeprompt(cprompt, ciditem) class ttree +return +/*/{Protheus.doc} ttree:ptchangebmp +Altera as imagens definidas para um item da árvore. + +@type method + +@param , character, Imagem quando o item da árvore estiver fechado. +@param , character, Imagem quando o item da árvore estiver aberto. +@param , character, Indica a chave de identificação do item na árvore. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/ptchangebmp +/*/ +method ptchangebmp(cfile1, cfile2, ciditem) class ttree +return +/*/{Protheus.doc} ttree:setscroll +Define a barra de rolagem da árvore. + +@type method + +@param , numeric, Indica o tipo \(1 = horizontal e 2 = vertical\) da barra de rolagem. +@param , logical, Indica se habilita \(.T.\) ou desabilita \(.F.\) a barra de rolagem. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/setscroll +/*/ +method setscroll(ntipo, lhabilita) class ttree +return +/*/{Protheus.doc} ttree:ptreset +Limpa todos os itens da árvore. + +@type method + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/ptreset +/*/ +method ptreset() class ttree +return +/*/{Protheus.doc} ttree:setflags +Habilita/Desabilita certas funcionalidades do componente. + +@type method + +@param , numeric, Valor que representa a\(s\) funcionalidade\(s\) a ser\(em\) habilitada\(s\). Valores de flags podem ser somados para que mais de uma funcionalidade seja habilitada ao mesmo tempo. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/setflags +/*/ +method setflags(nflags) class ttree +return +/*/{Protheus.doc} ttree:setcolwidth +Define a largura de uma coluna. + +@type method + +@param , numeric, Número da coluna a ser alterada \(começando por 1\). +@param , numeric, Tamanho em píxels da largura a ser definida para a coluna. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/setcolwidth +/*/ +method setcolwidth(ncol, nwidth) class ttree +return +/*/{Protheus.doc} ttree:setcolsalign +Define o alinhamento das informações nas colunas. + +@type method + +@param , array, Array contendo informações sobre a coluna desejada e seu novo alinhamento no formato: \{\{coluna, alinhamento\}, \{coluna, alinhamento\}\}. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/setcolsalign +/*/ +method setcolsalign(ainfo) class ttree +return + + +/*/{Protheus.doc} twebchannel +Cria um objeto para comunicação entre o SmartClient e o Componente TWebEngine através do protocolo WebSocket. + +@type binary class + + + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/twebchannel + +/*/ +class twebchannel +data lconnected as logical +data bjstoadvpl as codeblock +data nport as numeric +method new() +method connect() +method disconnect() +method advpltojs() +end class +/*/{Protheus.doc} twebchannel:new +Método construtor da classe. + +@type method + +@return object, Nova instância da classe TWebChannel + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/new +/*/ +method new() class twebchannel +return +/*/{Protheus.doc} twebchannel:connect +Executa a conexão entre o Navegador \(TWebEngine\) e o SmartClient. + +@type method + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/connect +/*/ +method connect() class twebchannel +return +/*/{Protheus.doc} twebchannel:disconnect +Executa a desconexão entre o Navegador \(TWebEngine\) e o SmartClient. + +@type method + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/disconnect +/*/ +method disconnect() class twebchannel +return +/*/{Protheus.doc} twebchannel:advpltojs +Executa o envio de informações para a pagina HTML carregada no componente TWebEngine que esta configurado para a Porta do TWebChannel. Assim é possivel, por exemplo, injetar um trecho JavaScript na página via ADVPL. + +@type method + +@param , character, Indica o tipo de mensagem que será enviada à página HTML. +@param , character, Indica o conteudo que será enviado à pagina HTML. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/advpltojs +/*/ +method advpltojs(ccodetype, ccontent) class twebchannel +return + + +/*/{Protheus.doc} twebengine +Cria um objeto para manipular uma página HTML, trocando informações em tempo real entre o SmartClient e o Navegador através do protocolo WebSocket. + +@type binary class + + + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/twebengine + +/*/ +class twebengine from TControl +data curl as character +data bloadfinished as codeblock +data bdlstatus as codeblock +data clang as character +data bjsconmsg as codeblock +method new() +method navigate() +method runjavascript() +method goback() +method goforward() +method setasmain() +method sethtml() +method clearcache() +method reload() +end class +/*/{Protheus.doc} twebengine:new +M�todo construtor da classe. + +@type method + +@return object, Nova instância da classe TWebEngine + +@param [ownd], object, Indica a janela ou controle visual onde o objeto será criado. +@param [nrow], numeric, Indica a coordenada vertical em pixels ou caracteres. +@param [ncol], numeric, Indica a coordenada horizontal em pixels ou caracteres. +@param [nwidth], numeric, Indica a largura em pixels do objeto. +@param [nheight], numeric, Indica a altura em pixels do objeto. +@param [curl], character, Indica a URL a ser executada, em schemas como: http:// https:// ou file:// +@param [nport], numeric, Porta do WebSocket para comunicação entre o Navegador e o SmartClient +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/new +/*/ +method new(ownd, nrow, ncol, nwidth, nheight, curl, nport) class twebengine +return +/*/{Protheus.doc} twebengine:navigate +Executa a navegação para URL selecionada + +@type method + +@param , character, Indica a URL a ser executada, em schemas como: http:// https:// ou file:// +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/navigate +/*/ +method navigate(curl) class twebengine +return +/*/{Protheus.doc} twebengine:runjavascript +Executa uma instrução JavaScript na página carregada. + +@type method + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/runjavascript +/*/ +method runjavascript() class twebengine +return +/*/{Protheus.doc} twebengine:goback +Retorno à página anterior, caso exista. + +@type method + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/goback +/*/ +method goback() class twebengine +return +/*/{Protheus.doc} twebengine:goforward +Avança para página posterior, caso exista. + +@type method + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/goforward +/*/ +method goforward() class twebengine +return +/*/{Protheus.doc} twebengine:setasmain +Indica ao SmartClient que o navegador em questão será o principal, recebendo a intrução para executar o comando goBack\(\) através da tecla KEY_BACK do dipositivo Móvel.. + +@type method + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/setasmain +/*/ +method setasmain() class twebengine +return +/*/{Protheus.doc} twebengine:sethtml +Renderiza e exibe o código HTML informado. + +@type method + +@param , character, Deve conter o código HTML. +@param [cbaseurl], character, Usado para resolver URLs relativas no documento, como imagens referenciadas ou folhas de estilo. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/sethtml +/*/ +method sethtml(chtml, cbaseurl) class twebengine +return +/*/{Protheus.doc} twebengine:clearcache +Limpa o cache de navegação. + +@type method + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/clearcache +/*/ +method clearcache() class twebengine +return +/*/{Protheus.doc} twebengine:reload +Recarrega a página corrente. + +@type method + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/reload +/*/ +method reload() class twebengine +return + + +/*/{Protheus.doc} twindow +Cria a janela principal do programa. + +@type binary class + + + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/twindow + +/*/ +class twindow from TSrvObject +data bstart as codeblock +data omenu as object +data lescclose as logical +data nresult as numeric +data bwindowstate as codeblock +data bfocuschange as codeblock +method new() +method activate() +method center() +method commitcontrols() +method ctrlrefresh() +method end() +method hasfocus() +method setmenu() +method windowstate() +end class +/*/{Protheus.doc} twindow:new +Método construtor da classe. + +@type method + +@return object, Nova instância da classe TWindow + +@param [ntop], numeric, Indica a coordenada vertical superior em pixels ou caracteres. +@param [nleft], numeric, Indica a coordenada horizontal esquerda em pixels ou caracteres. +@param [nbottom], numeric, Indica a coordenada vertical inferior em pixels ou caracteres. +@param [nright], numeric, Indica a coordenada horizontal direita em pixels ou caracteres. +@param [ctitle], character, Indica o título da janela. +@param [uparam6], numeric, Compatibility parameter. Pass NIL. +@param [uparam7], object, Compatibility parameter. Pass NIL. +@param [uparam8], object, Compatibility parameter. Pass NIL. +@param [uparam9], object, Compatibility parameter. Pass NIL. +@param [oparent], object, Indica a janela mãe \(principal\) da janela corrente. +@param [uparam11], logical, Compatibility parameter. Pass NIL. +@param [uparam12], logical, Compatibility parameter. Pass NIL. +@param [nclrfore], numeric, Indica a cor do texto da janela. +@param [nclrback], numeric, Indica a cor do fundo da janela. +@param [uparam15], object, Compatibility parameter. Pass NIL. +@param [uparam16], character, Compatibility parameter. Pass NIL. +@param [uparam17], logical, Compatibility parameter. Pass NIL. +@param [uparam18], logical, Compatibility parameter. Pass NIL. +@param [uparam19], logical, Compatibility parameter. Pass NIL. +@param [uparam20], logical, Compatibility parameter. Pass NIL. +@param [lpixel], logical, Indica se considera as coordenadas passadas em pixels \(.T.\) ou caracteres \(.F.\). +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/new +/*/ +method new(ntop, nleft, nbottom, nright, ctitle, uparam6, uparam7, uparam8, uparam9, oparent, uparam11, uparam12, nclrfore, nclrback, uparam15, uparam16, uparam17, uparam18, uparam19, uparam20, lpixel) class twindow +return +/*/{Protheus.doc} twindow:activate +Apresenta a janela. + +@type method + +@param [cshow], character, Indica se a janela será minimizada \(Iconized\) ou maximizada \(Maximized\). +@param [uparam2], codeblock, Compatibility parameter. Pass NIL. +@param [uparam3], codeblock, Compatibility parameter. Pass NIL. +@param [uparam4], codeblock, Compatibility parameter. Pass NIL. +@param [uparam5], codeblock, Compatibility parameter. Pass NIL. +@param [uparam6], codeblock, Compatibility parameter. Pass NIL. +@param [uparam7], codeblock, Compatibility parameter. Pass NIL. +@param [uparam8], codeblock, Compatibility parameter. Pass NIL. +@param [uparam9], codeblock, Compatibility parameter. Pass NIL. +@param [uparam10], codeblock, Compatibility parameter. Pass NIL. +@param [uparam11], codeblock, Compatibility parameter. Pass NIL. +@param [uparam12], codeblock, Compatibility parameter. Pass NIL. +@param [uparam13], codeblock, Compatibility parameter. Pass NIL. +@param [uparam14], codeblock, Compatibility parameter. Pass NIL. +@param [uparam15], codeblock, Compatibility parameter. Pass NIL. +@param [uparam16], codeblock, Compatibility parameter. Pass NIL. +@param [uparam17], codeblock, Compatibility parameter. Pass NIL. +@param [uparam18], codeblock, Compatibility parameter. Pass NIL. +@param [uparam19], codeblock, Compatibility parameter. Pass NIL. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/activate +/*/ +method activate(cshow, uparam2, uparam3, uparam4, uparam5, uparam6, uparam7, uparam8, uparam9, uparam10, uparam11, uparam12, uparam13, uparam14, uparam15, uparam16, uparam17, uparam18, uparam19) class twindow +return +/*/{Protheus.doc} twindow:center +Centraliza a janela. + +@type method + +@param [lcenter], logical, Define se a janela será centralizada ou não. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/center +/*/ +method center(lcenter) class twindow +return +/*/{Protheus.doc} twindow:commitcontrols +Força a atualização da informação contida no componente atualmente com foco entre o SmartClient e o AppServer. + +@type method + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/commitcontrols +/*/ +method commitcontrols() class twindow +return +/*/{Protheus.doc} twindow:ctrlrefresh +Força a atualização do objeto. + +@type method + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/ctrlrefresh +/*/ +method ctrlrefresh() class twindow +return +/*/{Protheus.doc} twindow:end +Finaliza a janela. + +@type method + +@return logical, Retorna verdadeiro \(.T.\) se finalizar a janela. Caso contrário, retorna falso \(.F.\). + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/end +/*/ +method end() class twindow +return +/*/{Protheus.doc} twindow:hasfocus +Indica se a janela esta em foco. + +@type method + +@return logical, Retorna verdadeiro \(.T.\) se o componente está em foco. Caso contrário, falso \(.F.\). + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/hasfocus +/*/ +method hasfocus() class twindow +return +/*/{Protheus.doc} twindow:setmenu +Define o objeto que será o menu da janela. + +@type method + +@param [omenu], object, Indica o objeto do tipo TMenuBar que será criado no controle visual. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/setmenu +/*/ +method setmenu(omenu) class twindow +return +/*/{Protheus.doc} twindow:windowstate +Indica o estado atual do componente. + +@type method + +@return numeric, Retorna um número inteiro indicando o estado atual do componente, sendo: 0=Restaurado 1=Minimizado 2=Maximizado + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/windowstate +/*/ +method windowstate() class twindow +return + + +/*/{Protheus.doc} twsdlmanager +A classe TWsdlManager faz o tratamento para arquivos WSDL \(Web Services Description Language\). Esta classe implementa métodos para identificação das informações de envio e resposta das operações definidas, além de métodos para envio e recebimento do documento SOAP. + +@type binary class + + + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/twsdlmanager + +/*/ +class twsdlmanager +data lverbose as logical +data lstatus as logical +data lrememptytags as logical +data lenableoptattr as logical +data ccurrentoperation as character +data ntimeout as numeric +data nconnecttimeout as numeric +data lprocresp as logical +data cerror as character +data cfaultcode as character +data cfaultsubcode as character +data cfaultstring as character +data cfaultactor as character +data clocation as character +data nsslversion as numeric +data csslcacertfile as character +data csslcertfile as character +data csslkeyfile as character +data csslkeypwd as character +data lusensprefix as logical +data lcheckinput as logical +data lcompressed as logical +data lsslinsecure as logical +data lalwayssendsa as logical +method new() +method parsefile() +method parseurl() +method listoperations() +method setoperation() +method getwsdldoc() +method simpleinput() +method complexinput() +method simpleoutput() +method complexoutput() +method simplefault() +method complexfault() +method setcomplexoccurs() +method setvalue() +method setvalues() +method setfirst() +method setfirstarray() +method setvalpar() +method setvalpararray() +method addhttpheader() +method setwssheader() +method getsoapmsg() +method sendsoapmsg() +method getsoapresponse() +method getparsedresponse() +method setproxy() +method getproxy() +method setcredentials() +method getcredentials() +method setauthentication() +method getauthentication() +method nextcomplex() +method getservices() +method getports() +method setport() +end class +/*/{Protheus.doc} twsdlmanager:new +Cria uma nova instância da classe TWsdlManager. + +@type method + +@return object, Nova instância da classe TWsdlManager + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/new +/*/ +method new() class twsdlmanager +return +/*/{Protheus.doc} twsdlmanager:parsefile +Realiza o parse de um arquivo WSDL através do parâmetro recebido indicando o local do mesmo. + +@type method + +@return logical, Retorna verdadeiro \(.T.\) caso tenha sido realizado o parse com sucesso. Falso \(.F.\) caso contrário. + +@param , character, Indica o diretório, a partir do rootpath, e o nome de um arquivo WSDL. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/parsefile +/*/ +method parsefile(cfile) class twsdlmanager +return +/*/{Protheus.doc} twsdlmanager:parseurl +Realiza o parse de uma URL que aponta para um arquivo WSDL através do parâmetro recebido indicando o local do mesmo. + +@type method + +@return logical, Retorna verdadeiro \(.T.\) caso tenha sido realizado o parse com sucesso. Falso \(.F.\) caso contrário. + +@param , character, Indica a URL apontando para um arquivo WSDL. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/parseurl +/*/ +method parseurl(curl) class twsdlmanager +return +/*/{Protheus.doc} twsdlmanager:listoperations +Lista as operações disponibilizadas pelo WebService através do documento WSDL. + +@type method + +@return array, Retorna um array com as operações disponibilizadas. + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/listoperations +/*/ +method listoperations() class twsdlmanager +return +/*/{Protheus.doc} twsdlmanager:setoperation +O método define a operação que será realizada. + +@type method + +@return logical, Verdadeiro \(.T.\) caso consiga definir; falso \(.F.\) caso contrário. + +@param , character, Nome da operação que será realizada. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/setoperation +/*/ +method setoperation(coperation) class twsdlmanager +return +/*/{Protheus.doc} twsdlmanager:getwsdldoc +Retorna a documentação do documento WSDL. + +@type method + +@return character, Retorna a documentação do documento WSDL ou uma string vazia caso não exista. + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/getwsdldoc +/*/ +method getwsdldoc() class twsdlmanager +return +/*/{Protheus.doc} twsdlmanager:simpleinput +Retorna os tipos simples utilizados na mensagem do tipo input para a operação definida. + +@type method + +@return array, Retorna um array contendo os tipos simples da mensagem do tipo input da operação atual. + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/simpleinput +/*/ +method simpleinput() class twsdlmanager +return +/*/{Protheus.doc} twsdlmanager:complexinput +Retorna os tipos complexos utilizados na mensagem do tipo input para a operação definida que possuem número variável de ocorrências \(minOccurs < maxOccurs\). + +@type method + +@return array, Retorna um array contendo os tipos complexos da mensagem do tipo input da operação atual com número variável de ocorrências. + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/complexinput +/*/ +method complexinput() class twsdlmanager +return +/*/{Protheus.doc} twsdlmanager:simpleoutput +Retorna os tipos simples utilizados na mensagem do tipo output para a operação definida. + +@type method + +@return array, Retorna um array contendo os tipos simples da mensagem do tipo output da operação atual. + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/simpleoutput +/*/ +method simpleoutput() class twsdlmanager +return +/*/{Protheus.doc} twsdlmanager:complexoutput +Retorna os tipos complexos utilizados na mensagem do tipo output para a operação definida. + +@type method + +@return array, Retorna um array contendo os tipos complexos da mensagem do tipo output da operação atual. + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/complexoutput +/*/ +method complexoutput() class twsdlmanager +return +/*/{Protheus.doc} twsdlmanager:simplefault +Retorna os tipos simples utilizados em mensagens do tipo fault para a operação definida. + +@type method + +@return array, Retorna um array contendo os tipos simples das mensagens do tipo fault da operação atual. + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/simplefault +/*/ +method simplefault() class twsdlmanager +return +/*/{Protheus.doc} twsdlmanager:complexfault +Retorna os tipos complexos utilizados em mensagens do tipo fault para a operação definida. + +@type method + +@return array, Retorna um array contendo os tipos complexos das mensagens do tipo fault da operação atual. + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/complexfault +/*/ +method complexfault() class twsdlmanager +return +/*/{Protheus.doc} twsdlmanager:setcomplexoccurs +O método define o número de vezes que um elemento do tipo complexo vai aparecer. + +@type method + +@return logical, Verdadeiro \(.T.\) caso consiga definir. Falso \(.F.\) caso contrário. + +@param , numeric, ID do elemento igual ao informado pelo método [NextComplex](TWsdlManager:NextComplex). +@param , numeric, Quantidade de vezes que o elemento vai aparecer. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/setcomplexoccurs +/*/ +method setcomplexoccurs(nid, nvalue) class twsdlmanager +return +/*/{Protheus.doc} twsdlmanager:setvalue +O método define o valor de entrada para um elemento do tipo simples do WSDL. + +@type method + +@return logical, Verdadeiro \(.T.\) caso consiga definir; falso \(.F.\) caso contrário. + +@param , numeric, ID do elemento igual ao informado pela função [SimpleInput](TWsdlManager:SimpleInput). +@param , character, Valor para esse elemento. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/setvalue +/*/ +method setvalue(nid, cvalue) class twsdlmanager +return +/*/{Protheus.doc} twsdlmanager:setvalues +O método define um vetor de valores de entrada para um elemento do tipo simples do WSDL. + +@type method + +@return logical, Verdadeiro \(.T.\) caso consiga definir; falso \(.F.\) caso contrário. + +@param , numeric, ID do elemento igual ao informada pela função [SimpleInput](TWsdlManager:SimpleInput). +@param , array, Vetor de valores para esse elemento. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/setvalues +/*/ +method setvalues(nid, avalues) class twsdlmanager +return +/*/{Protheus.doc} twsdlmanager:setfirst +O método define o valor de entrada para a primeira ocorrência de um elemento do tipo simples do WSDL. + +@type method + +@return logical, Verdadeiro \(.T.\) caso consiga definir; falso \(.F.\) caso contrário. + +@param , character, Nome do elemento igual ao informado pela função [SimpleInput](TWsdlManager:SimpleInput). +@param , character, Valor para esse elemento. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/setfirst +/*/ +method setfirst(cname, cvalue) class twsdlmanager +return +/*/{Protheus.doc} twsdlmanager:setfirstarray +O método define um vetor de valores de entrada para a primeira ocorrência de um elemento do tipo simples do WSDL. + +@type method + +@return logical, Verdadeiro \(.T.\) caso consiga definir; falso \(.F.\) caso contrário. + +@param , character, Nome do elemento igual ao informado pela função [SimpleInput](TWsdlManager:SimpleInput). +@param , array, Vetor de valores para esse elemento. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/setfirstarray +/*/ +method setfirstarray(cname, avalues) class twsdlmanager +return +/*/{Protheus.doc} twsdlmanager:setvalpar +O método define o valor de entrada para um elemento do tipo simples do WSDL, dado os elementos pais. + +@type method + +@return logical, Verdadeiro \(.T.\) caso consiga definir; falso \(.F.\) caso contrário. + +@param , character, Nome do elemento igual ao informado pela função [SimpleInput](TWsdlManager:SimpleInput). +@param , array, Vetor com os nomes dos elementos pais de **cName**. +@param , character, Valor para esse elemento. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/setvalpar +/*/ +method setvalpar(cname, aparents, cvalue) class twsdlmanager +return +/*/{Protheus.doc} twsdlmanager:setvalpararray +O método define um vetor de valores de entrada para um elemento do tipo simples do WSDL, dado os elementos pais. + +@type method + +@return logical, Verdadeiro \(.T.\) caso consiga definir; falso \(.F.\) caso contrário. + +@param , character, Nome do elemento igual ao informado pela função [SimpleInput](TWsdlManager:SimpleInput). +@param , array, Vetor com os elementos pais de **cName**. +@param , array, Vetor de valores para esse elemento. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/setvalpararray +/*/ +method setvalpararray(cname, aparents, avalues) class twsdlmanager +return +/*/{Protheus.doc} twsdlmanager:addhttpheader +O método adiciona um cabeçalho HTTP à lista de cabeçalhos que serão enviados na mensagem SOAP destinada ao servidor WSDL. + +@type method + +@return logical, Verdadeiro \(.T.\) caso consiga adicionar. Falso \(.F.\) caso contrário. + +@param , character, Nome do cabeçalho que será adicionado. +@param , character, Valor do cabeçalho que será adicionado. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/addhttpheader +/*/ +method addhttpheader(cname, cvalue) class twsdlmanager +return +/*/{Protheus.doc} twsdlmanager:setwssheader +O método adiciona ao cabeçalho da mensagem SOAP uma string contendo as tags de cabeçalho WS-Security. + +@type method + +@param , character, Conteúdo que será inserido no cabeçalho da mensagem SOAP, exatamente como for passado. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/setwssheader +/*/ +method setwssheader(cheader) class twsdlmanager +return +/*/{Protheus.doc} twsdlmanager:getsoapmsg +Retorna o documento SOAP que será enviado ao servidor. + +@type method + +@return character, Retorna o documento SOAP que será enviado ao servidor. + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/getsoapmsg +/*/ +method getsoapmsg() class twsdlmanager +return +/*/{Protheus.doc} twsdlmanager:sendsoapmsg +Envio o documento SOAP gerado ao endereço definido. + +@type method + +@return logical, Verdadeiro \(.T.\) caso consiga enviar o documento e receber a reposta do servidor. Falso \(.F.\) caso contrário. + +@param [cmsg], character, Indica a mensagem SOAP que será enviada, ao invés da mensagem gerada pela classe usando os valores que foram definidos. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/sendsoapmsg +/*/ +method sendsoapmsg(cmsg) class twsdlmanager +return +/*/{Protheus.doc} twsdlmanager:getsoapresponse +Retorna o documento SOAP de resposta recebido do servidor. + +@type method + +@return character, Retorna o documento SOAP de resposta recebido do servidor. + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/getsoapresponse +/*/ +method getsoapresponse() class twsdlmanager +return +/*/{Protheus.doc} twsdlmanager:getparsedresponse +Retorna uma string contendo a mensagem SOAP de resposta parseada. + +@type method + +@return character, Retorna uma string contendo a mensagem SOAP de resposta parseada. + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/getparsedresponse +/*/ +method getparsedresponse() class twsdlmanager +return +/*/{Protheus.doc} twsdlmanager:setproxy +Define o host e porta do proxy para fazer a conexão HTTP. + +@type method + +@param , character, Indica o host do proxy para fazer a conexão HTTP. +@param , numeric, Indica a porta do proxy para fazer a conexão HTTP. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/setproxy +/*/ +method setproxy(chost, nport) class twsdlmanager +return +/*/{Protheus.doc} twsdlmanager:getproxy +Retorna o host e porta do proxy para fazer a conexão HTTP. + +@type method + +@return logical, Retorna se o proxy está habilitado \(.T.\) ou não \(.F.\). + +@param <@chost>, character, Indica o host do proxy para fazer a conexão HTTP. +@param <@nport>, numeric, Indica a porta do proxy para fazer a conexão HTTP. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/getproxy +/*/ +method getproxy(chost, nport) class twsdlmanager +return +/*/{Protheus.doc} twsdlmanager:setcredentials +Define o usuário e senha do proxy para fazer a conexão HTTP. + +@type method + +@param , character, Indica o usuário do proxy para fazer a conexão HTTP. +@param , character, Indica a senha do proxy para fazer a conexão HTTP. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/setcredentials +/*/ +method setcredentials(cuser, cpass) class twsdlmanager +return +/*/{Protheus.doc} twsdlmanager:getcredentials +Retorna o usuário e senha do proxy para fazer a conexão HTTP. + +@type method + +@return logical, Retorna se o proxy está habilitado \(.T.\) ou não \(.F.\). + +@param <@cuser>, character, Indica o usuário do proxy para fazer a conexão HTTP. +@param <@cpass>, character, Indica a senha do proxy para fazer a conexão HTTP. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/getcredentials +/*/ +method getcredentials(cuser, cpass) class twsdlmanager +return +/*/{Protheus.doc} twsdlmanager:setauthentication +Define o usuário e senha usados para fazer autenticação HTTP. + +@type method + +@param , character, Indica o usuário usado para fazer autenticação HTTP. +@param , character, Indica a senha usada para fazer autenticação HTTP. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/setauthentication +/*/ +method setauthentication(cuser, cpass) class twsdlmanager +return +/*/{Protheus.doc} twsdlmanager:getauthentication +Retorna o usuário e senha usados para fazer autenticação HTTP. + +@type method + +@return logical, Retorna se a autenticação HTTP está habilitada \(.T.\) ou não \(.F.\). + +@param <@cuser>, character, Indica o usuário usado para fazer autenticação HTTP. +@param <@cpass>, character, Indica a senha usada para fazer autenticação HTTP. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/getauthentication +/*/ +method getauthentication(cuser, cpass) class twsdlmanager +return +/*/{Protheus.doc} twsdlmanager:nextcomplex +Retorna o elemento de tipo complexo que necessita definir o número de ocorrências \(minOccurs < maxOccurs\). Esse método deve ser chamado enquanto retornar um array com os dados do elemento complexo, e logo após deve ser chamado o método [SetComplexOccurs](TWsdlManager:SetComplexOccurs), definido o número de ocorrências do elemento. + +@type method + +@return array, Retorna um array contendo os dados do elemento de tipo complexo da mensagem da operação atual com número variável de ocorrências. Em caso de não ter mais elementos complexos a serem definidos, ou não ter algum elemento complexo que necessite de definição do número de ocorrências, o método retorna **Nil**. + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/nextcomplex +/*/ +method nextcomplex() class twsdlmanager +return +/*/{Protheus.doc} twsdlmanager:getservices +Retorna a lista de serviços disponíveis no Web Service. + +@type method + +@return array, Retorna um array contendo o nome dos serviços declarados no Web Service. + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/getservices +/*/ +method getservices() class twsdlmanager +return +/*/{Protheus.doc} twsdlmanager:getports +Retorna a lista de ports declarados apara o primeiro serviço do Web Service. + +@type method + +@return array, Retorna um array contendo as informações de cada port do primeiro serviço do Web Service. + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/getports +/*/ +method getports() class twsdlmanager +return +/*/{Protheus.doc} twsdlmanager:setport +Define o port ativo para o primeiro serviço disponível no Web Service. + +@type method + +@return logical, Retorna verdadeiro \(.T.\) se o port foi ativo com sucesso; caso contrário, retorna falso \(.F.\). + +@param , character, Indica o nome do port que será atvio. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/setport +/*/ +method setport(cport) class twsdlmanager +return + + diff --git a/.vscode/.advpl/_binary_functions.prw b/.vscode/.advpl/_binary_functions.prw new file mode 100644 index 0000000..b1ad9a1 --- /dev/null +++ b/.vscode/.advpl/_binary_functions.prw @@ -0,0 +1,9808 @@ +#include "protheus.ch" +#xtranslate binary function => function x_ + +/*/{Protheus.doc} changequery +Esta função tem como objetivo retornar uma query modificada de acordo a escrita adequada para o banco de dados em uso. + +@type binary function +@sintax ChangeQuery() => character +@return character, String contendo a query com os ajustes e compatibilizações necessárias para ser executada execução através da conexão com o SGDB atual. + +@param , character, String contendo query de consulta de dados \( SELECT \) a ser avaliado. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/changequery +/*/ +binary function changequery(cquery) +return + + +/*/{Protheus.doc} dbapp +Esta função faz migração de dados de uma tabela/arquivo para tabela/arquivo + +@type binary function +@sintax DBApp(, [aFields], [bFirstCondition], [bSecondCondition], [nCount], [nRecno], [xRest], [cRDD]) => Nil +@return Nil, Sempre retorna nulo. + +@param , character, String contendo o nome da tabela origem. +@param [afields], array, Array com campos TODO. +@param [bfirstcondition], codeblock, Primeiro Code Block com condição para inserir registro. +@param [bsecondcondition], codeblock, Segundo Code Block com condição para inserir registro. +@param [ncount], numeric, Numero maximo de registros a ser processado. +@param [nrecno], numeric, Unico registro a ser processado. +@param [xrest], variant, Compatibilidade. +@param [crdd], character, RDD utilizado para abertura da tabela cSource. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/dbapp +/*/ +binary function dbapp(csource, afields, bfirstcondition, bsecondcondition, ncount, nrecno, xrest, crdd) +return + + +/*/{Protheus.doc} dbcopy +Esta função cria a tabela com a estrutura e dados da tabela corrente. + +@type binary function +@sintax DBCopy(, [aFields], [bFirstCondition], [bSecondCondition], [nCount], [nRecno], [xRest], [cRDD]) => Nil +@return Nil, Sempre retorna nulo. + +@param , character, String contendo o nome da nova tabela. +@param [afields], array, Array com campos para ser criados. +@param [bfirstcondition], codeblock, Primeiro Code Block com condição para inserir registro. +@param [bsecondcondition], codeblock, Segundo Code Block com condição para inserir registro. +@param [ncount], numeric, Numero maximo de registros a ser processado. +@param [nrecno], numeric, Unico registro a ser processado. +@param [xrest], logical, Compatibilidade. +@param [crdd], character, RDD utilizado para abertura da tabela cSource. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/dbcopy +/*/ +binary function dbcopy(cfile, afields, bfirstcondition, bsecondcondition, ncount, nrecno, xrest, crdd) +return + + +/*/{Protheus.doc} dbdelim +Esta função cria um arquivo no Local File com a estrutura e dados da tabela corrente. + +@type binary function +@sintax DBDelim(, , [cDelim], [aFields], [bFirstCondition], [bSecondCondition], [nCount], [nRecno], [lRest]) => Nil +@return Nil, Sempre retorna nulo. + +@param , logical, Realizar a cópia ou não +@param , character, String contendo o diretorio e nome do arquivo aonde será salvo +@param [cdelim], character, Delimitador +@param [afields], array, Array com campos para ser criados. +@param [bfirstcondition], codeblock, Primeiro Code Block com condição para inserir registro. +@param [bsecondcondition], codeblock, Segundo Code Block com condição para inserir registro. +@param [ncount], numeric, Numero maximo de registros a ser processado. +@param [nrecno], numeric, Unico registro a ser processado. +@param [lrest], logical, Compatibilidade. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/dbdelim +/*/ +binary function dbdelim(lcopy, cfile, cdelim, afields, bfirstcondition, bsecondcondition, ncount, nrecno, lrest) +return + + +/*/{Protheus.doc} dblocate1 +Esta função seleciona o recno dependendo das condições passadas. + +@type binary function +@sintax DBLocate1([bFirstCondition], [bSecondCondition], [nCount], [xRecno], [lRest]) => Nil +@return Nil, Sempre retorna nulo. + +@param [bfirstcondition], codeblock, Primeiro Code Block com condição para encontrar o registro. +@param [bsecondcondition], codeblock, Segundo Code Block com condição para encontrar o registro. +@param [ncount], numeric, Numero maximo de registros a ser processado. +@param [xrecno], variant, Unico registro a ser processado. +@param [lrest], logical, Compatibilidade. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/dblocate1 +/*/ +binary function dblocate1(bfirstcondition, bsecondcondition, ncount, xrecno, lrest) +return + + +/*/{Protheus.doc} dbsdf +Esta função cria um arquivo no Local File com a estrutura e dados da tabela corrente. + +@type binary function +@sintax DBSdf(, , [aFields], [bFirstCondition], [bSecondCondition], [nCount], [nRecno], [lRest]) => Nil +@return Nil, Sempre retorna nulo. + +@param , logical, Realizar a cópia ou não +@param , character, String contendo o diretorio e nome do arquivo aonde será salvo +@param [afields], array, Array com campos para ser criados. +@param [bfirstcondition], codeblock, Primeiro Code Block com condição para inserir registro. +@param [bsecondcondition], codeblock, Segundo Code Block com condição para inserir registro. +@param [ncount], numeric, Numero maximo de registros a ser processado. +@param [nrecno], numeric, Unico registro a ser processado. +@param [lrest], logical, Compatibilidade. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/dbsdf +/*/ +binary function dbsdf(lcopy, cfile, afields, bfirstcondition, bsecondcondition, ncount, nrecno, lrest) +return + + +/*/{Protheus.doc} dbzap +Exclui todos os registros da tabela/arquivo. + +@type binary function +@sintax DBZap() => Nil +@return Nil, Retorno sempre é nulo. + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/dbzap +/*/ +binary function dbzap() +return + + +/*/{Protheus.doc} hextodec +Converte um número da base hexadecimal para base decimal. + +@type binary function +@sintax hextodec([cHex]) => numeric +@return numeric, Retorna um número em base decimal + +@param [chex], character, Valor hexadecimal a ser convertido +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/hextodec +/*/ +binary function hextodec(chex) +return + + +/*/{Protheus.doc} dbskipper +Desloca para outro registro da tabela/arquivo. + +@type binary function +@sintax DBSkipper([nCount]) => numeric +@return numeric, Retorno a quantidade de registros deslocados. + +@param [ncount], numeric, Numero maximo de registros a ser deslocados \(Pode ser numero negativo\) +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/dbskipper +/*/ +binary function dbskipper(ncount) +return + + +/*/{Protheus.doc} aadd +Inclui um elemento no array e ao elemento, do array recém-criado, é atribuído o valor especificado por parâmetro. + +@type binary function +@sintax AAdd(, ) => variant +@return variant, Retorna o valor especificado em <**xExpr**>. + +@param , array, Indica o array que receberá o novo elemento. +@param , variant, Indica uma expressão válida que será o valor do novo elemento. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/aadd +/*/ +binary function aadd(adest, xexpr) +return + + +/*/{Protheus.doc} ablavailable +descrição da funcao + +@type binary function +@sintax AblAvailable([@tNomeVar]) => codeblock +@return codeblock, descrição do retorno + +@param [@tnomevar], codeblock, descrição do parametro +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/ablavailable +/*/ +binary function ablavailable(tnomevar) +return + + +/*/{Protheus.doc} abs +Retorna o valor absoluto \(independente do sinal\) de uma expressão numérica. + +@type binary function +@sintax Abs() => numeric +@return numeric, Retorna um número que representa o valor absoluto da expressão informada. O valor será um número positivo ou zero. + +@param , numeric, Indica a expressão que será avaliada. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/abs +/*/ +binary function abs(nexp) +return + + +/*/{Protheus.doc} acopy +Copia elementos de um array para outro. + +@type binary function +@sintax ACopy(, , [nInicio], [nCont], [nPosDestino]) => array +@return array, Retorna uma referência do array aDestino. + +@param , array, Indica o array onde estão os elementos que serão copiados. +@param , array, Indica o array de destino onde os elementos serão copiados. +@param [ninicio], numeric, Indica o elemento inicial do array aOrigem a partir do qual os conteúdos serão copiados. Caso não seja especificado, o valor padrão será um \(1\). +@param [ncont], numeric, Indica a quantidade de elementos que serão copiados do array a partir do nInicio. Caso não seja especificado, será copiado do nInicio até o último elemento. +@param [nposdestino], numeric, Indica a partir de qual posição do array aDestino os elementos serão copiados. Caso não seja especificado, o valor padrão é um \(1\). +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/acopy +/*/ +binary function acopy(aorigem, adestino, ninicio, ncont, nposdestino) +return + + +/*/{Protheus.doc} acos +Calcula o valor em radianos do arco cosseno de um valor que representa o cosseno de um ângulo. + +@type binary function +@sintax ACos() => numeric +@return numeric, Retorna um valor entre 0 e PI radianos. + +@param , numeric, Indica o valor que representa o cosseno de um ângulo. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/acos +/*/ +binary function acos(ncos) +return + + +/*/{Protheus.doc} addcssrule +descrição da funcao + +@type binary function +@sintax addcssrule([@tNomeVar]) => codeblock +@return codeblock, descrição do retorno + +@param [@tnomevar], codeblock, descrição do parametro +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/addcssrule +/*/ +binary function addcssrule(tnomevar) +return + + +/*/{Protheus.doc} addfontalias +descrição da funcao + +@type binary function +@sintax addfontalias([@tNomeVar]) => codeblock +@return codeblock, descrição do retorno + +@param [@tnomevar], codeblock, descrição do parametro +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/addfontalias +/*/ +binary function addfontalias(tnomevar) +return + + +/*/{Protheus.doc} adel +Elimina um elemento do array e "arrasta" os demais para trás tornando nulo o último elemento. + +@type binary function +@sintax ADel(, ) => array +@return array, Retorna o array especificado em <**aSource**>. + +@param , array, Indica o array que contém um elemento para ser eliminado. +@param , numeric, Indica a posição do elemento no array, a partir do primeiro, que será eliminado. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/adel +/*/ +binary function adel(asource, npos) +return + + +/*/{Protheus.doc} adir +Preenche uma série de arrays com informações de arquivos e diretórios \(nomes de arquivos, tamanhos, datas, horas e atributos\). + +@type binary function +@sintax ADir([cEspecArq], [@aNomesArq], [@aTamanhos], [@aDatas], [@aHoras], [@aAtributos], [lChangeCase]) => numeric +@return numeric, Retorna a quantidade de arquivos encontrados que correspondem à máscara de pesquisa no diretório especificado. + +@param [cespecarq], character, Indica o path e máscara de arquivos a ser pesquisado. Para isso, pode-se incluir caracteres do tipo curinga \* e ?, como também se referenciar ao diretório ou path. Caso nada seja especificado, o parâmetro assumirá como padrão \*.\* +@param [@anomesarq], array, Indica o array que será preenchido com os nomes de arquivos que correspondem a . Cada elemento contém o nome do arquivo e extensão no formato string em maiúsculo. +@param [@atamanhos], array, Indica o array que será preenchido com os tamanhos dos arquivos correspondentes no array . Cada elemento será numérico. +@param [@adatas], array, Indica o array que será preenchido com as datas dos arquivos correspondentes no array . Cada elemento será do tipo data \(D\) +@param [@ahoras], array, Indica o array que será preenchido com as horas dos arquivos correspondentes no array . Cada elemento preenchido, contém uma string no formato hora, minutos e segundos \(hh:mm:ss\). +@param [@aatributos], array, Indica o array que será preenchido com os atributos dos arquivos correspondentes no array . Cada elemento é uma string. Caso seja especificado, os arquivos de diretório, sistema e escondidos são inclusos, assim como os arquivos normais. Mas se não for especificado, somente os arquivos normais serão inclusos. +@param [lchangecase], logical, Se verdadeiro \(.T.\), nomes de arquivos e pastas serão convertidos para letras minúsculas; caso contrário, falso \(.F.\), não será feito nenhum ajuste no nome do arquivo informado. Valor padrão \(.T.\). Veja maiores informações em Observações. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/adir +/*/ +binary function adir(cespecarq, anomesarq, atamanhos, adatas, ahoras, aatributos, lchangecase) +return + + +/*/{Protheus.doc} aduservalid +Faz a autenticação de uma conta de usuário de um domínio baseado no Active Directory do Microsoft Windows. + +@type binary function +@sintax ADUserValid(, , ) => codeblock +@return codeblock, Retorna verdadeiro \(.T.\) se a autenticação no domínio foi realizada com sucesso, caso contrário, falso \(.F.\). + +@param , character, Cenário 1: Nome do domínio no qual encontra-se a estação. Cenário 2: Código SID do usuário autenticado na estação. +@param , character, Cenário 1: Nome do usuário pertencente ao domínio informado. Cenário 2: String vazia, obrigatoriamente. +@param , character, Ambos os cenários: Senha do usuário informado. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/aduservalid +/*/ +binary function aduservalid(cdomainname, cusername, cpassword) +return + + +/*/{Protheus.doc} aesdecrypt +Decripta textos usando o algoritmo AES no modo definido. + +@type binary function +@sintax AESDecrypt(, , , [cIV]) => array +@return array, Array com o resultado do processo de decriptação. + +@param , numeric, Código identificador do modo do algoritmo AES a ser usado na decriptação. +@param , character, Texto de entrada a ser decriptado. +@param , character, Key da decriptação, conforme o modo do algoritmo AES a ser usado. +@param [civ], character, IV \(Vetor de Inicialização\) da decriptação, conforme o modo do algoritmo AES a ser usado. **Obrigatório para o modo CBC.** +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/aesdecrypt +/*/ +binary function aesdecrypt(ncipherid, cciphertext, ckey, civ) +return + + +/*/{Protheus.doc} aesencrypt +Encripta textos usando o algoritmo AES no modo definido. + +@type binary function +@sintax AESEncrypt(, , [cPassword], [cKey], [cIV]) => array +@return array, Array com o resultado do processo de encriptação. + +@param , numeric, Código identificador do modo do algoritmo AES a ser usado na encriptação. +@param , character, Texto de entrada a ser encriptado. +@param [cpassword], character, Texto auxiliar na geração da key da encriptação. +@param [ckey], character, Key da encriptação, conforme o modo do algoritmo AES a ser usado. +@param [civ], character, IV \(Vetor de Inicialização\) da encriptação, conforme o modo do algoritmo AES a ser usado. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/aesencrypt +/*/ +binary function aesencrypt(ncipherid, cplaintext, cpassword, ckey, civ) +return + + +/*/{Protheus.doc} aeval +Executa um bloco de código para cada elemento de um array. + +@type binary function +@sintax AEval(, , [nStart], [nCount]) => array +@return array, Retorna uma cópia do array indicado por **aArray** após a operação. + +@param , array, Indica o array que será lido. +@param , codeblock, Indica o bloco de código que será executado para cada elemento encontrado. +@param [nstart], numeric, Indica o elemento inicial. +@param [ncount], numeric, Indica a quantidade de elementos que serão processados a partir do parâmetro **nStart**. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/aeval +/*/ +binary function aeval(aarray, bblock, nstart, ncount) +return + + +/*/{Protheus.doc} afields +Preenche arrays com a estrutura da tabela atualmente em uso. + +@type binary function +@sintax afields([@aFields], [@aTypes], [@aWidths], [@aDecimals]) => numeric +@return numeric, Retorna a quantidade de colunas. + +@param [@afields], array, Nome dos campos +@param [@atypes], array, Tipo dos campos +@param [@awidths], array, Tamanho dos campos +@param [@adecimals], array, Casas decimais dos campos. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/afields +/*/ +binary function afields(afields, atypes, awidths, adecimals) +return + + +/*/{Protheus.doc} afill +Preenche um array com um único valor de qualquer tipo de dados \(inclusive array´s, blocos de código ou nulo\) na faixa especificada. + +@type binary function +@sintax AFill(, , [nStart], [nCount]) => array +@return array, Retorna uma cópia do array indicado por **aDest** após a operação. + +@param , array, Indica o array que será preenchido. +@param , variant, Indica o valor que será alocado em cada elemento do array. O conteúdo desse parâmetro, pode ser uma expressão de qualquer tipo de dado válido. +@param [nstart], numeric, Indica a posição do primeiro elemento que será preenchido. Caso não seja informado, o padrão é 1. +@param [ncount], numeric, Indica a quantidade de elementos que serão preenchidos. Caso não seja especificado, os elementos são preenchidos até o final do array. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/afill +/*/ +binary function afill(adest, xvalue, nstart, ncount) +return + + +/*/{Protheus.doc} ains +Inclui um elemento nulo na posição informada e "empurra" os demais para frente descartando o último elemento. + +@type binary function +@sintax AIns(, ) => array +@return array, Retorna uma cópia do array indicado por **aDest** após a operação. + +@param , array, Indica o array que será manipulado. +@param , numeric, Indica a posição, a partir da primeira, na qual será inserido um elemento nulo. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/ains +/*/ +binary function ains(adest, npos) +return + + +/*/{Protheus.doc} alias +Retorna o alias de uma área de trabalho especificada. + +@type binary function +@sintax Alias([nWorkArea]) => character +@return character, Retorna o alias da área de trabalho, no formato string, em letras maiúsculas. Caso o parâmetro \(nWorkArea\) não seja informado, o retorna será o alias da área de trabalho corrente ou, se não houver nenhum arquivo em uso, uma string vazia \(""\). + +@param [nworkarea], numeric, Indica o número \(entre 0 e 511\) da área de trabalho que será verificada. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/alias +/*/ +binary function alias(nworkarea) +return + + +/*/{Protheus.doc} alltrim +Remove os espaços em branco à direita e à esquerda de uma string. + +@type binary function +@sintax AllTrim() => character +@return character, Retorna uma string com espaços em branco à direita e à esquerda removidos. + +@param , variant, Indica o texto cujos espaços em branco serão removidos. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/alltrim +/*/ +binary function alltrim(ctext) +return + + +/*/{Protheus.doc} allwaysfalse +Função de compatibilidade que sempre retornará um valor falso \(.F.\). + +@type binary function +@sintax AllwaysFalse() => logical +@return logical, Retorna um valor lógico falso \(.F.\). + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/allwaysfalse +/*/ +binary function allwaysfalse() +return + + +/*/{Protheus.doc} allwaystrue +Função de compatibilidade que sempre retornará um valor verdadeiro \(.T.\). + +@type binary function +@sintax AllwaysTrue() => logical +@return logical, Retorna um valor lógico verdadeiro \(.T.\). + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/allwaystrue +/*/ +binary function allwaystrue() +return + + +/*/{Protheus.doc} ansitooem +Converte uma string do formato ANSI Text \(formato Microsoft Windows\) para OEM/MS-DOS + +@type binary function +@sintax ANSIToOEM() => character +@return character, Retorna a string convertida \(formato OEM/MS-DOS\) para ser exibida no MS-DOS + +@param , character, Indica a string \(formato ANSI Text\) que será convertida. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/ansitooem +/*/ +binary function ansitooem(cstringansi) +return + + +/*/{Protheus.doc} arc4 +Cria uma sequência de caracteres criptografada, utilizando o algoritmo de criptografia de fluxo ARC4, a partir de uma sequência de caracteres que compõe o dado a ser criptografado e uma sequência de caracteres adicional usada como base para a criptografia, chamada de chave. +Essa função é obsoleta, e deve ser substituída pela função [RC4Crypt](RC4Crypt). + +@type binary function +@sintax Arc4(, ) => character +@return character, Retorna uma string criptografada contendo os caracteres ASCII em hexadecimal separados por hífen \(-\). + +@param , character, Indica a sequência de caracteres que serão criptografadas. +@param , character, Indica a sequência de caracteres a serem utilizados como chave para o algoritmo de criptografia. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/arc4 +/*/ +binary function arc4(cbase, cchave) +return + + +/*/{Protheus.doc} asc +Converte um caractere para seu valor ASCII mais à esquerda em uma string. + +@type binary function +@sintax Asc() => numeric +@return numeric, Retorna um valor numérico inteiro, na faixa de 0 à 255, que representa o valor ASCII do parâmetro <**cString**>. + +@param , character, Indica a string que será convertida para um número. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/asc +/*/ +binary function asc(cstring) +return + + +/*/{Protheus.doc} ascan +Percorre um array procurando por um valor especificado. Pode ser especificado um valor a ser buscado, ou pode ser informada uma condição de busca através de um bloco de código. + +@type binary function +@sintax AScan(, , [nStart], [nCount]) => numeric +@return numeric, Caso o valor procurado seja encontrado, será retornado o número do elemento do array correspondente. Caso contrário, é retornado o valor 0 \(zero\). + +@param , array, Array onde será feita a busca. +@param , variant, Indica a expressão de busca. Para um array de dimensão simples, pode ser colocado diretamente um valor a ser procurado. Para uma busca mais complexa ou para uma busca em array muti-dimensional, deve ser especificado um bloco de código. +@param [nstart], numeric, Indica a partir de qual elemento será realizada a busca. Por padrão a pesquisa inicia no elemento 1. +@param [ncount], numeric, Indica por quantos elementos serão considerados na operação de busca. Caso não especificado, todos os elementos do array a partir da posição inicial de busca serão considerados. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/ascan +/*/ +binary function ascan(adest, xexpr, nstart, ncount) +return + + +/*/{Protheus.doc} ascanx +Realiza a leitura do array à procura de um valor específico. Funciona da mesma forma que a função **AScan**, porém quando utilizado um bloco de código para realizar a busca, o mesmo é chamado com um segundo parâmetro, informando qual é o elemento do array em questão que está sendo verificado na chamada corrente do bloco de código. + +@type binary function +@sintax AScanX(, , [nStart], [nCount]) => numeric +@return numeric, Retorna um valor numérico que representa a posição que ocupa no array pelo último elemento lido. Quando não encontrado é retornado 0. + +@param , array, Indica o array onde será feita a busca. +@param , codeblock, Indica o valor que será pesquisado através de um bloco de código. +@param [nstart], numeric, Indica a partir de qual elemento será realizada busca. Por padrão a pesquisa inicia no elemento 1. +@param [ncount], numeric, Indica por quantos elementos serão considerados na operação de busca. Caso não especificado, todos os elementos do array a partir da posição inicial de busca serão considerados. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/ascanx +/*/ +binary function ascanx(adest, bsearch, nstart, ncount) +return + + +/*/{Protheus.doc} asin +Retorna o valor em radianos do arco seno de um ângulo a partir do valor que representa o seno desse ângulo. + +@type binary function +@sintax ASin() => numeric +@return numeric, Retorna um valor entre -PI/2 e PI/2. + +@param , numeric, Indica o valor que representa o seno de um ângulo. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/asin +/*/ +binary function asin(nsin) +return + + +/*/{Protheus.doc} asize +Aumenta ou diminui um array a um tamanho especificado + +@type binary function +@sintax ASize(, ) => Nil +@return Nil, Retorna Nulo \(nil\) + +@param , array, Indica o array que terá o tamanho manipulado. +@param , numeric, Indica o novo tamanho do array. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/asize +/*/ +binary function asize(adestino, ntamanho) +return + + +/*/{Protheus.doc} asort +Ordena uma parte ou o array inteiro. + +@type binary function +@sintax ASort(, [nInicio], [nCont]) => array +@return array, Retorna uma referência ao array de origem aVetor. + +@param , array, Indica o array cujos elementos serão ordenados. +@param [ninicio], numeric, Indica a partir de qual elemento a ordenação será iniciada. Caso não seja especificado, a posição inicial será um \(1\). +@param [ncont], numeric, Indica a quantidade de elementos que serão ordenados. Caso não seja especificado, todos elementos a partir do nInicio serão ordenados. advpl_param bOrdem BO Indica o bloco de código utilizado para determinar a ordem que será seguida. Caso não seja especificado, a ordem padrão será ascendente. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/asort +/*/ +binary function asort(avetor, ninicio, ncont) +return + + +/*/{Protheus.doc} at +Retorna a posição da primeira ocorrência de uma substring em uma string. Para isso, a função pesquisa a string destino a partir da esquerda. + +@type binary function +@sintax At(, , [nStart]) => numeric +@return numeric, Retorna a posição da string localizada, dentro da procurada, na forma de um valor numérico inteiro. Caso a string não seja localizada, o retorno será 0 \(zero\). + +@param , character, Indica a string que será localizada. +@param , character, Indica a string que será procurada. +@param [nstart], numeric, Indica a partir de qual caractere iniciará a busca procurada, na forma de um valor numérico inteiro. O nStart deverá ser maior que zero, caso contrário o retorno será 0 \(zero\). +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/at +/*/ +binary function at(cpesquisa, cdestino, nstart) +return + + +/*/{Protheus.doc} atail +Retorna o último elemento do array + +@type binary function +@sintax ATail() => variant +@return variant, O último elemento do array. + +@param , array, Indica o array o qual o último elemento será retornado. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/atail +/*/ +binary function atail(aarray) +return + + +/*/{Protheus.doc} atan +Calcula o valor em radianos do arco tangente de um valor que representa a tangente de um ângulo. + +@type binary function +@sintax ATan() => numeric +@return numeric, Retorna um valor entre 0 e PI radianos. + +@param , numeric, Indica o valor que representa a tangente de um ângulo. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/atan +/*/ +binary function atan(ntan) +return + + +/*/{Protheus.doc} atn2 +Calcula o valor do ângulo, em radianos, de um valor que representa o seno e de um valor que representa o cosseno. + +@type binary function +@sintax Atn2(, ) => numeric +@return numeric, Retorna um valor entre 0 e PI radianos. + +@param , numeric, Indica o valor que representa o seno de um ângulo. +@param , numeric, Indica o valor que representa o cosseno de um ângulo. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/atn2 +/*/ +binary function atn2(nsin, ncos) +return + + +/*/{Protheus.doc} atohm +Converte uma matriz de dados em um tHashMap, podendo combinar as colunas para a chave de busca. + +@type binary function +@sintax AToHM(, [nColuna_1], [nTrim_1], [nColuna_N], [nTrim_N]) => object +@return object, Objeto da classe HashMap \(tHashMap\) + +@param , array, Matriz com os elementos a serem convertidos +@param [ncoluna_1], numeric, Indica o número da coluna que contem o valor da chave \(pesquisa\) +@param [ntrim_1], numeric, Tipo de Trim para as colunas do tipo caractere. +@param [ncoluna_n], numeric, Informar mais de uma coluna se necessário +@param [ntrim_n], numeric, Tipo de Trim para as colunas do tipo caractere. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/atohm +/*/ +binary function atohm(amatriz, ncoluna_1, ntrim_1, ncoluna_n, ntrim_n) +return + + +/*/{Protheus.doc} attismemberof +Indica se uma propriedade informada através de uma string por parâmetro existe na classe. + +@type binary function +@sintax AttIsMemberOf(, , [lRecursive]) => logical +@return logical, Retorna verdadeiro \(.T.\), se a propriedade for encontrada; caso contrário, falso \(.F.\). + +@param , object, Indica o objeto que representa a instância da classe a ser pesquisada. +@param , character, Indica o nome da propriedade a ser pesquisada. +@param [lrecursive], logical, \*Indica se as classes superiores também devem ser pesquisada, caso a instância atual possua herança. \( Default = .F. \) +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/attismemberof +/*/ +binary function attismemberof(oobj, cattname, lrecursive) +return + + +/*/{Protheus.doc} b_and +Realiza a operação binária **E** entre 2 números. + +@type binary function +@sintax B_AND(, ) => numeric +@return numeric, Retorna o valor do E binário entre **nNum1** e **nNum2**. + +@param , numeric, 1º número a ser utlizado na operação de E binário. +@param , numeric, 2º número a ser utlizado na operação de E binário. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/b_and +/*/ +binary function b_and(nnum1, nnum2) +return + + +/*/{Protheus.doc} b_or +Realiza a operação binária **OU** entre 2 números. + +@type binary function +@sintax B_OR(, ) => numeric +@return numeric, Retorna o valor do OU binário entre **nNum1** e **nNum2**. + +@param , numeric, 1º número a ser utlizado na operação de OU binário. +@param , numeric, 2º número a ser utlizado na operação de OU binário. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/b_or +/*/ +binary function b_or(nnum1, nnum2) +return + + +/*/{Protheus.doc} b_xor +Realiza a operação binária **OU EXCLUSIVO** entre 2 números. + +@type binary function +@sintax B_XOR(, ) => numeric +@return numeric, Retorna o valor do OU EXCLUSIVO binário entre **nNum1** e **nNum2**. + +@param , numeric, 1º número a ser utlizado na operação de OU EXCLUSIVO binário. +@param , numeric, 2º número a ser utlizado na operação de OU EXCLUSIVO binário. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/b_xor +/*/ +binary function b_xor(nnum1, nnum2) +return + + +/*/{Protheus.doc} beep +Emite um sinal sonoro + +@type binary function +@sintax Beep() => logical +@return logical, Retorna True caso seja efetivamente mandado o comando para o lado cliente. + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/beep +/*/ +binary function beep() +return + + +/*/{Protheus.doc} bin2d +Converte um caractere de 64 bits sinalizado para um numérico de ponto flutuante. + +@type binary function +@sintax Bin2D() => numeric +@return numeric, Retorna um valor numérico de ponto flutuante que representa o caractere informado. + +@param , character, Indica um caractere de oito bytes. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/bin2d +/*/ +binary function bin2d(cstring) +return + + +/*/{Protheus.doc} bin2f +Converte um caractere de 32 bits sinalizado para um numérico de ponto flutuante. + +@type binary function +@sintax Bin2F() => numeric +@return numeric, Retorna um valor numérico de ponto flutuante que representa o caractere informado. + +@param , character, Indica um caractere de quatro bytes. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/bin2f +/*/ +binary function bin2f(cstring) +return + + +/*/{Protheus.doc} bin2i +Converte um caractere de 16 bits sinalizado para um numérico. + +@type binary function +@sintax Bin2I() => numeric +@return numeric, Retorna um valor numérico inteiro que representa o caractere informado. + +@param , character, Indica o caractere de dois bytes. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/bin2i +/*/ +binary function bin2i(cstring) +return + + +/*/{Protheus.doc} bin2l +Converte um caractere de 32 bits sinalizado para um numérico. + +@type binary function +@sintax Bin2L() => numeric +@return numeric, Retorna um valor numérico inteiro que representa o caractere informado. + +@param , character, Indica um caractere de quatro bytes. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/bin2l +/*/ +binary function bin2l(cstring) +return + + +/*/{Protheus.doc} bin2str +Converte uma string com caracteres para uma string com o valor binário de cada caractere. + +@type binary function +@sintax Bin2Str() => character +@return character, Retorna uma string formatada de acordo com a string informada. + +@param , character, Indica a string que será convertida. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/bin2str +/*/ +binary function bin2str(cstring) +return + + +/*/{Protheus.doc} bin2w +Converte um caractere de 16 bits não sinalizado para um numérico. + +@type binary function +@sintax Bin2W() => numeric +@return numeric, Retorna um valor numérico inteiro que representa o caractere informado. + +@param , character, Indica o caractere de dois bytes. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/bin2w +/*/ +binary function bin2w(cstring) +return + + +/*/{Protheus.doc} biton +Verifica se os primeiros bits de uma string são zero. + +@type binary function +@sintax BitOn(, , , ) => NIL +@param , character, Indica a string que será verificada. +@param , numeric, Indica o índice do bit inicial. +@param , numeric, Indica a quantidade de bits que devem estar em 0. +@param , numeric, Indica a quantidade de bites que serão testados. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/biton +/*/ +binary function biton(cstr, nstart, nquant, nlength) +return + + +/*/{Protheus.doc} bmptojpg +Converte uma imagem do tipo BMP \(Bitmap\) para JPG \(Joint Photographic Group\). + +@type binary function +@sintax BmpToJpg(, , [bChangeCase]) => codeblock +@return codeblock, 0, se o arquivo for salvo com sucesso, caso contrário retorna -1 + +@param , character, Indica o caminho, respeitando o diretório do Application Server, e o nome do arquivo, com extensão BMP \(Bitmap\), de origem. +@param , character, Indica o caminho, respeitando o diretório do Application Server, e o nome do arquivo, com extensão JPG \(Joint Photographic Group\), de destino. +@param [bchangecase], logical, Caso .T. o caminho e nome dos arquivos informados \(cFileOld, e cFileNew\) serão convertidos para letras minúsculas. Valor padrão o valor é .F. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/bmptojpg +/*/ +binary function bmptojpg(cfileold, cfilenew, bchangecase) +return + + +/*/{Protheus.doc} bof +Informa se está no inicio do Arquivo/Tabela + +@type binary function +@sintax Bof() => logical +@return logical, Retorna .T. \(Verdadeiro\) se estiver no início do arquivo/tabela; Caso contrário, .F. \(Falso\) + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/bof +/*/ +binary function bof() +return + + +/*/{Protheus.doc} cdow +Retorna o dia da semana de uma determinada data. + +@type binary function +@sintax CDow() => character +@return character, Retorna o nome do dia da semana no formato de uma string, no idioma Inglês. A primeira letra será maiúscula e as demais minúsculas. Para uma data em branco ou inválida, o retorno será uma string vazia \(""\). + +@param , date, Indica o valor data que será considerado para obter o dia da semana. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/cdow +/*/ +binary function cdow(dexp) +return + + +/*/{Protheus.doc} ceiling +Calcula o arrendodamento \(para cima\) do valor do ponto flutuante. + +@type binary function +@sintax Ceiling() => numeric +@return numeric, Retorna o menor inteiro que é maior ou igual ao valor do ponto flutuante. + +@param , numeric, Indica o valor que será arredondado \(para cima\). +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/ceiling +/*/ +binary function ceiling(nvalor) +return + + +/*/{Protheus.doc} chdclsarr +descrição da funcao + +@type binary function +@sintax ChdClsArr([@tNomeVar]) => codeblock +@return codeblock, descrição do retorno + +@param [@tnomevar], codeblock, descrição do parametro +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/chdclsarr +/*/ +binary function chdclsarr(tnomevar) +return + + +/*/{Protheus.doc} chkrpochg +Verifica se houve alteração da configuração de SourcePath \(RPO Ativo\) após o início do processo atual. + +@type binary function +@sintax ChkRpoChg() => logical +@return logical, Retorna verdadeiro \(.T.\), se o programa atual for carregado a partir do SourcePath do arquivo de configuração \(totvsappserver.ini\) do TOTVS Application Server; caso contrário, falso \(.F.\). + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/chkrpochg +/*/ +binary function chkrpochg() +return + + +/*/{Protheus.doc} chmod +Altera as permissões de um arquivo. + +@type binary function +@sintax CHMOD(, , [uParam3], [lChangeCase]) => logical +@return logical, Retorna verdadeiro \(.T.\), se a alteração da restrição for realizada com sucesso; caso contrário, falso \(.F.\). + +@param , character, Indica o nome do arquivo no qual se deseja alterar suas propriedades \(atributos\) do sistema. +@param , numeric, Indica a permissão que será atribuída ao proprietário, grupo ou representante do arquivo indicado no parâmetro . +@param [uparam3], numeric, Compatibility parameter. Pass NIL. +@param [lchangecase], logical, Se verdadeiro \(.T.\), nomes de arquivos e pastas serão convertidos para letras minúsculas; caso contrário, falso \(.F.\), não será feito nenhum ajuste no nome do arquivo informado. Valor padrão \(.T.\). Veja maiores informações em Observações. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/chmod +/*/ +binary function chmod(cfilename, nfilemode, uparam3, lchangecase) +return + + +/*/{Protheus.doc} chr +Converte um código ASCII para caractere. + +@type binary function +@sintax Chr() => character +@return character, Retorna um único valor caractere cujo código ASCII está especificado no parâmetro nCodigo. + +@param , numeric, Indica um código ASCII na faixa de 0 à 255. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/chr +/*/ +binary function chr(ncodigo) +return + + +/*/{Protheus.doc} classdataarr +Retorna um array multidimensional com todas as informações das propriedades da instância da classe contida no objeto informado como parâmetro + +@type binary function +@sintax ClassDataArr(, [lParent]) => array +@return array, Retorna um array multidimensional com todas as informações das propriedades da instância da classe contida no objeto informado como parâmetro. + +@param , object, Indica um objeto para obter os dados / propriedades. +@param [lparent], logical, Se verdadeiro \(.T.\) retorna todos os parametros, inclusive os parâmetros herdados de outras classes, adiciona o nome da classe na 4ª coluna do array +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/classdataarr +/*/ +binary function classdataarr(oobj, lparent) +return + + +/*/{Protheus.doc} classmetharr +Retorna um array multidimensional com todas as informações dos métodos da instância da classe contida no objeto informado como parâmetro + +@type binary function +@sintax ClassMethArr(, [lParent]) => array +@return array, Retorna um array multidimensional com todas as informações das propriedades da instância da classe contida no objeto informado como parâmetro. + +@param , object, Indica um objeto para obter os métodos. +@param [lparent], logical, Se verdadeiro \(.T.\) retorna todos os parametros, inclusive os parâmetros herdados de outras classes, adiciona o nome da classe na 3ª coluna do array +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/classmetharr +/*/ +binary function classmetharr(oobj, lparent) +return + + +/*/{Protheus.doc} clearglbvalue +Limpa um conteúdo armazenado em uma variável global. + +@type binary function +@sintax ClearGlbValue(, [nTimeOut]) => numeric +@return numeric, Retorna o número de variáveis globais limpas da memória. + +@param , character, Indica o nome da variável global. +@param [ntimeout], numeric, Indica o tempo mínimo \(em segundos\) a partir do último acesso/leitura desta variável, para ela ser eliminada. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/clearglbvalue +/*/ +binary function clearglbvalue(cglbname, ntimeout) +return + + +/*/{Protheus.doc} clearvarsetget +Retira o bloco de código atribuído ao uso da variável, de forma que quando a variável for usada o bloco não será mais executado. + +@type binary function +@sintax ClearVarSetGet() => NIL +@param , character, Indica o nome da variável que deve estar declarada. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/clearvarsetget +/*/ +binary function clearvarsetget(cnamevar) +return + + +/*/{Protheus.doc} cmonth +Retorna o mês, como string, a partir de uma data passada como parâmetro. + +@type binary function +@sintax CMonth() => character +@return character, Retorna o mês \(em inglês\) a partir de uma data passada como parâmetro. A primeira letra será maiúscula e as demais minúsculas. Para uma data em branco ou inválida, o retorno será uma string nula \(""\). + +@param , date, Indica a data que terá seu mês convertido. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/cmonth +/*/ +binary function cmonth(ddata) +return + + +/*/{Protheus.doc} cmpbuildstr +Compara duas strings em formato nnn.nnn.nnn.nnn, considerando os quatro primeiros blocos numéricos + +@type binary function +@sintax CmpBuildStr(, ) => numeric +@return numeric, Retorna 0 se ambas são iguais, 1 se a primeira build é maior que a segunda, e -1 se a primeira build for menor que a segunda. + +@param , character, Primeira string para comparação +@param , character, Segunda string para comparação +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/cmpbuildstr +/*/ +binary function cmpbuildstr(cleft, cright) +return + + +/*/{Protheus.doc} colortorgb +A partir do valor numérico que representa uma cor, retorna uma lista dos números que representam o RGB. + +@type binary function +@sintax ColorToRGB() => array +@return array, Vetor com quatro posições indicando o vermelho, o verde, o azul e a transparência, sendo cada uma delas representadas por um valor numérico na escala de 0 a 255. + +@param , numeric, Cor representada por um único valor numérico, por exemplo CLR_HRED definida no arquivo colors.ch. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/colortorgb +/*/ +binary function colortorgb(ncolor) +return + + +/*/{Protheus.doc} compress +Compacta um buffer recebido através de algoritmo proprietário. + +@type binary function +@sintax Compress(<@cBufferOut>, <@nLenghtOut>, , ) => logical +@return logical, Retorna verdadeiro \(.T.\), se o buffer for compactado com sucesso; caso contrário, falso \(.F.\). + +@param <@cbufferout>, character, Retorna o buffer compactado, que contém os caracteres binários. +@param <@nlenghtout>, numeric, Retorna o tamanho do buffer compactado. +@param , character, Indica o buffer que será compactado. +@param , numeric, Indica o tamanho do buffer informado que deverá ser considerado para compactação. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/compress +/*/ +binary function compress(cbufferout, nlenghtout, cbufferin, nlenghtin) +return + + +/*/{Protheus.doc} computername +Retorna o nome da máquina \(hostname\) onde o SmartClient está sendo executado. + +@type binary function +@sintax ComputerName() => character +@return character, Nome da máquina. + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/computername +/*/ +binary function computername() +return + + +/*/{Protheus.doc} conout +Apresenta no console, do Application Server, uma mensagem. + +@type binary function +@sintax Conout() => NIL +@param , character, Indica a mensagem que será apresentada no console do Application Server. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/conout +/*/ +binary function conout(cmensagem) +return + + +/*/{Protheus.doc} conttype +Retorna um array com o tipo da variável. Diferente do ValType, retorna o tipo original da variável. No caso de ADPL puro irá sempre retornar o ValType \(Variant\), porém se for chamada com uma variável que veio do 4GL \(interop\) retorna o tipo que ela foi criada. + +@type binary function +@sintax ContType() => array +@return array, Retorna um array com duas posições, a primeira \(Caracter\) sempre é relativo ao Valor que a variável aceita \(valtype\), a segunda é o contentType \(Inteiro\) propriamente dito. + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/conttype +/*/ +binary function conttype() +return + + +/*/{Protheus.doc} cos +Calcula o valor do cosseno de um ângulo \(em radianos\). + +@type binary function +@sintax Cos() => numeric +@return numeric, Retorna o valor do cosseno de acordo com o ângulo informado. + +@param , numeric, Indica o valor do ângulo em radianos. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/cos +/*/ +binary function cos(nangle) +return + + +/*/{Protheus.doc} countexecutablelines +descrição da funcao + +@type binary function +@sintax CountExecutableLines([@tNomeVar]) => codeblock +@return codeblock, descrição do retorno + +@param [@tnomevar], codeblock, descrição do parametro +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/countexecutablelines +/*/ +binary function countexecutablelines(tnomevar) +return + + +/*/{Protheus.doc} cpyf2web +A função copia um arquivo do ambiente do servidor \(a partir do rootpath\) ou do cliente \(WebAgent\), para o SmartClient HTML. Se o arquivo for copiado para a pasta temporária \( user \) no Servidor Web, esta pasta é deletada automaticamente quando a sessão é finalizada. Já se o arquivo for copiado para a pasta de persistência \(Cache\) do servidor Web, a pasta será mantida no servidor Web até que seja excluída manualmente pelo administrador do ambiente. + +@type binary function +@sintax CpyF2Web(, [lIsUserDiskDir], [lCompactCopy], [lChangeCase], [lUnZipFile]) => numeric +@return numeric, Retorna o caminho do servidor web onde o arquivo foi salvo com sucesso. Caso ocorra alguma falha na cópia, retorna um valor vazio. + +@param , character, Indica o arquivo a ser usado como origem da cópia. +@param [lisuserdiskdir], logical, Indica se o arquivo vai ser salvo na pasta temporária ou na pasta do Environment onde está o Servidor Web. Default = .T. \(verdadeiro\). +@param [lcompactcopy], logical, Indica se o arquivo deve ser internamente compactado antes de fazer a cópia. Default = .T. \(verdadeiro\). +@param [lchangecase], logical, Se verdadeiro \(.T.\), nomes de arquivos e pastas serão convertidos para letras minúsculas; caso contrário, falso \(.F.\), não será feito nenhum ajuste no nome do arquivo informado. Default = .T. \(verdadeiro\). Veja maiores informações em Observações. +@param [lunzipfile], logical, Se verdadeiro \(.T.\), o arquivo será descompactado. caso contrário, falso \(.F.\), não faz nada. Default = .F. \(false\). +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/cpyf2web +/*/ +binary function cpyf2web(corigem, lisuserdiskdir, lcompactcopy, lchangecase, lunzipfile) +return + + +/*/{Protheus.doc} cpys2t +Copia um arquivo do ambiente do servidor, a partir do rootpath, para um diretório na máquina onde está sendo executado o SmartClient. + +@type binary function +@sintax CpyS2T(, , [lCompress], [lChangeCase]) => logical +@return logical, Retorna verdadeiro \(.T.\), se o arquivo for copiado com sucesso; Retorna falso \(.F.\), em caso de falha na cópia. + +@param , character, Indica o arquivo no servidor que será copiado \(a partir do rootpath\). +@param , character, Indica a pasta de destino na máquina onde está o SmartClient. +@param [lcompress], logical, Indica se o arquivo deve ser internamente compactado antes de fazer a cópia. Default = .T. \(verdadeiro\) +@param [lchangecase], logical, Se verdadeiro \(.T.\), nomes de arquivos e pastas serão convertidos para letras minúsculas; caso contrário, falso \(.F.\), não será feito nenhum ajuste no nome do arquivo informado. Valor padrão \(.T.\). Veja maiores informações em Observações. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/cpys2t +/*/ +binary function cpys2t(cfile, cfolder, lcompress, lchangecase) +return + + +/*/{Protheus.doc} cpys2tex +Copia um arquivo de um path absoluto da máquina onde o Application Server está sendo executado, para um path absoluto na máquina onde o Smartclient está sendo executado, atualizando também o datetime do arquivo copiado, para ser igual ao arquivo de origem. + +@type binary function +@sintax CpyS2TEx(, , [lChangeCase]) => logical +@return logical, Retorna verdadeiro \(.T.\) se o arquivo for copiado com sucesso; retorna falso \(.F.\) em caso de falha na cópia. + +@param , character, Indica o caminho completo do arquivo na máquina do servidor que será copiado. +@param , character, Indica o caminho completo do arquivo de destino na máquina onde está o SmartClient. +@param [lchangecase], logical, Se verdadeiro \(.T.\), nomes de arquivos e pastas serão convertidos para letras minúsculas; caso contrário, falso \(.F.\), não será feito nenhum ajuste no nome do arquivo informado. Valor padrão \(.T.\). Veja maiores informações em Observações. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/cpys2tex +/*/ +binary function cpys2tex(cserver, cclient, lchangecase) +return + + +/*/{Protheus.doc} cpyt2s +Copia um arquivo da máquina onde está sendo executado o SmartClient, para um diretório no ambiente do servidor, a partir do rootpath. + +@type binary function +@sintax CpyT2S(, , [lCompress], [lChangeCase]) => logical +@return logical, Retorna verdadeiro \(.T.\), se o arquivo for copiado com sucesso; Retorna falso \(.F.\), em caso de falha na cópia. + +@param , character, Indica o arquivo na máquina onde está o SmartClient que será copiado. +@param , character, Indica a pasta de destino no servidor \(a partir do rootpath\). +@param [lcompress], logical, Indica se o arquivo deve ser internamente compactado antes de fazer a cópia. Default = .T. \(verdadeiro\) +@param [lchangecase], logical, Se verdadeiro \(.T.\), nomes de arquivos e pastas serão convertidos para letras minúsculas; caso contrário, falso \(.F.\), não será feito nenhum ajuste no nome do arquivo informado. Valor padrão \(.T.\). Veja maiores informações em Observações. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/cpyt2s +/*/ +binary function cpyt2s(cfile, cfolder, lcompress, lchangecase) +return + + +/*/{Protheus.doc} crccalc +Calcula o CRC de um texto informado. + +@type binary function +@sintax CRCCalc(, , [@cRetHex]) => numeric +@return numeric, Retorna valor decimial do CRC calculado. + +@param , numeric, Algoritmo CRC que sera utilizado para o cálculo. Os algoritmos disponíveis ver Observações. +@param , character, Texto que será utilizado para cálculo do CRC. +@param [@crethex], character, Variável que receberá o valor CRC no formato hexadecimal. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/crccalc +/*/ +binary function crccalc(nalgoritmo, cinput, crethex) +return + + +/*/{Protheus.doc} ctod +Converte uma string formatada para o tipo data. + +@type binary function +@sintax CToD() => date +@return date, Retorna a data convertida. + +@param , character, Indica a string que contém uma data a ser convertida. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/ctod +/*/ +binary function ctod(cdata) +return + + +/*/{Protheus.doc} curdir +Exibe o diretório atual servidor. + +@type binary function +@sintax curdir() => NIL +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/curdir +/*/ +binary function curdir() +return + + +/*/{Protheus.doc} cvaltochar +Converte uma informação do tipo caractere, data, lógico ou numérico para string, sem adição de espaços na informação. + +@type binary function +@sintax cValToChar() => character +@return character, Retorna uma string de acordo com o valor e tipo do parâmetro informado. + +@param , variant, Indica um valor do tipo caractere, data, lógico ou numérico para converter em string. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/cvaltochar +/*/ +binary function cvaltochar(xparametro) +return + + +/*/{Protheus.doc} d2bin +Converte o número informado como parâmetro em uma string de 8 caracteres, correspondente à representação binária do número em ponto flutuante. + +@type binary function +@sintax D2Bin() => numeric +@return numeric, Retorna uma string de oito bytes que contém a representação binária do número em ponto flutuante. + +@param , numeric, Indica o valor numérico em ponto flutuante que será convertido. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/d2bin +/*/ +binary function d2bin(ndouble) +return + + +/*/{Protheus.doc} date +Retorna a data do sistema como sendo um valor do tipo data. +Essa função dispõe um meio de inicializar variáveis de memória com a data corrente, comparando outros valores do tipo data e realizando operações aritméticas relativas à data corrente. + +@type binary function +@sintax Date() => date +@return date, Retorna a data do sistema como sendo um valor do tipo data. + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/date +/*/ +binary function date() +return + + +/*/{Protheus.doc} datetimeutc +Retorna uma string com informações de data e hora no formato UTC. + +@type binary function +@sintax DateTimeUtc([aDate]) => character +@return character, Retorna uma string no formato UTC. + +@param [adate], array, Quando informado por referência, o array será preenchido com data UTC onde a posição 1 será data e a posição 2 a hora. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/datetimeutc +/*/ +binary function datetimeutc(adate) +return + + +/*/{Protheus.doc} day +Retorna o dia do mês de uma determinada data. + +@type binary function +@sintax Day() => numeric +@return numeric, Retorna um valor numérico inteiro \(dia do mês\) na faixa de zero a 31. + +@param , date, Indica a data que será convertida. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/day +/*/ +binary function day(ddata) +return + + +/*/{Protheus.doc} dbappend +Adiciona um novo registro vazio na tabela corrente. + +@type binary function +@sintax DBAppend([lUnlock]) => Nil +@return Nil, Retorno sempre é nulo. + +@param [lunlock], logical, Indica se, verdadeiro \(.T.\), libera todos os registros bloqueados anteriormente \(locks\); caso contrário, falso \(.F.\), todos os bloqueios anteriores são mantidos durante a inserção. O Valor padrão é verdadeiro \(.T.\). +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/dbappend +/*/ +binary function dbappend(lunlock) +return + + +/*/{Protheus.doc} dbchangealias +Muda o alias de uma área de trabalho aberta. + +@type binary function +@sintax DBChangeAlias(, ) => logical +@return logical, Retorna se o alias foi alterado ou não. + +@param , character, Indica o alias aberto de uma tabela. +@param , character, Indica o novo alias da tabela. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/dbchangealias +/*/ +binary function dbchangealias(coldalias, cnewalias) +return + + +/*/{Protheus.doc} dbclearallfilter +Limpa todas as condições de filtro de todas as tabelas abertas. + +@type binary function +@sintax DBClearAllFilter() => Nil +@return Nil, Retorno sempre é nulo. + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/dbclearallfilter +/*/ +binary function dbclearallfilter() +return + + +/*/{Protheus.doc} dbclearfilter +Limpa todas as condições de filtro. + +@type binary function +@sintax DBClearFilter() => Nil +@return Nil, Retorno sempre é nulo. + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/dbclearfilter +/*/ +binary function dbclearfilter() +return + + +/*/{Protheus.doc} dbclearindex +Fecha todos os índices da área de trabalho corrente. + +@type binary function +@sintax DBClearIndex() => Nil +@return Nil, Retorno sempre é nulo. + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/dbclearindex +/*/ +binary function dbclearindex() +return + + +/*/{Protheus.doc} dbcloseall +Fecha todas as áreas de trabalho em uso. + +@type binary function +@sintax DBCloseAll() => NIL +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/dbcloseall +/*/ +binary function dbcloseall() +return + + +/*/{Protheus.doc} dbclosearea +Fecha a área de trabalho corrente. + +@type binary function +@sintax DBCloseArea() => Nil +@return Nil, Retorno sempre é nulo. + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/dbclosearea +/*/ +binary function dbclosearea() +return + + +/*/{Protheus.doc} dbcommit +Salva em disco todas as atualizações pendentes na área de trabalho corrente. + +@type binary function +@sintax DBCommit() => Nil +@return Nil, Retorno sempre é nulo. + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/dbcommit +/*/ +binary function dbcommit() +return + + +/*/{Protheus.doc} dbcommitall +Salva em disco todas as atualizações pendentes na área de trabalho corrente. + +@type binary function +@sintax DBCommitAll() => Nil +@return Nil, Retorno sempre é nulo. + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/dbcommitall +/*/ +binary function dbcommitall() +return + + +/*/{Protheus.doc} dbcreateindex +Cria um indice para Tabela/View + +@type binary function +@sintax DBCreateIndex(, , [bExprKey], [lUnique]) => Nil +@return Nil, Retorno sempre é nulo. + +@param , character, Indica o nome do arquivo de índice que será criado +@param , character, Expressão das chaves do índice que será criado na forma de string. +@param [bexprkey], codeblock, Expressão das chaves do índice que será criado na forma executável. +@param [lunique], logical, Valor lógico para especificar que o indice será unico. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/dbcreateindex +/*/ +binary function dbcreateindex(cname, cexprkey, bexprkey, lunique) +return + + +/*/{Protheus.doc} dbdelete +Marca o registro atual para exclusão. + +@type binary function +@sintax DBDelete() => NIL +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/dbdelete +/*/ +binary function dbdelete() +return + + +/*/{Protheus.doc} dbeval +Avalia um bloco de código para cada registro que atenda um escopo definido, através dos blocos da primeira e segunda condição. + +@type binary function +@sintax DBEval(, [bFirstCondition], [bSecondCondition], [nCount], [nRecno], [lRest]) => Nil +@return Nil, Sempre retorna nulo. + +@param , codeblock, Indica o bloco de código que será executado para cada registro processado. +@param [bfirstcondition], codeblock, Primeiro Code Block com condição para inserir registro. +@param [bsecondcondition], codeblock, Segundo Code Block com condição para inserir registro. +@param [ncount], numeric, Numero maximo de registros a ser processado. +@param [nrecno], numeric, Unico registro a ser processado. +@param [lrest], logical, Indica que os demais registros serão processados. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/dbeval +/*/ +binary function dbeval(bblock, bfirstcondition, bsecondcondition, ncount, nrecno, lrest) +return + + +/*/{Protheus.doc} dbfieldinfo +Obtém informação de um determinado campo da tabela corrente. + +@type binary function +@sintax DBFieldInfo(, ) => variant +@return variant, Retorna a informação do campo. + +@param , numeric, Indica o tipo de informação que será verificada. +@param , numeric, Indica a posição do campo que será verificado. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/dbfieldinfo +/*/ +binary function dbfieldinfo(ntype, nfield) +return + + +/*/{Protheus.doc} dbfilter +Retorna a expressão do filtro ativo na área de trabalho corrente. + +@type binary function +@sintax DBFilter() => character +@return character, Retorna a expressão do filtro ativo na área de trabalho corrente. Caso não exista um filtro ativo, o retorno será uma string nula \(""\). + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/dbfilter +/*/ +binary function dbfilter() +return + + +/*/{Protheus.doc} dbfiltercb +Retorna o codeblock do filtro ativo na área de trabalho corrente. + +@type binary function +@sintax DBFilterCB() => codeblock +@return codeblock, Retorna o codeblock ativo na área de trabalho corrente. + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/dbfiltercb +/*/ +binary function dbfiltercb() +return + + +/*/{Protheus.doc} dbgetactfld +Retorna os campos visíveis de um alias. + +@type binary function +@sintax dbGetActFld() => character +@return character, Retorna uma string separada por vírgulas \(","\) com todos os campos visíveis de um alias e cuja visibilidade lógica não foi desativada. + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/dbgetactfld +/*/ +binary function dbgetactfld() +return + + +/*/{Protheus.doc} dbgobottom +Posiciona a tabela corrente no último registro lógico. + +@type binary function +@sintax DBGoBottom() => Nil +@return Nil, Retorno sempre é nulo. + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/dbgobottom +/*/ +binary function dbgobottom() +return + + +/*/{Protheus.doc} dbgoto +Posiciona a tabela corrente em um determinado registro, conforme a ordem física \(sequência sobre o recno\). + +@type binary function +@sintax DBGoTo() => Nil +@return Nil, Retorno sempre é nulo. + +@param , numeric, Indica a posição desejada. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/dbgoto +/*/ +binary function dbgoto(npos) +return + + +/*/{Protheus.doc} dbgotop +Posiciona a tabela corrente no primeiro registro lógico. + +@type binary function +@sintax DBGoTop() => Nil +@return Nil, Retorno sempre é nulo. + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/dbgotop +/*/ +binary function dbgotop() +return + + +/*/{Protheus.doc} dbinfo +Obtêm informações sobre a tabela corrente. + +@type binary function +@sintax DBInfo() => variant +@return variant, Retorna a informação da tabela, ou seja, a informação requisitada pelo usuário \(O tipo depende da informação requisitada\). Caso não tenha tabela corrente, o retorno será nulo. + +@param , numeric, Indica o tipo de informação que será verificada. Para mais informações, consulte a área Observações. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/dbinfo +/*/ +binary function dbinfo(ninfo) +return + + +/*/{Protheus.doc} dbininsert +Retorna se a tabela está em modo de inserção de registros ou não. + +@type binary function +@sintax DBInInsert() => logical +@return logical, Retorna **.T.** se estiver inserindo registros; caso contrário, **.F.**. + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/dbininsert +/*/ +binary function dbininsert() +return + + +/*/{Protheus.doc} dbl2dt +Converte uma Data em double \(decimal de ponto flutuante\) para data no formato "YYYYMMDD hh:mm:ss.fff" + +@type binary function +@sintax Dbl2Dt() => character +@return character, Retorna a data no formato "YYYYMMDD hh:mm:ss.fff" + +@param , numeric, Número decimal de ponto flutuante onde a parte inteira é o numero de dias e a parte decimal é o número de milissegundos a partir das 00:00:00.000 +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/dbl2dt +/*/ +binary function dbl2dt(ndt) +return + + +/*/{Protheus.doc} dbnickindexkey +Retorna o IndexKey, ou seja, a expressão do índice identificado pelo apelido. + +@type binary function +@sintax DBNickIndexKey() => character +@return character, Retorna a expressão do índice identificado pelo apelido. Caso não exista índice com o apelido especificado, o retorno será uma string nula \(""\). + +@param , character, Indica o apelido da ordem do índice. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/dbnickindexkey +/*/ +binary function dbnickindexkey(cnick) +return + + +/*/{Protheus.doc} dborderinfo +Obtêm informações sobre determinada ordem de índice. + +@type binary function +@sintax DBOrderInfo() => variant +@return variant, Retorna a informação requisitada pelo usuário para a ordem atual do alias corrente em uso. De acordo com o tipo de informação solicitado, o retorno pode ser "C" caractere ou "N" numérico. + +@param , numeric, Indica a informação desejada do índice corrente. Para mais informações, consulte a área de Observações. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/dborderinfo +/*/ +binary function dborderinfo(ntipoinfo) +return + + +/*/{Protheus.doc} dbrecall +Desmarca o registro atual caso ele tenha sido marcado para exclusão. + +@type binary function +@sintax DBRecall() => NIL +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/dbrecall +/*/ +binary function dbrecall() +return + + +/*/{Protheus.doc} dbrecordinfo +Obtêm informações sobre o registro atual da tabela corrente. + +@type binary function +@sintax DBRecordInfo(, [@nRecord]) => variant +@return variant, Retorna a informação do registro. + +@param , numeric, Indica o tipo de informação que será verificada. +@param [@nrecord], numeric, Indica o número do registro em que está posicionado. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/dbrecordinfo +/*/ +binary function dbrecordinfo(ninfotype, nrecord) +return + + +/*/{Protheus.doc} dbrlock +Bloqueia o registro atual ou o especificado. + +@type binary function +@sintax DBRLock([nRec]) => logical +@return logical, Retorna verdadeiro \(.T.\), se o registro for bloqueado com sucesso; caso contrário, falso \(.F.\). + +@param [nrec], numeric, Indica o número do registro que será bloqueado. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/dbrlock +/*/ +binary function dbrlock(nrec) +return + + +/*/{Protheus.doc} dbrlocklist +Retorna um array com o índice registros que estão bloqueados na tabela atual. + +@type binary function +@sintax DBRLockList() => array +@return array, Retorna uma lista com os números dos registros bloqueados na tabela corrente. + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/dbrlocklist +/*/ +binary function dbrlocklist() +return + + +/*/{Protheus.doc} dbrunlock +Libera determinado registro bloqueado. + +@type binary function +@sintax DBRUnlock([nRec]) => NIL +@param [nrec], numeric, Indica o número do registro que será desbloqueado. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/dbrunlock +/*/ +binary function dbrunlock(nrec) +return + + +/*/{Protheus.doc} dbseek +Localiza um registro com determinado valor da expressão de chave de índice. + +@type binary function +@sintax DBSeek(, [lSoftSeek], [lLast]) => logical +@return logical, Retorna verdadeiro \(.T.\), se encontrar um registro com o valor especificado; caso contrário, falso \(.F.\). + +@param , variant, Indica o valor da chave que será encontrada do tipo caracter. +@param [lsoftseek], logical, Indica se, verdadeiro \(.T.\), posiciona no primeiro registro com expressão de chave maior que o valor procurado; caso contrário, falso \(.F.\) \(Valor padrão\). +@param [llast], logical, Parâmetro de compatibilidade. Deve ser informado o valor nulo \( NIL \). +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/dbseek +/*/ +binary function dbseek(xexp, lsoftseek, llast) +return + + +/*/{Protheus.doc} dbselectarea +Define a área de trabalho especificada como ativa. + +@type binary function +@sintax DBSelectArea() => NIL +@param , variant, Indica a área de trabalho que ficará ativa. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/dbselectarea +/*/ +binary function dbselectarea(xarea) +return + + +/*/{Protheus.doc} dbsetactfld +Altera a visibilidade lógica de um ou mais campos de um alias. + +@type binary function +@sintax dbSetActFld() => NIL +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/dbsetactfld +/*/ +binary function dbsetactfld() +return + + +/*/{Protheus.doc} dbsetdriver +Retorna a RDD padrão que é utilizada, podendo alterá-la. + +@type binary function +@sintax DBSetDriver([cRDD]) => character +@return character, Retorna o nome da RDD padrão. + +@param [crdd], character, Indica a nova RDD padrão. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/dbsetdriver +/*/ +binary function dbsetdriver(crdd) +return + + +/*/{Protheus.doc} dbsetfilter +Define um filtro de visualização do alias corrente. + +@type binary function +@sintax DBSetFilter(, ) => Nil +@return Nil, Retorno sempre é nulo. + +@param , codeblock, Bloco de código AdvPL avaliado para determinar a visibilidade dos registros. +@param , character, Condição de filtro expressada no bloco de código como string. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/dbsetfilter +/*/ +binary function dbsetfilter(bcond, ccond) +return + + +/*/{Protheus.doc} dbsetnickname +Define um apelido para uma determinada ordem. + +@type binary function +@sintax DBSetNickname(, [cNickname]) => character +@return character, Retorna o apelido corrente. Caso a ordem especificada não seja encontrada, não consiga setar o apelido ou não havia apelido, o retorno será uma string nula \(""\). + +@param , character, Indica o nome da ordem que receberá o apelido. +@param [cnickname], character, Indica o nome do apelido da ordem que será setada. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/dbsetnickname +/*/ +binary function dbsetnickname(cindex, cnickname) +return + + +/*/{Protheus.doc} dbstruct +Retorna um array contendo a estrutura da tabela aberta sob a Alias atual. + +@type binary function +@sintax DBStruct() => array +@return array, Retorna um array com a estrutura dos campos. Cada elemento é um subarray contendo nome, tipo, tamanho e decimais. + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/dbstruct +/*/ +binary function dbstruct() +return + + +/*/{Protheus.doc} dbunlock +Retira todos os bloqueios de registros e de arquivos da tabela atual. + +@type binary function +@sintax DBUnlock() => NIL +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/dbunlock +/*/ +binary function dbunlock() +return + + +/*/{Protheus.doc} dbunlockall +Retira o bloqueio de todos os registro e arquivos de todas as tabelas abertas em uma área de trabalho. + +@type binary function +@sintax DBUnlockAll() => NIL +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/dbunlockall +/*/ +binary function dbunlockall() +return + + +/*/{Protheus.doc} dbusearea +Abre uma tabela de dados na área de trabalho atual ou na primeira área de trabalho disponível. + +@type binary function +@sintax DBUseArea([lNewArea], [cDriver], , , [lShared], [lReadOnly]) => Nil +@return Nil, Retorno sempre é nulo. + +@param [lnewarea], logical, Caso verdadeiro, indica que a tabela deve ser aberta em uma nova workarea \(Default=.F.\) +@param [cdriver], character, Informa o Driver \(RDD\) a ser utilizada para a abertura da tabela. Caso não especificado \(NIL\), será usado o driver default de acesso a arquivos locais. +@param , character, Nome da arquivo/tabela a ser aberta. Caso o driver utilizado acesse tabelas no sistema de arquivos, deve ser informado um path no servidor de aplicação. Não é possível abrir tabelas de dados no SmartClient. +@param , character, Nome dado ao ALIAS desta tabela, para ser referenciado no programa Advpl. +@param [lshared], logical, Caso verdadeiro, indica que a tabela deve ser aberta em modo compartilhado, isto é, outros processos também poderão abrir esta tabela. +@param [lreadonly], logical, Caso verdadeiro, indica que este alias será usado apenas para leitura de dados. Caso contrário, estas operações serão permitidas. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/dbusearea +/*/ +binary function dbusearea(lnewarea, cdriver, cfile, calias, lshared, lreadonly) +return + + +/*/{Protheus.doc} dec_add +Realiza a soma dos decimais especificados, nos parâmetros <**dLeft**> e <**dRight**>, e retorna um novo decimal com o valor do resultado. + +@type binary function +@sintax DEC_ADD(, ) => decimal +@return decimal, Retorna o resultado da soma dos dois valores \(<**dLeft**> + <**dRight**>\). + +@param , decimal, Indica o valor base. +@param , decimal, Indica o valor a ser somado. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/dec_add +/*/ +binary function dec_add(dleft, dright) +return + + +/*/{Protheus.doc} dec_create +Esta função permite criar um decimal com valor inicial, precisão e escala especificados. + +@type binary function +@sintax DEC_CREATE(, , ) => decimal +@return decimal, Retorna o novo decimal criado. + +@param , variant, Indica o valor inicial do decimal. Somente caractere ou numérico. +@param , numeric, Indica a precisão do decimal. O valor deve ser maior que zero e menor que 64. +@param , numeric, Indica a escala do decimal. Valor deve ser maior ou igual a zero e menor que o parâmetro <**iPrecision**>. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/dec_create +/*/ +binary function dec_create(xvalue, iprecision, iscale) +return + + +/*/{Protheus.doc} dec_div +Realiza a divisão de decimais de ponto fixo. + +@type binary function +@sintax DEC_DIV(, ) => decimal +@return decimal, Retorna o resultado da divisão dos dois valores \(<**dLeft**> / <**dRight**>\). + +@param , decimal, Indica o dividendo da operação. +@param , decimal, Indica o divisor da operação. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/dec_div +/*/ +binary function dec_div(dleft, dright) +return + + +/*/{Protheus.doc} dec_mod +Retorna o resto da divisão de decimais de ponto fixo. + +@type binary function +@sintax DEC_MOD(, ) => decimal +@return decimal, Retorna o resto da divisão \(<**dLeft**> % <**dRight**>\). + +@param , decimal, Indica o dividendo da operação. +@param , decimal, Indica o divisor da operação. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/dec_mod +/*/ +binary function dec_mod(dleft, dright) +return + + +/*/{Protheus.doc} dec_mul +Realiza a multiplicação de decimais de ponto fixo. + +@type binary function +@sintax DEC_MUL(, ) => decimal +@return decimal, Retorna o resultado da multiplicação dos dois valores \(<**dLeft**> \* <**dRight**>\). + +@param , decimal, Indica o valor base. +@param , decimal, Indica o valor a ser multiplicado. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/dec_mul +/*/ +binary function dec_mul(dleft, dright) +return + + +/*/{Protheus.doc} dec_pow +Retorna a potenciação de decimais de ponto fixo. + +@type binary function +@sintax DEC_POW(, ) => decimal +@return decimal, Retorna a potenciação dos parâmetros \(<**dLeft**> ^ <**dRight**>\). + +@param , decimal, Indica a base da operação. +@param , decimal, Indica o expoente da operação. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/dec_pow +/*/ +binary function dec_pow(dleft, dright) +return + + +/*/{Protheus.doc} dec_rescale +Realiza rescale de um decimal de ponto fixo + +@type binary function +@sintax DEC_RESCALE(, , [nRound]) => decimal +@return decimal, Retorna o número reescalonado. + +@param , decimal, Indica o número que deve ser reescalonado. +@param , numeric, Indica a nova escala do número. +@param [nround], numeric, Indica o tipo de rescale. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/dec_rescale +/*/ +binary function dec_rescale(dnum, nscale, nround) +return + + +/*/{Protheus.doc} dec_resize +Permite alterar a precisão e a escala de um decimal de ponto fixo. + +@type binary function +@sintax DEC_RESIZE(, , , [nRound]) => decimal +@return decimal, Retorna o decimal modificado de acordo com os parâmetros informados. + +@param , decimal, Indica o número que será alterado. +@param , numeric, Indica a quantidade de dígitos do decimal. +@param , numeric, Indica a quantidade de casas decimais. +@param [nround], numeric, Indica o tipo de arredondamento das casas decimais. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/dec_resize +/*/ +binary function dec_resize(dnum, nprecision, nscale, nround) +return + + +/*/{Protheus.doc} dec_round +Arredonda um decimal de ponto fixo sem alterar a quantidade de dígitos total ou a quantidade de casas decimais. + +@type binary function +@sintax DEC_ROUND(, ) => decimal +@return decimal, Retorna o decimal arredondado para a quantidade de casas decimais indicado em <**nRound**>. + +@param , decimal, Indica o número que será arredonado. +@param , numeric, Indica a quantidade de casas decimais. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/dec_round +/*/ +binary function dec_round(dnum, nround) +return + + +/*/{Protheus.doc} dec_sub +Realiza a subtração de decimais de ponto fixo. + +@type binary function +@sintax DEC_SUB(, ) => decimal +@return decimal, Retorna o resultado da subtração dos dois valores \(<**dLeft**> - <**dRight**>\). + +@param , decimal, Indica o valor base. +@param , decimal, Indica o valor a ser subtraído. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/dec_sub +/*/ +binary function dec_sub(dleft, dright) +return + + +/*/{Protheus.doc} dec_to_dbl +Retorna o resultado da conversão de um tipo decimal de ponto fixo para numérico. + +@type binary function +@sintax DEC_TO_DBL() => numeric +@return numeric, Resultado da conversão. + +@param , decimal, Indica o valor a ser convertido. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/dec_to_dbl +/*/ +binary function dec_to_dbl(dvar) +return + + +/*/{Protheus.doc} decode64 +Converte uma string contendo um buffer codificado em BASE64 para o seu formato original + +@type binary function +@sintax Decode64(, [cFilePath*], [lChangeCase*]) => character +@return character, Retorna uma string convertida para o formato original + +@param , character, Indica uma string codificada em BASE64 que será decodificada. +@param [cfilepath*], character, Indica um arquivo para salvar o resultado da conversão +@param [lchangecase*], logical, Se verdadeiro \(.T.\), nomes de arquivos e pastas serão convertidos para letras minúsculas; caso contrário, falso \(.F.\), não será feito nenhum ajuste no nome do arquivo informado. Valor padrão \(.T.\). Veja maiores informações em Observações. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/decode64 +/*/ +binary function decode64(ctoconvert, cfilepath*, lchangecase*) +return + + +/*/{Protheus.doc} decodeutf16 +Converte uma string UTF-16 \(16-bit Unicode Transformation Format\) para a codificação CP1252. SetTitleMatchMode, 2 \* @advpl_param cText CR Indica a string UTF-16 que será convertida para o formato CP1252. + +@type binary function +@sintax DecodeUTF16([nEndian]) => character +@return character, Retorna uma nova string no formato CP1252. + +@param [nendian], numeric, Indica o endianness do texto de entrada, podendo ser: 0 - Auto-Select \(padrão\), 1 - Big-Endian e 2 - Little-Endian. Caso não seja especificado se é big-endian ou little-endian, a função verifica os primeiros bytes da sequência, procurando o Byte Order Mark \(BOM\). Caso não seja encontrado o BOM, a string é tratada como utf-16be \( big-endian \) +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/decodeutf16 +/*/ +binary function decodeutf16(nendian) +return + + +/*/{Protheus.doc} decodeutf8 +Converte uma string UTF-8 \(8-bit Unicode Transformation Format\) para a codificação CP1252. + +@type binary function +@sintax DecodeUTF8() => character +@return character, Retorna uma nova string no formato CP1252. + +@param , character, Indica a string UTF-8 que será convertida para o formato CP1252. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/decodeutf8 +/*/ +binary function decodeutf8(ctext) +return + + +/*/{Protheus.doc} delclassintf +Exclui todas classes de interface da thread. + +@type binary function +@sintax DelClassIntf() => NIL +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/delclassintf +/*/ +binary function delclassintf() +return + + +/*/{Protheus.doc} deleted +Verifica se o registro atual está com marcado para exclusão. + +@type binary function +@sintax Deleted() => logical +@return logical, Retorna verdadeiro \(**.T.**\), se o registro tem marca de excluído; caso contrário, falso \(**.F.**\). + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/deleted +/*/ +binary function deleted() +return + + +/*/{Protheus.doc} deletekeyini +Exclui a chave de uma determinada seção do arquivo de configuração \(\*.INI\). + +@type binary function +@sintax DeleteKeyIni(, , ) => logical +@return logical, Retorna verdadeiro \(.T.\), se a chave for excluída com sucesso; caso contrário, falso \(.F.\). + +@param , character, Indica o nome da seção que a chave será excluída. Exemplo: Environment, Jobs, General, etc. +@param , character, Indica o nome da chave, no arquivo de configuração \(\*.INI\), que será criada ou alterada na seção do ambiente em uso. +@param , character, Indica o nome do arquivo de configuração \(\*.INI\) do binário. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/deletekeyini +/*/ +binary function deletekeyini(csecao, cchave, cinifile) +return + + +/*/{Protheus.doc} deletesectionini +Exclui uma determinada seção do arquivo de configuração \(\*.INI\). + +@type binary function +@sintax DeleteSectionIni(, ) => logical +@return logical, Retorna verdadeiro \(.T.\), se a chave for excluída; caso contrário, falso \(.F.\). + +@param , character, Indica a seção que será excluída. +@param , character, Indica o nome do arquivo de configuração \(.INI\) do binário. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/deletesectionini +/*/ +binary function deletesectionini(csecao, cinifile) +return + + +/*/{Protheus.doc} delksyslog +Remove um identificador previamente adicionado utilizando a função SetKSysLog + +@type binary function +@sintax DelKSysLog() => NIL +@param , character, chave de identificação +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/delksyslog +/*/ +binary function delksyslog(ckey) +return + + +/*/{Protheus.doc} delnamedclassintf +descrição da funcao + +@type binary function +@sintax DelNamedClassIntf([@tNomeVar]) => codeblock +@return codeblock, descrição do retorno + +@param [@tnomevar], codeblock, descrição do parametro +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/delnamedclassintf +/*/ +binary function delnamedclassintf(tnomevar) +return + + +/*/{Protheus.doc} delobjdata +descrição da funcao + +@type binary function +@sintax DelObjData([@tNomeVar]) => codeblock +@return codeblock, descrição do retorno + +@param [@tnomevar], codeblock, descrição do parametro +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/delobjdata +/*/ +binary function delobjdata(tnomevar) +return + + +/*/{Protheus.doc} descend +Converte e retorna a forma complementada da expressão string especificada. + +@type binary function +@sintax Descend() => character +@return character, Retorna a string especificada como parâmetro de uma forma complementada. Um DESCEND\(\) de CHR\(0\) sempre retorna CHR\(0\). + +@param , character, Indica a seqüência de caracteres que será analisada. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/descend +/*/ +binary function descend(cstring) +return + + +/*/{Protheus.doc} directory +Cria um array bidimensional com o conteúdo de um diretório. +Para isso, retorna informações a respeito dos arquivos no diretório corrente ou especificado. Essa função é semelhante a ADir\(\), porém, retorna um único array ao invés de adicionar valores a uma séria de arrays existentes passados por referência. + +@type binary function +@sintax Directory(, [cAtributos], [uParam3], [lCaseSensitive], [nTypeOrder]) => array +@return array, Retorna um array de subarrays, sendo que cada subarray contém informações sobre cada arquivo que atenda o parâmetro \(\). Para mais detalhes, consulte a tabela B na área Observações. + +@param , character, Indica o diretório que será pesquisado e os arquivos que serão apresentados. Além disso, caracteres do tipo curinga são permitidos na especificação de arquivos. Caso esse parâmetro não seja especificado, o valor padrão é \*.\*. +@param [catributos], character, Indica quais arquivos com atributos especiais devem ser incluídos no array. Esse parâmetro consiste em uma string que contém um ou mais dos caracteres H, S, D e V. Para mais detalhes, consulte a tabela A na área Observações. +@param [uparam3], numeric, Compatibility parameter. Pass NIL. +@param [lcasesensitive], logical, Se verdadeiro \(.T.\), indica o nome do arquivo será transformado para letra maiúscula. Caso falso \(.F.\), o nome do arquivo será retornado conforme escrito no disco rígido. +@param [ntypeorder], numeric, Indica o tipo de ordenação do resultado da função. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/directory +/*/ +binary function directory(cdiresp, catributos, uparam3, lcasesensitive, ntypeorder) +return + + +/*/{Protheus.doc} dirremove +Remove um diretório específico. + +@type binary function +@sintax DirRemove(, [uParam2], [lChangeCase]) => logical +@return logical, Retorna verdadeiro \(.T.\), se o diretório for removido com sucesso; caso contrário, falso \(.F.\). + +@param , character, Indica o nome do diretório que será removido. +@param [uparam2], numeric, Compatibility parameter. Pass NIL. +@param [lchangecase], logical, Se verdadeiro \(.T.\), nomes de arquivos e pastas serão convertidos para letras minúsculas; caso contrário, falso \(.F.\), não será feito nenhum ajuste no nome do arquivo informado. Valor padrão \(.T.\). Veja maiores informações em Observações. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/dirremove +/*/ +binary function dirremove(cpath, uparam2, lchangecase) +return + + +/*/{Protheus.doc} diskspace +Retorna o número de bytes que estão disponíveis em uma determinada unidade de disco da estação remota. + +@type binary function +@sintax DiskSpace([nDrive]) => numeric +@return numeric, Retorna o número de bytes que estão disponíveis na unidade de disco. +Em caso de erro, retorna -1. + +@param [ndrive], numeric, Indica o número da unidade de disco \(drive\). Sendo: 0=Unidade de disco atual da estação \(Padrão\), 1=Drive A: da estação remota, 2=Drive B da estação remota, 3=Drive C: da estação remota, 4=Drive D: da estação remota e etc. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/diskspace +/*/ +binary function diskspace(ndrive) +return + + +/*/{Protheus.doc} dow +Retorna o dia da semana no formato numérico. + +@type binary function +@sintax Dow() => numeric +@return numeric, Retorna o número \(entre 0 e 7\) do dia da semana. Sendo, Domingo=1 e Sábado=7. No entanto, se o parâmetro dData estiver vazio, a função retornará zero \(0\). + +@param , date, Indica o valor data que será considerado para obter o dia da semana. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/dow +/*/ +binary function dow(ddata) +return + + +/*/{Protheus.doc} dt2dbl +Converte uma Data no formato "YYYYMMDD hh:mm:ss.fff" para um double \(decimal de ponto flutuante\) + +@type binary function +@sintax Dt2Dbl() => numeric +@return numeric, Retorna um número Double com a informação de data/hora. + +@param , character, Data a ser convertida, sempre deve ser informada no formato "YYYYMMDD hh:mm:ss.fff" +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/dt2dbl +/*/ +binary function dt2dbl(cexp) +return + + +/*/{Protheus.doc} dtoc +Converte um valor data para uma string com formato mês, dia e ano \(mm/dd/aa\). + +@type binary function +@sintax DToC() => character +@return character, Retorna a data convertida. + +@param , date, Indica a data que será convertida. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/dtoc +/*/ +binary function dtoc(ddata) +return + + +/*/{Protheus.doc} dtos +Converte um valor data para uma string com formato ano, mês e dia \(aaaammdd\). + +@type binary function +@sintax DToS() => character +@return character, Retorna a data convertida para oito caracteres no formato aaaammdd. + +@param , date, Indica a data que será convertida. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/dtos +/*/ +binary function dtos(ddata) +return + + +/*/{Protheus.doc} elaptime +Retorna uma string, com o número de segundos decorridos entre dois horários \(hora inicial e final\) diferentes, no formato hh:mm:ss. + +@type binary function +@sintax ElapTime(, ) => character +@return character, Retorna a diferença do tempo no formato hh:mm:ss. + +@param , character, Indica a hora inicial no formato hh:mm:ss +@param , character, Indica a hora final no formato hh:mm:ss +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/elaptime +/*/ +binary function elaptime(chorainicial, chorafinal) +return + + +/*/{Protheus.doc} embaralha +Embaralha/Desembaralha uma string. + +@type binary function +@sintax Embaralha(, ) => character +@return character, Retorna string embaralhada/desembaralhada. + +@param , character, Indica o texto que será embaralhado. +@param , numeric, Quando 0 embaralha String. Quando 1 desembaralha string. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/embaralha +/*/ +binary function embaralha(ctexto, ntipo) +return + + +/*/{Protheus.doc} empty +Determina se o resultado de uma expressão é vazio. + +@type binary function +@sintax Empty() => logical +@return logical, Retorna verdadeiro \(.T.\), se a expressão resultar em um valor vazio; caso contrário, falso \(.F.\) + +@param , variant, Indica uma expressão ou variável de qualquer tipo de dado. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/empty +/*/ +binary function empty(xexp) +return + + +/*/{Protheus.doc} encode64 +Converte uma string ou arquivo\* de texto ou binário para uma nova string codificada segundo o padrão BASE64 + +@type binary function +@sintax Encode64([cToConvert], [cFilePath*], [lZip*], [lChangeCase*]) => character +@return character, Retorna a string codificada em BASE64. + +@param [ctoconvert], character, Indica a string ASCII que será convertida para BASE64 +@param [cfilepath*], character, Caminho para arquivo\* que será convertido para BASE64 +@param [lzip*], logical, Se verdadeiro\(.T.\), irá compactar o conteúdo do arquivo antes de transformar em BASE64; caso contrário \(.F.\) não compacta o conteúdo do arquivo. Valor padrão \(.F.\) +@param [lchangecase*], logical, Se verdadeiro \(.T.\), nomes de arquivos e pastas serão convertidos para letras minúsculas; caso contrário, falso \(.F.\), não será feito nenhum ajuste no nome do arquivo informado. Valor padrão \(.T.\). Veja maiores informações em Observações. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/encode64 +/*/ +binary function encode64(ctoconvert, cfilepath*, lzip*, lchangecase*) +return + + +/*/{Protheus.doc} encodeutf16 +Converte uma string de origem em CP1252 \( Windows 1252 code-page \) para a codificação UTF-16 \( 16-bit Unicode Transformation Format \). + +@type binary function +@sintax EncodeUTF16(, [nEndian]) => character +@return character, Retorna uma nova string no formato UTF-16. + +@param , character, Indica a string que será convertida para o formato UTF-16. A string usada como parâmetro deve atender à codificação CP1252. +@param [nendian], numeric, Indica o endianness do texto de saída, podendo ser: 1 - Big-Endian \(padrão\) e 2 - Little-Endian. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/encodeutf16 +/*/ +binary function encodeutf16(ctext, nendian) +return + + +/*/{Protheus.doc} encodeutf8 +Converte uma string de origem em CP1252 \( Windows 1252 code-page \) para a codificação UTF-8 \( 8-bit Unicode Transformation Format \). + +@type binary function +@sintax EncodeUTF8() => character +@return character, Retorna a string no formato UTF-8. + +@param , character, Indica a string que será convertida para o formato UTF-8. A string usada como parâmetro deve atender à codificação CP1252. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/encodeutf8 +/*/ +binary function encodeutf8(ctext) +return + + +/*/{Protheus.doc} encryptrsa +Realiza a criptografia de uma string utilizando o algoritmo RSA \(Ron Rivest, Adi Shamir e Len Adleman\). + +@type binary function +@sintax EncryptRSA(, , [uParam3]) => character +@return character, Retorna a string <**cInfo**> criptografada com o algoritmo RSA, utilizando a chave pública apontada por <**cKeyFile**>. + +@param , character, Indica o nome do arquivo que contém a chave pública que será usada para criptografar o dado. +@param , character, Indica a string que será criptografada. +@param [uparam3], logical, Compatibility parameter. Pass NIL. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/encryptrsa +/*/ +binary function encryptrsa(ckeyfile, cinfo, uparam3) +return + + +/*/{Protheus.doc} eof +Informa se está no fim do Arquivo/Tabela. + +@type binary function +@sintax Eof() => logical +@return logical, Retorna .T. \(Verdadeiro\) se estiver no fim do arquivo/tabela; Caso contrário, .F. \(Falso\) + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/eof +/*/ +binary function eof() +return + + +/*/{Protheus.doc} errorblock +Recupera e/ou define um bloco de código para ser avaliado quando ocorrer um erro em tempo de execução. + +@type binary function +@sintax ErrorBlock([bErrorHandler]) => codeblock +@return codeblock, Retorna o bloco de código de tratamento de erro corrente. + +@param [berrorhandler], codeblock, Indica o bloco de código que será executado sempre que houver um erro em tempo de execução. Quando o bloco de código é avaliado, esse parâmetro é passado na forma de um objeto erro como argumento pelo sistema. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/errorblock +/*/ +binary function errorblock(berrorhandler) +return + + +/*/{Protheus.doc} eval +Executa um bloco de código + +@type binary function +@sintax Eval(, [xVariavel]) => variant +@return variant, Retorna o valor da última expressão do bloco de código. + +@param , codeblock, Indica o bloco de código que será avaliado. +@param [xvariavel], variant, Indica o argumento que será avaliado no bloco de código. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/eval +/*/ +binary function eval(bbloco, xvariavel) +return + + +/*/{Protheus.doc} evpdigest +Calcula o hash criptrográfico \(ou digest\) de um conteúdo do tipo "C" Caractere informado como parâmetro. + +@type binary function +@sintax EVPDigest(, ) => character +@return character, Retorna o hash calculado a partir de **cContent** como uma string binária em AdvPL -- cada caractere representa um byte de retorno, com os valores de 0 a 255. + +@param , character, Indica o conteúdo que será avaliado para calcular o hash. +@param , numeric, Indica o tipo de algoritmo de hash criptográfico que será utilizado para o cálculo. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/evpdigest +/*/ +binary function evpdigest(ccontent, ntype) +return + + +/*/{Protheus.doc} evpprivsign +Assina usando algoritmo digest um determinado conteúdo usando uma chave privada. + +@type binary function +@sintax EVPPrivSign([cPathKey], [cContent], [nType], [cSigned], [cPassword], [cErrStr]) => NIL +@param [cpathkey], character, Indica a string que contém o caminho para a chave privada formato .PEM . +@param [ccontent], character, Indica a string que será assinada. +@param [ntype], numeric, Indica o tipo do algortimo digest que será utilizado. +@param [csigned], character, Indica uma string que contém o valor assinado. +@param [cpassword], character, Indica a senha da chave privada apontada por cPathKey. +@param [cerrstr], character, Indica a variável para retornar as mensagens de erro. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/evpprivsign +/*/ +binary function evpprivsign(cpathkey, ccontent, ntype, csigned, cpassword, cerrstr) +return + + +/*/{Protheus.doc} evpprivvery +Verifica usando algoritmo digest um determinado conteúdo usando uma chave pública. + +@type binary function +@sintax EVPPrivVery([cPathKey], [cContent], [nType], [cSigned], [cPassword], [cErrStr]) => NIL +@param [cpathkey], character, Indica o caminho path da chave pública que deve ser no formato do arquivo .PEM. +@param [ccontent], character, Indica o valor que será verificado, com um conteúdo já assinado. +@param [ntype], numeric, Indica o tipo de algoritmo digest que será utilizado para verificar a assinatura. +@param [csigned], character, Indica uma string que contém o valor assinado. +@param [cpassword], character, Indica a senha da chave pública apontada por cPathKey. +@param [cerrstr], character, Indica a variável para retornar as mensagens de erro. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/evpprivvery +/*/ +binary function evpprivvery(cpathkey, ccontent, ntype, csigned, cpassword, cerrstr) +return + + +/*/{Protheus.doc} execindllclose +Encerra a conexão com uma DLL \(*Dynamic-link library *, ou Biblioteca de vinculo dinâmica\). + +@type binary function +@sintax ExecInDllClose() => NIL +@param , numeric, Indica o handle da DLL obtida através da função ExecInDLLOpen\(\). +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/execindllclose +/*/ +binary function execindllclose(nhandle) +return + + +/*/{Protheus.doc} execindllopen +Abre uma DLL \(*Dynamic-link library *, ou Biblioteca de vinculo dinâmica\) para executar functions ou procedures. + +@type binary function +@sintax ExecInDllOpen() => numeric +@return numeric, Retorna o handle de abertura da DLL. + +@param , character, Indica o nome e caminho da DLL. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/execindllopen +/*/ +binary function execindllopen(cdllname) +return + + +/*/{Protheus.doc} execindllrun +Executa funções ou procedures de uma DLL \(*Dynamic-link library *, ou Biblioteca de vinculo dinâmica\). + +@type binary function +@sintax ExecInDllRun(, , ) => NIL +@param , character, Indica o handle da DLL obtida através da função ExecInDLLOpen\(\). +@param , numeric, Indica a opção que será executada pela DLL. +@param , character, Indica o buffer, no formato caracter, que será recebido pela DLL. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/execindllrun +/*/ +binary function execindllrun(nhandle, nopc, cbuffer) +return + + +/*/{Protheus.doc} exedllrun2 +Executa funções ou procedures de uma DLL \(*Dynamic-link library *, ou Biblioteca de vinculo dinâmica\). + +@type binary function +@sintax ExeDLLRun2(, , ) => NIL +@param , character, Indica o handle da DLL obtida através da função ExecInDLLOpen\(\). +@param , numeric, Indica a opção que será executada pela DLL. +@param , character, Indica o buffer, no formato caracter, que será recebido pela DLL. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/exedllrun2 +/*/ +binary function exedllrun2(nhandle, nopc, cbuffer) +return + + +/*/{Protheus.doc} exedllrun3 +Executa funções ou procedures de uma DLL \(*Dynamic-link library *, ou Biblioteca de vinculo dinâmica\). + +@type binary function +@sintax ExeDLLRun3(, , ) => NIL +@param , character, Indica o handle da DLL obtida através da função ExecInDLLOpen\(\). +@param , numeric, Indica a opção que será executada pela DLL. +@param , character, Indica o buffer, no formato caracter, que será recebido pela DLL. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/exedllrun3 +/*/ +binary function exedllrun3(nhandle, nopc, cbuffer) +return + + +/*/{Protheus.doc} existdir +Determina se um diretório existe e é válido. + +@type binary function +@sintax ExistDir(, [uParam2], [lChangeCase]) => logical +@return logical, Retorna verdadeiro \(.T.\), se o diretório existir; caso contrário, falso \(.F.\). + +@param , character, Indica o nome do diretório que será verificado. +@param [uparam2], numeric, Compatibility parameter. Pass NIL. +@param [lchangecase], logical, Se verdadeiro \(.T.\), nomes de arquivos e pastas serão convertidos para letras minúsculas; caso contrário, falso \(.F.\), não será feito nenhum ajuste no nome do arquivo informado. Valor padrão \(.T.\). Veja maiores informações em Observações. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/existdir +/*/ +binary function existdir(cpath, uparam2, lchangecase) +return + + +/*/{Protheus.doc} exp +Calcula o valor do antilogaritmo de base 'e' \(base do logaritmo natural\) de um valor numérico. + +@type binary function +@sintax Exp() => numeric +@return numeric, Retorna o valor do antilogaritmo de base 'e' do expoente informado. + +@param , numeric, Indica o expoente que será utilizado no cálculo. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/exp +/*/ +binary function exp(nexpoente) +return + + +/*/{Protheus.doc} len +Retorna o tamanho de uma variável. + +@type binary function +@sintax Len() => numeric +@return numeric, Retorna o tamanho de **xParam**. + +@param , variant, Variável que será avaliada +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/len +/*/ +binary function len(xparam) +return + + +/*/{Protheus.doc} lower +Converte o texto para letras minúsculas. + +@type binary function +@sintax Lower() => character +@return character, Retorna o texto com letras minúsculas. + +@param , character, Indica o texto que será convertido de letras maiúsculas para minúsculas. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/lower +/*/ +binary function lower(ctext) +return + + +/*/{Protheus.doc} ltrim +Remove os espaços em branco à esquerda de uma string. + +@type binary function +@sintax LTrim() => character +@return character, Retorna uma string com espaços em branco à esquerda removidos. + +@param , character, Indica o texto cujos espaços em branco serão removidos. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/ltrim +/*/ +binary function ltrim(ctext) +return + + +/*/{Protheus.doc} round +Arredonda um valor decimal para a quantidade especificada de dígitos. + +@type binary function +@sintax Round(, ) => numeric +@return numeric, Retorna um valor numérico arredondado. + +@param , numeric, Indica o valor que será arredondado. +@param , numeric, Indica o número de casas decimais para arredondamento. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/round +/*/ +binary function round(nvalue, npoint) +return + + +/*/{Protheus.doc} rtrim +Remove os espaços em branco à direita de uma string. + +@type binary function +@sintax RTrim() => character +@return character, Retorna uma string com espaços em branco à direita removidos. + +@param , character, Indica o texto cujos espaços em branco serão removidos. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/rtrim +/*/ +binary function rtrim(ctext) +return + + +/*/{Protheus.doc} strzero +A partir de um numérico esta função retorna uma string formatada, inserindo zeros à esquerda e/ou o símbolo decimal \("."\) em suas casas, de acordo com as informações do parâmetro. + +@type binary function +@sintax StrZero(, , [nDecimal]) => character +@return character, Retorna uma string a partir do valor numérico e do tamanho informado no parâmetro. + +@param , numeric, Indica o valor numérico que será convertido para string. +@param , numeric, Indica o tamanho da string será gerada. +@param [ndecimal], numeric, Indica o número de casas após o símbolo decimal. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/strzero +/*/ +binary function strzero(nvalor, ntamanho, ndecimal) +return + + +/*/{Protheus.doc} substr +Retorna uma parte especifica da string. + +@type binary function +@sintax SubStr(, , [nLen]) => logical +@return logical, Retorna a string após realizar o tratamento. + +@param , character, Indica a string que será tratada. +@param , numeric, Indica o indice inicial da string <**cText**>. +@param [nlen], numeric, Indica o número de caracteres que retornará a partir de <**nIndex**>. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/substr +/*/ +binary function substr(ctext, nindex, nlen) +return + + +/*/{Protheus.doc} upper +Converte o texto para letras maiúsculas. + +@type binary function +@sintax Upper() => character +@return character, Retorna o texto com letras maiúsculas. + +@param , character, Indica o texto que será convertido de letras minúsculas para maiúsculas. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/upper +/*/ +binary function upper(ctext) +return + + +/*/{Protheus.doc} exuserexception +Exibe a janela de registro de erros encontrados \(Error log\) com a mensagem desejada e abortar a aplicação. + +@type binary function +@sintax ExUserException() => NIL +@param , character, Indica o texto que será apresentado na janela de registros de erros encontrados \(Error log\). +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/exuserexception +/*/ +binary function exuserexception(ctexto) +return + + +/*/{Protheus.doc} f2bin +Converte o número informado como parâmetro em uma string de 4 caracteres, correspondente à representação binária do número em ponto flutuante. + +@type binary function +@sintax F2Bin() => character +@return character, Retorna uma string de quatro bytes que contém a representação binária do número em ponto flutuante. + +@param , numeric, Indica o valor numérico em ponto flutuante que será convertido. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/f2bin +/*/ +binary function f2bin(nfloat) +return + + +/*/{Protheus.doc} fclose +Fecha um arquivo binário aberto + +@type binary function +@sintax FClose([nHandle]) => numeric +@return numeric, Retorna falso \(.F.\), se ocorrer ao fechar o arquivo; caso contrário, verdadeiro \(.T.\). + +@param [nhandle], numeric, Indica handle do arquivo obtido, previamente, através da função FOpen\(\) ou FCreate\(\). +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/fclose +/*/ +binary function fclose(nhandle) +return + + +/*/{Protheus.doc} fcount +Retorna a quantidade de campos existentes na estrutura da área de trabalho ativa. + +@type binary function +@sintax FCount() => numeric +@return numeric, Retorna a quantidade de campos existentes na estrutura da área de trabalho ativa. + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/fcount +/*/ +binary function fcount() +return + + +/*/{Protheus.doc} fcreate +Cria um arquivo vazio no disco, para operação de escrita em modo exclusivo, com o tamanho de 0 \( zero \) bytes. Se o arquivo especificado já existe no disco, o arquivo é aberto em modo exclusivo, e seu conteúdo é eliminado \( truncado em 0 bytes \). Caso a operação não seja completa com sucesso, a função retorna o handler -1, caso contrário é retornado o handler de acesso ao arquivo, para operações de escrita. + +@type binary function +@sintax FCreate(, [nAtributo], [xParam3], [lChangeCase]) => numeric +@return numeric, Retorna o handle do arquivo para ser usado nas demais funções de manutenção de arquivo. O handle será maior ou igual a zero. Caso não seja possível criar o arquivo, a função retornará o handle -1. Para obter mais detalhes da casua da ocorrência, utilize a função FError. + +@param , character, Indica o nome do arquivo que será criado. Pode-se especificar um path absoluto ou relativo para criar arquivos no ambiente local \(SmartClient\) ou no servidor. +@param [natributo], numeric, Compatibilidade. Deve ser informado o valor nulo \( NIL \) ou 0 \(zero\), o arquivo sempre será criado com atributos default. +@param [xparam3], Nil, Compatibilidade. Deve ser informado o valor nulo \( NIL \) +@param [lchangecase], logical, Se verdadeiro \(.T.\), nomes de arquivos e pastas serão convertidos para letras minúsculas; caso contrário, falso \(.F.\), não será feito nenhum ajuste no nome do arquivo informado. Valor padrão \(.T.\). Veja maiores informações em Observações. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/fcreate +/*/ +binary function fcreate(carquivo, natributo, xparam3, lchangecase) +return + + +/*/{Protheus.doc} ferase +Exclui um arquivo do disco. + +@type binary function +@sintax FErase(, [xParam], [lChangeCase]) => numeric +@return numeric, Retorna 0 \(zero\), se o arquivo for apagado com sucesso, e -1, caso não seja possível. Se o retorno for -1, é possível utilizar a função FError\(\) para obter mais detalhes da ocorrência. + +@param , character, Indica o nome do arquivo que será apagado. Além disso, pode-se especificar um path absoluto ou relativo para apagar arquivos na estação local ou no servidor. +@param [xparam], variant, Compatibilidade. Deve ser informado o valor nulo \( NIL \) +@param [lchangecase], logical, Se verdadeiro \(.T.\), nomes de arquivos e pastas serão convertidos para letras minúsculas; caso contrário, falso \(.F.\), não será feito nenhum ajuste no nome do arquivo informado. Valor padrão \(.T.\). Veja maiores informações em Observações. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/ferase +/*/ +binary function ferase(carquivo, xparam, lchangecase) +return + + +/*/{Protheus.doc} ferror +A função FError\(\) é utilizada para recuperar um código de erro após uma falha em operação com arquivos \( File I/O \). Quando utilizadas funções de manipulação de arquivo em baixo nível \( FCreate, FOpen, FSeek ... \), e uma operação desta natureza apresentou falha e/ou não foi realizada com sucesso, utilizamos a função FError\(\) para recuperar um código de ocorrência que aponta a condição de falha da última operação. + +@type binary function +@sintax FError() => numeric +@return numeric, Retorna um código numérico de erro referente a última operação de arquivo realizada. Caso não haja nenhum erro, a função retorna 0 \(zero\). Na área Observações, consulte os códigos de retorno. + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/ferror +/*/ +binary function ferror() +return + + +/*/{Protheus.doc} field +Retorna o nome de um campo de uma tabela aberta. + +@type binary function +@sintax Field() => character +@return character, Retorna uma string contendo o nome do campo especificado. + +@param , numeric, Indica a posição do campo na estrutura da tabela. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/field +/*/ +binary function field(npos) +return + + +/*/{Protheus.doc} fieldblock +Retorna um bloco de código para um determinado campo da tabela corrente. + +@type binary function +@sintax FieldBlock() => codeblock +@return codeblock, Retorna o bloco de código para o campo especificado no alias atual. + +@param , character, Indica o nome do campo que será retornado o bloco de código. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/fieldblock +/*/ +binary function fieldblock(cfield) +return + + +/*/{Protheus.doc} fieldget +Recupera o conteúdo de um campo do registro atualmente posicionado no alias selecionado, a partir da sua posição ordinal na estrutura da tabela. + +@type binary function +@sintax FieldGet() => variant +@return variant, Retorna o conteúdo do campo informado no registrual atual do alias aberto. + +@param , numeric, Número da posição ordinal do campo na tabela. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/fieldget +/*/ +binary function fieldget(npos) +return + + +/*/{Protheus.doc} fieldname +Retorna o nome de um campo de uma tabela aberta. + +@type binary function +@sintax FieldName() => character +@return character, Retorna uma string contendo o nome do campo especificado. + +@param , numeric, Indica a posição do campo na estrutura da tabela. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/fieldname +/*/ +binary function fieldname(npos) +return + + +/*/{Protheus.doc} fieldpos +Retorna a posição de um determinado campo dentro da área de trabalho corrente. + +@type binary function +@sintax FieldPos() => numeric +@return numeric, Retorno a posição do campo, caso não exista retorna 0. + +@param , character, Nome do campo. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/fieldpos +/*/ +binary function fieldpos(cfield) +return + + +/*/{Protheus.doc} fieldput +Permite definir o valor de um campo em uma tabela utilizando a posição ordinal do campo na estrutura da tabela. + +@type binary function +@sintax FieldPut(, ) => variant +@return variant, Retorna o valor atribuido, caso o número do campo seja inválido retorna NIL. + +@param , numeric, Posição do campo do alias/tabela atuais. +@param , variant, Valor atribuito ao campo especificado, esse valor deve ser do mesmo tipo do campo do alias/tabela. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/fieldput +/*/ +binary function fieldput(npos, xvalue) +return + + +/*/{Protheus.doc} fieldwblock +Retorna um bloco de código para um campo de uma área de trabalho aberta. + +@type binary function +@sintax FieldWBlock(, ) => codeblock +@return codeblock, Retorna o bloco de código para o campo da área de trabalho informada. + +@param , character, Indica o nome do campo que será retornado o bloco de código. +@param , numeric, Indica o número da área de trabalho que será retornado o bloco de código. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/fieldwblock +/*/ +binary function fieldwblock(cfield, nwokarea) +return + + +/*/{Protheus.doc} file +Determina se existe arquivo no diretório ou path AdvPL padrão. + +@type binary function +@sintax File(, [nWhere], [lChangeCase]) => logical +@return logical, Retorna verdadeiro \(.T.\), se o arquivo existir; caso contrário, falso \(.F.\). + +@param , character, Indica o nome do arquivo ou diretório+arquivo que será procurado. Além disso, são aceitos os caracteres curingas \(\* e ?\) e diretórios absolutos e relativos. +@param [nwhere], numeric, Indica o local onde será realizada a procura do arquivo. Sendo: 0 = O acesso depende do path \(Quando for um path relativo a procura será no Application Server; caso seja um path absoluto, a procura será no Smart Client\). 1 = A procura será realizada no diretório de instalação do Application Server. 2 = A procura será realizada no diretório de instalação do Smart Client. +@param [lchangecase], logical, Se verdadeiro \(.T.\), nomes de arquivos e pastas serão convertidos para letras minúsculas; caso contrário, falso \(.F.\), não será feito nenhum ajuste no nome do arquivo informado. Valor padrão \(.T.\). Veja maiores informações em Observações. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/file +/*/ +binary function file(carquivo, nwhere, lchangecase) +return + + +/*/{Protheus.doc} findclass +Indica se uma classe, informada através de uma string por parâmetro existe no binário e/ou repositório do ambiente atua. + +@type binary function +@sintax FindClass() => logical +@return logical, Retorna verdadeiro \(.T.\), se a classe for encontrada no RPO ou no binário; caso contrário, falso \(.F.\). + +@param , character, Indica o nome da classe a ser verificada. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/findclass +/*/ +binary function findclass(cclassname) +return + + +/*/{Protheus.doc} findfunction +Verifica se uma determinada função está disponível no repositório de objetos ou no binário, do Application Server, para ser executada. + +@type binary function +@sintax Findfunction() => logical +@return logical, Retorna verdadeiro \(.T.\), se a função estiver disponível, no repositório de objetos corrente, para ser executada; caso contrário, falso \(.F.\). + +@param , character, Indica o nome da função que será consultada. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/findfunction +/*/ +binary function findfunction(cfuncao) +return + + +/*/{Protheus.doc} flistzip +Lista os arquivos que estão dentro do arquivo compactado em formato Zip. + +@type binary function +@sintax FListZip(, [@nRet], [cSenha]) => array +@return array, Retorna uma lista com os nomes e tamanhos dos arquivos compactados. + +@param , character, Indica o nome do arquivo compactado zip. +@param [@nret], numeric, Retorno da função, se 0 retornou corretamente a lista de arquivos, diferente de 0 se aconteceu algum erro. +@param [csenha], character, Senha que foi utilizada na compactação +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/flistzip +/*/ +binary function flistzip(carquivozip, nret, csenha) +return + + +/*/{Protheus.doc} flock +Bloqueia uma tabela ou arquivo. + +@type binary function +@sintax FLock() => logical +@return logical, Retorna verdadeiro \(.T.\), se a tabela for bloqueada com sucesso; caso contrário, falso \(.F.\). + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/flock +/*/ +binary function flock() +return + + +/*/{Protheus.doc} fopen +Abre um arquivo binário. +É uma função de tratamento de arquivo de baixo nível que abre um arquivo binário existente para que possa ser lido e escrito, dependendo do argumento no parâmetro . + +@type binary function +@sintax FOpen(, [nModo], [xParam3], [lChangeCase]) => numeric +@return numeric, Retorna o handle de arquivo aberto, na faixa de 0 a 65.535. Caso ocorra um erro, o retorno será -1. + +@param , character, Indica o nome do arquivo que será aberto que inclui o path, caso haja um. +@param [nmodo], numeric, Indica o modo de acesso DOS solicitado que indicará como o arquivo aberto deve ser acessado. O acesso é uma das categorias relacionadas na tabela A e as retrições de compartilhamento estão na tabela B. O modo padrão é 0 \(zero\), aberto para leitura, com compartilhamento por compatibilidade. Ao definirmos o modo de acesso, deve-se somar um elemento da tabela A com a B. +@param [xparam3], variant, Compatibilidade. Deve ser informado o valor nulo \( NIL \) +@param [lchangecase], logical, Se verdadeiro \(.T.\), nomes de arquivos e pastas serão convertidos para letras minúsculas; caso contrário, falso \(.F.\), não será feito nenhum ajuste no nome do arquivo informado. Valor padrão \(.T.\). Veja maiores informações em Observações. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/fopen +/*/ +binary function fopen(carq, nmodo, xparam3, lchangecase) +return + + +/*/{Protheus.doc} fpprecise +Função de Ativar ou Desativar comportamento de Float Point Precise. + +@type binary function +@sintax FPPrecise([lPrecise]) => NIL +@param [lprecise], logical, Verdadeiro \(.T.\) ativa e Falso\(.F.\) desativa \( Default = .F. \) +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/fpprecise +/*/ +binary function fpprecise(lprecise) +return + + +/*/{Protheus.doc} fread +Lê caracteres de um arquivo binário para uma variável de buffer. + +@type binary function +@sintax FRead(, , ) => numeric +@return numeric, Retorna a quantidade de bytes lidos na forma de um valor numérico inteiro. Um valor de retorno menor ou 0 \(zero\) indica final de arquivo ou algum erro de leitura. Para obter mais detalhes, utilize a função FError\(\). + +@param , numeric, Indica o handle do arquivo obtido pelas funções FOpen\(\) ou FCreate\(\). +@param , character, Indica o nome de uma variável do tipo caractere. Essa variável é utilizada como buffer de leitura, para que os dados lidos sejam armazenados. O tamanho desta variável deve ser maior ou igual ao tamanho informado no parâmetro . +@param , numeric, Indica a quantidade de bytes que serão lidos do arquivo a partir do posicionamento do ponteiro atual. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/fread +/*/ +binary function fread(nhandle, cbuffervar, nqtdbytes) +return + + +/*/{Protheus.doc} freadstr +Lê caracteres de um arquivo binário. + +@type binary function +@sintax FReadStr(, ) => character +@return character, Retorna uma string contendo os caracteres lidos. + +@param , numeric, Indica o handle do arquivo obtido pelas funções FOpen\(\), FCreate\(\). +@param , numeric, Indica a quantidade de bytes que devem ser lidos do arquivo a partir do posicionamento do ponteiro atual. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/freadstr +/*/ +binary function freadstr(nhandle, nqtdbytes) +return + + +/*/{Protheus.doc} freeobj +Elimina da memória a instância do objeto informado como parâmetro. + +@type binary function +@sintax FreeObj([oObj]) => NIL +@param [oobj], object, Indica o objeto AdvPL a ser eliminado da memória. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/freeobj +/*/ +binary function freeobj(oobj) +return + + +/*/{Protheus.doc} frename +Renomeia um arquivo. + +@type binary function +@sintax FRename(, , [nParam3], [lChangeCase]) => numeric +@return numeric, Retorna 0 \(zero\), se a operação for realizada com sucesso; caso contrário, retornará -1 se falhar. Em caso de falha, utilize a função FError\(\) para obter mais detalhes. + +@param , character, Indica o nome do arquivo que será renomeado, inclusive sua extensão. Também podem ser incluídos como parte do nome uma letra indicativa da unidade de disco e/ou nome do diretório. Caso não seja especificado nenhuma unidade de disco ou diretório, será considerado o diretório atual do servidor. +@param , character, Indica o novo nome do arquivo, incluindo a extensão. Também podem ser incluídos como parte do nome uma letra indicativa da unidade de disco e/ou nome do diretório. +@param [nparam3], Nil, Compatibilidade, informar sempre Nil. +@param [lchangecase], logical, Se verdadeiro \(.T.\), nomes de arquivos e pastas serão convertidos para letras minúsculas; caso contrário, falso \(.F.\), não será feito nenhum ajuste no nome do arquivo informado. Valor padrão \(.T.\). Veja maiores informações em Observações. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/frename +/*/ +binary function frename(carquivo, cnovoarq, nparam3, lchangecase) +return + + +/*/{Protheus.doc} frenameex +Renomeia um arquivo no Application Server e/ou Smart Client respeitando o case do nome do arquivo indicado no segundo parametro. \(Por default, primeiro parâmetro continua alterando o case\) + +@type binary function +@sintax FRenameEx(, , [nParam3]) => numeric +@return numeric, Retorna 0 \(zero\), se a operação for realizada com sucesso; caso contrário, retornará -1 se falhar. Em caso de falha, utilize a função FError\(\) para obter mais detalhes. + +@param , character, Indica o nome do arquivo que será renomeado, inclusive sua extensão. Também podem ser incluídos como parte do nome uma letra indicativa da unidade de disco e/ou nome do diretório. Caso não seja especificado nenhuma unidade de disco ou diretório, será considerado o diretório atual do servidor. +@param , character, Indica o novo nome do arquivo, incluindo a extensão. Também podem ser incluídos como parte do nome uma letra indicativa da unidade de disco e/ou nome do diretório. +@param [nparam3], Nil, Compatibilidade, informar sempre Nil. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/frenameex +/*/ +binary function frenameex(carquivo, cnovoarq, nparam3) +return + + +/*/{Protheus.doc} fseek +Posiciona o ponteiro do arquivo para as próximas operações de leitura ou gravação. + +@type binary function +@sintax FSeek(, , [nOrigem]) => numeric +@return numeric, Retorna a nova posição do ponteiro de arquivo, com relação ao início do arquivo \(posição 0\), na forma de um valor numérico inteiro. Este valor não considera a posição original do ponteiro de arquivos antes da execução da função FSeek\(\). + +@param , numeric, Indica o manipulador do arquivo obtido através das funções FCreate\(\) e FOpen. +@param , numeric, Indica o número de bytes que o ponteiro de arquivo será movido a partir da posição definida no parâmetro . Esse número pode ser positivo, negativo ou zero, dependendo da direção na qual se deseja que o ponteiro seja movido. +@param [norigem], numeric, Indica a partir de qual posição será iniciada a contagem do número de bytes a ser movido. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/fseek +/*/ +binary function fseek(nhandle, noffset, norigem) +return + + +/*/{Protheus.doc} ft_feof +Indica se o ponteiro está posicionado no fim do arquivo texto. + +@type binary function +@sintax FT_FEOF() => logical +@return logical, Retorna verdadeiro \(.T.\), se o ponteiro do arquivo texto \(aberto pela função FT_FUse\) estiver posicionado no final; caso contrário, falso \(.F.\). + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/ft_feof +/*/ +binary function ft_feof() +return + + +/*/{Protheus.doc} ft_fgoto +Move o ponteiro, que indica a leitura do arquivo texto, para a posição absoluta especificada no parâmetro . + +@type binary function +@sintax FT_FGoto() => NIL +@param , numeric, Indica a posição do ponteiro que realizará a leitura dos dados no arquivo. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/ft_fgoto +/*/ +binary function ft_fgoto(npos) +return + + +/*/{Protheus.doc} ft_fgotop +Posiciona no início \(primeiro caracter da primeira linha\) do arquivo texto aberto pela função FT_FUse\(\). + +@type binary function +@sintax FT_FGotop() => NIL +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/ft_fgotop +/*/ +binary function ft_fgotop() +return + + +/*/{Protheus.doc} ft_flastrec +Lê e retorna o número total de linhas do arquivo texto aberto pela função FT_FUse\(\). + +@type binary function +@sintax FT_FLastRec() => numeric +@return numeric, Retorna a quantidade de linhas existentes no arquivo. Caso o arquivo esteja vazio ou não exista arquivo aberto, a função retornará 0 \(zero\). + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/ft_flastrec +/*/ +binary function ft_flastrec() +return + + +/*/{Protheus.doc} ft_freadln +Lê e retorna uma linha de texto do arquivo aberto pela função FT_FUse\(\). As linhas do texto, são delimitadas pela sequência de caracteres CRLF \(chr\(13\)+chr\(10\)\) ou apenas LF \(chr\(10\)\), e o tamanho máximo de cada linha é 1022 bytes. + +@type binary function +@sintax FT_FReadLn() => character +@return character, Retorna a linha inteira na qual está posicionado o ponteiro para leitura de dados. + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/ft_freadln +/*/ +binary function ft_freadln() +return + + +/*/{Protheus.doc} ft_frecno +Lê e retorna a posição atual do ponteiro do arquivo texto aberto pela função FT_FUse\(\). + +@type binary function +@sintax FT_FRecno() => character +@return character, Retorna a posição corrente do ponteiro do arquivo texto. + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/ft_frecno +/*/ +binary function ft_frecno() +return + + +/*/{Protheus.doc} ft_fskip +Move o ponteiro, do arquivo texto aberto pela função FT_FUse\(\), para uma nova posição. + +@type binary function +@sintax FT_FSkip() => NIL +@param , numeric, Indica o número de linhas do arquivo texto \(\*.txt\). +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/ft_fskip +/*/ +binary function ft_fskip(nlinhas) +return + + +/*/{Protheus.doc} ft_fuse +Abre e fecha um arquivo texto para disponibilizar às funções FT_F\*. + +@type binary function +@sintax FT_FUse() => numeric +@return numeric, Retorna o handle de controle do arquivo. Em caso de falha na abertura, a função retornará -1. + +@param , character, Indica o nome do arquivo \*.txt que será aberto. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/ft_fuse +/*/ +binary function ft_fuse(ctxtfile) +return + + +/*/{Protheus.doc} funzip +Descompacta um arquivo no formato Zip. + +@type binary function +@sintax FUnZip(, , [cSenha]) => numeric +@return numeric, Retorna 0 zero se consegui descompactar ou diferente de 0 zero em caso de erro. + +@param , character, Indica o nome do arquivo que será descompactado zip. +@param , character, Pasta onde o arquivo será descompactado. +@param [csenha], character, Se o arquivo foi compactado com senha, informar essa senha +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/funzip +/*/ +binary function funzip(carquivozip, cpasta, csenha) +return + + +/*/{Protheus.doc} fwrite +Escreve dados de um buffer de string em um arquivo binário. Para isso, pode-se escrever todo ou parte do conteúdo do buffer, limitando a quantidade de bytes. + +@type binary function +@sintax FWrite(, , [nQtdBytes]) => numeric +@return numeric, Retorna a quantidade de bytes escritos na forma de um valor numérico inteiro. Caso o valor seja igual ao parâmetro , a operação foi realizada com sucesso; caso contrário, se o valor for menor ou zero, o disco rígido está cheio ou ocorreu erro. + +@param , numeric, Indica o manipulador de arquivo obtido através das funções FCreate\(\) e FOpen\(\). +@param , character, Indica a string que será escrita no arquivo especificado. O tamanho desta variável deve ser maior ou igual ao tamanho informado no parâmetro \(caso seja informado o tamanho\). +@param [nqtdbytes], numeric, Indica a quantidade de bytes que serão escritos a partir da posição atual do ponteiro de arquivos. Caso não seja informado, todo o conteúdo do parâmetro é escrito. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/fwrite +/*/ +binary function fwrite(nhandle, cbuffer, nqtdbytes) +return + + +/*/{Protheus.doc} fzip +Compacta uma lista de arquivos no formato Zip. + +@type binary function +@sintax FZip(, , [cBaseDir], [cSenha]) => numeric +@return numeric, Retorna 0 zero se conseguir compactar ou diferente de 0 zero em caso de erro + +@param , character, Indica o nome do arquivo final compactado zip. +@param , array, Lista de arquivos que serão compactados. +@param [cbasedir], character, Indica o diretório base para não incluir dentro do arquivo compactado. +@param [csenha], character, Informar uma senha para gerar um arquivo compactado criptografado +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/fzip +/*/ +binary function fzip(carquivozip, aarquivos, cbasedir, csenha) +return + + +/*/{Protheus.doc} gensql +descrição da funcao + +@type binary function +@sintax GenSql([@tNomeVar]) => codeblock +@return codeblock, descrição do retorno + +@param [@tnomevar], codeblock, descrição do parametro +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/gensql +/*/ +binary function gensql(tnomevar) +return + + +/*/{Protheus.doc} get_sqlca +descrição da funcao + +@type binary function +@sintax Get_Sqlca([@tNomeVar]) => codeblock +@return codeblock, descrição do retorno + +@param [@tnomevar], codeblock, descrição do parametro +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/get_sqlca +/*/ +binary function get_sqlca(tnomevar) +return + + +/*/{Protheus.doc} getallrpoinfo +Retorna um array contendo TODOS - sem exceção - os dados das funções contidas no RPO - Repositório Portável de Objetos. + +@type binary function +@sintax GetAllRpoInfo() => NIL +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/getallrpoinfo +/*/ +binary function getallrpoinfo() +return + + +/*/{Protheus.doc} getapoinfo +Retorna um array com informações \(nome, linguagem, modo de compilação, data da última modificação e hora/minuto/segundo\) de um determinado arquivo de código-fonte \(\*.PRW\). + +@type binary function +@sintax GetApoInfo() => array +@return array, Retorna um array com os dados do arquivo de código fonte. Para informações do formato do array, consulte a tabela Formato do array de retorno, na área Observações. + +@param , character, Indica o nome do arquivo de código fonte \(.PRW\). +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/getapoinfo +/*/ +binary function getapoinfo(cfonte) +return + + +/*/{Protheus.doc} getapores +Retorna o conteúdo de um resource do repositório. + +@type binary function +@sintax GetApoRes() => character +@return character, Conteúdo do resource + +@param , character, Indica o nome do resource. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/getapores +/*/ +binary function getapores(cres) +return + + +/*/{Protheus.doc} getapppath +Recupera caminho no qual o Application Server está sendo executado. + +@type binary function +@sintax getAppPath(<@cPath>) => numeric +@return numeric, Retorna 0 em caso de sucesso na obtenção do caminho ou valor maior que zero em caso de erro. + +@param <@cpath>, character, Variável, por referência, que receberá o caminho onde o application server está sendo executado. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/getapppath +/*/ +binary function getapppath(cpath) +return + + +/*/{Protheus.doc} getauthargs +Recupera os parametros utilizados para autenticação. + +@type binary function +@sintax GetAuthArgs() => object +@return object, Retorna um THashMap com os parametros de autenticação. + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/getauthargs +/*/ +binary function getauthargs() +return + + +/*/{Protheus.doc} getbuild +Retorna uma string com informações da build \(ID da compilação\) em uso pelo Application Server. + +@type binary function +@sintax GetBuild([lType]) => character +@return character, Retorna uma string com os dados da build corrente. + +@param [ltype], logical, Indica se deve retornar a versão do SmartClient \(**.T.**\) ou Application Server \(**.F.**\). Se não for informado, será atribuído **.F.**. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/getbuild +/*/ +binary function getbuild(ltype) +return + + +/*/{Protheus.doc} getcbsource +Recupera o código-fonte de um bloco de código. + +@type binary function +@sintax GetCBSource() => character +@return character, Retorna o código-fonte do bloco de código especificado. Veja detalhes adicionais no tópico de Observações. + +@param , codeblock, Indica a variável que contém o bloco de código para recuperar o código-fonte. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/getcbsource +/*/ +binary function getcbsource(bblocodecodigo) +return + + +/*/{Protheus.doc} getchildct +descrição da funcao + +@type binary function +@sintax GetChildCt([@tNomeVar]) => codeblock +@return codeblock, descrição do retorno + +@param [@tnomevar], codeblock, descrição do parametro +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/getchildct +/*/ +binary function getchildct(tnomevar) +return + + +/*/{Protheus.doc} getclassname +Retorna o nome da classe. + +@type binary function +@sintax GetClassName() => character +@return character, Retorna o nome da classe. + +@param , object, Indica o objeto que será utilizado para pesquisar o nome. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/getclassname +/*/ +binary function getclassname(oobjeto) +return + + +/*/{Protheus.doc} getclientdir +Retorna o caminho do diretório onde o Smart Client está instalado. + +@type binary function +@sintax GetClientDir() => character +@return character, Retorna o caminho do diretório onde o Smart Client está instalado. + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/getclientdir +/*/ +binary function getclientdir() +return + + +/*/{Protheus.doc} getclientip +Retorna o número IP - Internet Protocol do servidor que o SmartClient está instalado. + +@type binary function +@sintax GetClientIP() => character +@return character, Retorna o número IP do servidor que o Smart Client está instalado. + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/getclientip +/*/ +binary function getclientip() +return + + +/*/{Protheus.doc} getcodepage +Retorna o encode definido no .ini do Application Server. + +@type binary function +@sintax GetCodePage() => character +@return character, encode atual. + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/getcodepage +/*/ +binary function getcodepage() +return + + +/*/{Protheus.doc} getcomputername +Retorna o nome da máquina \(Hostname\) onde o SmartClient está sendo executado. + +@type binary function +@sintax GetComputerName() => character +@return character, Nome da máquina. + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/getcomputername +/*/ +binary function getcomputername() +return + + +/*/{Protheus.doc} getconnstatus +Informa se a conexão com o TOTVS Application Server foi encerrada. + +@type binary function +@sintax GetConnStatus() => logical +@return logical, Retorna verdadeiro \(.T.\), se a conexão com o Application Server for encerrada com sucesso; caso contrário, falso \(.F.\). + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/getconnstatus +/*/ +binary function getconnstatus() +return + + +/*/{Protheus.doc} getcredential +Obtém a credencial do usuário, no sistema operacional, no qual está autenticado. + +@type binary function +@sintax GetCredential() => character +@return character, Retorna uma string que corresponde a credencial do usuário. + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/getcredential +/*/ +binary function getcredential() +return + + +/*/{Protheus.doc} getdbextension +Retorna a extensão dos arquivos de banco de dados. + +@type binary function +@sintax GetDBExtension() => character +@return character, Retorna a extensão dos arquivos de banco de dados. + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/getdbextension +/*/ +binary function getdbextension() +return + + +/*/{Protheus.doc} getdependency +Retorna os fontes necessários para a\(s\) chamada\(s\) de classes ou funções de um determinado arquivo. + +@type binary function +@sintax GetDependency() => NIL +@param , character, String com o nome do fonte que deseja saber as dependências +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/getdependency +/*/ +binary function getdependency(sfonte) +return + + +/*/{Protheus.doc} getdtodate +Converte uma string para o tipo data. + +@type binary function +@sintax GetDtoDate() => date +@return date, Retorna a data convertida + +@param , character, Indica a string que contém uma data a ser convertida. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/getdtodate +/*/ +binary function getdtodate(cdata) +return + + +/*/{Protheus.doc} getdtoval +Converte uma string que contém um valor numérico para um número formatado. + +@type binary function +@sintax GetDtoVal() => numeric +@return numeric, Retorna um dado numérico. + +@param , character, Indica a string \(com valor numérico\) que será convertida. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/getdtoval +/*/ +binary function getdtoval(cdtoval) +return + + +/*/{Protheus.doc} getenv +Determina o conteúdo de uma variável de ambiente \(environment\) do sistema operacional em uso no Application Server. + +@type binary function +@sintax GetEnv() => character +@return character, Caso a variável de ambiente esteja definida, será retornada uma string correspondente ao conteúdo da variável. Caso a variável não esteja definida, é retornado uma string vazia \(''\) + +@param , character, Indica o nome da variável de ambiente do sistema operacional. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/getenv +/*/ +binary function getenv(cvarenv) +return + + +/*/{Protheus.doc} getenvhost +Retorna o host \(nome/endereço\), quando ambiente Web, da página chamada. + +@type binary function +@sintax GetEnvHost() => character +@return character, exemplo: www.totvs.com.br + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/getenvhost +/*/ +binary function getenvhost() +return + + +/*/{Protheus.doc} getenvserver +Retorna uma string com o nome do ambiente \(environment\) em execução no Application Server. + +@type binary function +@sintax GetEnvServer() => character +@return character, Retorna uma string com o nome do ambiente \(environment\) em execução no Application Server. + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/getenvserver +/*/ +binary function getenvserver() +return + + +/*/{Protheus.doc} getfuncarray +Retorna um ou mais arrays contendo os dados das funções contidas no RPO - Repositório Portável de Objetos, a partir de uma máscara. + +@type binary function +@sintax GetFuncArray(, [@aTipo], [@aArquivo], [@aLinha], [@aData], [@aHora]) => array +@return array, Retorna um array que contém os nomes das funções localizadas através da máscara, compiladas no repositório em uso pelo ambiente. + +@param , character, Indica a máscara que será utilizada para realizar a busca. Observação: Podem ser utilizados caracteres do tipo curinga \("?" ou "\*"\). +@param [@atipo], array, Indica o array que será alimentado com o tipo da função encontrada. +@param [@aarquivo], array, Indica o array que será alimentado com o nome do arquivo que contém o código fonte. +@param [@alinha], array, Indica o array que será alimentado com o número da linha correspondente a declaração da função no arquivo do código fonte. +@param [@adata], array, Indica o array que será alimentado com a data da última modificação do arquivo que contém o código fonte. +@param [@ahora], array, Indica o array que será alimentado com a hora da última modificação do arquivo que contém o código fonte. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/getfuncarray +/*/ +binary function getfuncarray(cmascara, atipo, aarquivo, alinha, adata, ahora) +return + + +/*/{Protheus.doc} getglbvalue +Retorna a string armazenada em uma variável global. + +@type binary function +@sintax GetGlbValue() => character +@return character, Retorna o valor da variável global especificada no parâmetro cGlbName. Caso a variável não seja encontrada, retorna um caracter vazio. + +@param , character, Indica o nome da variável global. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/getglbvalue +/*/ +binary function getglbvalue(cglbname) +return + + +/*/{Protheus.doc} getglbvars +Retorna os valores armazenados em uma variável global. + +@type binary function +@sintax GetGlbVars(, <@xValue1...N>) => logical +@return logical, Retorna verdadeiro \(.T.\) caso o identificador seja encontrado e as variáveis sejam retornadas; caso contrário, retorna falso \(.F.\). + +@param , character, Indica o nome da variável global. +@param <@xvalue1...n>, variant, Indica os nomes de uma ou mais variáveis, passadas por referência, que receberão os valores armazenados na variável global. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/getglbvars +/*/ +binary function getglbvars(cglbname, xvalue1n) +return + + +/*/{Protheus.doc} gethardwareid +Retorna o número de série do drive onde está sendo executado o TOTVS \| Application Server. + +@type binary function +@sintax GetHardwareId() => character +@return character, Retorna o ID \(número de série\) do drive onde está sendo executado o TOTVS \| Application Server. + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/gethardwareid +/*/ +binary function gethardwareid() +return + + +/*/{Protheus.doc} getimpwindows +Retorna um array com os nomes das impressoras disponíveis. + +@type binary function +@sintax GetImpWindows() => array +@return array, Retorna um array, no formato texto, com as impressoras instaladas. Sendo que, a primeira impressora da lista é a padrão. + +@param , logical, Indica se, verdadeiro \(.T.\), retorna as impressoras do Application Server; caso contrário, falso \(.F.\), do Smart Client. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/getimpwindows +/*/ +binary function getimpwindows(ldirect) +return + + +/*/{Protheus.doc} getinikeys +Retorna um array com o nome de todas as chaves de uma determinada sessão em um arquivo de configuração APPServer \(APPSERVER.INI\), como por exemplo, a sessão TCP retornaria as suas chaves\(TYPE, PORT\). + +@type binary function +@sintax GetIniKeys(, , [uParam3]) => array +@return array, Retorna um array com o nome de todas as chaves de uma determinada sessão em um arquivo de configuração \(.INI\). Porém, caso a sessão especificada não seja encontrada, o array retornará vazio. + +@param , character, Indica o nome do arquivo de configuração do APPServer \(APPSERVER.INI\) que se deseja obter as seções. +@param , character, Indica o nome da Sessão do arquivo de configuração que se deseja obter as chaves. +@param [uparam3], numeric, Compatibility parameter. Pass NIL. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/getinikeys +/*/ +binary function getinikeys(cini, csessao, uparam3) +return + + +/*/{Protheus.doc} getinisessions +Retorna um array com o nome de todas as seções de um determinado arquivo de configuração \(.INI\), como por exemplo, TCP, GENERAL e DRIVERS. + +@type binary function +@sintax GetINISessions(, [uParam2]) => array +@return array, Retorna um array com os nomes de todas as seções do arquivo de configuração \(.INI\). Porém, caso o arquivo especificado não seja encontrado, o array retornará vazio. + +@param , character, Indica o nome do arquivo de configuração \(.INI\) que se deseja obter as seções. +@param [uparam2], numeric, Compatibility parameter. Pass NIL. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/getinisessions +/*/ +binary function getinisessions(cini, uparam2) +return + + +/*/{Protheus.doc} getlinesprog +Retorna o numero de linhas executáveis do fonte onde ela foi chamada, ou GetLinesProg\("fonte.extensao"\) para retornar de um outro fonte. + +@type binary function +@sintax GetLinesProg() => numeric +@return numeric, Numero de linhas do fonte + +@param , character, Caso presente, procura o arquivo indicado no RPO atual e ve qual o numero de linhas dele. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/getlinesprog +/*/ +binary function getlinesprog(cfile) +return + + +/*/{Protheus.doc} getmailobj +Obtém o objeto de e-mail tMailManager, referente ao valor informado no parâmetro . + +@type binary function +@sintax GetMailObj() => object +@return object, Retorna um objeto tMailManager, caso tenha sido encontrado o identificador ; caso contrário retorna Nil. + +@param , character, Indica um identificador para recuperar o objeto armazenado. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/getmailobj +/*/ +binary function getmailobj(cid) +return + + +/*/{Protheus.doc} getmainsource +Retorna o nome do fonte onde foi iniciada a entrada no programa, sendo ele o primeiro fonte da pilha de execução. + +@type binary function +@sintax GetMainSource() => character +@return character, Retorna o nome do fonte principal, onde foi feita a entrada no programa que criou a pilha de execução. + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/getmainsource +/*/ +binary function getmainsource() +return + + +/*/{Protheus.doc} getobjdetail +descrição da funcao + +@type binary function +@sintax GetObjDetail([@tNomeVar]) => codeblock +@return codeblock, descrição do retorno + +@param [@tnomevar], codeblock, descrição do parametro +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/getobjdetail +/*/ +binary function getobjdetail(tnomevar) +return + + +/*/{Protheus.doc} getparenttree +Retorna um array com o nome da classe e das classes herdadas por ordem de herança. + +@type binary function +@sintax GetParentTree() => array +@return array, Um array de caracteres com os nomes das classes herdadas + +@param , object, Indica o objeto o qual deseja saber o nome da classe e sua herança +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/getparenttree +/*/ +binary function getparenttree(oobjeto) +return + + +/*/{Protheus.doc} getport +Retorna o número da porta que o servidor de aplicação, license, http ou https está escutando. + +@type binary function +@sintax GetPort() => numeric +@return numeric, Retorna o número da porta em formato númerico, caso a porta não esteja habilitada ou o tipo da porta não esteja no intervalo de 1 a 4, retorna -1. + +@param , numeric, Indica o tipo da porta \(1 - Application, 2 - License, 3 - HTTP, 4 - HTTPS\). +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/getport +/*/ +binary function getport(ntype) +return + + +/*/{Protheus.doc} getportactive +Retorna um array com os nomes das portas disponíveis. + +@type binary function +@sintax GetPortActive() => array +@return array, Retorna um array, no formato texto, com as portas disponíveis. + +@param , logical, Indica se, verdadeiro \(.T.\), retorna as portas do Application Server; caso contrário, falso \(.F.\), do Smart Client. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/getportactive +/*/ +binary function getportactive(ldirect) +return + + +/*/{Protheus.doc} getpowersc +Retorna os elementos do plano de energia \(power scheme\) corrente do sistema operacional em um array de arrays. + +@type binary function +@sintax GetPowerSC() => array +@return array, Array de arrays contendo os dados dos elementos do plano de energia corrente do sistema operacional. + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/getpowersc +/*/ +binary function getpowersc() +return + + +/*/{Protheus.doc} getprgtag +descrição da funcao + +@type binary function +@sintax GetPrgTag([@tNomeVar]) => codeblock +@return codeblock, descrição do retorno + +@param [@tnomevar], codeblock, descrição do parametro +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/getprgtag +/*/ +binary function getprgtag(tnomevar) +return + + +/*/{Protheus.doc} getprocinfoarray +Retorna uma lista com informações de todas as threads \(menos as threads de usuário/monitor\) que estão em execução no Application Server. + +@type binary function +@sintax GetProcInfoArray() => array +@return array, Lista com informações das threads \(vide Obs.\) + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/getprocinfoarray +/*/ +binary function getprocinfoarray() +return + + +/*/{Protheus.doc} getprofint +Recupera o conteúdo numérico de uma chave do arquivo win.ini \(arquivo utilizado para armazenar configurações básicas de inicialização\) do sistema operacional + +@type binary function +@sintax GetProfInt(, , ) => numeric +@return numeric, Retorna o conteúdo da chave especificada ou o seu valor padrão. + +@param , character, Indica o nome da seção em que um valor será recuperado. +@param , character, Indica o nome da chave em que um valor será recuperado. +@param , numeric, Indica o conteúdo padrão que será recuperado. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/getprofint +/*/ +binary function getprofint(csecao, cchave, npadrao) +return + + +/*/{Protheus.doc} getprofstring +Recupera o conteúdo caractere de uma chave do arquivo win.ini \(arquivo utilizado para armazenar configurações básicas de inicialização\) do sistema operacional. + +@type binary function +@sintax GetProfString(, , ) => character +@return character, Retorna o conteúdo da chave especificada ou o seu valor padrão. + +@param , character, Indica o nome da seção em que um valor será recuperado. +@param , character, Indica o nome da chave em que um valor será recuperado. +@param , character, Indica o conteúdo padrão que será recuperado. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/getprofstring +/*/ +binary function getprofstring(csecao, cchave, cpadrao) +return + + +/*/{Protheus.doc} getprograms +Retorna um array contendo o nome dos programas AdvPl carregados em memória. + +@type binary function +@sintax GetPrograms() => NIL +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/getprograms +/*/ +binary function getprograms() +return + + +/*/{Protheus.doc} getpvprofileint +Recupera o conteúdo numérico de uma chave, do arquivo de configuração \(\*.INI\), qualquer. + +@type binary function +@sintax GetPvProfileInt(, , , , [uParam5], [uParam6]) => numeric +@return numeric, Retorna o conteúdo da chave especificada, ou o seu valor padrão + +@param , character, Indica o nome da seção do arquivo a ser considerada. +@param , character, Indica o nome da chave a ser considerada. +@param , numeric, Indica o conteúdo padrão \( default \) a ser retornado , caso a chave não seja encontrada no arquivo de configuração. +@param , character, Indica o nome do arquivo de configuração \(\*.INI\) a ser utilizado. +@param [uparam5], numeric, Compatibilidade +@param [uparam6], numeric, Compatibilidade +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/getpvprofileint +/*/ +binary function getpvprofileint(csecao, cchave, npadrao, cnomearqcfg, uparam5, uparam6) +return + + +/*/{Protheus.doc} getpvprofstring +Recupera o conteúdo caractere de uma chave de um arquivo de configuração \(\*.INI\) qualquer. + +@type binary function +@sintax GetPvProfString(, , , , [uParam5], [uParam6]) => character +@return character, Retorna o conteúdo da chave especificada, ou o seu valor padrão + +@param , character, Indica o nome da seção do arquivo a ser considerada. +@param , character, Indica o nome da chave a ser considerada. +@param , character, Indica o conteúdo padrão \( default \) a ser retornado , caso a chave não seja encontrada no arquivo de configuração. +@param , character, Indica o nome do arquivo de configuração \(\*.INI\) a ser utilizado. +@param [uparam5], numeric, Compatibilidade +@param [uparam6], numeric, Compatibilidade +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/getpvprofstring +/*/ +binary function getpvprofstring(csecao, cchave, cpadrao, cnomearqcfg, uparam5, uparam6) +return + + +/*/{Protheus.doc} getremoteininame +Retorna o caminho completo do arquivo de configuração \(\*.INI\) do SmartClient. + +@type binary function +@sintax GetRemoteIniName() => character +@return character, Retorna o caminho completo do arquivo de configuração \(\*.INI\) do SmartClient. + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/getremoteininame +/*/ +binary function getremoteininame() +return + + +/*/{Protheus.doc} getremotetype +Identifica a tipo e versão do Smart Client em execução. + +@type binary function +@sintax GetRemoteType([@cLibVersion]) => numeric +@return numeric, Retorna o número correspondente ao sistema operacional, em uso, que o Smart Client está sendo executado. Sendo: -1 = Job, Web ou Working Thread \(Sem remote\); 1 = Ambiente Microsoft Windows ou 2 = Ambiente Linux/Unix. + +@param [@clibversion], character, Indica a versão da biblioteca gráfica do Smart Client. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/getremotetype +/*/ +binary function getremotetype(clibversion) +return + + +/*/{Protheus.doc} getresarray +Retorna um array com os resources do repositório baseado na pesquisa por nome ou máscara. + +@type binary function +@sintax GetResArray(, [nRPO]) => array +@return array, Resources do repositório + +@param , character, Indica o nome do resource ou máscara que será usada na pesquisa. Serão aceitos caracteres curingas '\*' e '?'. +@param [nrpo], numeric, Indica o nome do repositório que será feita a busca. Valores possíveis: 1 - RPO Padrão, 2 - RPO TLPP, 3 - RPO Custom. Caso o parâmetro não seja informado, a busca sera realizada em todos os repositórios citados. Este parâmetro é válido a partir a release 20.3.0.x \(Application Server Harpia\) +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/getresarray +/*/ +binary function getresarray(cmask, nrpo) +return + + +/*/{Protheus.doc} getrmtdate +Retorna a data atual do sistema definido na máquina onde o SmartClient está sendo executado. + +@type binary function +@sintax GetRmtDate() => date +@return date, Data atual do sistema + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/getrmtdate +/*/ +binary function getrmtdate() +return + + +/*/{Protheus.doc} getrmtinfo +Retorna um array com as definições do computador que o SmartClient está sendo executado. + +@type binary function +@sintax GetRmtInfo() => array +@return array, Retorna um array com as definições do computador que o SmartClient está sendo executado. + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/getrmtinfo +/*/ +binary function getrmtinfo() +return + + +/*/{Protheus.doc} getrmttime +Retorna a hora atual do sistema definido na máquina onde o SmartClient está sendo executado. + +@type binary function +@sintax GetRmtTime() => character +@return character, Hora atual do sistema + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/getrmttime +/*/ +binary function getrmttime() +return + + +/*/{Protheus.doc} getrmtversion +Retorna um string com a versão atual do SmartClient + +@type binary function +@sintax GetRmtVersion() => array +@return array, Retorna um string no formato YEAR.MAJOR.MINOR.VERSION \(exemplo 17.2.0.1\) + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/getrmtversion +/*/ +binary function getrmtversion() +return + + +/*/{Protheus.doc} getrpolog +Retorna um array com os dados de todos os patchs aplicados. + +@type binary function +@sintax getRpoLog([nRPO]) => array +@return array, Retorna um array com os dados de todos os patchs aplicados. Para informações do formato do array, consulte a tabela Formato do array de retorno, na área Observações. + +@param [nrpo], numeric, Indica o nome o repositório que será feita a busca. Valores possíveis: 1 - RPO Padrão, 3 - RPO Custom. Caso o parâmetro não seja informado o valor 1 é assumido como padrão. Este parâmetro é válido a partir a release 20.3.0.x \(Application Server Harpia\) +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/getrpolog +/*/ +binary function getrpolog(nrpo) +return + + +/*/{Protheus.doc} getscreenres +descrição da funcao + +@type binary function +@sintax GetScreenRes([@tNomeVar]) => codeblock +@return codeblock, descrição do retorno + +@param [@tnomevar], codeblock, descrição do parametro +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/getscreenres +/*/ +binary function getscreenres(tnomevar) +return + + +/*/{Protheus.doc} getserverip +Retorna o número IP do servidor onde a aplicação Advpl está sendo executada. + +@type binary function +@sintax GetServerIP([lGetAllAddress]) => array +@return array, Se lGetAllAddress for .T., retorna todos os endereços relacionados ao servidor em um array \(vide OBS para estrutura do array\). + +@param [lgetalladdress], logical, Indica se deve ser retornado todos os endereços relacionados ao servidor. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/getserverip +/*/ +binary function getserverip(lgetalladdress) +return + + +/*/{Protheus.doc} getservertype +Retorna um número inteiro que representa o tipo de execução do Application Server. + +@type binary function +@sintax GetServerType() => numeric +@return numeric, Retorna o tipo de execução do Application Server. Sendo: 0=None, 1=Console \(texto\), 2=ISAPI \(Web\) e 3=FAT \(Gráfico\). + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/getservertype +/*/ +binary function getservertype() +return + + +/*/{Protheus.doc} getsrcarray +Retorna um array com o nome dos fontes compilados. + +@type binary function +@sintax GetSrcArray(, [nRPO]) => array +@return array, Retorna um array de strings, contendo o nome dos fontes compilados identificados no repositório. + +@param , character, Indica o nome do código fonte ou máscara. Observação: São aceitos os caracteres curingas \(\* e ?\). +@param [nrpo], numeric, Indica o nome do repositório que será feita a busca. Valores possíveis: 1 - RPO Padrão, 2 - RPO TLPP, 3 - RPO Custom. Caso o parâmetro não seja informado, a busca sera realizada em todos os repositórios citados. Este parâmetro é válido a partir a release 20.3.0.x \(Application Server Harpia\) +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/getsrcarray +/*/ +binary function getsrcarray(cnome, nrpo) +return + + +/*/{Protheus.doc} getsrvarch +Retorna a arquitetura do processador que está sendo executado o Application Server. Suporta os sistemas operacionais Windows e Linux. + +@type binary function +@sintax GetSrvArch() => character +@return character, Retorna a arquitetura do processador no formato linux base. Valores possíveis: 32 bits - i686, 64 bits - x86_64, ARM - aarch32, ARM64 - aarch64, Deconhecido - unknown. + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/getsrvarch +/*/ +binary function getsrvarch() +return + + +/*/{Protheus.doc} getsrvbuildtype +Retorna a informação do tipo de geração do servidor. ex: release, debug ou relwithdebinfo + +@type binary function +@sintax GetSrvBuildType() => character +@return character, Retorna o tipo de geração do servidor \(release, debug ou relwithdebinfo\) + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/getsrvbuildtype +/*/ +binary function getsrvbuildtype() +return + + +/*/{Protheus.doc} getsrvglbinfo +Retorna uma string contendo um resumo do status atual do serviço do Application Server, incluindo detalhamento de processos internos, processos de usuário, memória do serviço, pools de memória do kernel do Application Server, memória do processo e acumuladores globais. + +@type binary function +@sintax GetSrvGlbInfo() => character +@return character, Retorna uma string descrevendo o status atual do serviço + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/getsrvglbinfo +/*/ +binary function getsrvglbinfo() +return + + +/*/{Protheus.doc} getsrvinfo +Retorna um array com as definições do servidor onde o TOTVS \| Application Server foi instanciado. + +@type binary function +@sintax GetSrvInfo() => array +@return array, Retorna um array com informações do Totvs Application Server. Para o formato do array vide observação. + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/getsrvinfo +/*/ +binary function getsrvinfo() +return + + +/*/{Protheus.doc} getsrvininame +Retorna o nome do arquivo de configuração \(\*.INI\) do Application Server. + +@type binary function +@sintax GetSrvIniName() => character +@return character, Retorna o nome do arquivo de configuração \(\*.INI\) do Application Server. + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/getsrvininame +/*/ +binary function getsrvininame() +return + + +/*/{Protheus.doc} getsrvmeminfo +Recupera o status de memória da máquina onde o Application Server está sendo executado. + +@type binary function +@sintax GetSrvMemInfo() => character +@return character, Retorna uma string contendo o resumo das informações de memória da máquina onde o Application Server está sendo executado. + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/getsrvmeminfo +/*/ +binary function getsrvmeminfo() +return + + +/*/{Protheus.doc} getsrvnickname +Retorna uma string com o apelido do Application Server. + +@type binary function +@sintax GetSrvNickName() => character +@return character, String com o apelido do Application Server. + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/getsrvnickname +/*/ +binary function getsrvnickname() +return + + +/*/{Protheus.doc} getsrvosinfo +Retorna informações do sistema operacional onde o Application Server está sendo executado. + +@type binary function +@sintax GetSrvOSInfo() => character +@return character, Retorna uma string contendo as informações do Sistema Operacional onde o Application Server está sendo executado. + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/getsrvosinfo +/*/ +binary function getsrvosinfo() +return + + +/*/{Protheus.doc} getsrvprofstring +Recupera o conteúdo de uma chave de configuração, do ambiente em uso, no arquivo de configuração \(.INI\) do TOTVS Application Server. + +@type binary function +@sintax GetSrvProfString(, ) => character +@return character, Retorna o conteúdo da chave especificada. Caso a chave não seja encontrada na seção de configuração do ambiente atual, a função retornará o conteúdo informado no parâmetro cDefault. + +@param , character, Indica a chave que deve ser lida do arquivo de configuração. +@param , character, Indica o conteúdo da chave a ser retornada, caso a chave não seja encontrada. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/getsrvprofstring +/*/ +binary function getsrvprofstring(cchave, cdefault) +return + + +/*/{Protheus.doc} getsrvversion +Retorna a versão do build do atual binario Appserver. + +@type binary function +@sintax GetSrvVersion() => character +@return character, Retorna a versão no formato nn.n.n.n. + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/getsrvversion +/*/ +binary function getsrvversion() +return + + +/*/{Protheus.doc} getstringpixsize +Retorna uma matriz com a altura e a largura total em pixels de uma determinada string, dados uma fonte específica, tamanho e modificadores \(negrito, itálico, sublinhado\). + +@type binary function +@sintax GetStringPixSize(, , , [lBold], [lItalic], [lUnderline]) => array +@return array, Retorna a altura e a lagura total em pixels, dos caracteres fornecidos em cString. + +@param , character, String com o texto a ser contado \(altura e largura\). +@param , character, Indica o nome da fonte instalada no Smart Client. +@param , numeric, Indica o tamanho da fonte. +@param [lbold], logical, Indica se a fonte está em negrito. +@param [litalic], logical, Indica se a fonte está em itálico. +@param [lunderline], logical, Indica se a fonte está sublinhada. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/getstringpixsize +/*/ +binary function getstringpixsize(cstring, cfontname, ntamanho, lbold, litalic, lunderline) +return + + +/*/{Protheus.doc} gettcpobj +descrição da funcao + +@type binary function +@sintax GetTcpObj([@tNomeVar]) => codeblock +@return codeblock, descrição do retorno + +@param [@tnomevar], codeblock, descrição do parametro +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/gettcpobj +/*/ +binary function gettcpobj(tnomevar) +return + + +/*/{Protheus.doc} gettemppath +Retorna o caminho da pasta temporária do sistema atual. + +@type binary function +@sintax GetTempPath([lLocal]) => character +@return character, Retorna o caminho da pasta temporária do sistema atual. + +@param [llocal], logical, Indica se verdadeiro \(.T.\), é procurado o diretório temporário do Smart Client ou, falso \(.F.\), do Application Server. Valor padrão: .T. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/gettemppath +/*/ +binary function gettemppath(llocal) +return + + +/*/{Protheus.doc} gettimestamp +Retorna uma string com informações de data e hora, no formato time stamp da a data infromada no parâmetro. + +@type binary function +@sintax GetTimeStamp(, [aDate]) => character +@return character, Retorna uma string no formato timestamp da data informada no parâmetro 1. + +@param , date, Indica a data que será utilizada para obter o timestamp. +@param [adate], array, Retorno do timestamp no array passado por referência, o formato do array será data posição 1 e hora posição 2. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/gettimestamp +/*/ +binary function gettimestamp(ddate, adate) +return + + +/*/{Protheus.doc} getuserfromsid +Recupera o nome do domínio e nome do usuário a partir de um código no padrão SID \(Security Identifier\) da Microsoft que os representa. + +@type binary function +@sintax GetUserFromSID(, <@cDomainName>, <@cUserName>) => logical +@return logical, Caso a obtenção dos nomes de domínio e usuário foi realizada com sucesso retorna verdadeiro \(.T.\), caso contrário retorna falso \(.F.\). + +@param , character, Código SID do usuário autenticado na estação. Pode ser obtido com a função GetCredential\(\). +@param <@cdomainname>, character, Será preenchido pela função após ser invocada. Conterá o nome do domínio extraído do código SID. +@param <@cusername>, character, Será preenchido pela função após ser invocada. Conterá o nome do usuário extraído do código SID. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/getuserfromsid +/*/ +binary function getuserfromsid(csid, cdomainname, cusername) +return + + +/*/{Protheus.doc} getuserinfoarray +Retorna um array multidimensional com as informações de cada um do processos em execução no Protheus 8 Server e/ou Application Server. + +@type binary function +@sintax GetUserInfoArray([lShowMoreInfo*]) => array +@return array, Retorna um array multidimensional com os números e dados de cada uma das threads. + +@param [lshowmoreinfo*], logical, Se informado verdadeiro \(.T.\), retorna mais informações por thread \(apenas 4GL/Telnet 4GL\). +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/getuserinfoarray +/*/ +binary function getuserinfoarray(lshowmoreinfo*) +return + + +/*/{Protheus.doc} getvarnamelen +Retorna o tamanho de uma variável AdvPL. + +@type binary function +@sintax GetVarNameLen() => numeric +@return numeric, Retorna o tamanho definido atualmente para uma variável. + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/getvarnamelen +/*/ +binary function getvarnamelen() +return + + +/*/{Protheus.doc} getvarsize +Retorna o tamanho em bytes que a variável ocupa em memória no Application Server. + +@type binary function +@sintax GetVarSize() => numeric +@return numeric, Retorna o tamanho da variável em bytes. + +@param , variant, Variável que será analisada +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/getvarsize +/*/ +binary function getvarsize(xvar) +return + + +/*/{Protheus.doc} getvdrobj +descrição da funcao + +@type binary function +@sintax GetVdrObj([@tNomeVar]) => codeblock +@return codeblock, descrição do retorno + +@param [@tnomevar], codeblock, descrição do parametro +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/getvdrobj +/*/ +binary function getvdrobj(tnomevar) +return + + +/*/{Protheus.doc} getwebjob +Retorna o nome de usuário da thread em que foi executada. + +@type binary function +@sintax GetWebJob() => character +@return character, Retorna uma string com o nome do usuário da thread em que a chamada à função foi realizada. Como em AdvPL uma função pode ser iniciada de várias formas, esse nome de usuário tem uma semântica diferente dependendo de contexto em que foi iniciado:• Via SmartClient \(Windows, Linux, Mac ou ActiveX\): representa o nome do usuário logado na máquina que executou o SmartClient.• Via requisições WEB .apl: o retorno é a string “HTTP:GENPROC”.• Via requisições WEBEX .apw: o retorno é o nome da seção \(definida em responsejob\) que foi configurada no totvsappserver.ini para atender a requisição.• Via seção ONSTART do totvsappserver.ini: o retorno é o nome do job configurado para atender a requisição.• Via função StartJob dentro de um programa AdvPL: nesse caso o retorno é o usuário da thread que executou StartJob seguido de um _ no final. Ex: username_.• Via chamadas RPC: retorna uma string vazia. + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/getwebjob +/*/ +binary function getwebjob() +return + + +/*/{Protheus.doc} glblock +Obtém um flag de bloqueio para serialização de operações, com escopo na instância atual do Protheus Server em execução, com liberação explícita através da função GlbUnlock\(\). Caso não haja uma liberação explícita, haverá uma liberação automática do bloqueio no término do processo \(Thread\) em execução que obteve o bloqueio. + +@type binary function +@sintax GlbLock() => logical +@return logical, Retorna .T. caso o bloqueio tenha sido obtido para o processo atual. Caso a função retorne .F., já existe um outro processo \( Thread \) neste mesmo Protheus Server que possui um bloqueio. + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/glblock +/*/ +binary function glblock() +return + + +/*/{Protheus.doc} glbnmlock +Realiza o bloqueio de um identificador nomeado. + +@type binary function +@sintax GlbNmLock() => logical +@return logical, Retorna .T. caso o identificador de bloqueio tenha sido obtido com sucesso para o processo atual. Caso um identificador de bloqueio com este jone, já tenha sido retornado e não liberado para outro processo, a função retorna .F. + +@param , character, Indica o nome do identificador de bloqueio. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/glbnmlock +/*/ +binary function glbnmlock(ctext) +return + + +/*/{Protheus.doc} glbnmunlock +Libera um bloqueio de um identificador nomeado obtido pela função GlbNmLock\(\). + +@type binary function +@sintax GlbNmUnlock() => logical +@return logical, Retorna .T. caso o identificador de bloqueio tenha sido liberado com sucesso para o processo atual. Para isso, o identificador precisa existir na lista de bloqueios, e o processo atual deve ter sido o responsavel por realizar o bloqueio. Caso contrário a função retorna .F. + +@param , character, Indica o nome do identificador de bloqueio. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/glbnmunlock +/*/ +binary function glbnmunlock(ctext) +return + + +/*/{Protheus.doc} glbunlock +Libera explicitamente o flag de bloqueio para serialização de operações obtido pelo processo atual através da função GlbLock\(\) + +@type binary function +@sintax GlbUnlock() => logical +@return logical, Retorna .T. caso o bloqueio tenta sido liberado. Caso não haja um bloqueio global a ser liberado, ou ele não tenha sido obtido pelo meu processo, ou já tenha sido liberado anteriormente, a função retorna .F. + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/glbunlock +/*/ +binary function glbunlock() +return + + +/*/{Protheus.doc} gzcompress +Compacta um arquivo do ambiente do servidor, a partir do rootpath, para um arquivo no formato gzip. + +@type binary function +@sintax GzCompress(, [cGzip], [lChangeCase]) => logical +@return logical, Retorna **.T.** se a compactação for realizada com sucesso; caso contrário, retorna **.F.**. + +@param , character, Indica o arquivo no servidor que será compactado. +@param [cgzip], character, Indica o nome do arquivo compactado. +@param [lchangecase], logical, Se verdadeiro \(.T.\), nomes de arquivos e pastas serão convertidos para letras minúsculas; caso contrário, falso \(.F.\), não será feito nenhum ajuste no nome do arquivo informado. Valor padrão \(.T.\). Veja maiores informações em Observações. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/gzcompress +/*/ +binary function gzcompress(cfile, cgzip, lchangecase) +return + + +/*/{Protheus.doc} gzdecomp +Descompacta o conteúdo de um arquivo no formato gzip \(GNU zip\) do ambiente do servidor, a partir do rootpath, para um diretório no servidor. + +@type binary function +@sintax GzDecomp(, , [lChangeCase]) => logical +@return logical, Retorna **.T.** se a descompactação for realizada com sucesso; caso contrário, retorna **.F.**. + +@param , character, Indica o nome do arquivo, no formato Gzip, cujo conteúdo será descompactado. +@param , character, Indica o diretório onde o arquivo será descompactado. +@param [lchangecase], logical, Se verdadeiro \(.T.\), nomes de arquivos e pastas serão convertidos para letras minúsculas; caso contrário, falso \(.F.\), não será feito nenhum ajuste no nome do arquivo informado. Valor padrão \(.T.\). Veja maiores informações em Observações. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/gzdecomp +/*/ +binary function gzdecomp(cgzip, coutdir, lchangecase) +return + + +/*/{Protheus.doc} gzstrcomp +Compacta uma string no formato **gzip**. + +@type binary function +@sintax GzStrComp(, <@cTarget>, <@nTargetLen>) => logical +@return logical, Retorna **.T.** se a compactação for realizada com sucesso; caso contrário, retorna **.F.**. + +@param , character, Indica a string que será compactada. +@param <@ctarget>, character, Indica a string compactada. +@param <@ntargetlen>, numeric, Indica o tamanho da string compactada. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/gzstrcomp +/*/ +binary function gzstrcomp(csource, ctarget, ntargetlen) +return + + +/*/{Protheus.doc} gzstrdecomp +Descompacta uma string no formato **gzip**. + +@type binary function +@sintax GzStrDecomp(, , <@cTarget>) => logical +@return logical, Retorna **.T.** se a descompactação for realizada com sucesso; caso contrário, retorna **.F.**. + +@param , character, Indica a string que está compactada. +@param , numeric, Indica o tamanho da string compactada. +@param <@ctarget>, character, Indica a string descompactada. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/gzstrdecomp +/*/ +binary function gzstrdecomp(csource, nsourcelen, ctarget) +return + + +/*/{Protheus.doc} hasvvspeak +descrição da funcao + +@type binary function +@sintax HasVVSpeak([@tNomeVar]) => codeblock +@return codeblock, descrição do retorno + +@param [@tnomevar], codeblock, descrição do parametro +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/hasvvspeak +/*/ +binary function hasvvspeak(tnomevar) +return + + +/*/{Protheus.doc} hmac +HMAC \(Hash-based Message Authentication Code\) gera o hash de autenticação de uma mensagem de entrada, em combinação com uma chave secreta. Essa implementação suporta os algoritmos SHA-1,SHA-256,SHA-512 e MD5. + +@type binary function +@sintax HMAC(, , , [nRetType], [nContentType], [nKeyType]) => character +@return character, Retorna o hash \(Message Authentication Code\) do conteúdo de entrada informado, no formato especificado. + +@param , character, Indica a string de entrada que contém os dados para os quais será gerado o hash. +@param , character, Indica a chave que será utilizada para gerar o hash. +@param , numeric, Indica o tipo de algoritmo criptográfico que será utilizado para geração do Hash. Veja tabela nas observações. +@param [nrettype], numeric, Indica o tipo do formato de retorno do hash. Quando não informado valor padrão será **2 \(Hex Hash\)**. Veja tabela nas observações. +@param [ncontenttype], numeric, Indica o tipo do formato do conteúdo da variável cContent. Quando não informado o padrão será **1 \(Texto\)**. Veja tabela nas observações. +@param [nkeytype], numeric, Indica o tipo do formato da chave informada na variável cKey. Quando não informado o padrão será **1 \(Texto\)**. Veja tabela nas observações. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/hmac +/*/ +binary function hmac(ccontent, ckey, ncryptotype, nrettype, ncontenttype, nkeytype) +return + + +/*/{Protheus.doc} hmadd +Adiciona um novo item ao objet tHashMap, indicando qual o campo da chave de procura. + +@type binary function +@sintax HMAdd(, , [nColuna_1], [nTrim_1], [nColuna_N], [nTrim_N]) => logical +@return logical, Verdadeiro \(.T.\) se adicionou com sucesso e Falso \(.F\) se houve erro + +@param , object, Objeto da classe HashMap \(tHashMap\) +@param , array, Array com os valores que serão adicionados ao HashMap +@param [ncoluna_1], numeric, Indica o número da coluna que contem o valor da chave a ser inserida +@param [ntrim_1], numeric, Tipo de Trim para colunas de caractere +@param [ncoluna_n], numeric, Informar mais de uma coluna se necessário \(máximo 8\) +@param [ntrim_n], numeric, Tipo de Trim para as colunas do tipo caractere. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/hmadd +/*/ +binary function hmadd(ohash, aval, ncoluna_1, ntrim_1, ncoluna_n, ntrim_n) +return + + +/*/{Protheus.doc} hmclean +Limpa todos os dados alocados em um objeto da classe tHashMap. + +@type binary function +@sintax HMClean() => logical +@return logical, Verdadeiro \(.T.\) se limpou todos os dados ou falso \(.F.\) se houve algum erro + +@param , object, Objeto da classe HashMap \(tHashMap\) +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/hmclean +/*/ +binary function hmclean(ohash) +return + + +/*/{Protheus.doc} hmcount +Retorna a quantidade de elementos em um objeto do tipo HashMap + +@type binary function +@sintax HmCount([oHashMap]) => numeric +@return numeric, Quantidade de elementos no objeto informado. + +@param [ohashmap], object, Objeto do tipo Hashmap +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/hmcount +/*/ +binary function hmcount(ohashmap) +return + + +/*/{Protheus.doc} hmdel +Remove o valor armazenado correspondente a chave em um objeto da classe tHashMap. + +@type binary function +@sintax HMDel(, ) => logical +@return logical, Verdadeiro \(.T.\) se deletou o valor e Falso \(.F\) se não encontrou + +@param , object, Objeto da classe HashMap \(tHashMap\) +@param , variant, Chave de armazenamento do valor +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/hmdel +/*/ +binary function hmdel(ohash, ykey) +return + + +/*/{Protheus.doc} hmget +Obtém o valor armazenado correspondente a chave em um objeto da classe tHashMap. + +@type binary function +@sintax HMGet(, , <@aVal>) => logical +@return logical, Retorna verdadeiro \(.T.\) se achar a chave, ou falso \(.F.\) se não achar. + +@param , object, Objeto da classe HashMap \(tHashMap\) +@param , variant, Chave de armazenamento do valor +@param <@aval>, array, Retorna o valor armazenado na chave +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/hmget +/*/ +binary function hmget(ohash, ykey, aval) +return + + +/*/{Protheus.doc} hmgetn +Obtém o valor armazenado correspondente a chave em um objeto da classe tHashMap. + +@type binary function +@sintax HMGetN(, , <@aVal>) => logical +@return logical, Retorna verdadeiro \(.T.\) se achar a chave, ou falso \(.F.\) se não achar. + +@param , object, Objeto da classe HashMap \(tHashMap\) +@param , numeric, Chave de armazenamento do valor +@param <@aval>, numeric, Retorna o valor armazenado na chave +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/hmgetn +/*/ +binary function hmgetn(ohash, nkey, aval) +return + + +/*/{Protheus.doc} hmkey +Obtem o valor de chave simples ou composta a partir das colunas eleitas de um array. A chave obtida poderá ser usada nas funções: HMGet, HMSet, HMDel. + +@type binary function +@sintax HMKey(, [nColuna_1], [n_Trim_1], [nColuna_N], [n_Trim_N]) => character +@return character, Palavra contendo a chave de busca referente às colunas + +@param , array, Linha com os elementos que participaram da chave de busca +@param [ncoluna_1], numeric, Indica o número da coluna que contem o valor da chave a ser inserida +@param [n_trim_1], numeric, Tipo de Trim para colunas de caractere +@param [ncoluna_n], numeric, Informar mais de uma coluna se necessário \(máximo 8\) +@param [n_trim_n], numeric, Tipo de Trim para as colunas do tipo caractere. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/hmkey +/*/ +binary function hmkey(aarray, ncoluna_1, n_trim_1, ncoluna_n, n_trim_n) +return + + +/*/{Protheus.doc} hmlist +Lista todos os elementos do objeto HashMap em um array. + +@type binary function +@sintax HMList(, <@aElem>) => logical +@return logical, Verdadeiro \(.T.\) se conseguiu listar todos os elementos ou Falso \(.F.\) caso contrário + +@param , object, Objeto da classe HashMap \(tHashMap\) +@param <@aelem>, array, Array para retorno da lista dos elementos do HashMap +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/hmlist +/*/ +binary function hmlist(ohash, aelem) +return + + +/*/{Protheus.doc} hmnew +Cria um objeto da classe tHashMap. + +@type binary function +@sintax HMNew() => object +@return object, Objeto da classe HashMap \(tHashMap\) + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/hmnew +/*/ +binary function hmnew() +return + + +/*/{Protheus.doc} hmset +Atualiza o valor correspondente a chave em um objeto da classe tHashMap. + +@type binary function +@sintax HMSet(, , ) => logical +@return logical, Verdadeiro \(.T.\) se executou corretamente e Falso \(.F\) se houve erro + +@param , object, Objeto da classe HashMap \(tHashMap\) +@param , variant, Chave de armazenamento do valor +@param , variant, Valor a ser armazenado na chave +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/hmset +/*/ +binary function hmset(ohash, ykey, xval) +return + + +/*/{Protheus.doc} hmsetn +Atualiza ou cria valor correspondente a chave em um objeto da classe tHashMap. + +@type binary function +@sintax HMSetN(, , ) => logical +@return logical, Verdadeiro \(.T.\) se executou corretamente e Falso \(.F\) se houve erro + +@param , object, Objeto da classe HashMap \(tHashMap\) +@param , numeric, Chave de armazenamento do valor +@param , numeric, Valor a ser armazenado na chave +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/hmsetn +/*/ +binary function hmsetn(ohash, nkey, nval) +return + + +/*/{Protheus.doc} hsmexponent +Retorna o expoente \(exponent\) de uma chave privada no formato big-endian armazenada em um dispositivo HSM. + +@type binary function +@sintax HSMExponent(, [cPass], [lClient]) => character +@return character, Retorna o expoente de uma chave no formato big-endian; retorna **Nil** caso ocorra um erro no processamento. + +@param , character, Indica o caminho, no dispositivo HSM, para a chave privada. +@param [cpass], character, Indica a senha da chave, se existente. +@param [lclient], logical, Indica se o dispositivo HSM está na máquina do SmartClient. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/hsmexponent +/*/ +binary function hsmexponent(ckey, cpass, lclient) +return + + +/*/{Protheus.doc} hsmfinalize +Finaliza o uso de dispositivo HSM. + +@type binary function +@sintax HSMFinalize([lClient]) => logical +@return logical, Retorna **1** caso consiga finalizar o HSM com sucesso; caso contrário, retorna **0**. + +@param [lclient], logical, Indica se o dispositivo HSM está na máquina do SmartClient. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/hsmfinalize +/*/ +binary function hsmfinalize(lclient) +return + + +/*/{Protheus.doc} hsmgetcertfile +Extrai um certificado armazenado num dispositivo HSM para um arquivo. + +@type binary function +@sintax HSMGetCertFile(, , [cPass], [lClient]) => logical +@return logical, Retorna **.T.** caso consiga extrair o certificado do HSM; caso contrário, retorna **.F.**. + +@param , character, Indica o caminho no dispositivo HSM para o certificado. +@param , character, Indica o caminho de destino do certificado, incluindo o nome do arquivo. +@param [cpass], character, Indica a senha do slot onde está armazenado o certificado apontado por **cHSMPath**. +@param [lclient], logical, Indica se o dispositivo HSM está na máquina do SmartClient. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/hsmgetcertfile +/*/ +binary function hsmgetcertfile(chsmpath, cfile, cpass, lclient) +return + + +/*/{Protheus.doc} hsmgetkeyfile +Extrai uma chave pública armazenada num dispositivo HSM para um arquivo. + +@type binary function +@sintax HSMGetKeyFile(, , [cPass], [lChangeCase], [lClient]) => logical +@return logical, Retorna **.T.** caso consiga extrair a chave pública do HSM; caso contrário, retorna **.F.**. + +@param , character, Indica o caminho no dispositivo HSM para o certificado de cliente. +@param , character, Indica o caminho de destino da chave pública, incluindo o nome do arquivo. +@param [cpass], character, Indica a senha do slot onde está armazenado o certificado apontado por **cHSMPath**. +@param [lchangecase], logical, Se verdadeiro \(.T.\), nomes de arquivos e pastas serão convertidos para letras minúsculas; caso contrário, falso \(.F.\), não será feito nenhum ajuste no nome do arquivo informado. Valor padrão \(.T.\). Veja maiores informações em Observações. +@param [lclient], logical, Indica se o dispositivo HSM está na máquina do SmartClient. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/hsmgetkeyfile +/*/ +binary function hsmgetkeyfile(chsmpath, cfile, cpass, lchangecase, lclient) +return + + +/*/{Protheus.doc} hsminitialize +Inicializa o dispositivo HSM. + +@type binary function +@sintax HSMInitialize([cModule], [lClient]) => numeric +@return numeric, Retorna 1 caso consiga inicializar o dispositivo HSM; caso contrário, retorna 0. + +@param [cmodule], character, Indica o caminho do módulo do dispositivo HSM que será inicializado. +@param [lclient], logical, Indica se o dispositivo HSM está na máquina do SmartClient. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/hsminitialize +/*/ +binary function hsminitialize(cmodule, lclient) +return + + +/*/{Protheus.doc} hsmmodulus +Retorna o módulo público \(public modulus\) de uma chave privada no formato big-endian armazenada em um dispositivo HSM. + +@type binary function +@sintax HSMModulus(, [cPass], [lClient]) => character +@return character, Retorna o módulo público de uma chave no formato big-endian; retorna **Nil** caso ocorra um erro no processamento. + +@param , character, Indica o caminho, no dispositivo HSM, para a chave privada. +@param [cpass], character, Indica a senha da chave, se existente. +@param [lclient], logical, Indica se o dispositivo HSM está na máquina do SmartClient. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/hsmmodulus +/*/ +binary function hsmmodulus(ckey, cpass, lclient) +return + + +/*/{Protheus.doc} hsmobjlist +Lista os objetos contidos em um slot. + +@type binary function +@sintax HSMObjList(, , [lClient]) => array +@return array, Retorna um vetor com as informações dos objetos de um slot. + +@param , numeric, Indica o número do slot de HSM. +@param , character, Indica a senha de acesso ao HSM. +@param [lclient], logical, Indica se o dispositivo HSM está na máquina do SmartClient. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/hsmobjlist +/*/ +binary function hsmobjlist(nslot, cpass, lclient) +return + + +/*/{Protheus.doc} hsmprivsign +Assina usando algoritmo digest um determinado conteúdo usando uma chave privada armazenada em dispositivo HSM. + +@type binary function +@sintax HSMPrivSign(, , , , [@cErrStr], [lClient]) => character +@return character, Retorna o valor do parâmetro **cContent**, assinado de acordo com o tipo **nType** e a chave privada informada **cKey**. + +@param , character, Indica o caminho no dispositivo HSM para a chave privada. +@param , character, Indica o valor que será assinado. +@param , numeric, Indica o tipo do algoritmo digest que será utilizado. +@param , character, Indica a senha do slot onde está armazenado a chave privada apontada por **cKey**. +@param [@cerrstr], character, Indica a variável para retornar as mensagens de erro. +@param [lclient], logical, Indica se o dispositivo HSM está na máquina do SmartClient. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/hsmprivsign +/*/ +binary function hsmprivsign(ckey, ccontent, ntype, cpass, cerrstr, lclient) +return + + +/*/{Protheus.doc} hsmprivvery +Verifica a assinatura digital utilizando o certificado/chave pública armazenada em dispositivo HSM. + +@type binary function +@sintax HSMPrivVery(, , , , [@cErrStr], , [lClient]) => NIL +@param , character, Indica a string que contém o caminho para o certificado no HSM. O caminho tem o o formato slot_-label_ +@param , character, Indica a string que será utilizada na verificação da assinatura digital. +@param , numeric, Indica o tipo de algoritmo que será utilizado para realizar a verificação da assinatura digital. +@param , character, Indica a senha do slot onde está armazenado a chave privada apontada por **cKey**. +@param [@cerrstr], character, Indica a variável para retornar as mensagens de erro. +@param , character, Indica uma string que contém o valor assinado. +@param [lclient], logical, Indica uma string que contém o valor assinado. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/hsmprivvery +/*/ +binary function hsmprivvery(ckey, ccontent, ntype, cpass, cerrstr, cassinado, lclient) +return + + +/*/{Protheus.doc} hsmslotlist +Lista os slots HSM disponíveis. + +@type binary function +@sintax HSMSlotList([lClient]) => array +@return array, Retorna um vetor com as informações dos slots. + +@param [lclient], logical, Indica se o dispositivo HSM está na máquina do SmartClient. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/hsmslotlist +/*/ +binary function hsmslotlist(lclient) +return + + +/*/{Protheus.doc} httpcget +Permite emular um client HTTP - Hypertext Transfer Protocol diretamente da máquina onde o SmartClient está sendo executado, através de uma função da linguagem AdvPL, acessando um determinado documento HTML, publicado em um servidor Web, utilizando o método GET, permitindo a passagem de parâmetros via URL e aguardando por um tempo determinado \(time-out\) pela resposta do servidor solicitado. + +@type binary function +@sintax HttpCGet(, [cGetParms], [nTimeOut], [aHeadStr], [@cHeaderGet]) => character +@return character, Retorna a string que corresponde a requisição solicitada. + +@param , character, Indica o endereço HTTP com a pasta e o documento solicitado. +@param [cgetparms], character, Indica uma string de parâmetros, do tipo GET, que serão enviados ao servidor HTTP através da URI. Caso não seja especificado, este parâmetro será considerado vazio \(""\). +@param [ntimeout], numeric, Indica o tempo, em segundos, máximo de inatividade permitido durante a recepção do documento. Caso não seja especificado, o valor assumido será de 120 segundos. +@param [aheadstr], array, Indica o array que contêm as strings que serão acrescentadas no header da requisição HTTP que será realizada. Utilizar "\|" \(pipes\) para separação entre parâmetro e valor. +@param [@cheaderget], character, Indica a string que conterá o header de resposta HTTP enviado pelo servidor requisitado. Observação: A variável deve ser declarada antes da chamada da função. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/httpcget +/*/ +binary function httpcget(curl, cgetparms, ntimeout, aheadstr, cheaderget) +return + + +/*/{Protheus.doc} httpcpost + + +@type binary function +@sintax HttpCPost(, [cPostParms], [nTimeOut], [aHeadStr], [@cHeaderGet]) => character +@return character, Retorna a string que corresponde a requisição solicitada. + +@param , character, Indica o endereço HTTP com a pasta e o documento solicitado. +@param [cpostparms], character, Indica uma string de parâmetros, do tipo POST, que serão enviados ao servidor HTTP através da URL. Caso não seja especificado, este parâmetro será considerado vazio \(""\). +@param [ntimeout], numeric, Indica o tempo, em segundos, máximo de inatividade permitido durante a recepção do documento. Caso não seja especificado, o valor assumido será de 120 segundos. +@param [aheadstr], array, Indica o array que contêm as strings que serão acrescentadas no header da requisição HTTP que será realizada. Utilizar "\|" \(pipes\) para separação entre parâmetro e valor. +@param [@cheaderget], character, Indica a string que conterá o header de resposta HTTP enviado pelo servidor requisitado. Observação: A variável deve ser declarada antes da chamada da função. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/httpcpost +/*/ +binary function httpcpost(curl, cpostparms, ntimeout, aheadstr, cheaderget) +return + + +/*/{Protheus.doc} httpget +Permite emular um client HTTP - Hypertext Transfer Protocol, através de uma função da linguagem AdvPL, acessando um determinado documento HTML, publicado em um servidor Web, utilizando o método GET, permitindo a passagem de parâmetros via URL e aguardando por um tempo determinado \(time-out\) pela resposta do servidor solicitado. + +@type binary function +@sintax HttpGet(, [cGetParms], [nTimeOut], [aHeadStr], [@cHeaderGet]) => character +@return character, Retorna uma string HTML que corresponde ao documento solicitado. + +@param , character, Indica o endereço HTTP com a pasta e o documento solicitado. +@param [cgetparms], character, Indica a lista de strings de parâmetros que serão enviadas ao servidor HTTP, através da URI. Caso este parâmetro não seja especificado, o mesmo será considerado vazio \(""\). +@param [ntimeout], numeric, Indica o tempo, em segundos, máximo de inatividade permitido durante a recepção do documento. Caso este parâmetro não seja especificado, o valor padrão assumido será de 120 segundos \(2 minutos\). +@param [aheadstr], array, Indica o array que contêm as strings que serão acrescentadas ao header da requisição que será realizada. Utilizar "\|" \(pipes\) para separação entre parâmetro e valor. +@param [@cheaderget], character, Indica o retorno, através de referência, da header de resposta HTTP enviada pelo servidor requisitado. Observação: A variável deve ser declarada antes da chamada da função. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/httpget +/*/ +binary function httpget(curl, cgetparms, ntimeout, aheadstr, cheaderget) +return + + +/*/{Protheus.doc} httpgetstatus +Retorna o status da conexão HTTP - HyperText Transfer Protocol \(Protocolo de Transferência de Hipertexto\) requisitada. + +@type binary function +@sintax HTTPGetStatus(<@cError>, [lClient]) => numeric +@return numeric, Retorna o status da conexão HTTP atual requerida. + +@param <@cerror>, character, Indica a descrição do erro HTTP. +@param [lclient], logical, Indica se irá retornar o status da conexão feita pelo SmartClient \(.T.\) ou pelo AppServer \(.F.\). Valor padrão: **.F.**. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/httpgetstatus +/*/ +binary function httpgetstatus(cerror, lclient) +return + + +/*/{Protheus.doc} httppost +Permite emular um client HTTP - Hypertext Transfer Protocol, através de uma função AdvPL, postando um bloco de informações para uma determinada URL em um servidor Web, utilizando o método POST, permitindo a passagem de parâmetros adicionais via URL e aguardando por um tempo determinado \(time-out\) pela resposta do servidor solicitado. + +@type binary function +@sintax HttpPost(, [cGetParms], [cPostParms], [nTimeOut], [aHeadStr], [@cHeaderGet]) => character +@return character, Retorna a string que corresponde a requisição solicitada. + +@param , character, Indica o endereço HTTP com a pasta e o documento solicitado. +@param [cgetparms], character, Indica uma string de parâmetros, do tipo GET, que serão enviados ao servidor HTTP através da URI. Caso não seja especificado,este parâmetro será considerado vazio \(""\). +@param [cpostparms], character, Indica uma string de parâmetros, do tipo POST, que serão enviados ao servidor HTTP através da URL. Caso não seja especificado, este parâmetro será considerado vazio \(""\). +@param [ntimeout], numeric, Indica o tempo, em segundos, máximo de inatividade permitido durante a recepção do documento. Caso não seja especificado, o valor assumido será de 120 segundos. +@param [aheadstr], array, Indica o array que contêm as strings que serão acrescentadas no header da requisição HTTP que será realizada. +@param [@cheaderget], character, Indica a string que conterá o header de resposta HTTP enviado pelo servidor requisitado. Observação: A variável deve ser declarada antes da chamada da função. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/httppost +/*/ +binary function httppost(curl, cgetparms, cpostparms, ntimeout, aheadstr, cheaderget) +return + + +/*/{Protheus.doc} httpsetpass +Define o usuário e senha para autenticação HTTP. + +@type binary function +@sintax HTTPSetPass(, , [lClient]) => NIL +@param , character, Indica o usuário para autenticação HTTP. +@param , character, Indica a senha para autenticação HTTP. +@param [lclient], logical, Indica se irá definir na conexão feita pelo SmartClient \(.T.\) ou pelo AppServer \(.F.\). Valor padrão: **.F.**. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/httpsetpass +/*/ +binary function httpsetpass(cuser, cpass, lclient) +return + + +/*/{Protheus.doc} httpsget +Permite emular um Client HTTP - Hypertext Transfer Protocol, utilizando protocolo HTTPS através de uma função AdvPL, postando um bloco de informações para um determinado documento publicado em um servidor Web, utilizando o método GET, permitindo a passagem de parâmetros adicionais via URL e aguardando por um tempo determinado \(time-out\) pela resposta do servidor solicitado. + +@type binary function +@sintax HTTPSGet(, , , , [cGETParms], [nTimeOut], [aHeadStr], [@cHeaderRet], [lClient]) => character +@return character, Retorna a string que corresponde à requisição solicitada. + +@param , character, Indica o endereço HTTP com a pasta e o documento solicitado. +@param , character, Indica o path do arquivo, em formato PEM \(modelo Apache\), do arquivo que contém o certificado digital. +@param , character, Indica o path da chave privada, em formato PEM \(modelo Apache\), do arquivo que contém a chave privada, referente ao certificado digital. +@param , character, Indica a senha que será utilizada para a abertura da chave privada. Para uma chave privada que não possua senha deve ser informada uma string vazia. +@param [cgetparms], character, Indica uma string de parâmetros, do tipo GET, que serão enviados ao servidor HTTP através da URI. Caso não seja especificado, este parâmetro é considerado vazio \(""\). +@param [ntimeout], numeric, Indica o tempo, em segundos, máximo de inatividade permitido durante a recepção do documento. Caso não seja especificado, o valor assumido será de 120 segundos. +@param [aheadstr], array, Indica o array que contêm as strings que serão acrescentadas no header da requisição HTTP que será realizada. +@param [@cheaderret], character, Indica a string que conterá o header de resposta HTTP enviado pelo servidor requisitado. Observação: A variável deve ser declarada antes da chamada da função. +@param [lclient], logical, Indica se o GET será feito pelo SmartClient \(.T.\) ou pelo AppServer \(.F.\). Valor padrão: **.F.**. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/httpsget +/*/ +binary function httpsget(curl, ccertificate, cprivkey, cpassword, cgetparms, ntimeout, aheadstr, cheaderret, lclient) +return + + +/*/{Protheus.doc} httpspost +Permite emular um Client HTTP - Hypertext Transfer Protocol, utilizando protocolo HTTPS através de uma função AdvPL, postando um bloco de informações para um determinado documento publicado em um servidor Web, utilizando o método POST, permitindo a passagem de parâmetros adicionais via URL e aguardando por um tempo determinado \(time-out\) pela resposta do servidor solicitado. + +@type binary function +@sintax HTTPSPost(, , , , [cGETParms], [cPOSTParms], [nTimeOut], [aHeadStr], [@cHeaderRet], [lClient]) => character +@return character, Retorna a string que corresponde à requisição solicitada. + +@param , character, Indica o endereço HTTP com a pasta e o documento solicitado. +@param , character, Indica o path do arquivo, em formato PEM \(modelo Apache\), do arquivo que contém o certificado digital. +@param , character, Indica o path da chave privada, em formato PEM \(modelo Apache\), do arquivo que contém a chave privada, referente ao certificado digital. +@param , character, Indica a senha que será utilizada para a abertura da chave privada. Para uma chave privada que não possua senha deve ser informada uma string vazia. +@param [cgetparms], character, Indica uma string de parâmetros, do tipo GET, que serão enviados ao servidor HTTP através da URI. Caso não seja especificado, este parâmetro é considerado vazio \(""\). +@param [cpostparms], character, Indica uma string de parâmetros, do tipo POST, que serão enviados ao servidor HTTP através do pacote HTTP. Caso não seja especificado, este parâmetro é considerado vazio \(""\). +@param [ntimeout], numeric, Indica o tempo, em segundos, máximo de inatividade permitido durante a recepção do documento. Caso não seja especificado, o valor assumido será de 120 segundos. +@param [aheadstr], array, Indica o array que contêm as strings que serão acrescentadas no header da requisição HTTP que será realizada. +@param [@cheaderret], character, Indica a string que conterá o header de resposta HTTP enviado pelo servidor requisitado. Observação: A variável deve ser declarada antes da chamada da função. +@param [lclient], logical, Indica se o POST será feito pelo SmartClient \(.T.\) ou pelo AppServer \(.F.\). Valor padrão: **.F.**. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/httpspost +/*/ +binary function httpspost(curl, ccertificate, cprivkey, cpassword, cgetparms, cpostparms, ntimeout, aheadstr, cheaderret, lclient) +return + + +/*/{Protheus.doc} httpsquote +Permite emular um Client HTTP \(Hypertext Transfer Protocol\) através de uma função AdvPL, utilizando protocolo HTTPS, no qual o método HTTP é informado para a função, postando um bloco de informações para um determinado documento publicado em um servidor Web, permitindo a passagem de parâmetros adicionais via URL e aguardando por um tempo determinado \(time-out\) pela resposta do servidor solicitado. + +@type binary function +@sintax HTTPSQuote(, , , , , [cGETParms], [cPOSTParms], [nTimeOut], [aHeadStr], [@cHeaderRet], [lClient]) => character +@return character, Retorna a string que corresponde à requisição solicitada. + +@param , character, Indica o endereço HTTP com a pasta e o documento solicitado. +@param , character, Indica o path do arquivo, em formato PEM \(modelo Apache\), do arquivo que contém o certificado digital. +@param , character, Indica o path da chave privada, em formato PEM \(modelo Apache\), do arquivo que contém a chave privada, referente ao certificado digital. +@param , character, Indica a senha que será utilizada para a abertura da chave privada. Para uma chave privada que não possua senha deve ser informada uma string vazia. +@param , character, Define o HTTP Method que será utilizado, permitindo outros além de POST/GET. +@param [cgetparms], character, Indica uma string de parâmetros, do tipo GET, que serão enviados ao servidor HTTP através da URI. Caso não seja especificado, este parâmetro é considerado vazio \(""\). +@param [cpostparms], character, Indica uma string de parâmetros, do tipo POST, que serão enviados ao servidor HTTP através do pacote HTTP. Caso não seja especificado, este parâmetro é considerado vazio \(""\). +@param [ntimeout], numeric, Indica o tempo, em segundos, máximo de inatividade permitido durante a recepção do documento. Caso não seja especificado, o valor assumido será de 120 segundos. +@param [aheadstr], array, Indica o array que contêm as strings que serão acrescentadas no header da requisição HTTP que será realizada. +@param [@cheaderret], character, Indica a string que conterá o header de resposta HTTP enviado pelo servidor requisitado. Observação: A variável deve ser declarada antes da chamada da função. +@param [lclient], logical, Indica se a operação será feita pelo SmartClient \(.T.\) ou pelo AppServer \(.F.\). Valor padrão: **.F.**. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/httpsquote +/*/ +binary function httpsquote(curl, ccertificate, cprivkey, cpassword, cmethod, cgetparms, cpostparms, ntimeout, aheadstr, cheaderret, lclient) +return + + +/*/{Protheus.doc} httpsslclient +Define em memória as configurações para conexão SSL. + +@type binary function +@sintax HTTPSSLClient(, , , , , , [nHSM], [lClient], [nVerbose], [nBugs], [nState], [cCACertPath]) => NIL +@param , numeric, Habilita/Desabilita SSL2. +@param , numeric, Habilita/Desabilita SSL3. +@param , numeric, Habilita/Desabilita TLS1. +@param , character, Senha para a chave privada e/ou certificado. +@param , character, Indica o caminho do certificado de cliente. +@param , character, Indica o caminho da chave privada de cliente. +@param [nhsm], numeric, Define se utiliza HSM. +@param [lclient], logical, Indica se a definição será para conexão pelo SmartClient. +@param [nverbose], numeric, Habilita/Desabilita Verbose. +@param [nbugs], numeric, Habilita/Desabilita Bugs. +@param [nstate], numeric, Habilita/Desabilita State. +@param [ccacertpath], character, Indica o caminho do certificado de CA. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/httpsslclient +/*/ +binary function httpsslclient(nssl2, nssl3, ntls1, cpassword, ccertpath, ckeypath, nhsm, lclient, nverbose, nbugs, nstate, ccacertpath) +return + + +/*/{Protheus.doc} i2bin +Converte um número inteiro em uma string formatada como um inteiro de 16 bits. + +@type binary function +@sintax I2Bin() => character +@return character, Retorna uma string de dois bytes que contém um inteiro binário de 16 bits. + +@param , numeric, Indica o valor numérico inteiro que será convertido. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/i2bin +/*/ +binary function i2bin(nint) +return + + +/*/{Protheus.doc} int +Retorna um valor numérico inteiro, a partir de um valor numérico com parte inteira e decimal informado como parâmetro, desconsiderando todos os dígitos à direta do ponto decimal. + +@type binary function +@sintax Int() => numeric +@return numeric, Retorna a parte inteira do número informado como parâmetro. + +@param , numeric, Indica o valor numérico a ser utilizado. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/int +/*/ +binary function int(nvalue) +return + + +/*/{Protheus.doc} ipccount +Obtém e retorna todas as threads livres que estão no ar de um determinado ambiente. + +@type binary function +@sintax IPCCount() => numeric +@return numeric, Retorna um número inteiro indicando o total de threads livres. + +@param , character, Indica o local ou semáforo em que as threads foram iniciadas. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/ipccount +/*/ +binary function ipccount(csemaforo) +return + + +/*/{Protheus.doc} ipcgo +Envia uma chamada para uma thread, que não precisa ser necessariamente do mesmo ambiente, que está em espera. + +@type binary function +@sintax IPCGo() => Nil +@return Nil, Nulo + +@param , character, Indica o local ou semáforo em que as threads foram iniciadas. Observação: O semáforo especificado não deve conter letras minúsculas. Todas as letras informadas no semáforo devem ser maiúsculas. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/ipcgo +/*/ +binary function ipcgo(csemaforo) +return + + +/*/{Protheus.doc} ipcwait +Coloca em modo de espera uma thread que foi carregada e aguarda uma chamada da função IPCGo\(\). + +@type binary function +@sintax IPCWait() => logical +@return logical, Retorna verdadeiro \(.T.\), se receber uma chamada da função IPCGo\(\); caso contrário, falso \(.F.\), se não receber chamada ou sair por time-out. + +@param , numeric, Indica o tempo de time-out em milisegundos para a thread sair do ar. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/ipcwait +/*/ +binary function ipcwait(ntimeout) +return + + +/*/{Protheus.doc} ipcwaitex +Coloca em modo de espera a thread em execução, criando um semáforo nomeado, e aguarda por um determinado período pela liberação desse semáforo. A liberação do semáforo pode ocorrer por time-out, ou através da chamada da função IPCGo\(\) por outro processo, utilizando como parâmetro o nome do semáforo nomeado criado pela IPCWaitEx\(\). Além disso, a liberação semáforo pela função IPCGo\(\) pode enviar parâmetros adicionais, recuperados pela função IPCWaitEx\(\). + +@type binary function +@sintax IPCWaitEx(, ) => logical +@return logical, Retorna verdadeiro \(.T.\), se receber uma chamada da função IPCGo\(\); caso contrário, falso \(.F.\), se não receber chamada ou sair por time-out. + +@param , character, Indica o nome do semáforo que estamos trabalhando. Observação: O nome do semáforo não pode conter letras minúsculas. Todas as letras devem ser maiúsculas. +@param , numeric, Indica o tempo de time-out em milisegundos para a thread sair do ar. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/ipcwaitex +/*/ +binary function ipcwaitex(csemaforo, ntimeout) +return + + +/*/{Protheus.doc} is8859encode +descrição da funcao + +@type binary function +@sintax Is8859Encode([@tNomeVar]) => codeblock +@return codeblock, descrição do retorno + +@param [@tnomevar], codeblock, descrição do parametro +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/is8859encode +/*/ +binary function is8859encode(tnomevar) +return + + +/*/{Protheus.doc} isalpha +Determina se o caractere à esquerda de uma string é alfabético. + +@type binary function +@sintax IsAlpha() => logical +@return logical, Retorna verdadeiro \(.T.\) se o primeiro caractere da string for uma letra do alfabeto ou retorna falso \(.F.\) se a string começar com um dígito ou qualquer outro caractere. + +@param , character, Indica a string que será analisada. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/isalpha +/*/ +binary function isalpha(cstring) +return + + +/*/{Protheus.doc} isbuildtrunk +descrição da funcao + +@type binary function +@sintax IsBuildTrunk([@tNomeVar]) => codeblock +@return codeblock, descrição do retorno + +@param [@tnomevar], codeblock, descrição do parametro +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/isbuildtrunk +/*/ +binary function isbuildtrunk(tnomevar) +return + + +/*/{Protheus.doc} isdigit +Determina se o caractere mais à esquerda de uma string é um dígito. + +@type binary function +@sintax IsDigit() => logical +@return logical, Retorna verdadeiro \(.T.\) se o primeiro caractere da string for um dígito entre 0 e 9 ou retorna falso \(.F.\) caso não seja. + +@param , character, Indica a string que será analisada. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/isdigit +/*/ +binary function isdigit(cstring) +return + + +/*/{Protheus.doc} islower +Determina se o caractere mais à esquerda de uma string é uma letra minúscula. + +@type binary function +@sintax IsLower() => logical +@return logical, Retorna verdadeiro \(.T.\) se o primeiro caractere da string for uma letra minúscula ou retorna falso \(.F.\) caso contrário. + +@param , character, Indica a string que será avaliada. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/islower +/*/ +binary function islower(cstring) +return + + +/*/{Protheus.doc} isplugin +Retorna se o Smart Client está sendo executado em um plug-in ActiveX. + +@type binary function +@sintax IsPlugin() => logical +@return logical, Retorna verdadeiro \(.T.\), se o Smart Client estiver sendo executado em um plug-in ActiveX; caso contrário, falso \(.F.\). + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/isplugin +/*/ +binary function isplugin() +return + + +/*/{Protheus.doc} isprinter2 +Indica o status de uma determinada porta de impressão. + +@type binary function +@sintax IsPrinter2(, [lValue], [lValue]) => logical +@return logical, Retorna verdadeiro \(.T.\), se a porta de impressão estiver OK; caso contrário, falso \(.F.\). + +@param , character, Indica a porta de impressão. +@param [lvalue], logical, Não utilizado. Parâmetro de compatibilidade. +@param [lvalue], numeric, Indica o direcionamento de impressão. Sendo: 1= PRT_CLIENT \(Smart Client\) E 2=PRT_SERVER \(Application Server\). Caso não seja informado, o valor padrão é PRT_CLIENT. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/isprinter2 +/*/ +binary function isprinter2(cstring, lvalue, lvalue) +return + + +/*/{Protheus.doc} isrmt64 +Retorna se o binário TOTVS \| SmartClient rodando na estação é de arquitetura 64-bit ou não. + +@type binary function +@sintax IsRmt64() => logical +@return logical, Retorna verdadeiro \(.T.\) se o binário SmartClient é de arquitetura 64-bit, caso contrário retornará falso \(.F.\). + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/isrmt64 +/*/ +binary function isrmt64() +return + + +/*/{Protheus.doc} issecure +Retorna um valor booleano informando se a conexão é ou não segura. + +@type binary function +@sintax IsSecure() => logical +@return logical, Retorna verdadeiro \(.T.\), se a conexão for segura \(SSL - Secure Sockets Layer\); caso contrário, falso \(.F.\). + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/issecure +/*/ +binary function issecure() +return + + +/*/{Protheus.doc} issrv64 +Verifica se o Application Server está sendo executado em ambiente 64 bit, + +@type binary function +@sintax isSrv64() => logical +@return logical, Retorna verdadeiro \(.T.\) se o Application Server estiver sendo executado em ambiente 64 bit. Caso contrário, falso \(.F.\). + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/issrv64 +/*/ +binary function issrv64() +return + + +/*/{Protheus.doc} issrvbige +Verifica se o tipo de envio de dados do servidor é Big Endian + +@type binary function +@sintax IsSrvBigE() => logical +@return logical, Retorna verdadeiro \(.T.\) caso o tipo de envio de dados do servidor seja Big Endian, do contrário retorna falso \(.F.\) + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/issrvbige +/*/ +binary function issrvbige() +return + + +/*/{Protheus.doc} issrvunix +Informa se o Application Server está sendo executado em ambiente Unix, Linux ou Microsoft Windows. + +@type binary function +@sintax IsSrvUnix() => logical +@return logical, Retorna verdadeiro \(.T.\), se o Application Server estiver sendo executado em Unix ou Linux; caso contrário, retornará falso \(.F.\), se estiver sendo executado em ambiente Microsoft Windows. + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/issrvunix +/*/ +binary function issrvunix() +return + + +/*/{Protheus.doc} isupper +Determina se o caractere mais à esquerda de uma string é uma letra maiúscula. + +@type binary function +@sintax IsUpper() => logical +@return logical, Retorna verdadeiro \(.T.\) se o primeiro caractere da string for uma letra maiúscula ou caso contrário, retorna falso \(.F.\). + +@param , character, Indica a string que será avaliada. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/isupper +/*/ +binary function isupper(cstring) +return + + +/*/{Protheus.doc} jobinfo +Retorna informações sobre os Jobs atualmente executados. + +@type binary function +@sintax JobInfo() => array +@return array, Array com n \(Quantidade de Jobs\) elementos sendo cada Array um outro array com 7 elementos descrevendo cada Job: JobName \(Caracter\) -> Nome do processo \(job\) Environment \(Caracter\) -> Nome do ambiente que está executando o processo Total \(Numérico\) -> Número total de instâncias \(threads\) que o processo está executando Starting \(Numérico\) -> Número de instâncias em processo de inicialização Started \(Numérico\) -> Número de instâncias iniciadas. Running \(Numérico\) -> Número de instâncias em execução Finishing \(Numérico\) -> Número de instâncias sendo finalizadas. + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/jobinfo +/*/ +binary function jobinfo() +return + + +/*/{Protheus.doc} jpgtobmp +descrição da funcao + +@type binary function +@sintax JpgToBmp([@tNomeVar]) => codeblock +@return codeblock, descrição do retorno + +@param [@tnomevar], codeblock, descrição do parametro +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/jpgtobmp +/*/ +binary function jpgtobmp(tnomevar) +return + + +/*/{Protheus.doc} killapp +Caso a função seja chamada sem parâmetros ou com valor falso \(.F.\) retornará se a thread recebeu uma chamada para ser finalizada. Caso seja chamada com valor verdadeiro \(.T.\) irá finalizar a thread onde a função foi chamada. + +@type binary function +@sintax KillApp([lKill]) => logical +@return logical, Retorna verdadeiro \(.T.\), se a thread corrente recebeu uma chamada para ser finalizada, caso contrário retorna falso \(.F.\). + +@param [lkill], logical, Caso verdadeiro finaliza a thread, caso falso apenas retorna se a thread recebeu uma chamada de finalização. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/killapp +/*/ +binary function killapp(lkill) +return + + +/*/{Protheus.doc} killuser +Finaliza a conexão de um usuário do Smart Client. + +@type binary function +@sintax KillUser() => NIL +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/killuser +/*/ +binary function killuser() +return + + +/*/{Protheus.doc} l2bin +Converte um número inteiro em uma string formatada como um inteiro de 32 bits. + +@type binary function +@sintax L2Bin() => character +@return character, Retorna uma string de quatro bytes que contém um inteiro binário de 32 bits. + +@param , numeric, Indica o valor numérico inteiro que será convertido. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/l2bin +/*/ +binary function l2bin(nint) +return + + +/*/{Protheus.doc} land +Realiza a operação lógica **E** entre 2 ou mais números. + +@type binary function +@sintax LAnd(, , [nNum3], [nNum4], [nNum5], [nNum6], [nNum7], [nNum8], [nNum9], [nNum10], [nNum11], [nNum12], [nNum13], [nNum14]) => numeric +@return numeric, Retorna o valor do E lógico entre todos os parâmetros passados, sendo "**0**" como "**.F.**" e "**1**" como "**.T.**". + +@param , numeric, 1º número a ser utlizado na operação de E lógico. +@param , numeric, 2º número a ser utlizado na operação de E lógico. +@param [nnum3], numeric, 3º número a ser utlizado na operação de E lógico. +@param [nnum4], numeric, 4º número a ser utlizado na operação de E lógico. +@param [nnum5], numeric, 5º número a ser utlizado na operação de E lógico. +@param [nnum6], numeric, 6º número a ser utlizado na operação de E lógico. +@param [nnum7], numeric, 7º número a ser utlizado na operação de E lógico. +@param [nnum8], numeric, 8º número a ser utlizado na operação de E lógico. +@param [nnum9], numeric, 9º número a ser utlizado na operação de E lógico. +@param [nnum10], numeric, 10º número a ser utlizado na operação de E lógico. +@param [nnum11], numeric, 11º número a ser utlizado na operação de E lógico. +@param [nnum12], numeric, 12º número a ser utlizado na operação de E lógico. +@param [nnum13], numeric, 13º número a ser utlizado na operação de E lógico. +@param [nnum14], numeric, 14º número a ser utlizado na operação de E lógico. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/land +/*/ +binary function land(nnum1, nnum2, nnum3, nnum4, nnum5, nnum6, nnum7, nnum8, nnum9, nnum10, nnum11, nnum12, nnum13, nnum14) +return + + +/*/{Protheus.doc} lastrec +Retorna o número do último registro inserido na tabela atual. + +@type binary function +@sintax LastRec() => numeric +@return numeric, Retorna o número do último registro inserido na tabela atual. + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/lastrec +/*/ +binary function lastrec() +return + + +/*/{Protheus.doc} listdrives +Retorna as unidades \(drives\), e/ou seus respectivos tipos, da máquina que está executando o TOTVS \| Application Server ou o TOTVS \| SmartClient. + +@type binary function +@sintax ListDrives([@aUnits], [@aTypes], ) => logical +@return logical, Retorna **.T.** se conseguiu listar o que foi solicitado; caso contrário, retorna **.F.**. + +@param [@aunits], array, Retorna todas as unidades da máquina. +@param [@atypes], array, Retorna o tipo das unidades listadas. +@param , numeric, Indica se será listado da máquina do TOTVS \| Application Server ou do TOTVS \| SmartClient. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/listdrives +/*/ +binary function listdrives(aunits, atypes, nwhere) +return + + +/*/{Protheus.doc} localtoutc +Converte a data e hora local para UTC - Coordinated Universal Time. + +@type binary function +@sintax LocalToUTC(, , [nDST]) => array +@return array, Retorna um array contendo a data \(yyyyMMdd\) e a hora \(hh:mm:ss\) no formato UTC. + +@param , date, Indica a data local no formato ano, mês e dia. Exemplo: yyyyMMdd. +@param , date, Indica a hora local no formato hora, minuto e segundo. Exemplo: hh:mm:ss. +@param [ndst], numeric, Indica se a hora informada representa um horário solar \(0\) ou horário de verão \(1\). Caso não especificado, será considerado 0 \(standard time, ou horário solar\). +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/localtoutc +/*/ +binary function localtoutc(cdate, ctime, ndst) +return + + +/*/{Protheus.doc} log +Calcula o logaritmo natural de um valor numérico. + +@type binary function +@sintax Log() => numeric +@return numeric, Retorna o valor numérico do logaritmo natural. + +@param , numeric, Indica o valor cujo logaritmo é calculado. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/log +/*/ +binary function log(nvalue) +return + + +/*/{Protheus.doc} log10 +Calcula o logaritmo de um valor numérico. + +@type binary function +@sintax Log10() => numeric +@return numeric, Retorna o valor numérico do logaritmo de **nValue**. + +@param , numeric, Indica o valor cujo logaritmo é calculado. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/log10 +/*/ +binary function log10(nvalue) +return + + +/*/{Protheus.doc} logmsg +Registra uma mensagem de log com as informações do sistema no formato SysLog \(RFC 5424\), e automaticamente insere informações como: data e hora da geração da mensagem, hostname e id da thread. O Log é expedido para o servidor de log \(LogServer\) de forma assíncrona, não gerando contenção no servidor de aplicação, podendo ser usado como “trace” sem grande prejuízo para a execução. + +@type binary function +@sintax LogMsg() => NIL +@param , character, Nome da função/aplicação onde o log está sendo gerado +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/logmsg +/*/ +binary function logmsg(cfunc) +return + + +/*/{Protheus.doc} logusername +Obtém o nome do usuário logado no sistema operacional da estação em que está sendo executado o Smart Client. + +@type binary function +@sintax LogUserName() => character +@return character, Retorna uma string que corresponde ao login de sistema do usuário. + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/logusername +/*/ +binary function logusername() +return + + +/*/{Protheus.doc} look4bit +Retorna a quantidade de bits com nível lógico igual a 1 em uma string. + +@type binary function +@sintax Look4Bit(, , , ) => numeric +@return numeric, Retorna a quantidade de bits 1 na string apontada por **cStr**. + +@param , character, Indica a string que será verificada. +@param , numeric, Indica o índice do bit inicial. +@param , numeric, Indica a quantidade de bits que serão verificados. +@param , numeric, Indica o índice do último byte que será testado. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/look4bit +/*/ +binary function look4bit(cstr, nstart, ntest, nlength) +return + + +/*/{Protheus.doc} lor +Realiza a operação lógica **OU** entre 2 ou mais números. + +@type binary function +@sintax LOr(, , [nNum3], [nNum4], [nNum5], [nNum6], [nNum7], [nNum8], [nNum9], [nNum10], [nNum11], [nNum12], [nNum13], [nNum14]) => numeric +@return numeric, Retorna o valor do OU lógico entre todos os parâmetros passados, sendo "**0**" como "**.F.**" e "**1**" como "**.T.**". + +@param , numeric, 1º número a ser utlizado na operação de OU lógico. +@param , numeric, 2º número a ser utlizado na operação de OU lógico. +@param [nnum3], numeric, 3º número a ser utlizado na operação de OU lógico. +@param [nnum4], numeric, 4º número a ser utlizado na operação de OU lógico. +@param [nnum5], numeric, 5º número a ser utlizado na operação de OU lógico. +@param [nnum6], numeric, 6º número a ser utlizado na operação de OU lógico. +@param [nnum7], numeric, 7º número a ser utlizado na operação de OU lógico. +@param [nnum8], numeric, 8º número a ser utlizado na operação de OU lógico. +@param [nnum9], numeric, 9º número a ser utlizado na operação de OU lógico. +@param [nnum10], numeric, 10º número a ser utlizado na operação de OU lógico. +@param [nnum11], numeric, 11º número a ser utlizado na operação de OU lógico. +@param [nnum12], numeric, 12º número a ser utlizado na operação de OU lógico. +@param [nnum13], numeric, 13º número a ser utlizado na operação de OU lógico. +@param [nnum14], numeric, 14º número a ser utlizado na operação de OU lógico. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/lor +/*/ +binary function lor(nnum1, nnum2, nnum3, nnum4, nnum5, nnum6, nnum7, nnum8, nnum9, nnum10, nnum11, nnum12, nnum13, nnum14) +return + + +/*/{Protheus.doc} makedir +Cria um diretório. + +@type binary function +@sintax MakeDir(, [uParam2], [lChangeCase]) => numeric +@return numeric, Retorna zero \(0\), se o diretório for criado com sucesso; caso contrário, retorna diferente de zero. + +@param , character, Indica o nome do diretório que será criado. +@param [uparam2], numeric, Compatibility parameter. Pass NIL. +@param [lchangecase], logical, Se verdadeiro \(.T.\), nomes de arquivos e pastas serão convertidos para letras minúsculas; caso seja falso \(.F.\), não será feito nenhum ajuste no nome do arquivo informado. Valor padrão \(.T.\). Veja maiores informações em Observações. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/makedir +/*/ +binary function makedir(cpath, uparam2, lchangecase) +return + + +/*/{Protheus.doc} match +Valida se uma string está formatada conforme um determinado padrão. + +@type binary function +@sintax Match(, ) => logical +@return logical, Retorna **.T.** caso **cValue** seja validado pelo padrão indicado em **cMask**; caso contrário, retornará **.F.**. + +@param , character, Indica o valor que será validado contra um padrão. +@param , character, Indica a máscara com o padrão para validar **cValue**. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/match +/*/ +binary function match(cvalue, cmask) +return + + +/*/{Protheus.doc} mathc +Realiza operações matemáticas \(Soma, Subtração, Divisão, Multiplicação e Exponenciação\) com strings que contém um valor numérico. + +@type binary function +@sintax MathC(, , ) => character +@return character, Retorna uma nova string com o resultado da operação matemática. Observação: O resultado terá até 18 casas de precisão. + +@param , character, Realiza operações matemáticas \(Soma, Subtração, Divisão, Multiplicação e Exponenciação\) com strings que contém um valor numérico. +@param , character, Indica o operador/caracter \(/, +, \*, -, e\) da operação que será realizada. +@param , character, Indica a string que contém um valor numérico, representando o número no qual desejamos realizar uma operação. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/mathc +/*/ +binary function mathc(cnum1, coperacao, cnum2) +return + + +/*/{Protheus.doc} max +Retorna o maior entre dois valores numéricos ou data. + +@type binary function +@sintax Max(, ) => variant +@return variant, Retorna o maior dos dois parâmetros. O valor retornado é do mesmo tipo de dado que os parâmetros. + +@param , variant, Indica o valor que será comparado com o segundo parâmetro. +@param , variant, Indica a segunda expressão que será utilizada para comparação. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/max +/*/ +binary function max(xexp1, xexp2) +return + + +/*/{Protheus.doc} md5 +Aplica a um conteúdo o algoritmo MD5 \(MessageDigest Algorithm 5\). + +@type binary function +@sintax MD5(, [nType]) => character +@return character, Retorna o hash do conteúdo. + +@param , character, Indica o conteúdo no qual será aplicado o algoritmo. +@param [ntype], numeric, Indica se o hash retornado será binário \(1=RAW_DIGEST\) ou hexadecimal \(2=HEX_DIGEST\). +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/md5 +/*/ +binary function md5(cvalor, ntype) +return + + +/*/{Protheus.doc} md5file +Lê o conteúdo do arquivo especificado e, a partir deste arquivo, gera uma chave hash utilizando MD5 - Message Digest Algorithm 5. + +@type binary function +@sintax MD5File(, [nTipo], [nWhere]) => character +@return character, Retorna o hash MD5 do arquivo informado. Em caso de falha na abertura do arquivo, o retorno será uma string vazia \( '' \). + +@param , character, Indica o nome do arquivo a ser considerado para a geração do hash MD5. +@param [ntipo], numeric, Indica se o hash retornado será binário \(1=RAW_DIGEST\) ou hexadecimal \(2=HEX_DIGEST\). +@param [nwhere], numeric, Indica o local onde será realizada a procura do arquivo. Sendo: 0=O acesso depende do path \(Quando for um path relativo a procura será no TOTVS Application Server; caso seja um path absoluto, a procura será no TOTVS Smart Client\). 1 = A procura será realizada no diretório de instalação do TOTVS Application Server. 2 = A procura será realizada no diretório de instalação do TOTVS Smart Client. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/md5file +/*/ +binary function md5file(cfile, ntipo, nwhere) +return + + +/*/{Protheus.doc} memglbsize +Retorna a quantidade de memória, em bytes, sendo consumida pela lista de variáveis globais na memória. + +@type binary function +@sintax MemGlbSize() => numeric +@return numeric, Retorna o número de bytes consumido por todas as variáveis globais na memória da instância atual do servidor de aplicação. + +@param , character, Identificador da variável global. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/memglbsize +/*/ +binary function memglbsize(cglbname) +return + + +/*/{Protheus.doc} memoline +Retorna o conteúdo de um campo, do tipo memo ou string com múltiplas linhas. + +@type binary function +@sintax MemoLine(, [nLineLength], [nLineNumber], [nTabSize], [lWrapWord]) => character +@return character, Retorna o conteúdo desejado do texto. + +@param , character, Indica o texto com múltiplas linhas para filtro. +@param [nlinelength], numeric, Indica o tamanho máximo que será retornado da linha. +@param [nlinenumber], numeric, Indica o número da linha que será retornada. +@param [ntabsize], numeric, Indica o tamanho da tabulação que será usada +@param [lwrapword], logical, Indica se apenas palavras inteiras devem ser consideradas no tamanho do retorno +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/memoline +/*/ +binary function memoline(ctext, nlinelength, nlinenumber, ntabsize, lwrapword) +return + + +/*/{Protheus.doc} memoread +Retorna o conteúdo de um arquivo do tipo texto. + +@type binary function +@sintax MemoRead(, [lChangeCase]) => logical +@return logical, Retorna o conteúdo do arquivo texto, ou uma string vazia \(""\) em caso de erro. + +@param , character, Indica o caminho do arquivo que será lido do tipo texto. +@param [lchangecase], logical, Se verdadeiro \(.T.\), nomes de arquivos e pastas serão convertidos para letras minúsculas; caso contrário, falso \(.F.\), não será feito nenhum ajuste no nome do arquivo informado. Valor padrão \(.T.\). Veja maiores informações em Observações. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/memoread +/*/ +binary function memoread(cfile, lchangecase) +return + + +/*/{Protheus.doc} memotran +descrição da funcao + +@type binary function +@sintax MemoTran([@tNomeVar]) => codeblock +@return codeblock, descrição do retorno + +@param [@tnomevar], codeblock, descrição do parametro +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/memotran +/*/ +binary function memotran(tnomevar) +return + + +/*/{Protheus.doc} memowrite +Permite escrever e salvar um arquivo texto. + +@type binary function +@sintax MemoWrite(, ) => logical +@return logical, Retorna **.T.** se conseguiu criar o arquivo; caso contrário, retorna **.F.**. + +@param , character, Indica o caminho do arquivo que será criado do tipo texto. O tamanho máximo do caminho é de 256 bytes. +@param , character, Indica o texto que será inserido no arquivo. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/memowrite +/*/ +binary function memowrite(cfile, ctext) +return + + +/*/{Protheus.doc} nome +descrição da funcao + +@type binary function +@sintax nome([@tNomeVar]) => codeblock +@return codeblock, descrição do retorno + +@param [@tnomevar], codeblock, descrição do parametro +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/nome +/*/ +binary function nome(tnomevar) +return + + +/*/{Protheus.doc} methlsmemberof +Indica se o método informado através de uma string por parâmetro existe na classe + +@type binary function +@sintax MethlsMemberOf(, , [lRecursive]) => logical +@return logical, Retorna verdadeiro \(.T.\), se o método for encontrado; caso contrário, falso \(.F.\). + +@param , object, Indica o objeto que representa a instância da classe a ser pesquisada. +@param , character, Indica o nome do método declarado na classe a ser pesquisado. +@param [lrecursive], logical, \*Informa se a busca pelo método deve ser realizado nas classes pai, no caso de instância de classe com herança. \(Default = .F.\) +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/methlsmemberof +/*/ +binary function methlsmemberof(oobj, cmethname, lrecursive) +return + + +/*/{Protheus.doc} metricsname +Retorna um Objeto no formato Json com os nomes de todas as métricas disponíveis para coleta e a versão da api quando solicitado. + +@type binary function +@sintax MetricsName([WithVersion]) => character +@return character, Retorna um objeto json com os nomes de todas as métricas disponíveis para coleta. + +@param [withversion], logical, Quando informado com valor verdadeiro, insere a versão da api na propriedade version. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/metricsname +/*/ +binary function metricsname(withversion) +return + + +/*/{Protheus.doc} metricsread +Retorna um objeto Json com as métricas coletadas pelo sistema. + +@type binary function +@sintax MetricsRead([Metric_Name]) => character +@return character, Retorna uma string, no formato json, com as métricas coletadas. + +@param [metric_name], array, Quando informado, filtra objeto de saída inserindo apenas as métricas que contem os nomes informados. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/metricsread +/*/ +binary function metricsread(metric_name) +return + + +/*/{Protheus.doc} min +Retorna o menor entre dois valores numéricos ou data. + +@type binary function +@sintax Min(, ) => variant +@return variant, Retorna o menor dos dois parâmetros. O valor retornado é do mesmo tipo de dado que os parâmetros. + +@param , variant, Indica o valor que será comparado com o segundo parâmetro. +@param , variant, Indica a segunda expressão que será utilizada para comparação. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/min +/*/ +binary function min(xexp1, xexp2) +return + + +/*/{Protheus.doc} mlcount +Conta a quantidade de linhas de um campo memo ou string com múltiplas linhas, considerando um numero máximo de letras por linha, tamanho estimado para caracteres de tabulação, e quebras de linhas CRLF \(pulo de linha\) dentro do texto. + +@type binary function +@sintax MLCount(, [nLinLen], [nTabSize], [lQuebra]) => numeric +@return numeric, Retorna o número de linhas da string considerando os parâmetros de formatação informados. + +@param , character, Indica o texto com múltiplas linhas para verificar a quantidade de linhas. +@param [nlinlen], numeric, Especifica o número de caracteres por linha para que ocorra a quebra de linhas. \(Default: 79\) +@param [ntabsize], numeric, Define um tamanho para tabulação. \(Default: 4\) +@param [lquebra], logical, Especifica o comportamento de contagem de linhas quando a ultima palavra não cabe inteira na linha atual. .T. - Coloca a palavra na próxima linha \(Default\) .F. - Quebra a palavra no tamanho da linha e coloca o restante na próxima linha. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/mlcount +/*/ +binary function mlcount(ctext, nlinlen, ntabsize, lquebra) +return + + +/*/{Protheus.doc} mod +Retorna um número que representa o resto da divisão do primeiro parâmetro \(nDividend\) pelo segundo \(nDivisor\). O operador módulo \(%\) do AdvPL têm a mesma funcionalidade da função Mod. + +@type binary function +@sintax Mod(, ) => numeric +@return numeric, Retorna um número que representa o resto de <**nDividend**> dividido por <**nDivisor**>. + +@param , numeric, Indica o dividendo da operação de divisão. +@param , numeric, Indica o divisor da operação de divisão. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/mod +/*/ +binary function mod(ndividend, ndivisor) +return + + +/*/{Protheus.doc} mscompress +Compacta um ou vários arquivos em um único arquivo no formato Microsiga Zip \(extensão .mzp\). + +@type binary function +@sintax MsCompress(, [cDest], [cPass], [lChangeCase]) => character +@return character, Em caso de sucesso, retorna uma string com o nome do arquivo gerado; caso contrário, retornará uma string em branco \(""\). + +@param , variant, Indica o arquivo ou lista de arquivos que serão compactados. Os tipos de dados válidos para este parâmetro são: Caracter, para especificar um único arquivo, ou Array de caracteres, para especificar um ou mais arquivos. +@param [cdest], character, Indica o caminho do arquivo de destino. +@param [cpass], character, Indica a senha que será utilizada para criptografar o arquivo compactado. +@param [lchangecase], logical, Indica se colocará o nome dos arquivos em letra minúscula. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/mscompress +/*/ +binary function mscompress(xfile, cdest, cpass, lchangecase) +return + + +/*/{Protheus.doc} mscrc32 +Calcula um CRC - Cyclic Redundancy Code \(Código de Redundância Cíclica\) de uma string e retorna um número/resultado. + +@type binary function +@sintax MsCRC32() => numeric +@return numeric, Retorna um número inteiro, com até 10 dígitos, que corresponde ao CRC da string informada no parâmetro cString. + +@param , character, Indica a string da qual será calculado um CRC32. Observação: É garantido que, para a mesma string, sempre se obtenha um mesmo número, porém, não é garantido que para strings diferentes, os números sejam sempre diferentes. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/mscrc32 +/*/ +binary function mscrc32(cstring) +return + + +/*/{Protheus.doc} mscrc32str +Calcula um CRC - Calcula um CRC - Cyclic Redundancy Code \(Código de Redundância Cíclica\) de uma string e retorna uma string com o resultado. + +@type binary function +@sintax MsCRC32Str() => character +@return character, Retorna uma string com o CRC da string informada no parâmetro cString. + +@param , character, Indica a string da qual será calculado um CRC32. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/mscrc32str +/*/ +binary function mscrc32str(cstring) +return + + +/*/{Protheus.doc} msdecomp +Descompacta um arquivo compactado, no formato Microsiga Zip \(extensão .mzp\), no diretório informado. + +@type binary function +@sintax MsDecomp(, [cDest], [cPass]) => logical +@return logical, Retorna verdadeiro \(.T.\), se a descompactação for realizada com sucesso; caso contrário, falso \(.F.\). + +@param , variant, Indica o nome do arquivo, no formato MZP \(Microsiga Zip\), que será descompactado. +@param [cdest], character, Indica o endereço de destino onde será gravado o arquivo descompactado. Observação: Pode-se informar o caminho do servidor ou o diretório local. +@param [cpass], character, Indica a senha para descompactar o arquivo, caso tenha sido compactado com senha. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/msdecomp +/*/ +binary function msdecomp(xfile, cdest, cpass) +return + + +/*/{Protheus.doc} msparse +descrição da funcao + +@type binary function +@sintax msparse([@tNomeVar]) => codeblock +@return codeblock, descrição do retorno + +@param [@tnomevar], codeblock, descrição do parametro +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/msparse +/*/ +binary function msparse(tnomevar) +return + + +/*/{Protheus.doc} msparsererror +descrição da funcao + +@type binary function +@sintax MSParserError([@tNomeVar]) => codeblock +@return codeblock, descrição do retorno + +@param [@tnomevar], codeblock, descrição do parametro +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/msparsererror +/*/ +binary function msparsererror(tnomevar) +return + + +/*/{Protheus.doc} msparsefull +descrição da funcao + +@type binary function +@sintax msparsefull([@tNomeVar]) => codeblock +@return codeblock, descrição do retorno + +@param [@tnomevar], codeblock, descrição do parametro +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/msparsefull +/*/ +binary function msparsefull(tnomevar) +return + + +/*/{Protheus.doc} nand +Realiza a operação binária **E** entre 2 ou mais números. + +@type binary function +@sintax NAnd(, , [nNum3], [nNum4], [nNum5], [nNum6], [nNum7], [nNum8], [nNum9], [nNum10], [nNum11], [nNum12], [nNum13], [nNum14]) => numeric +@return numeric, Retorna o valor do E binário entre todos os parâmetros passados. + +@param , numeric, 1º número a ser utilizado na operação de E binário. +@param , numeric, 2º número a ser utilizado na operação de E binário. +@param [nnum3], numeric, 3º número a ser utilizado na operação de E binário. +@param [nnum4], numeric, 4º número a ser utilizado na operação de E binário. +@param [nnum5], numeric, 5º número a ser utilizado na operação de E binário. +@param [nnum6], numeric, 6º número a ser utilizado na operação de E binário. +@param [nnum7], numeric, 7º número a ser utilizado na operação de E binário. +@param [nnum8], numeric, 8º número a ser utilizado na operação de E binário. +@param [nnum9], numeric, 9º número a ser utilizado na operação de E binário. +@param [nnum10], numeric, 10º número a ser utilizado na operação de E binário. +@param [nnum11], numeric, 11º número a ser utilizado na operação de E binário. +@param [nnum12], numeric, 12º número a ser utilizado na operação de E binário. +@param [nnum13], numeric, 13º número a ser utilizado na operação de E binário. +@param [nnum14], numeric, 14º número a ser utilizado na operação de E binário. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/nand +/*/ +binary function nand(nnum1, nnum2, nnum3, nnum4, nnum5, nnum6, nnum7, nnum8, nnum9, nnum10, nnum11, nnum12, nnum13, nnum14) +return + + +/*/{Protheus.doc} newclassintf +descrição da funcao + +@type binary function +@sintax NewClassIntf([@tNomeVar]) => codeblock +@return codeblock, descrição do retorno + +@param [@tnomevar], codeblock, descrição do parametro +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/newclassintf +/*/ +binary function newclassintf(tnomevar) +return + + +/*/{Protheus.doc} newclassmethod +descrição da funcao + +@type binary function +@sintax NewClassMethod([@tNomeVar]) => codeblock +@return codeblock, descrição do retorno + +@param [@tnomevar], codeblock, descrição do parametro +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/newclassmethod +/*/ +binary function newclassmethod(tnomevar) +return + + +/*/{Protheus.doc} nor +Realiza a operação binária **OU** entre 2 ou mais números. + +@type binary function +@sintax NOr(, , [nNum3], [nNum4], [nNum5], [nNum6], [nNum7], [nNum8], [nNum9], [nNum10], [nNum11], [nNum12], [nNum13], [nNum14]) => numeric +@return numeric, Retorna o valor do OU binário entre todos os parâmetros passados. + +@param , numeric, 1º número a ser utilizado na operação de OU binário. +@param , numeric, 2º número a ser utilizado na operação de OU binário. +@param [nnum3], numeric, 3º número a ser utilizado na operação de OU binário. +@param [nnum4], numeric, 4º número a ser utilizado na operação de OU binário. +@param [nnum5], numeric, 5º número a ser utilizado na operação de OU binário. +@param [nnum6], numeric, 6º número a ser utilizado na operação de OU binário. +@param [nnum7], numeric, 7º número a ser utilizado na operação de OU binário. +@param [nnum8], numeric, 8º número a ser utilizado na operação de OU binário. +@param [nnum9], numeric, 9º número a ser utilizado na operação de OU binário. +@param [nnum10], numeric, 10º número a ser utilizado na operação de OU binário. +@param [nnum11], numeric, 11º número a ser utilizado na operação de OU binário. +@param [nnum12], numeric, 12º número a ser utilizado na operação de OU binário. +@param [nnum13], numeric, 13º número a ser utilizado na operação de OU binário. +@param [nnum14], numeric, 14º número a ser utilizado na operação de OU binário. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/nor +/*/ +binary function nor(nnum1, nnum2, nnum3, nnum4, nnum5, nnum6, nnum7, nnum8, nnum9, nnum10, nnum11, nnum12, nnum13, nnum14) +return + + +/*/{Protheus.doc} notbit +Inverte os bits dos caracteres de uma string. + +@type binary function +@sintax NotBit(<@cStr>, ) => NIL +@param <@cstr>, character, Indica a string que será modificada. +@param , numeric, Indica a quantidade de caracteres que terão seus bits invertidos. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/notbit +/*/ +binary function notbit(cstr, nlength) +return + + +/*/{Protheus.doc} ntol +Converte um valor numérico em lógico. + +@type binary function +@sintax NToL() => numeric +@return numeric, Retorna o valor lógico correspondente ao valor numérico passado por parâmetro. + +@param , numeric, Indica o valor numérico que será convertido para lógico. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/ntol +/*/ +binary function ntol(nvalue) +return + + +/*/{Protheus.doc} nxor +Esta função pode ser usada no lugar da função obsoleta B_XOR\(\). + +@type binary function +@sintax NXor(, , [nNum3], [nNum4], [nNum5], [nNum6], [nNum7], [nNum8], [nNum9], [nNum10], [nNum11], [nNum12], [nNum13], [nNum14]) => numeric +@return numeric, Retorna o valor do XOR binário entre todos os parâmetros passados. + +@param , numeric, 1º número a ser utilizado na operação de XOR binário. +@param , numeric, 2º número a ser utilizado na operação de XOR binário. +@param [nnum3], numeric, 3º número a ser utilizado na operação de XOR binário. +@param [nnum4], numeric, 4º número a ser utilizado na operação de XOR binário. +@param [nnum5], numeric, 5º número a ser utilizado na operação de XOR binário. +@param [nnum6], numeric, 6º número a ser utilizado na operação de XOR binário. +@param [nnum7], numeric, 7º número a ser utilizado na operação de XOR binário. +@param [nnum8], numeric, 8º número a ser utilizado na operação de XOR binário. +@param [nnum9], numeric, 9º número a ser utilizado na operação de XOR binário. +@param [nnum10], numeric, 10º número a ser utilizado na operação de XOR binário. +@param [nnum11], numeric, 11º número a ser utilizado na operação de XOR binário. +@param [nnum12], numeric, 12º número a ser utilizado na operação de XOR binário. +@param [nnum13], numeric, 13º número a ser utilizado na operação de XOR binário. +@param [nnum14], numeric, 14º número a ser utilizado na operação de XOR binário. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/nxor +/*/ +binary function nxor(nnum1, nnum2, nnum3, nnum4, nnum5, nnum6, nnum7, nnum8, nnum9, nnum10, nnum11, nnum12, nnum13, nnum14) +return + + +/*/{Protheus.doc} objecthandle +descrição da funcao + +@type binary function +@sintax objecthandle([@tNomeVar]) => codeblock +@return codeblock, descrição do retorno + +@param [@tnomevar], codeblock, descrição do parametro +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/objecthandle +/*/ +binary function objecthandle(tnomevar) +return + + +/*/{Protheus.doc} oemtoansi +Converte uma string do formato OEM/MS-DOS Text para ANSI Text \(formato do Microsoft Windows\). + +@type binary function +@sintax OEMToANSI() => character +@return character, Retorna a string convertida \(formato ANSI\) para ser exibida no Microsoft Windows + +@param , character, Indica a string \(formato OEM/MS-DOS\) que será convertida. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/oemtoansi +/*/ +binary function oemtoansi(cstringoem) +return + + +/*/{Protheus.doc} pad +Adiciona caracteres de preenchimento à direita do conteúdo de uma variável. + +@type binary function +@sintax Pad(, , [cFill]) => character +@return character, Retorna uma string com o tamanho indicado em **nLen** contendo o valor indicado em **xExp** preenchido à direita com o caractere indicado em **cFill**. + +@param , variant, Indica um valor no qual serão inseridos caracteres de preenchimento. +@param , numeric, Indica o tamanho da string que será retornada. +@param [cfill], character, Indica o caractere que será inserido no parâmetro. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/pad +/*/ +binary function pad(xexp, nlen, cfill) +return + + +/*/{Protheus.doc} padc +Centraliza o conteúdo de uma variável adicionando caracteres de preenchimento à direita e à esquerda. + +@type binary function +@sintax PadC(, , [cFill]) => character +@return character, Retorna uma string com o tamanho indicado em **nLen** contendo o valor indicado em **xExp** centralizado, preenchido com o caractere indicado em **cFill**. + +@param , variant, Indica um valor no qual serão inseridos caracteres de preenchimento. +@param , numeric, Indica o tamanho da string que será retornada. +@param [cfill], character, Indica o caractere que será inserido no parâmetro. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/padc +/*/ +binary function padc(xexp, nlen, cfill) +return + + +/*/{Protheus.doc} padl +Adiciona caracteres de preenchimento à esquerda do conteúdo de uma variável. + +@type binary function +@sintax PadL(, , [cFill]) => character +@return character, Retorna uma string com o tamanho indicado em **nLen** contendo o valor indicado em **xExp** preenchido à esquerda com o caractere indicado em **cFill**. + +@param , variant, Indica um valor no qual serão inseridos caracteres de preenchimento. +@param , numeric, Indica o tamanho da string que será retornada. +@param [cfill], character, Indica o caractere que será inserido no parâmetro. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/padl +/*/ +binary function padl(xexp, nlen, cfill) +return + + +/*/{Protheus.doc} padr +Adiciona caracteres de preenchimento à direita do conteúdo de uma variável. + +@type binary function +@sintax PadR(, , [cFill]) => character +@return character, Retorna uma string com o tamanho indicado em **nLen** contendo o valor indicado em **xExp** preenchido à direita com o caractere indicado em **cFill**. + +@param , variant, Indica um valor no qual serão inseridos caracteres de preenchimento. +@param , numeric, Indica o tamanho da string que será retornada. +@param [cfill], character, Indica o caractere que será inserido no parâmetro. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/padr +/*/ +binary function padr(xexp, nlen, cfill) +return + + +/*/{Protheus.doc} pcount +Retorna o número de parâmetros passados para uma função AdvPL. + +@type binary function +@sintax PCount() => numeric +@return numeric, Retorna o número de parâmetros passados para uma função AdvPL. + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/pcount +/*/ +binary function pcount() +return + + +/*/{Protheus.doc} pemcertpub +Retorna o conteúdo público do certificado digital no formato PEM \(Privacy Enhanced Mail\). + +@type binary function +@sintax PemCertPub(, [cPassword]) => character +@return character, Conteúdo do certificado no formato PEM. + +@param , variant, Dados do certificado. Pode ser caractere, json ou hashmap. Mais informações no campo Observações. +@param [cpassword], character, Senha do certificado, caso haja e a variável cCertData seja passada em caractere. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/pemcertpub +/*/ +binary function pemcertpub(ccertdata, cpassword) +return + + +/*/{Protheus.doc} peminfo +Extrai as informações referentes a um arquivo de certificados no formato .PEM \(Privacy Enhanced Mail\). + +@type binary function +@sintax PEMInfo(, [cPassword], [nHashAlgorithm]) => array +@return array, Retorna um vetor com as informações referente aos certificados existentes no arquivo PEM. + +@param , character, Indica o caminho do arquivo .PEM, a partir do diretório raiz \(RootPath\) do TOTVS Application Server. +@param [cpassword], character, Indica a senha para extrair os dados do arquivo PEM. +@param [nhashalgorithm], numeric, Indica o algoritmo de hash que deverá ser usado para o cálculo do Fingerprint/Thumbprint do certificado. Default: 3 \(SHA1\) +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/peminfo +/*/ +binary function peminfo(cfile, cpassword, nhashalgorithm) +return + + +/*/{Protheus.doc} pfx2pem +Extrai o certificado de cliente e o certificado de autorização \(Certificate Authorith\) de um arquivo com extensão .PFX \(formato padrão do IIS - Internet Information Services\), e gera como saída um arquivo no formato .PEM \(Privacy Enhanced Mail\). + +@type binary function +@sintax PFX2PEM(, , <@cError>, [cPassword]) => logical +@return logical, Retorna **.T.** quando o PEM é gerado com sucesso; caso contrário, **.F.**. + +@param , character, Indica o caminho do arquivo .PFX, a partir da raiz do diretório \(RootPath\) do TOTVS Application Server. +@param , character, Indica o caminho do arquivo .PEM, a partir da raiz do diretório \(RootPath\) do TOTVS Application Server, com as informações de certificado de cliente. +@param <@cerror>, character, Indica a saída da mensagem de erro, em caso de falha. +@param [cpassword], character, Indica a senha para extrair os dados do arquivo PFX. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/pfx2pem +/*/ +binary function pfx2pem(cpfxfile, cpemfile, cerror, cpassword) +return + + +/*/{Protheus.doc} pfxca2pem +Extrai o certificado de autorização \(Certificate Authorith\) de um arquivo com extensão .PFX \(formato padrão do IIS - Internet Information Services\), e gera como saída um arquivo no formato .PEM \(Privacy Enhanced Mail\). + +@type binary function +@sintax PFXCA2PEM(, , <@cError>, [cPassword]) => logical +@return logical, Retorna **.T.** se conseguiu extrair os certificados de autorização do arquivo .PFX; caso contrário, **.F.**. + +@param , character, Indica o caminho do arquivo .PFX, a partir da raiz do diretório \(RootPath\) do TOTVS \| Application Server. +@param , character, Indica o caminho do arquivo .PEM, a partir da raiz do diretório \(RootPath\) do TOTVS \| Application Server, com as informações dos certificados de autorização. +@param <@cerror>, character, Indica a saída da mensagem de erro, em caso de falha. +@param [cpassword], character, Indica a senha para exportar os dados do certificado. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/pfxca2pem +/*/ +binary function pfxca2pem(cpfxfile, cpemfile, cerror, cpassword) +return + + +/*/{Protheus.doc} pfxcert2pem +Extrai o certificado de cliente de um arquivo com extensão .PFX \(formato padrão do IIS - Internet Information Services\), e gera como saída um arquivo no formato .PEM \(Privacy Enhanced Mail\). + +@type binary function +@sintax PFXCert2PEM(, , <@cError>, [cPassword]) => logical +@return logical, Retorna **.T.** quando o PEM é gerado com sucesso; caso contrário, **.F.**. + +@param , character, Indica o caminho do arquivo .PFX, a partir da raiz do diretório \(RootPath\) do TOTVS Application Server. +@param , character, Indica o caminho do arquivo .PEM, a partir da raiz do diretório \(RootPath\) do TOTVS Application Server, com as informações de certificado de cliente. +@param <@cerror>, character, Indica a saída da mensagem de erro, em caso de falha. +@param [cpassword], character, Indica a senha para extrair os dados do arquivo PFX. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/pfxcert2pem +/*/ +binary function pfxcert2pem(cpfxfile, cpemfile, cerror, cpassword) +return + + +/*/{Protheus.doc} pfxinfo +Extrai de um arquivo com extensão .PFX \(formato padrão do IIS - Internet Information Services\) as informações referentes a certificado de cliente e certificados de CA \(Certificate Authority\). + +@type binary function +@sintax PFXInfo(, [cPassword]) => array +@return array, Retorna um vetor com as informações referentes a certificado de cliente e certificados de CA. + +@param , character, Indica o caminho do arquivo .PFX, a partir do diretório raiz \(RootPath\) do TOTVS \| Application Server. +@param [cpassword], character, Indica a senha para extrair os dados do arquivo PFX. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/pfxinfo +/*/ +binary function pfxinfo(cfile, cpassword) +return + + +/*/{Protheus.doc} pfxkey2pem +Extrai a chave privada de um arquivo com extensão .PFX \(formato padrão do IIS - Internet Information Services\), e gera como saída um arquivo no formato .PEM \(Privacy Enhanced Mail\). + +@type binary function +@sintax PFXKey2PEM(, , <@cError>, [cPassword]) => logical +@return logical, Retorna **.T.** se conseguiu extrair a chave privada do arquivo .PFX; caso contrário, **.F.**. + +@param , character, Indica o caminho do arquivo .PFX, a partir da raiz do diretório \(RootPath\) do TOTVS Application Server. +@param , character, Indica o caminho do arquivo .PEM, a partir da raiz do diretório \(RootPath\) do TOTVS Application Server, com as informações de chave privada. +@param <@cerror>, character, Indica a saída da mensagem de erro, em caso de falha. +@param [cpassword], character, Indica a senha para extrair os dados do arquivo PFX. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/pfxkey2pem +/*/ +binary function pfxkey2pem(cpfxfile, cpemfile, cerror, cpassword) +return + + +/*/{Protheus.doc} ping +A função Ping\(\) retorna a latência entre o AppServer e SmartClient, resultado será a média do tempo das requisições. + +@type binary function +@sintax Ping() => NIL +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/ping +/*/ +binary function ping() +return + + +/*/{Protheus.doc} pk7key2pem +Extrai todos os certificado de um arquivo PKCS#7 em formato DER \(Distinguished Encoding Rules\) para o formato PEM \(Privacy Enhanced Mail\). + +@type binary function +@sintax PK7Key2PEM(, , <@cError>) => logical +@return logical, Retorna **.T.** se conseguiu converter o arquivo .PK7; caso contrário, **.F.**. + +@param , character, Indica o caminho do arquivo .PK7, a partir do RootPath do TOTVS Application Server. +@param , character, Indica o caminho do arquivo .PEM, a partir do RootPath do TOTVS Application Server. +@param <@cerror>, character, Indica a saída da mensagem de erro, em caso de falha. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/pk7key2pem +/*/ +binary function pk7key2pem(cpk7file, cpemfile, cerror) +return + + +/*/{Protheus.doc} pk8key2pem +Converte uma chave privada PKCS#8 em formato DER \(Distinguished Encoding Rules\) para o formato PEM \(Privacy Enhanced Mail\). + +@type binary function +@sintax PK8Key2PEM(, , <@cError>, [cPassword]) => logical +@return logical, Retorna **.T.** se conseguiu converter o arquivo .PK8; caso contrário, **.F.**. + +@param , character, Indica o caminho do arquivo .PK8, a partir da raiz do diretório \(RootPath\) do TOTVS Application Server. +@param , character, Indica o caminho do arquivo .PEM, a partir da raiz do diretório \(RootPath\) do TOTVS Application Server, com as informações de chave privada. +@param <@cerror>, character, Indica a saída da mensagem de erro, em caso de falha. +@param [cpassword], character, Indica a senha que será usada no arquivo .PEM. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/pk8key2pem +/*/ +binary function pk8key2pem(cpk8file, cpemfile, cerror, cpassword) +return + + +/*/{Protheus.doc} privsignrsa +Assina um determinado conteúdo usando chave privada. + +@type binary function +@sintax PrivSignRSA(, , , , [@cErrStr], [nPad]) => character +@return character, Retorna o valor do parâmetro cContent, assinado, de acordo com o tipo nTipo e a chave privada informada cPathKey. + +@param , character, Indica a string que contém o caminho para a chave privada \(formato .PEM\) ou o conteúdo do arquivo. +@param , character, Indica a string que será assinada. +@param , numeric, Indica o tipo de algoritmo que será utilizado para realizar a assinatura da chave. +@param , character, Indica uma string que contém o valor da senha usada na geração da chave privada criptografada. +@param [@cerrstr], character, Indica a variável para retornar as mensagens de erro. +@param [npad], numeric, Indica o tipo de schema de criptografia que será utilizado. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/privsignrsa +/*/ +binary function privsignrsa(ckeyorpathkey, ccontent, ntipo, csenha, cerrstr, npad) +return + + +/*/{Protheus.doc} privveryrsa +Verifica um determinado conteúdo assinado, usando a chave pública. + +@type binary function +@sintax PrivVeryRSA(, , , , [@cErrStr], [nPad]) => codeblock +@return codeblock, Retorna verdadeiro \(.T.\) se o valor informado no parâmetro cContent está de acordo com o valor enviado que foi assinado pelo tipo nTipo e a chave informada cPathKey. Caso contrário, falso \(.F.\). + +@param , character, Indica a string que contém o caminho para a chave privada \(formato .PEM\) ou o conteúdo do arquivo. +@param , character, Indica o valor que será verificado, com um conteúdo já assinado. +@param , numeric, Indica o tipo de algoritmo que será utilizado para verificar a assinatura. +@param , character, Indica uma string que contém o valor da assinatura gerada mediante a aplicação da chave privada criptografada. +@param [@cerrstr], character, Indica a variável para retornar as mensagens de erro. +@param [npad], numeric, Indica o tipo de schema de criptografia que será utilizado. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/privveryrsa +/*/ +binary function privveryrsa(ckeyorpathkey, ccontent, ntipo, cassinatura, cerrstr, npad) +return + + +/*/{Protheus.doc} procsource +descrição da funcao + +@type binary function +@sintax procSource([@tNomeVar]) => codeblock +@return codeblock, descrição do retorno + +@param [@tnomevar], codeblock, descrição do parametro +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/procsource +/*/ +binary function procsource(tnomevar) +return + + +/*/{Protheus.doc} propref +descrição da funcao + +@type binary function +@sintax PropRef([@tNomeVar]) => codeblock +@return codeblock, descrição do retorno + +@param [@tnomevar], codeblock, descrição do parametro +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/propref +/*/ +binary function propref(tnomevar) +return + + +/*/{Protheus.doc} propsetget +descrição da funcao + +@type binary function +@sintax PropSetGet([@tNomeVar]) => codeblock +@return codeblock, descrição do retorno + +@param [@tnomevar], codeblock, descrição do parametro +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/propsetget +/*/ +binary function propsetget(tnomevar) +return + + +/*/{Protheus.doc} putglbvalue +Cria uma variável global para armazenar um único valor do tipo string e armazena a string de conteúdo fornecida. + +@type binary function +@sintax PutGlbValue(, ) => NIL +@param , character, Indica o nome da variável global a ser criada. +@param , character, Indica a string de conteúdo a ser armazenado na variável global. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/putglbvalue +/*/ +binary function putglbvalue(cglbname, cvalue) +return + + +/*/{Protheus.doc} putglbvars +Cria uma variável global para armazenar múltiplos valores de tipos diversos e armazena os valores fornecidos. + +@type binary function +@sintax PutGlbVars(, ) => NIL +@param , character, Indica o nome da variável global a ser criada. +@param , variant, Indica um ou mais valores a serem armazenados na variável global. Ver Observações para os tipos suportados. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/putglbvars +/*/ +binary function putglbvars(cglbname, xvalue1n) +return + + +/*/{Protheus.doc} qout +Apresenta uma mensagem no consolte do Application Server. + +@type binary function +@sintax QOut() => NIL +@param , character, Indica o texto que será apresentado no console do Application Server. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/qout +/*/ +binary function qout(ctext) +return + + +/*/{Protheus.doc} qqout +Apresenta uma mensagem no consolte do Application Server. + +@type binary function +@sintax QQOut() => NIL +@param , character, Indica o texto que será apresentado no console do Application Server. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/qqout +/*/ +binary function qqout(ctext) +return + + +/*/{Protheus.doc} randomize +Gera um número inteiro aleatório entre a faixa, inferior e superior, recebida através dos parâmetros \(nMinimo e nMaximo\). + +@type binary function +@sintax Randomize(, ) => numeric +@return numeric, Retorna um número randômico, no intervalo entre os parâmetros nMinimo e nMaximo. O número gerado pode ser maior ou igual a nMinimo e menor ou igual a nMaximo -1. + +@param , numeric, Indica o menor número que será gerado. +@param , numeric, Indica o maior número \(menos um\) que será gerado. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/randomize +/*/ +binary function randomize(nminimo, nmaximo) +return + + +/*/{Protheus.doc} rat +Retorna a posição da última ocorrência de uma substring em uma string. Para isso, a função pesquisa a string destino a partir da direita. + +@type binary function +@sintax RAt(, ) => numeric +@return numeric, Retorna o índice em que <**cSearch**> foi encontrada. + +@param , character, Indica a string que será localizada. +@param , character, Indica a string onde <**cSearch**> será procurada. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/rat +/*/ +binary function rat(csearch, csource) +return + + +/*/{Protheus.doc} rc4crypt +Encripta e decripta uma determinada cadeia de caracteres usando o algoritmo RC4. + +@type binary function +@sintax RC4Crypt(, , [lIsReturnASCII], [lIsInputASCII]) => character +@return character, Retorna uma cadeia de caracteres criptografada. + +@param , character, Indica a sequência de caracteres que serão criptografados. +@param , character, Indica a sequência de caracteres a serem utilizados como chave para o algoritmo de criptografia. +@param [lisreturnascii], logical, Formato do retorno. Se **.T.**, indica que o retorno será em código ASCII hexadecimal, onde cada código corresponde a dois caracteres, sem "0x" inicial; caso contrário, se **.F.**, o retorno será em texto plano. Por padrão é assumido **.T.**. +@param [lisinputascii], logical, Formato da entrada. Se **.T.**, indica que a entrada está em código ASCII hexadecimal, onde cada código corresponde a dois caracteres, sem "0x" inicial; caso contrário, se **.F.**, a entrada está em texto plano. Por padrão é assumido **.F.**. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/rc4crypt +/*/ +binary function rc4crypt(cinput, ckey, lisreturnascii, lisinputascii) +return + + +/*/{Protheus.doc} rddname +Retorna o nome da RDD utilizada. + +@type binary function +@sintax RDDName() => character +@return character, Retorna o nome da RDD utilizada. + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/rddname +/*/ +binary function rddname() +return + + +/*/{Protheus.doc} rddsetdefault +Retorna a RDD padrão que é utilizada, podendo alterá-la. + +@type binary function +@sintax RDDSetDefault([cRDD]) => character +@return character, Retorna o nome da RDD padrão. + +@param [crdd], character, Indica a nova RDD padrão. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/rddsetdefault +/*/ +binary function rddsetdefault(crdd) +return + + +/*/{Protheus.doc} recno +Retorna o número do registro atualmente posicionado na área de trabalho ativa. + +@type binary function +@sintax Recno() => numeric +@return numeric, Retorna o identificador numérico do registro atualmente posicionado na área de trabalho ativa. + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/recno +/*/ +binary function recno() +return + + +/*/{Protheus.doc} recsize +Retorna o tamanho de um registro da tabela aberta. + +@type binary function +@sintax RecSize() => NIL +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/recsize +/*/ +binary function recsize() +return + + +/*/{Protheus.doc} releaseprogs +Encerra imediatamente o contexto dos programas do processo AdvPL atual, sem finalizar o processo. Entende-se por encerramento de contexto a limpeza dos conteúdos das variáveis estáticas alocadas após a primeira execução da função na conexão e a limpeza da interface de classes dinâmicas alocadas pelo processo atual. + +@type binary function +@sintax ReleaseProgs() => NIL +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/releaseprogs +/*/ +binary function releaseprogs() +return + + +/*/{Protheus.doc} remotexclsid +descrição da funcao + +@type binary function +@sintax RemoteXCLSID([@tNomeVar]) => codeblock +@return codeblock, descrição do retorno + +@param [@tnomevar], codeblock, descrição do parametro +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/remotexclsid +/*/ +binary function remotexclsid(tnomevar) +return + + +/*/{Protheus.doc} remotexversion +Retorna a build do Smart Client ActiveX. + +@type binary function +@sintax RemoteXVersion() => character +@return character, Retorna a build do Smart Client ActiveX. + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/remotexversion +/*/ +binary function remotexversion() +return + + +/*/{Protheus.doc} replicate +Gera uma string repetida a partir de outra. + +@type binary function +@sintax Replicate(, ) => character +@return character, Retorna a string <**cString**> repetida <**nCount**> vezes. + +@param , character, Indica a string que será repetida. +@param , numeric, Indica a quantidade de vezes que a string será repetida. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/replicate +/*/ +binary function replicate(cstring, ncount) +return + + +/*/{Protheus.doc} resource2file +Salva o conteúdo de um recurso do repositório em um arquivo. + +@type binary function +@sintax Resource2File([cResource], [cFile]) => logical +@return logical, Se o recurso foi copiado no disco com sucesso retorna verdadeiro \(.T.\), caso contrário retorna falso \(.F.\). + +@param [cresource], character, Indica o nome e extensão do recurso no repositório a ser salvo em disco. +@param [cfile], character, Indica o diretório e nome do arquivo onde o recurso será salvo. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/resource2file +/*/ +binary function resource2file(cresource, cfile) +return + + +/*/{Protheus.doc} retimgtype +Retorna o tipo de imagem \( BMP ou JPG \) a partir de um path informado por parâmetro. + +@type binary function +@sintax RetImgType() => numeric +@return numeric, Tipo da imagem, onde: 1 = Bitmap e 2 = JPG + +@param , character, Indica o path completo da imagem. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/retimgtype +/*/ +binary function retimgtype(cpath) +return + + +/*/{Protheus.doc} right +Retorna um determinado número da caracteres à direita de uma string. + +@type binary function +@sintax Right(, ) => character +@return character, Retorna uma cópia da string, iniciando a partir do caractere final da string \(último caractere da direita\), considerando o número de caracteres especificado no segundo parâmetro. + +@param , character, Indica o texto que será tratado. +@param , numeric, Indica o número de caracteres à direita a serem retornados. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/right +/*/ +binary function right(ctext, ncount) +return + + +/*/{Protheus.doc} rlock +Bloqueia somente o registro atual. + +@type binary function +@sintax RLock() => logical +@return logical, Retorna verdadeiro \(.T.\), se o registro for bloqueado com sucesso; caso contrário, falso \(.F.\). + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/rlock +/*/ +binary function rlock() +return + + +/*/{Protheus.doc} rsaexponent +Retorna o expoente \(exponent\) de uma chave no formato big-endian. + +@type binary function +@sintax RSAExponent(, , [cPassword]) => character +@return character, Retorna o expoente de uma chave no formato big-endian ou **Nil** \(caso ocorra um erro no processamento\). + +@param , character, Indica o caminho relativo \(ao RootPath\) para a chave. +@param , logical, Indica se está sendo utilizada uma chave pública. +@param [cpassword], character, Indica a senha da chave RSA. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/rsaexponent +/*/ +binary function rsaexponent(ckey, lpublic, cpassword) +return + + +/*/{Protheus.doc} rsamodulus +Retorna o módulo público \(public modulus\) de uma chave no formato PEM. + +@type binary function +@sintax RSAModulus(, , [cPassword]) => character +@return character, Retorna o módulo público da chave em uma string binária em AdvPL - com bytes de 0 a 255 - ou **Nil** \(caso ocorra um erro no processamento\). + +@param , character, Indica o caminho relativo \(ao RootPath\) para a chave. +@param , logical, Indica se está sendo utilizada uma chave pública. +@param [cpassword], character, Indica a senha da chave \(se existente\). +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/rsamodulus +/*/ +binary function rsamodulus(ckey, lpublic, cpassword) +return + + +/*/{Protheus.doc} runcommand +Executa um comando no sistema operacional e retorna o resultado apresentado no stdout \(console\). + +@type binary function +@sintax RunCommand() => character +@return character, Retorna o resultado do comando exibido no console. + +@param , character, Texto com o comando a ser executado. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/runcommand +/*/ +binary function runcommand(nexp) +return + + +/*/{Protheus.doc} seconds +Retorna a hora do sistema em segundos. + +@type binary function +@sintax Seconds() => numeric +@return numeric, Retorna um valor que representa o número de segundos, decorridos desde a meia-noite, conforme a hora atual do sistema. + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/seconds +/*/ +binary function seconds() +return + + +/*/{Protheus.doc} select +Retorna o número da área de trabalho de um alias especificado. + +@type binary function +@sintax Select([cAlias]) => numeric +@return numeric, Retorna o número da área de trabalho do alias especificado. + +@param [calias], character, Indica o alias que será pesquisado. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/select +/*/ +binary function select(calias) +return + + +/*/{Protheus.doc} serialnumber +Retorna o número de série de um drive Windows da máquina onde está sendo executado o TOTVS \| Application Server. + +@type binary function +@sintax SerialNumber([cDrive]) => character +@return character, Retorna o número de série do drive especificado. + +@param [cdrive], character, Indica a letra do drive que será consultado. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/serialnumber +/*/ +binary function serialnumber(cdrive) +return + + +/*/{Protheus.doc} set +Realiza a definição de alguns parâmetros do sistema, permite também retornar o valor previamente definido. + +@type binary function +@sintax Set(, [xValue]) => variant +@return variant, Retorna o valor previamente definido para o parâmetro. + +@param , numeric, Parâmetro a ser definido ou consultado +@param [xvalue], variant, Valor a ser definido para o parâmetro +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/set +/*/ +binary function set(nparam, xvalue) +return + + +/*/{Protheus.doc} set4gllineclr +descrição da funcao + +@type binary function +@sintax set4gllineclr([@tNomeVar]) => codeblock +@return codeblock, descrição do retorno + +@param [@tnomevar], codeblock, descrição do parametro +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/set4gllineclr +/*/ +binary function set4gllineclr(tnomevar) +return + + +/*/{Protheus.doc} setcss +Define um CSS \(Cascading Style Sheet\) padrão que será utilizado na criação de componentes visuais. + +@type binary function +@sintax SetCSS() => codeblock +@return codeblock, Nulo + +@param , character, Indica o CSS que será aplicado nos componentes visuais. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/setcss +/*/ +binary function setcss(ccss) +return + + +/*/{Protheus.doc} setkeyblock +Define um bloco de código que será executado sempre que a função SetKey\(\) for chamada. + +@type binary function +@sintax SetKeyBlock() => NIL +@param , codeblock, Bloco de código que será executado. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/setkeyblock +/*/ +binary function setkeyblock(bbloco) +return + + +/*/{Protheus.doc} setksyslog +Adiciona um identificador no formato \[chave valor\] a todas mensagens enviadas ao syslog, através das funções Conout e LogMsg. + +@type binary function +@sintax SetKSysLog(, ) => NIL +@param , character, chave de identificação +@param , character, valor, da chave de identificação +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/setksyslog +/*/ +binary function setksyslog(ckey, cvalor) +return + + +/*/{Protheus.doc} setmailobj +Armazena ou apaga um objeto TMailManager na lista de objetos do servidor. + +@type binary function +@sintax SetMailObj(, ) => NIL +@param , character, Indica um identificador, usado para recuperar o objeto armazenado posteriormente. +@param , variant, Indica um objeto do tipo TMailManager ou nulo. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/setmailobj +/*/ +binary function setmailobj(cid, omailobj) +return + + +/*/{Protheus.doc} setnoproxyfor +Configura uma lista de domínios ou IPs que não devem utilizar proxy. + +@type binary function +@sintax SetNoProxyFor(, [lClient]) => NIL +@param , character, Indica a lista de domínios ou IP que não irão usar proxy. +@param [lclient], logical, Indica se irá definir na conexão feita pelo SmartClient \(.T.\) ou pelo AppServer \(.F.\). Valor padrão: **.F.**. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/setnoproxyfor +/*/ +binary function setnoproxyfor(cdomainlist, lclient) +return + + +/*/{Protheus.doc} setproxy +Define as configurações para utilizar proxy HTTP. + +@type binary function +@sintax SetProxy(, , [cUser], [cPass], [lClient]) => NIL +@param , character, Indica o endereço do servidor de proxy HTTP. +@param , numeric, Indica a porta do servidor de proxy HTTP. +@param [cuser], character, Indica o usuário para proxy HTTP. +@param [cpass], character, Indica a senha para proxy HTTP. +@param [lclient], logical, Indica se irá definir na conexão feita pelo SmartClient \(.T.\) ou pelo AppServer \(.F.\). Valor padrão: **.F.**. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/setproxy +/*/ +binary function setproxy(cserver, nport, cuser, cpass, lclient) +return + + +/*/{Protheus.doc} setrmtdate +Define e data corrente do Smart Client. + +@type binary function +@sintax SetRmtDate() => NIL +@param , date, Indica a data que será definida para o Smart Client. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/setrmtdate +/*/ +binary function setrmtdate(ddata) +return + + +/*/{Protheus.doc} settransparentcolor +descrição da funcao + +@type binary function +@sintax SetTransparentColor([@tNomeVar]) => codeblock +@return codeblock, descrição do retorno + +@param [@tnomevar], codeblock, descrição do parametro +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/settransparentcolor +/*/ +binary function settransparentcolor(tnomevar) +return + + +/*/{Protheus.doc} setvarnamelen +Define o tamanho de uma variável AdvPL. + +@type binary function +@sintax SetVarNameLen([nValue]) => numeric +@return numeric, Retorna o tamanho definido anteriormente para uma variável. + +@param [nvalue], numeric, Indica o tamanho da variável. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/setvarnamelen +/*/ +binary function setvarnamelen(nvalue) +return + + +/*/{Protheus.doc} setvdrobj +descrição da funcao + +@type binary function +@sintax SetVdrObj([@tNomeVar]) => codeblock +@return codeblock, descrição do retorno + +@param [@tnomevar], codeblock, descrição do parametro +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/setvdrobj +/*/ +binary function setvdrobj(tnomevar) +return + + +/*/{Protheus.doc} sha1 +SHA1 \(Secure Hash Algorithm\) gera o hash \(ou digest\) de um conteúdo, com base no algoritmo definido em FIPS PUB 180-1 published April 17, 1995. + +@type binary function +@sintax SHA1(, [nRetType]) => character +@return character, Retorna o hash \(ou digest\) do conteúdo informado. + +@param , character, Indica a string que contém os dados no qual será gerado o hash. +@param [nrettype], numeric, Indica o tipo de retorno do digest. Quando informado 1 \(um\) retorna uma string no formato RAW_DIGEST \(sequência de 20 bytes ASCII\); quando informado 2 \(dois\) retorna uma string no formato HEX_DIGEST \(sequência hexadecimal de 40 caracteres em hexadecimal\). Caso não informado, o valor padrão é 2 \(dois\). +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/sha1 +/*/ +binary function sha1(ccontent, nrettype) +return + + +/*/{Protheus.doc} sha256 +SHA256 gera o hash \(message digest\) de uma mensagem de entrada, com base no algoritmo SHA-256 da família SHA-2, definido em FIPS PUB 180-4 e publicado em 2001 pelo NIST. + +@type binary function +@sintax SHA256(, [nRetType]) => character +@return character, Retorna o hash \(message digest\) do conteúdo de entrada informado, no formato especificado. + +@param , character, Indica a string de entrada que contém os dados para os quais será gerado o hash. +@param [nrettype], numeric, Indica o tipo do formato de retorno do hash. Quando informado **1 \(um\)** retorna uma string no formato **RAW_DIGEST** \(sequência de 32 bytes ASCII\); quando informado **2 \(dois\)** ou **qualquer outro valor inteiro diferente de 1 \(um\)** retorna uma string no formato **HEX_DIGEST** \(sequência hexadecimal de 64 bytes\). Caso não informado, o valor padrão é **2 \(dois\)**. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/sha256 +/*/ +binary function sha256(ccontent, nrettype) +return + + +/*/{Protheus.doc} sha384 +SHA384 gera o hash \(message digest\) de uma mensagem de entrada, com base no algoritmo SHA-384 da família SHA-2, definido em FIPS PUB 180-4 e publicado em 2001 pelo NIST. + +@type binary function +@sintax SHA384(, [nRetType]) => character +@return character, Retorna o hash \(Message Authentication Code\) do conteúdo de entrada informado, no formato especificado. + +@param , character, Indica a string de entrada que contém os dados para os quais será gerado o hash. +@param [nrettype], numeric, Indica o tipo do formato de retorno do hash. Quando não informado valor padrão será **2 \(Hex Hash\)**. Veja tabela nas observações. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/sha384 +/*/ +binary function sha384(ccontent, nrettype) +return + + +/*/{Protheus.doc} sha512 +SHA512 gera o hash \(message digest\) de uma mensagem de entrada, com base no algoritmo SHA-512 da família SHA-2, definido em FIPS PUB 180-4 e publicado em 2001 pelo NIST. + +@type binary function +@sintax SHA512(, [nRetType]) => character +@return character, Retorna o hash \(message digest\) do conteúdo de entrada informado, no formato especificado. + +@param , character, Indica a string de entrada que contém os dados para os quais será gerado o hash. +@param [nrettype], numeric, Indica o tipo do formato de retorno do hash. Quando informado **1 \(um\)** retorna uma string no formato **RAW_DIGEST** \(sequência de 64 bytes ASCII\); quando informado **2 \(dois\)** ou **qualquer outro valor inteiro diferente de 1 \(um\)** retorna uma string no formato **HEX_DIGEST** \(sequência hexadecimal de 128 bytes\). Caso não informado, o valor padrão é **2 \(dois\)**. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/sha512 +/*/ +binary function sha512(ccontent, nrettype) +return + + +/*/{Protheus.doc} shellexecute +Executa uma função, um arquivo ou qualquer execução em linha de comando no S.O. na estação onde o Smartclient está em execução. Esta função encontra-se disponível para Windows e Linux. + +@type binary function +@sintax ShellExecute(, , , , [nOpc]) => character +@return character, Retorna 0 \(zero\) em caso de sucesso da execução do processo e diferente de zero para erros. + +@param , character, Indica o nome da ação que será executada. +@param , character, Indica o caminho e diretório do arquivo que será executado. +@param , character, Indica o parâmetro de linha que será repassado para o executável. +@param , character, Indica o diretório de trabalho onde o arquivo será executa. +@param [nopc], numeric, Indica o modo de interface a ser criado para a execução do programa. Para mais informações consulte observações. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/shellexecute +/*/ +binary function shellexecute(cacao, carquivo, cparam, cdirtrabalho, nopc) +return + + +/*/{Protheus.doc} showinfmem +descrição da funcao + +@type binary function +@sintax ShowInfMem([@tNomeVar]) => codeblock +@return codeblock, descrição do retorno + +@param [@tnomevar], codeblock, descrição do parametro +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/showinfmem +/*/ +binary function showinfmem(tnomevar) +return + + +/*/{Protheus.doc} sin +Calcula o valor do seno de um ângulo \(em radianos\). + +@type binary function +@sintax Sin() => numeric +@return numeric, Retorna o valor do seno de acordo com o ângulo informado. + +@param , numeric, Indica o valor do ângulo em radianos. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/sin +/*/ +binary function sin(nangle) +return + + +/*/{Protheus.doc} sleep +Tem o objetivo de fazer com que a thread corrente deixe de ser executada de acordo com o valor informado como parâmetro. + +@type binary function +@sintax Sleep() => NIL +@param , numeric, Representa um total de tempo no qual a thread irá ficar sem executar. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/sleep +/*/ +binary function sleep(nsleep) +return + + +/*/{Protheus.doc} smartjob +descrição da funcao + +@type binary function +@sintax SmartJob([@tNomeVar]) => codeblock +@return codeblock, descrição do retorno + +@param [@tnomevar], codeblock, descrição do parametro +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/smartjob +/*/ +binary function smartjob(tnomevar) +return + + +/*/{Protheus.doc} smimesign +descrição da funcao + +@type binary function +@sintax SMIMESign([@tNomeVar]) => codeblock +@return codeblock, descrição do retorno + +@param [@tnomevar], codeblock, descrição do parametro +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/smimesign +/*/ +binary function smimesign(tnomevar) +return + + +/*/{Protheus.doc} socketconn +Cria um conexão TCP com uma aplicação de destino, através do uso de um Socket do sistema operacional. + +@type binary function +@sintax SocketConn(, , , [nTimeOut]) => character +@return character, String de bytes retornados pelo serviço chamado. Cada serviço pode retornar um buffer composto de uma string de bytes / caracteres, a ordem e interpretação deste retorno deve ser conhecida pela aplicação que o utiliza. + +@param , character, Indica a string com o endereço IP ou nome da máquina de destino desejado. +@param , numeric, Indica o número da porta de comunicação que será utilizada para realizar a conexão. +@param , character, String a ser enviada para a conexão de destino, caso ela seja estabelecida com sucesso. +@param [ntimeout], numeric, Informa o tempo, em segundos, de espera por um retorno \( time-out \). +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/socketconn +/*/ +binary function socketconn(cip, nport, creq, ntimeout) +return + + +/*/{Protheus.doc} splitpath +Divide um caminho de disco completo em todas as suas subpartes \(drive, diretório, nome e extensão\). + +@type binary function +@sintax SplitPath(, , , , ) => NIL +@param , character, Indica o nome do arquivo que será quebrado. Além disso, opcionalmente, pode-se incluir o diretório e unidade do disco. +@param , character, Indica o nome da unidade do disco \(exemplo: C:\\\). Caso o arquivo informando não possua a unidade de disco ou o diretório refira-se ao servidor, a função retornará uma string em branco. +@param , character, Indica o nome do diretório. Caso o arquivo informado não possua diretório, a função retornará uma string em branco. +@param , character, Indica o nome do arquivo sem extensão. Caso o parâmetro cArquivo não seja informado, a função retornará uma string em branco. +@param , character, Indica a extensão do arquivo informado, no parâmetro cArquivo, pré-fixada com um ponto ".". Caso a extensão, no parâmetro cArquivo, não seja especificada, a função retornará uma string em branco. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/splitpath +/*/ +binary function splitpath(carquivo, cdrive, cdiretorio, cnome, cextensao) +return + + +/*/{Protheus.doc} sqrt +Calcula o valor da raiz quadrada de um número positivo. + +@type binary function +@sintax Sqrt() => numeric +@return numeric, Retorna a raiz quadrada. + +@param , numeric, Indica o valor do radicando. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/sqrt +/*/ +binary function sqrt(nradicand) +return + + +/*/{Protheus.doc} svrdisplay +Função para verificar se o Application Server esta sendo executado em uma sessão com interface gráfica. + +@type binary function +@sintax SvrDisplay() => logical +@return logical, Retorna verdadeiro \(.T.\), se o TOTVS \| Application Server está sendo executado em uma sessão com interface gráfica, caso contrário, retorna falso \(.F.\). + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/svrdisplay +/*/ +binary function svrdisplay() +return + + +/*/{Protheus.doc} startjob +Executa uma rotina em uma segunda thread sem interface. + +@type binary function +@sintax StartJob(, , , [parm1,parm2,...parm25]) => NIL +@param , character, Indica o nome do Job que será executado. +@param , character, Indica o nome do ambiente em que o Job será executado. +@param , logical, Indica se, verdadeiro \(.T.\), o processo será finalizado; caso contrário, falso \(.F.\). +@param [parm1,parm2,...parm25], variant, Os parâmetros \(máximo 25 parâmetros\) informados a partir deste ponto serão repassados para a função especificada no parâmetro cName. Caso informados parâmetros do tipo B \(Code-Block\) ou O \(Object\), no processo de destino receberá NIL. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/startjob +/*/ +binary function startjob(cname, cenv, lwait, parm1,parm2,parm25) +return + + +/*/{Protheus.doc} str +A partir de um numérico esta função retorna uma string formatada, inserindo espaços \(" "\) à esquerda e/ou o símbolo decimal \("."\) em suas casas, de acordo com a informação do parâmetro. + +@type binary function +@sintax Str(, [nTamanho], [nDecimais]) => character +@return character, Retorna uma string a partir do valor numérico e do tamanho informado no parâmetro. + +@param , numeric, Indica o valor numérico que será convertido para string. +@param [ntamanho], numeric, Indica o tamanho da string será gerada. +@param [ndecimais], numeric, Indica o número de casas após o símbolo decimal. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/str +/*/ +binary function str(nnumero, ntamanho, ndecimais) +return + + +/*/{Protheus.doc} striconv +Converte uma string de um codepage para outro. + +@type binary function +@sintax StrIConv(, , ) => character +@return character, Retorna a string convertida + +@param , character, Indica o texto que será convertido +@param , character, Indica o codepage de origem +@param , character, Indica o codepage de destino +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/striconv +/*/ +binary function striconv(ctext, cfromcodepage, ctocodepage) +return + + +/*/{Protheus.doc} strtokarr +Fatia a string cValue de acordo com o separador cToken informado e retorna um vetor com todas as partes. + +@type binary function +@sintax StrTokArr(, ) => array +@return array, Retorna um array de caracteres contendo a string separada. + +@param , character, Indica a string que será fatiada. +@param , character, Indica um ou mais caracteres \(*Token*\) que serão utilizados como separadores. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/strtokarr +/*/ +binary function strtokarr(cvalue, ctoken) +return + + +/*/{Protheus.doc} strtokarr2 +Fatia a string cValue de acordo com o separador cToken e retorna um vetor com todas as partes. + +@type binary function +@sintax StrTokArr2(, , [lEmptyStr]) => array +@return array, Retorna um array de caracteres contendo a string separada. + +@param , character, Indica a string que será fatiada. +@param , character, Indica um ou mais caracteres \(*Token*\) que serão utilizados como separadores. +@param [lemptystr], logical, Indica se elementos vazios também devem ser retornados. Valor default = **.F.** +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/strtokarr2 +/*/ +binary function strtokarr2(cvalue, ctoken, lemptystr) +return + + +/*/{Protheus.doc} strtran +Pesquisa e substitui um conjunto de caracteres de uma string. + +@type binary function +@sintax StrTran(, , [cReplace], [nStart], [nCount]) => character +@return character, Retorna uma nova string com as ocorrências de **cSearch** substituídas por **cReplace**. + +@param , character, Indica a sequência de caracteres ou campo memo onde será realizado a pesquisa. +@param , character, Indica a sequência de caracteres que será pesquisada. +@param [creplace], character, Indica a sequência de caracteres que deve substituir a expressão localizada. +@param [nstart], numeric, Indica a primeira ocorrência a ser substituída. +@param [ncount], numeric, Indica o número de substituições que devem ser realizadas. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/strtran +/*/ +binary function strtran(cstring, csearch, creplace, nstart, ncount) +return + + +/*/{Protheus.doc} stuff +Elimina e insere caracteres em uma string. Para isso, a função elimina caracteres a partir da posição inicial . Depois, insere na string resultante a partir do início , para formar a string que será retornada. + +@type binary function +@sintax Stuff(, , , ) => character +@return character, Retorna uma nova string \(cópia de cString\), sendo que os caracteres especificados foram eliminados e inserida. + +@param , character, Indica a string destino na qual serão eliminados e inseridos caracteres. +@param , numeric, Indica a posição inicial na string destino em que ocorre a inserção/eliminação. +@param , numeric, Indica a quantidade de caracteres que serão eliminados. +@param , character, Indica a string que será inserida. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/stuff +/*/ +binary function stuff(cstring, ninicio, nelimina, cinsere) +return + + +/*/{Protheus.doc} stuffbit +Altera uma sequencia de bits de uma string para 1. + +@type binary function +@sintax StuffBit(<@cStr>, , , ) => NIL +@param <@cstr>, character, Indica a string que será modificada. +@param , numeric, Indica o índice do bit inicial. +@param , numeric, Indica a quantidade de bits que serão colocados em 1. +@param , numeric, Indica o índice do último byte que será modificado. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/stuffbit +/*/ +binary function stuffbit(cstr, nstart, ntest, nlength) +return + + +/*/{Protheus.doc} syserrorblock +Define o bloco de código que será executado quando ocorrer um erro irreparável no Smart Client. + +@type binary function +@sintax SysErrorBlock([bError]) => NIL +@param [berror], codeblock, Indica o bloco de código que será executado quando ocorrer um erro no Smart Client. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/syserrorblock +/*/ +binary function syserrorblock(berror) +return + + +/*/{Protheus.doc} sysrefresh +Atualiza todas as mensagens pendentes da conexão. + +@type binary function +@sintax SysRefresh() => logical +@return logical, Retorna verdadeiro \(.T.\), se o processo for realizado com sucesso; caso contrário retorna falso \(.F.\). + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/sysrefresh +/*/ +binary function sysrefresh() +return + + +/*/{Protheus.doc} tan +Calcula o valor da tangente de um ângulo \(em radianos\). + +@type binary function +@sintax Tan() => numeric +@return numeric, Retorna o valor da tangente de acordo com o ângulo informado. + +@param , numeric, Indica o valor do ângulo em radianos. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/tan +/*/ +binary function tan(nangle) +return + + +/*/{Protheus.doc} tarcompress +Armazena arquivos e diretórios em um único arquivo no formato TAR \(Tape ARchive\). + +@type binary function +@sintax TarCompress(, , [lChangeCase]) => character +@return character, Em caso de sucesso, retorna o nome do arquivo criado, incluindo o rootpath onde o arquivo no formato TAR foi criado; caso dê erro, retorna uma string em branco \(""\). + +@param , array, Indica os arquivos e diretórios que serão armazenados. +@param , character, Indica o nome do arquivo que será gerado com a extensão ".tar". +@param [lchangecase], logical, Se verdadeiro \(.T.\), nomes de arquivos e pastas serão convertidos para letras minúsculas; caso contrário, falso \(.F.\), não será feito nenhum ajuste no nome do arquivo informado. Valor padrão \(.T.\). Veja maiores informações em Observações. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/tarcompress +/*/ +binary function tarcompress(aitens, cdest, lchangecase) +return + + +/*/{Protheus.doc} tardecomp +Restaura os arquivos e diretórios contidos em um arquivo no formato TAR \(Tape ARchive\) + +@type binary function +@sintax TarDecomp(, , [@nFilesOut], [lChangeCase]) => logical +@return logical, Retorna verdadeiro \(**.T.**\), se a descompactação for realizada com sucesso; caso contrário, retorna falso \(**.F.**\). + +@param , character, Indica o nome do arquivo \( com formato TAR \) cujo conteúdo será restaurado. +@param , character, Indica o diretório onde os arquivos, contidos no arquivo TAR, serão restaurados. +@param [@nfilesout], numeric, Retorna o número de arquivos extraídos na operação. +@param [lchangecase], logical, Se verdadeiro \(.T.\), nomes de arquivos e pastas serão convertidos para letras minúsculas; caso contrário, falso \(.F.\), não será feito nenhum ajuste no nome do arquivo informado. Valor padrão \(.T.\). Veja maiores informações em Observações. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/tardecomp +/*/ +binary function tardecomp(ctarfile, coutdir, nfilesout, lchangecase) +return + + +/*/{Protheus.doc} tcalter +Altera a estrutura de uma tabela. + +@type binary function +@sintax TCAlter(, , , [@nErro]) => logical +@return logical, Retorna **.T.** se a alterção for realizada com sucesso, caso contrário, retorna **.F.** + +@param , character, Indica o nome da tabela que será alterada. +@param , array, Indica o array que contém as informações dos campos atuais da tabela. +@param , array, Indica o array que contém a nova estrutura desejada para a tabela. +@param [@nerro], numeric, Caso ocorra algum erro na alteração da estrutura, o número do erro do DBAccess será retornado através desta variável. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/tcalter +/*/ +binary function tcalter(ctable, aestruturaatual, aestruturanova, nerro) +return + + +/*/{Protheus.doc} tcapibuild +Retorna a build do biblioteca client do DBAccess, a DBAPI. + +@type binary function +@sintax TCAPIBuild() => character +@return character, Retorna uma string contendo a build e a data de geração da DBAPI. + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/tcapibuild +/*/ +binary function tcapibuild() +return + + +/*/{Protheus.doc} tccanopen +Verifica se uma tabela e/ou índice existe. + +@type binary function +@sintax TCCanOpen(, [cIndex]) => logical +@return logical, Retorna **.T.** se a tabela e/ou índice existir, caso contrário, retorna **.F.** + +@param , character, Nome da tabela. +@param [cindex], character, Nome do índice. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/tccanopen +/*/ +binary function tccanopen(ctable, cindex) +return + + +/*/{Protheus.doc} tccommit +Realiza o controle de transação no DBAccess + +@type binary function +@sintax TCCommit(, [xParam]) => Nil +@return Nil, Sempre retorna nulo. + +@param , numeric, Numero relacionado a ação do TCCommit +@param [xparam], variant, Compatibilidade. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/tccommit +/*/ +binary function tccommit(noption, xparam) +return + + +/*/{Protheus.doc} tcdelfile +Exclui uma tabela ou view de um banco relacional, através do DBAccess. + +@type binary function +@sintax TCDelFile() => logical +@return logical, Retorna **.T.** se excluiu com sucesso, caso contrário, retorna **.F.** + +@param , character, Nome da Tabela/View a ser excluida. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/tcdelfile +/*/ +binary function tcdelfile(cname) +return + + +/*/{Protheus.doc} tcdelindex +Exclui um índice de um arquivo do banco de dados relacional, através do DBAccess. + +@type binary function +@sintax TCDelIndex(, ) => logical +@return logical, Retorna verdadeiro \(.T.\), se o índice da tabela for excluída com sucesso; caso contrário, falso \(.F.\). + +@param , character, Indica o nome da tabela a qual o índice pertence. +@param , character, Indica o nome do índice a ser excluído. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/tcdelindex +/*/ +binary function tcdelindex(ctable, cindex) +return + + +/*/{Protheus.doc} tcfilterex +Define um filtro de visualização do alias corrente. + +@type binary function +@sintax TCFilterEx(, ) => logical +@return logical, Retorna .T. \(Verdadeiro\) no caso de sucesso. No caso de erro retorna .F. \(Falso\). + +@param , character, Condição de filtro expressada em uma string. +@param , numeric, Slot do filtro, deve ser maior que 0 \(Zero\). +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/tcfilterex +/*/ +binary function tcfilterex(cquery, nslot) +return + + +/*/{Protheus.doc} tcgenqry +Permite a abertuda de uma query diretamente no banco de dados utilizado na conexão atual, mediante uso da RDD TOPCONN. O retorno desta função deve ser passado como 3º parâmetro da função **DbUseArea**, conforme exemplo abaixo. + +@type binary function +@sintax TCGenQry(, , ) => character +@return character, Retorna sempre uma string vazia. + +@param , Nil, Compatibilidade. +@param , Nil, Compatibilidade. +@param , character, Indica a expressão da query que será aberta. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/tcgenqry +/*/ +binary function tcgenqry(xpar1, xpar2, cquery) +return + + +/*/{Protheus.doc} tcgetbuild +Retorna a build do DBAccess em que está conectado. + +@type binary function +@sintax TCGetBuild([lDate]) => character +@return character, Retorna uma string contendo a build do DBAccess em que está conectado. + +@param [ldate], logical, Indica se incluirá ou não a data de geração da build no valor que será retornado. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/tcgetbuild +/*/ +binary function tcgetbuild(ldate) +return + + +/*/{Protheus.doc} tcgetconn +Recupera o número da conexão ativa com o DBAccess. + +@type binary function +@sintax TCGetConn() => numeric +@return numeric, Retorna o número da conexão ativa. + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/tcgetconn +/*/ +binary function tcgetconn() +return + + +/*/{Protheus.doc} tcgetdb +Recupera o tipo do banco de dados relacional, em uso, pela conexão atual com o DBAccess. + +@type binary function +@sintax TCGetDB() => character +@return character, Retorna uma string contendo um identificador do banco de dados em uso pela conexão atual. + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/tcgetdb +/*/ +binary function tcgetdb() +return + + +/*/{Protheus.doc} tcgetdbsid +Retorna uma string que identifica a conexão atualmente em uso no SGDB utilizado. + +@type binary function +@sintax TCGetDBSID() => character +@return character, Retorna um identificador string único, que identifica a conexão atual no SGDB. + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/tcgetdbsid +/*/ +binary function tcgetdbsid() +return + + +/*/{Protheus.doc} tcgetinfo +Retorna informações sobre o DBAccess conectado atualmente + +@type binary function +@sintax TCGetInfo([nInfo], [cParam]) => character +@return character, Retorna uma string AdvPL com a informação desejada. + +@param [ninfo], numeric, Indica o número da informação a ser recuperada. +@param [cparam], character, Para alguns tipos de informação, permite informar um parâmetro adicional ou critério de informação de retorno. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/tcgetinfo +/*/ +binary function tcgetinfo(ninfo, cparam) +return + + +/*/{Protheus.doc} tcgetio +Retorna um array de rotinas e IOs/segundos do DBAccess. + +@type binary function +@sintax TCGetIO() => array +@return array, Retorna um array com a seguinte estrutura: Coluna 1: Rotina - Coluna 2: IOs/Segundo. + +@param , numeric, Indica o limite de IOs/segundos. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/tcgetio +/*/ +binary function tcgetio(nthreshold) +return + + +/*/{Protheus.doc} tcgetsid +Retorna o número do processo em uso no TOTVS \| DBAccess para a conexão atual. + +@type binary function +@sintax TCGetSID() => numeric +@return numeric, Retorna o número da thread da conexão atual com o DBAccess. + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/tcgetsid +/*/ +binary function tcgetsid() +return + + +/*/{Protheus.doc} tcisconnected +Função para verificar se está conectado no banco de dados. + +@type binary function +@sintax TCIsConnected([nHwnd]) => logical +@return logical, Retorna **.T.** se está conectado, caso contrário, retorna **.F.** + +@param [nhwnd], numeric, Número da conexão. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/tcisconnected +/*/ +binary function tcisconnected(nhwnd) +return + + +/*/{Protheus.doc} tcisview +Função para verificar por nome se um objeto é uma view. + +@type binary function +@sintax TCIsView() => logical +@return logical, Retorna **.T.** se o nome informado pertece a uma view, caso contrário, retorna **.F.** + +@param , character, Nome da tabela/view a ser verificada. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/tcisview +/*/ +binary function tcisview(cname) +return + + +/*/{Protheus.doc} tcisvlock +Indica se está o DBAccess possui o recurso de Virtual Locks. + +@type binary function +@sintax TCIsVLock() => logical +@return logical, Retorna verdadeiro \(.T.\) se o DBAccess tiver o recurso de Virtual Locks; caso contrário, retorna falso \(.F.\). + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/tcisvlock +/*/ +binary function tcisvlock() +return + + +/*/{Protheus.doc} tclink +Cria uma nova conexão com um banco de dados SGBD através do DBAccess. + +@type binary function +@sintax TCLink([cConn], [cServerAddr], [nPort]) => numeric +@return numeric, Retorna um identificador numérico igual ou maior que zero para a conexão em caso de sucesso. Em caso de falha, será retornado um número negativo, indicando uma ocorrência de falha na conexão. + +@param [cconn], character, Indica a string de conexão do DBAccess, composta por um identificador do tipo da conexão mais o nome do **"alias/environment"** da conexão. \(Padrão = DBDatabase e DBAlias configurado no appserver.ini\) +@param [cserveraddr], character, Indica o nome ou endereço IP do servidor onde está o DBAccess onde a conexão deve ser realizada. \(Padrão = DBServer configurado no appserver.ini\) +@param [nport], numeric, Indica o número da porta TCP que o DBAccess está configurado aguardando por novas conexões. \(Padrão = 7890\). +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/tclink +/*/ +binary function tclink(cconn, cserveraddr, nport) +return + + +/*/{Protheus.doc} tcmaxmap +Altera o valor minimo de campos da tabela para realizar o **TCSrvMap** + +@type binary function +@sintax TCMaxMap() => Nil +@return Nil, Sempre retorna nulo. + +@param , numeric, Numero de colunas. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/tcmaxmap +/*/ +binary function tcmaxmap(cnum) +return + + +/*/{Protheus.doc} tcobject +Informa se um objeto existe no SGBD conectado. + +@type binary function +@sintax TCObject(, [@cType]) => logical +@return logical, Retorna verdadeiro \(.T.\) se o objeto existir no SGBD em que está conectado; caso contrário, falso \(.F.\). + +@param , character, Indica o nome do objeto que será procurado. +@param [@ctype], character, Indica o tipo do objeto procurado. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/tcobject +/*/ +binary function tcobject(cobject, ctype) +return + + +/*/{Protheus.doc} tcping +Recupera a latência entre o DBAccess e o SGDB + +@type binary function +@sintax TCPing() => numeric +@return numeric, média da latência em segundos com precisão em milissegundos. + +@param , numeric, Quantidade de pacotes enviados, deve ser maior que 0 \(Zero\). +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/tcping +/*/ +binary function tcping(ncount) +return + + +/*/{Protheus.doc} tcquit +Finaliza todas as conexões ativas. + +@type binary function +@sintax TCQuit() => logical +@return logical, Retorna .T. quando a função finalizou todas as conexões ativas com sucesso, se não retorna .F. + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/tcquit +/*/ +binary function tcquit() +return + + +/*/{Protheus.doc} tcrefresh +Atualiza as definições globais de uma tabela no cache de definições do DBAccess. + +@type binary function +@sintax TCRefresh() => Nil +@return Nil, Esta função sempre retorna nulo. + +@param , character, Indica o nome da tabela para atualizar o cache de definições do DBAccess. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/tcrefresh +/*/ +binary function tcrefresh(ctable) +return + + +/*/{Protheus.doc} tcsetconn +Permite alternar entre as conexões ativas com o DBAccess. + +@type binary function +@sintax TCSetConn() => logical +@return logical, Retorna verdadeiro \(.T.\), se a conexão corrente for trocada com sucesso. Se a conexão informada não existir ou já estiver sido fechada, a conexão atual é mantida e a função retorna falso \(.F.\). + +@param , numeric, Indica o número da conexão que deve ser tornar a corrente. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/tcsetconn +/*/ +binary function tcsetconn(nhandle) +return + + +/*/{Protheus.doc} tcsetfield +Altera o tratamento, do tipo de dado ou precisão, para um campo/coluna retornada através de uma query. + +@type binary function +@sintax TCSetField(, , , [nSize], [nPrecision]) => NIL +@param , character, Indica o alias da query. +@param , character, Indica o nome do campo/coluna de retorno. +@param , character, Indica o tipo de dado a ser retornado através deste campo/coluna, que pode ser: D \(Data\), N \(Numérico\) ou L \(Lógico\). +@param [nsize], numeric, Indica o tamanho do campo. Valor padrão: 0 \(zero\). +@param [nprecision], numeric, Indica a quantidade de decimais do campo. Valor padrão: 0 \(zero\). +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/tcsetfield +/*/ +binary function tcsetfield(calias, cfield, ctype, nsize, nprecision) +return + + +/*/{Protheus.doc} tcsetparam +Insere ou atualiza um parâmetro na TOP_PARAM. + +@type binary function +@sintax TCSetParam(, ) => numeric +@return numeric, Retorna 0 \(zero\) se a operação foi completada com sucesso ou diferente em caso de erro. + +@param , character, Indica o nome do parâmetro que será criado ou atualizado. +@param , character, Indica o valor do parâmetro indicado em **cParam**. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/tcsetparam +/*/ +binary function tcsetparam(cparam, cvalue) +return + + +/*/{Protheus.doc} tcsetvidx +Liga ou desliga o modo de virtualização automática de índices em tempo de execução. + +@type binary function +@sintax TCSetVIdx() => logical +@return logical, Retorna o valor definido para a virtualização automática. + +@param , logical, Indica se a virtualização automática deve ser ativada \(**.T.**\) ou desativada \(**.F.**\). +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/tcsetvidx +/*/ +binary function tcsetvidx(lset) +return + + +/*/{Protheus.doc} tcspexec +Função que executa uma stored procedure no banco de dados atual. + +@type binary function +@sintax TCSPExec(, [xParam]) => array +@return array, Retorna um array que contêm os valores de retorno da stored procedure. O retorno será nulo se nenhum valor for retornado pela stored procedure ou ocorrer algum erro na chamada da procedure. + +@param , character, Nome da stored procedure a ser executada. +@param [xparam], character, Indica uma ou mais expressões, separadas por vírgula, indicando os parâmetros necessários para a execução da stored procedure. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/tcspexec +/*/ +binary function tcspexec(cstoredprocedure, xparam) +return + + +/*/{Protheus.doc} tcspexist +Função verifica a existência de uma stored procedure no banco de dados atual. + +@type binary function +@sintax TCSPExist() => logical +@return logical, Retorna **.T.** se a stored procedure existir, caso contrário, retorna **.F.** + +@param , character, Nome da stored procedure a ser verificada. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/tcspexist +/*/ +binary function tcspexist(cstoredproc) +return + + +/*/{Protheus.doc} tcsqlerror +Recupera uma string contendo a última ocorrência de erro de execução de statement e/ou operação. + +@type binary function +@sintax TCSqlError() => numeric +@return numeric, Retorna uma string contendo a última mensagem e/ou ocorrênca de erro da conexão atual do DBAccess, registrada após o último statement executado. Caso o último statement executado não apresente erro, ou ainda o processo atual não possua nenhuma conexão ativa com o DBAccess, a função retornará uma string vazia \(""\). + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/tcsqlerror +/*/ +binary function tcsqlerror() +return + + +/*/{Protheus.doc} tcsqlexec +Executa uma sentença de sintaxe SQL \(Structured Query Language\). + +@type binary function +@sintax TCSqlExec() => numeric +@return numeric, Retorna o status da execução. Se menor que 0 indica que a sentença não foi executada com sucesso. + +@param , character, Indica a string que contém a sentença que será informada à função e executada no banco de dados. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/tcsqlexec +/*/ +binary function tcsqlexec(cstatement) +return + + +/*/{Protheus.doc} tcsqlreplay +Permite habilitar e desabilitar a coleta de logs de trace de execuções do DBaccess via TOTVS \| Application Server das conexões ativas do processo atual. + +@type binary function +@sintax TCSQLReplay(, <@cMessage>) => logical +@return logical, Retorna **.T.** se a stored procedure existir, caso contrário, retorna **.F.** + +@param , numeric, Opção desejada detalhada nas observações. +@param <@cmessage>, character, Parametro de entrada e/ou Mensagem de retorno +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/tcsqlreplay +/*/ +binary function tcsqlreplay(noption, cmessage) +return + + +/*/{Protheus.doc} tcsrvmap +Mapeia os campos de seleção no banco de dados. + +@type binary function +@sintax TCSrvMap(, [cMap], [bRefresh]) => logical +@return logical, .T. \(Verdadeiro\) caso de sucesso, caso contrário, .F. \(Falso\). + +@param , character, Alias da área de trabalho. +@param [cmap], character, Campos da tabela separado por virgula. +@param [brefresh], logical, Flag para realizar um refresh após o mapeamento. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/tcsrvmap +/*/ +binary function tcsrvmap(calias, cmap, brefresh) +return + + +/*/{Protheus.doc} tcsrvtype +Retorna uma string que identifica o tipo da plataforma da conexão ativa/atual do DBAccess. + +@type binary function +@sintax TCSrvType() => character +@return character, Retorna uma string contendo o tipo da plataforma do DBAccess em uso pela conexão atual. Caso não haja conexão ativa, será retornada uma string em branco. + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/tcsrvtype +/*/ +binary function tcsrvtype() +return + + +/*/{Protheus.doc} tcstruct +Retorna um array contendo a estrutura da tabela ou view no SGBD. + +@type binary function +@sintax TCStruct() => array +@return array, Retorna um array contendo a estrutura de **cName** no SGBD. + +@param , character, Indica o nome da tabela ou view no SGBD. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/tcstruct +/*/ +binary function tcstruct(cname) +return + + +/*/{Protheus.doc} tcunique +Cria uma chave unica para a tabela corrente. + +@type binary function +@sintax TCUnique(, [cColumn]) => numeric +@return numeric, 0 no caso de sucesso. No caso de erro retorna os numeros de erros. + +@param , character, Alias da tabela corrente. +@param [ccolumn], character, Nome das coluna da tabela. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/tcunique +/*/ +binary function tcunique(calias, ccolumn) +return + + +/*/{Protheus.doc} tcunlink +Encerra a conexão especificada com o DBAccess. + +@type binary function +@sintax TCUnlink([nHandle], [lVerbose]) => logical +@return logical, Retorna verdadeiro \(.T.\), se a conexão for encerrada com sucesso; caso contrário, falso \(.F.\), se houver falha de execução. + +@param [nhandle], numeric, Indica o número da conexão que será finalizada. +@param [lverbose], logical, Caso especificado **.T.**, mostra mensagens de advertência do log de console, como por exemplo fechamento automático de alias da conexão. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/tcunlink +/*/ +binary function tcunlink(nhandle, lverbose) +return + + +/*/{Protheus.doc} tcview2db +Função para materializar uma view e seus dados em uma tabela física. + +@type binary function +@sintax TCView2DB(, ) => logical +@return logical, Retorna **.T.** se tabela cTable foi criada, caso contrário, retorna **.F.** e o motivo do erro pode ser verificado com a função [TCSQLError](TCSQLError). + +@param , character, Nome da view a ser materializada. +@param , character, Nome da tabela a ser criada no SGBD. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/tcview2db +/*/ +binary function tcview2db(cview, ctable) +return + + +/*/{Protheus.doc} tcviewmulti +Cria uma view para multiplas tabelas, sendo possível, mapear somente os campos que são relevantes a regra de negócio. + +@type binary function +@sintax TCViewMulti(, , ) => logical +@return logical, Retorna **.T.** se a view foi criada, caso contrário, retorna **.F.** e o motivo do erro pode ser verificado com a função [TCSQLError](TCSQLError). + +@param , character, Nome da view a ser criada. +@param , character, Nome da tabela master da view. +@param , character, Estrutura da view a ser criada, que consiste de uma lista de valores separados por virgula, onde é necessário informar a tabela e o campo da tabela que será mapeada na view, veja o exemplo abaixo. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/tcviewmulti +/*/ +binary function tcviewmulti(cview, ctable, cstruct) +return + + +/*/{Protheus.doc} tcviewone +Cria uma view para uma tabela no modelo 1 para 1, ou seja, todos os campos da tabela serão mapeados na view. + +@type binary function +@sintax TCViewOne(, ) => logical +@return logical, Retorna **.T.** se a view foi criada, caso contrário, retorna **.F.** e o motivo do erro pode ser verificado com a função [TCSQLError](TCSQLError). + +@param , character, Nome da view a ser criada. +@param , character, Nome da tabela master da view. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/tcviewone +/*/ +binary function tcviewone(cview, ctable) +return + + +/*/{Protheus.doc} tcviewren +Permite renomear uma View do SGBD, criada através das funções TCViewOne\(\) e/ou TCViewMulti\(\). + +@type binary function +@sintax TCViewRen(, ) => logical +@return logical, Retorna .T. em caso de sucesso na operação de renomear a View. Caso contrário retorna .F., e maiores informações sobre a falha na operação podem ser obtidas através da função TCSqlError\(\) + +@param , character, Indica o nome da View existente a ser renomeada. +@param , character, Indica o novo nome da View a ser renomeada. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/tcviewren +/*/ +binary function tcviewren(cviewname, cviewnewname) +return + + +/*/{Protheus.doc} tcviewstruct +Função que recebe o nome da view como parâmetro e retorna o nome da tabela master e a estrutura da view, no formato \(table,field,table,field,...\) + +@type binary function +@sintax TCViewStruct(, <@cTable>, <@cStruct>) => logical +@return logical, Retorna **.T.** em caso de sucesso, caso contrário, retorna **.F.** e o motivo do erro pode ser verificado com a função [TCSQLError](TCSQLError). + +@param , character, Nome da view. +@param <@ctable>, character, Variável que será preenchida com nome da tabela master. +@param <@cstruct>, character, Variável que será preenchida com a estrutura da view informada em cView. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/tcviewstruct +/*/ +binary function tcviewstruct(cview, ctable, cstruct) +return + + +/*/{Protheus.doc} tcvlock +Faz lock virtual nomeado no DBAccess. + +@type binary function +@sintax TCVLock() => logical +@return logical, Retorna se o lock virtual foi feito com sucesso ou não. + +@param , character, Indica o nome do lock virtual que será feito no DBAccess. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/tcvlock +/*/ +binary function tcvlock(cname) +return + + +/*/{Protheus.doc} tcvunlock +Realiza unlock de um ou mais locks virtuais no DBAccess. + +@type binary function +@sintax TCVUnlock([cName]) => logical +@return logical, Retorna .T. se o unlock foi feito com sucesso se não retorna .F. + +@param [cname], character, Indica o nome do lock virtual a realizar unlock. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/tcvunlock +/*/ +binary function tcvunlock(cname) +return + + +/*/{Protheus.doc} tdsvarinfo +Retorna um texto contendo o nome, tipo e o conteúdo da váriavel informada. + +@type binary function +@sintax TDSVarinfo(, ) => character +@return character, Informações da variável. + +@param , character, Nome da variável que será analisada. +@param , variant, Variável que será analisada. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/tdsvarinfo +/*/ +binary function tdsvarinfo(cnomevar, var) +return + + +/*/{Protheus.doc} tfiledialog +Apresenta uma janela nativa com a estrutura de arquivos do lado do SmartClient. + +@type binary function +@sintax tFileDialog() => character +@return character, Retorna o nome do item. Caso nenhum item tenha sido selecionado, o retorna será uma string vazia. + +@param , character, Indica a mensagem que será apresentada no console do Application Server. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/tfiledialog +/*/ +binary function tfiledialog(cmensagem) +return + + +/*/{Protheus.doc} threadcount +Retorna o número de threads/processos ativos no serviço do Application Server onde a função foi executada. + +@type binary function +@sintax ThreadCount() => numeric +@return numeric, Retorna o número de threads/processos ativos. + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/threadcount +/*/ +binary function threadcount() +return + + +/*/{Protheus.doc} threadid +Retorna o ID \(número de identificação\) da thread em que a chamada da função foi realizada. + +@type binary function +@sintax ThreadId() => numeric +@return numeric, Retorna um numérico com o ID da thread. + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/threadid +/*/ +binary function threadid() +return + + +/*/{Protheus.doc} threadtimeout +Ligar ou desligar o InactiveTimeout na thread corrente + +@type binary function +@sintax ThreadTimeout([Segundos]) => numeric +@return numeric, O InactiveTimeout corrente da thread + +@param [segundos], numeric, Quantidade de segundos para ativar o timeout da thread +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/threadtimeout +/*/ +binary function threadtimeout(segundos) +return + + +/*/{Protheus.doc} time +Retorna a hora do sistema operacional. Essa função é utilizada para apresentar ou imprimir a hora do sistema operacional em um relatório ou tela. + +@type binary function +@sintax Time() => character +@return character, Retorna a hora do sistema operacional como string na forma **hh:mm:ss**. + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/time +/*/ +binary function time() +return + + +/*/{Protheus.doc} timecounter +Recupera o valor do contador de desempenho, pode ser usado para medições de intervalo de tempo. + +@type binary function +@sintax timecounter() => numeric +@return numeric, Retorna um intervalo de tempo. + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/timecounter +/*/ +binary function timecounter() +return + + +/*/{Protheus.doc} timefull +Retorna a hora atual completa, contendo hora, minuto, segundo e milésimo de segundo + +@type binary function +@sintax TimeFull() => numeric +@return numeric, Retorna a hora atual + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/timefull +/*/ +binary function timefull() +return + + +/*/{Protheus.doc} timeglbvalue +Retorna a quantidade de segundos decorrida desde o último acesso \( criação, atualização ou leitura \) de uma variável global. + +@type binary function +@sintax TimeGlbValue() => numeric +@return numeric, Retorna tempo \( em segundos \) decorrido desde o último acesso à variável global. Caso não exista na memória identificador global com o nome informado, a função retorna -1 + +@param , character, Indica o nome da variável global. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/timeglbvalue +/*/ +binary function timeglbvalue(cglbname) +return + + +/*/{Protheus.doc} tran +Define uma expressão que resulta num valor do tipo caracter, data, numérico ou lógico e que será convertido para caracter e formatado. + +@type binary function +@sintax TRAN() => NIL +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/tran +/*/ +binary function tran() +return + + +/*/{Protheus.doc} trans +Define uma expressão que resulta num valor do tipo caracter, data, numérico ou lógico e que será convertido para caracter e formatado. + +@type binary function +@sintax TRANS() => NIL +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/trans +/*/ +binary function trans() +return + + +/*/{Protheus.doc} transf +Define uma expressão que resulta num valor do tipo caracter, data, numérico ou lógico e que será convertido para caracter e formatado. + +@type binary function +@sintax TRANSF() => NIL +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/transf +/*/ +binary function transf() +return + + +/*/{Protheus.doc} transfo +Define uma expressão que resulta num valor do tipo caracter, data, numérico ou lógico e que será convertido para caracter e formatado. + +@type binary function +@sintax TRANSFO() => NIL +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/transfo +/*/ +binary function transfo() +return + + +/*/{Protheus.doc} transfor +Define uma expressão que resulta num valor do tipo caracter, data, numérico ou lógico e que será convertido para caracter e formatado. + +@type binary function +@sintax TRANSFOR() => NIL +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/transfor +/*/ +binary function transfor() +return + + +/*/{Protheus.doc} transform +Define uma expressão que resulta num valor do tipo caractere, data, numérico ou lógico e que será convertido para caractere e formatado. + +@type binary function +@sintax TRANSFORM() => NIL +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/transform +/*/ +binary function transform() +return + + +/*/{Protheus.doc} left +Retorna um determinado número da caracteres à esquerda de uma string. + +@type binary function +@sintax Left(, ) => character +@return character, Retorna uma cópia da string, iniciando a partir do caractere final da string \(último caractere da esquerda\), considerando o número de caracteres especificado no segundo parâmetro. + +@param , character, Indica o texto que será tratado. +@param , numeric, Indica o número de caracteres à esquerda a serem retornados. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/left +/*/ +binary function left(ctext, ncount) +return + + +/*/{Protheus.doc} space +Retorna uma string com uma quantidade especificada de espaços. + +@type binary function +@sintax Space() => character +@return character, Retorna uma string com espaços. + +@param , numeric, Indica a quantidade de espaços que serão retornados. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/space +/*/ +binary function space(ncount) +return + + +/*/{Protheus.doc} val +Converte uma sequência de caracteres que contêm dígitos em um valor numérico. + +@type binary function +@sintax Val() => numeric +@return numeric, Retorna um valor numérico. + +@param , character, Indica uma string que contém uma sequência de números a serem convertidos. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/val +/*/ +binary function val(cstring) +return + + +/*/{Protheus.doc} ttcloudenv +Retorna um número definido na chave TOTVSCLOUD no arquivo de configuração do Application Server. + +@type binary function +@sintax TTCloudEnv([nEnv]) => numeric +@return numeric, Retorna o número definido no arquivo de configurações ou o passado pelo parâmetro nEnv. + +@param [nenv], numeric, Indica o número correspondente ao ambiente cloud que o Application Server está sendo utilizado. **.F.**. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/ttcloudenv +/*/ +binary function ttcloudenv(nenv) +return + + +/*/{Protheus.doc} type +Retorna o tipo de dado de uma expressão ou variável. + +@type binary function +@sintax Type() => character +@return character, Retorna o tipo de dado da expressão informada. + +@param , character, Indica a expressão e/ou o nome da variável a ser verificada. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/type +/*/ +binary function type(cexpr) +return + + +/*/{Protheus.doc} uncompress +Descompacta um buffer \(gerado pela função **Compress**\) recebido através do algoritmo proprietário. + +@type binary function +@sintax UnCompress(<@cBufferOut>, <@nLenghtOut>, , ) => logical +@return logical, Retorna verdadeiro \(.T.\), se o buffer for descompactado com sucesso; caso contrário, falso \(.F.\). + +@param <@cbufferout>, character, Indica a variável string que receberá o buffer descompactado. +@param <@nlenghtout>, numeric, Indica o tamanho do buffer descompactado. +@param , character, Indica o buffer que será descompactado. +@param , numeric, Indica o tamanho do buffer compactado. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/uncompress +/*/ +binary function uncompress(cbufferout, nlenghtout, cbufferin, nlenghtin) +return + + +/*/{Protheus.doc} unstuff +Altera uma sequência de bits de uma string para 0. + +@type binary function +@sintax UnStuff(<@cStr>, , , ) => NIL +@param <@cstr>, character, Indica a string que será modificada. +@param , numeric, Indica o índice do bit inicial. +@param , numeric, Indica a quantidade de bits que serão colocados em 0. +@param , numeric, Indica o índice do último byte que será modificado. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/unstuff +/*/ +binary function unstuff(cstr, nstart, ntest, nlength) +return + + +/*/{Protheus.doc} used +Determina se há um arquivo de banco de dados em uso na área de trabalho especificada. + +@type binary function +@sintax Used() => logical +@return logical, Retorna verdadeiro \(.T.\), se existir um arquivo de banco de dados em uso; caso contrário, falso \(.F.\). + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/used +/*/ +binary function used() +return + + +/*/{Protheus.doc} userexception +Força um erro, na linguagem AdvPL, para que possa ser tratado posteriormente. Para isso, esta função recebe uma string com a descrição do erro que será apresentada de acordo com o ambiente que está executando. + +@type binary function +@sintax UserException([cDescricao]) => numeric +@return numeric, \(Nulo\) + +@param [cdescricao], character, Indica a string que contém a descrição do erro forçado através da função. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/userexception +/*/ +binary function userexception(cdescricao) +return + + +/*/{Protheus.doc} utctolocal +Converte data e hora UTC para data e hora local. + +@type binary function +@sintax UTCToLocal(, , [nDST]) => array +@return array, Retorna um array contendo a data \(yyyyMMdd\) e a hora \(hh:mm:ss\). + +@param , character, Indica a data UTC no formato ano, mês e dia. Exemplo: yyyyMMdd. +@param , character, Indica a hora UTC no formato hora, minuto e segundo. Exemplo: hh:mm:ss. +@param [ndst], numeric, Caso seja informado o valor 0 \(Default\), indica que o resultado deve representar o horário solar \(ou standard time\). Caso seja informado o valor 1, a data e horário serão a representação de tempo em horário de verão \(Daylight Savings Time\). +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/utctolocal +/*/ +binary function utctolocal(cdate, ctime, ndst) +return + + +/*/{Protheus.doc} uuidrandom +Cria um identificador UUID \(do inglês Universally Unique IDentifier\) exclusivo + +@type binary function +@sintax UUIDRandom() => character +@return character, Identificador exclusivo. + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/uuidrandom +/*/ +binary function uuidrandom() +return + + +/*/{Protheus.doc} uuidrandomseq +Cria um identificador UUID \(do inglês Universally Unique IDentifier\) exclusivo sequencial. + +@type binary function +@sintax UUIDRandomSeq() => character +@return character, Identificador exclusivo. + +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/uuidrandomseq +/*/ +binary function uuidrandomseq() +return + + +/*/{Protheus.doc} valtype +Retorna um caractere que identifica o tipo de dado da variável informada através do parâmetro. + +@type binary function +@sintax ValType() => character +@return character, Retorna um caractere que identifica o tipo de dado informado. + +@param , variant, Indica o dado ou a variável que se deseja identificar. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/valtype +/*/ +binary function valtype(xparam) +return + + +/*/{Protheus.doc} varbegint +Inicia a transação em uma "chave", bloqueando o acesso aos seus valores nas tabelas "Tabela X" e "Tabela A". + +@type binary function +@sintax VarBeginT([cUID], [cKeyWrk]) => NIL +@param [cuid], character, Identificador da sessão de Variáveis Globais. +@param [ckeywrk], character, Identificador da chave. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/varbegint +/*/ +binary function varbegint(cuid, ckeywrk) +return + + +/*/{Protheus.doc} varclean +Remove todos os dados das "Tabela X" e "Tabela A" de uma sessão , assim como todas as transações de chaves. + +@type binary function +@sintax VarClean([cUID]) => NIL +@param [cuid], character, Identificador da sessão de Variáveis Globais. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/varclean +/*/ +binary function varclean(cuid) +return + + +/*/{Protheus.doc} varcleana +Remove os valores de todas as chaves da "Tabela A" + +@type binary function +@sintax VarCleanA([cUID]) => NIL +@param [cuid], character, Identificador da sessão de Variáveis Globais. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/varcleana +/*/ +binary function varcleana(cuid) +return + + +/*/{Protheus.doc} varcleanx +Remove os valores de todas as chaves da "Tabela X" + +@type binary function +@sintax VarCleanX([cUID]) => NIL +@param [cuid], character, Identificador da sessão de Variáveis Globais. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/varcleanx +/*/ +binary function varcleanx(cuid) +return + + +/*/{Protheus.doc} vardel +Remove o valor de uma chave na "Tabela X" e na "Tabela A". + +@type binary function +@sintax VarDel([cUID], [cChave]) => NIL +@param [cuid], character, Identificador da sessão de Variáveis Globais. +@param [cchave], character, Identificador da chave. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/vardel +/*/ +binary function vardel(cuid, cchave) +return + + +/*/{Protheus.doc} vardela +Remove o valor de uma chave na "Tabela A" + +@type binary function +@sintax VarDelA([cUID], [cChave]) => NIL +@param [cuid], character, Identificador da sessão de Variáveis Globais. +@param [cchave], character, Identificador da chave. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/vardela +/*/ +binary function vardela(cuid, cchave) +return + + +/*/{Protheus.doc} vardelx +Remove o valor de uma chave na "Tabela X" + +@type binary function +@sintax VarDelX([cUID], [cChave]) => NIL +@param [cuid], character, Identificador da sessão de Variáveis Globais. +@param [cchave], character, Identificador da chave. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/vardelx +/*/ +binary function vardelx(cuid, cchave) +return + + +/*/{Protheus.doc} varendt +Finaliza a transação em uma "chave", liberando novamente o acesso aos valores desta "chave" nas tabelas "Tabela X" e "Tabela A". + +@type binary function +@sintax VarEndT([cUID], [cChave]) => NIL +@param [cuid], character, Identificador da sessão de Variáveis Globais. +@param [cchave], character, Identificador da chave. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/varendt +/*/ +binary function varendt(cuid, cchave) +return + + +/*/{Protheus.doc} varget +Recupera o valor de uma "chave" de forma transacionada/síncrona na "Tabela X" e na "Tabela A" de uma determinada sessão, pois faz bloqueio da "chave" . + +@type binary function +@sintax VarGet([cUID], [cChave]) => NIL +@param [cuid], character, Identificador da sessão de Variáveis Globais. +@param [cchave], character, dentificador da chave. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/varget +/*/ +binary function varget(cuid, cchave) +return + + +/*/{Protheus.doc} varget_a +Obtém uma lista com todas as chaves e seus respectivos valores das tabelas "Tabela X" e "Tabela A". + +@type binary function +@sintax VarGet_A([cUID]) => NIL +@param [cuid], character, Identificador da sessão de Variáveis Globais. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/varget_a +/*/ +binary function varget_a(cuid) +return + + +/*/{Protheus.doc} vargeta +Recupera o valor de uma "chave" na "Tabela A" de uma determinada sessão, e faz bloqueio da "chave" . + +@type binary function +@sintax VarGetA([cUID]) => NIL +@param [cuid], character, Identificador da sessão de Variáveis Globais. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/vargeta +/*/ +binary function vargeta(cuid) +return + + +/*/{Protheus.doc} vargetaa +Obtém uma lista com todas as chaves e seus respectivos valores da "Tabela A". + +@type binary function +@sintax VarGetAA([cUID]) => NIL +@param [cuid], character, Identificador da sessão de Variáveis Globais. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/vargetaa +/*/ +binary function vargetaa(cuid) +return + + +/*/{Protheus.doc} vargetad +Recupera o valor de uma "chave" na "Tabela A" de uma determinada sessão, sem fazer bloqueio da "chave" \(Dirty\). + +@type binary function +@sintax VarGetAD([cUID], [cChave]) => NIL +@param [cuid], character, Identificador da sessão de Variáveis Globais. +@param [cchave], character, Identificador da chave. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/vargetad +/*/ +binary function vargetad(cuid, cchave) +return + + +/*/{Protheus.doc} vargetd +Recupera o valor de uma "chave" tanto da "Tabela X" quanto da "Tabela A" de uma determinada sessão, mas não faz bloqueio da "chave" \(Dirty\). + +@type binary function +@sintax VarGetD([cUID], [cChave]) => NIL +@param [cuid], character, Identificador da sessão de Variáveis Globais. +@param [cchave], character, Identificador da chave. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/vargetd +/*/ +binary function vargetd(cuid, cchave) +return + + +/*/{Protheus.doc} vargetx +Recupera o valor de uma "chave" na "Tabela X" de uma determinada sessão, e faz bloqueio da "chave" . + +@type binary function +@sintax VarGetX([cUID], [cChave]) => NIL +@param [cuid], character, Identificador da sessão de Variáveis Globais. +@param [cchave], character, Identificador da chave. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/vargetx +/*/ +binary function vargetx(cuid, cchave) +return + + +/*/{Protheus.doc} vargetxa +Obtém uma lista com todas as chaves e seus respectivos valores da "Tabela X". + +@type binary function +@sintax VarGetXA([cUID]) => NIL +@param [cuid], character, Identificador da sessão de Variáveis Globais. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/vargetxa +/*/ +binary function vargetxa(cuid) +return + + +/*/{Protheus.doc} vargetxd +Recupera o valor de uma "chave" na "Tabela X" de uma determinada sessão, sem fazer bloqueio da "chave" \(Dirty\). + +@type binary function +@sintax VarGetXD([cUID], [cChave]) => NIL +@param [cuid], character, Identificador da sessão de Variáveis Globais. +@param [cchave], character, Identificador da chave. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/vargetxd +/*/ +binary function vargetxd(cuid, cchave) +return + + +/*/{Protheus.doc} varisuid +Verifica se o identificador da sessão de variáveis globais fornecido está associado a um HashMap global. + +@type binary function +@sintax VarIsUID([cUID]) => NIL +@param [cuid], character, Identificador da sessão de Variáveis Globais. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/varisuid +/*/ +binary function varisuid(cuid) +return + + +/*/{Protheus.doc} varprint +descrição da funcao + +@type binary function +@sintax VarPrint([@tNomeVar]) => codeblock +@return codeblock, descrição do retorno + +@param [@tnomevar], codeblock, descrição do parametro +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/varprint +/*/ +binary function varprint(tnomevar) +return + + +/*/{Protheus.doc} varprinta +descrição da funcao + +@type binary function +@sintax VarPrintA([@tNomeVar]) => codeblock +@return codeblock, descrição do retorno + +@param [@tnomevar], codeblock, descrição do parametro +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/varprinta +/*/ +binary function varprinta(tnomevar) +return + + +/*/{Protheus.doc} varprintx +descrição da funcao + +@type binary function +@sintax VarPrintX([@tNomeVar]) => codeblock +@return codeblock, descrição do retorno + +@param [@tnomevar], codeblock, descrição do parametro +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/varprintx +/*/ +binary function varprintx(tnomevar) +return + + +/*/{Protheus.doc} varref +Cria referência entre duas variáveis. + +@type binary function +@sintax VarRef(, ) => logical +@return logical, Retorna, verdadeiro \(.T.\), se a referência foi estabelecida com sucesso; caso contrário, falso \(.F.\). + +@param , character, Indica o nome da variável que será referência. +@param , character, cVarRefenciada Caracter Indica o nome da variável que será referenciada. Desta forma, toda vez que esta variável for alterada, sua referência também será. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/varref +/*/ +binary function varref(cvarrefencia, cvarrefencia) +return + + +/*/{Protheus.doc} varsclean +descrição da funcao + +@type binary function +@sintax VarsClean([@tNomeVar]) => codeblock +@return codeblock, descrição do retorno + +@param [@tnomevar], codeblock, descrição do parametro +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/varsclean +/*/ +binary function varsclean(tnomevar) +return + + +/*/{Protheus.doc} varset +Insere ou Atualiza o valor de uma "chave" na "Tabela X" de uma determinada sessão, e faz bloqueio da "chave" . + +@type binary function +@sintax VarSet([cUID], [cKeyWrk]) => NIL +@param [cuid], character, Identificador da sessão de Variáveis Globais. +@param [ckeywrk], character, Identificador da chave. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/varset +/*/ +binary function varset(cuid, ckeywrk) +return + + +/*/{Protheus.doc} varseta +Insere ou Atualiza o valor de uma "chave" na "Tabela A" de uma determinada sessão, e faz bloqueio da "chave" . + +@type binary function +@sintax VarSetA([cUID]) => NIL +@param [cuid], character, Identificador da sessão de Variáveis Globais. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/varseta +/*/ +binary function varseta(cuid) +return + + +/*/{Protheus.doc} varsetad +Insere ou Atualiza o valor de uma "chave" na "Tabela A" de uma determinada sessão, sem fazer bloqueio da "chave" \(Dirty\). + +@type binary function +@sintax VarSetAD([cUID], [cChave]) => NIL +@param [cuid], character, Identificador da sessão de Variáveis Globais. +@param [cchave], character, Identificador da chave. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/varsetad +/*/ +binary function varsetad(cuid, cchave) +return + + +/*/{Protheus.doc} varsetd +Insere ou Atualiza o valor de uma "chave" tanto na "Tabela X" quanto na "Tabela A" de uma determinada sessão, mas não faz bloqueio da "chave" \(Dirty\). + +@type binary function +@sintax VarSetD([cUID], [cChave]) => NIL +@param [cuid], character, Identificador da sessão de Variáveis Globais. +@param [cchave], character, Identificador da chave. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/varsetd +/*/ +binary function varsetd(cuid, cchave) +return + + +/*/{Protheus.doc} varsetget +Permite associar um bloco de código a uma variável de programa do Advpl, onde o bloco de código será chamado quando a variável for acessada. + +@type binary function +@sintax VarSetGet(, , [lApenasUpdate]) => logical +@return logical, Retorna .T. caso a variável especificada como primeiro parâmetro exista na lista de variávels do programa em execução. + +@param , character, Indica o nome da variável a ser associada com o bloco de código. +@param , codeblock, Indica o bloco de código que será executado quando a variável for acessada. +@param [lapenasupdate], logical, Caso especificado .T., ondica se apenas operação de atribuição \( assign \) deve disparar o bloco de código. Caso informado o valor .F. \( default \), o bloco de código será chamado quando da leitura e/ou atribuição de conteúdo. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/varsetget +/*/ +binary function varsetget(cvariavel, bbloco, lapenasupdate) +return + + +/*/{Protheus.doc} varsetx +Insere ou Atualiza o valor de uma "chave" na "Tabela X" de uma determinada sessão, e faz bloqueio da "chave" . + +@type binary function +@sintax VarSetX([cUID], [cChave]) => NIL +@param [cuid], character, Identificador da sessão de Variáveis Globais. +@param [cchave], character, Identificador da chave. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/varsetx +/*/ +binary function varsetx(cuid, cchave) +return + + +/*/{Protheus.doc} varsetxd +Insere ou Atualiza o valor de uma "chave" na "Tabela X" de uma determinada sessão, sem fazer bloqueio da "chave" \(Dirty\). + +@type binary function +@sintax VarSetXD([cUID], [cChave]) => NIL +@param [cuid], character, Identificador da sessão de Variáveis Globais. +@param [cchave], character, Identificador da chave. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/varsetxd +/*/ +binary function varsetxd(cuid, cchave) +return + + +/*/{Protheus.doc} varsprint +descrição da funcao + +@type binary function +@sintax VarsPrint([@tNomeVar]) => codeblock +@return codeblock, descrição do retorno + +@param [@tnomevar], codeblock, descrição do parametro +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/varsprint +/*/ +binary function varsprint(tnomevar) +return + + +/*/{Protheus.doc} varunref +Cancela a referência entre duas variáveis. + +@type binary function +@sintax VarUnref() => logical +@return logical, Retorna, verdadeiro \(.T.\), se a referência foi cancelada com sucesso; caso contrário, falso \(.F.\). + +@param , character, Nome da variável que é referência. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/varunref +/*/ +binary function varunref(cvarrefencia) +return + + +/*/{Protheus.doc} w2bin +Converte um número inteiro em uma string formatada como um inteiro de 16 bits não sinalizado. + +@type binary function +@sintax W2Bin() => character +@return character, Retorna uma string de dois bytes que contém um inteiro binário de 16 bits. + +@param , numeric, Indica o valor numérico inteiro que será convertido. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/w2bin +/*/ +binary function w2bin(nint) +return + + +/*/{Protheus.doc} waitrun +Executa e aguarda pelo término de um programa externo \(arquivo executável\) através do sistema operacional da estação onde o SmartClient está sendo executado. + +@type binary function +@sintax WaitRun(, [nOpc]) => character +@return character, Retorna 0 \(zero\) em caso de sucesso da execução do processo e diferente de zero para erros. + +@param , character, Indica o nome e extensão do arquivo executável. +@param [nopc], numeric, Indica o modo de interface a ser criado para a execução do programa. Para mais informações consulte observações. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/waitrun +/*/ +binary function waitrun(cexename, nopc) +return + + +/*/{Protheus.doc} waitrunsrv +Executa um programa externo \(arquivo executável\) no ambiente onde o servidor esta sendo executado. + +@type binary function +@sintax WaitRunSrv(, [lWait], [nPath]) => character +@return character, Retorna 0 \(zero\) em caso de sucesso da execução do processo e diferente de zero para erros. + +@param , character, Indica o nome e extensão do arquivo executável. +@param [lwait], logical, Verdadeiro para a execução aguardar o termino do programa externo, ou falso para não aguardar o termino e continuar a execução do programa. +@param [npath], character, Indica o path de execução onde o programa irá rodar. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/waitrunsrv +/*/ +binary function waitrunsrv(cexename, lwait, npath) +return + + +/*/{Protheus.doc} webencript +Realiza a criptografia ou decriptografia de um conteúdo + +@type binary function +@sintax WebEncript(, [lDecript], [lUseinjava]) => character +@return character, Retorna uma string com o conteúdo encriptado ou decriptado + +@param , character, Conteudo que será encriptado ou decriptado. +@param [ldecript], logical, Quando informado verdadeiro \(.T.\) irá decriptar ; quando informado falso \(.F.\) irá encriptar . Quando não informado é encriptado . +@param [luseinjava], logical, Usar .T. quando função for usada com validação em Java. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/webencript +/*/ +binary function webencript(ccontent, ldecript, luseinjava) +return + + +/*/{Protheus.doc} winexec +Executa uma aplicação externa na estação onde o SmartClient está em execução. + +@type binary function +@sintax WinExec() => character +@return character, Retorna 0 \(zero\) em caso de sucesso da execução do processo e diferente de zero para erros. + +@param , character, Indica o o caminho e nome do programa que será executado. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/winexec +/*/ +binary function winexec(cexec) +return + + +/*/{Protheus.doc} word +Retorna a parte inteira de uma variável numérica AdvPL. + +@type binary function +@sintax Word() => numeric +@return numeric, Retorna a parte inteira do número informado, ignorando qualquer valor decimal. + +@param , numeric, Valor numérico a ser considerado. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/word +/*/ +binary function word(nvalue) +return + + +/*/{Protheus.doc} writepprostring +Permite criar e/ou alterar um seção/chave de configuração no arquivo de configuração \(.INI\). No entanto, caso o arquivo não exista ele será criado. Pode-se, opcionalmente, definir um path absoluto, com unidade de disco, de modo que o arquivo de configuração \(.INI\) será atualizado na estação onde o TOTVS Smart Client está sendo executado. + +@type binary function +@sintax WritePProString(, , , ) => logical +@return logical, Retorna verdadeiro \(.T.\) se a chave for incluída e/ou alterada com sucesso ou falso \(.F.\) caso ocorra alguma falha ou impossibilidade de acesso no arquivo de configuração \(.INI\). + +@param , character, Indica o nome da seção, no arquivo de configuração \(.INI\), que será utilizada. Porém, caso a seção não exista, a mesma será criada. +@param , character, ndica o nome da chave da seção, do arquivo de configuração \(.INI\), que terá seu conteúdo alterado. Porém, caso a chave não exista na seção especificada, a mesma será criada. +@param , character, Indica o conteúdo da chave que será atualizado. +@param , character, Indica o nome do arquivo de configuração \(\*.INI\) que será alterado. Porém, é importante observar os seguintes casos: Se o arquivo de configuração \(.INI\) não existir, o mesmo será criado; Se o path do arquivo de configuração \(\*.INI\) não for informado, o mesmo será criado/atualizado no diretório onde está instalado TOTVS Application Server, no servidor; Se especificado um path absoluto, com unidade de disco, o arquivo de configuração \(.INI\) será criado e/ou atualizado na estação remota, no path informado. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/writepprostring +/*/ +binary function writepprostring(csecao, cchave, cconteudo, carqini) +return + + +/*/{Protheus.doc} writeprofstring +Cria ou altera o conteúdo de uma chave no arquivo win.ini \(arquivo utilizado para armazenar configurações básicas de inicialização\) do sistema operacional. + +@type binary function +@sintax WriteProfString(, , ) => logical +@return logical, Retorna verdadeiro \(.T.\), se a chave for incluída ou alterada com sucesso, ou falso \(.F.\), caso ocorra alguma falha ou impossibilidade de acesso no arquivo de configuração. + +@param , character, Indica o nome da seção em que um valor será recuperado. +@param , character, Indica o nome da chave em que um valor será recuperado. +@param , character, Indica o conteúdo padrão que será recuperado. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/writeprofstring +/*/ +binary function writeprofstring(csecao, cchave, cpadrao) +return + + +/*/{Protheus.doc} writersapk +Converte uma chave privada no formato DER \(Distinguished Encoding Rules\) para o formato PEM \(Privacy Enhanced Mail\) criptografando com o algoritmo RSA. + +@type binary function +@sintax WriteRSAPK(, , <@cError>) => logical +@return logical, Retorna **.T.** se conseguiu converter o arquivo; caso contrário, **.F.**. + +@param , character, Indica o caminho do arquivo origem \(formato DER\), a partir da raiz do diretório \(RootPath\) do TOTVS Application Server. +@param , character, Indica o caminho do arquivo destino \(formato PEM\), a partir da raiz do diretório \(RootPath\) do TOTVS Application Server, com as informações de chave privada. +@param <@cerror>, character, Indica a saída da mensagem de erro, em caso de falha. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/writersapk +/*/ +binary function writersapk(cderfile, crsafile, cerror) +return + + +/*/{Protheus.doc} writesrvprofstring +Cria ou altera um chave, no arquivo de configuração \(\*.INI\), na seção do ambiente em uso. + +@type binary function +@sintax WriteSrvProfString(, ) => logical +@return logical, Retorna verdadeiro \(.T.\) se a chave for incluída ou alterada com sucesso ou falso \(.F.\) caso ocorra alguma falha ou impossibilidade de acesso no arquivo de configuração \(\*.INI\). + +@param , character, Indica o nome da chave, no arquivo de configuração \(\*.INI\), que será criada ou alterada na seção do ambiente em uso. +@param , character, Indica o conteúdo que será definido ou atualizado. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/writesrvprofstring +/*/ +binary function writesrvprofstring(cchave, cvalor) +return + + +/*/{Protheus.doc} wsclassnew +Cria uma nova instância de uma estrutura de Web Services. + +@type binary function +@sintax WSClassNew() => object +@return object, Retorna uma referência para a nova instância da estrutura passada como parâmetro. Caso a estrutura não exista, o retorno será nulo. + +@param , character, Indica o nome da estrutura \(Server\), de Web Services, para criar o objeto. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/wsclassnew +/*/ +binary function wsclassnew(csrvstruct) +return + + +/*/{Protheus.doc} wsdescdata +Obtém todas as propriedades de uma classe de Web Services. + +@type binary function +@sintax WSDescData(, [lIncluiDoc]) => array +@return array, Retorna um array com as informações das propriedades contidas na classe. Caso não encontre a classe especificada, o retorno será um array vazio. + +@param , character, Indica o nome da classe \(Server\), de Web Services, para a obtenção das propriedades. +@param [lincluidoc], logical, Indica que, se verdadeiro \(.T.\), o valor inicial da propriedade será incluído no array de retorno; caso contrário, falso \(.F.\), o valor não será incluso. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/wsdescdata +/*/ +binary function wsdescdata(cclassname, lincluidoc) +return + + +/*/{Protheus.doc} wsdescmeth +Obtém todos os métodos \(incluindo os parâmetros de send e receive\) de uma classe de Web Services. + +@type binary function +@sintax WSDescMeth() => array +@return array, Retorna um array com a lista de métodos contidos na classe. Caso não encontre a classe especificada, o array retornará vazio. + +@param , character, Indica o nome da classe \(Server\), de Web Services, para a obtenção das propriedades. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/wsdescmeth +/*/ +binary function wsdescmeth(cclassname) +return + + +/*/{Protheus.doc} wsdl2parser +Realiza o parser de um conteudo importado de um WSDL Passado no primeiro parametro da função, como tipo Caracter + +@type binary function +@sintax WSDL2Parser(, <@aLocalType>, <@aLocalName>, <@aLocalImport>, <@cError>, <@cWarning>) => numeric +@return numeric, \(Nulo\) + +@param , character, String contendo um WSDL para o parser. +@param <@alocaltype>, array, Array com os tipo de dados fornece definições usadas para descrever as mensagens trocadas. +@param <@alocalname>, array, Array com os dados que especifica um endereço para uma ligação, definindo assim uma única comunicação final. +@param <@alocalimport>, array, Array com os Endereços para importar outras definições. +@param <@cerror>, character, Caso ocorra algum erro na execução da função, a variável será preenchida com sua descrição. +@param <@cwarning>, character, Caso ocorra algum alerta \(warning\) durante a execução da função, a variável será preenchida com sua descrição. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/wsdl2parser +/*/ +binary function wsdl2parser(cwsdl, alocaltype, alocalname, alocalimport, cerror, cwarning) +return + + +/*/{Protheus.doc} wsdlparser +Realiza o parser de um conteudo importado de um WSDL. + +@type binary function +@sintax WSDLParser(, <@aLocalType>, <@aLocalMsg>, <@aLocalPort>, <@aLocalBind>, <@aLocalServ>, <@aLocalName>, <@aLocalImport>, <@cError>, <@cWarning>) => numeric +@return numeric, \(Nulo\) + +@param , character, Indica a string que contém um WSDL para realizar o parser. +@param <@alocaltype>, array, Indica um array, por referência, que fornecerá definições que serão utilizadas para descrever as mensagens trocadas. +@param <@alocalmsg>, array, Indica um array que contém os dados que representam uma definição abstrata dos dados que serão transmitidos. Uma mensagem consiste de parte lógica, cada uma das quais está associada a uma definição dentro de algum tipo de sistema. +@param <@alocalport>, array, Indica um array com os dados que são um conjunto de resumo de operações. Cada operação, refere-se a uma mensagem de entrada e saída. +@param <@alocalbind>, array, Indica um array que contém os dados que especifica os dados concretos do protocolo de formato das especificações para operações e mensagens definidas por um determinado portType. +@param <@alocalserv>, array, Indica um array com os dados que contêm os serviços que serão utilizados para agregar um conjunto de portas. +@param <@alocalname>, array, Indica um array com os dados que especifica o endereço que será utilizado para realizar uma ligação. Desta forma, será definida uma única comunicação final. +@param <@alocalimport>, array, Indica um array com os endereços que serão utilizados para importar outras definições. +@param <@cerror>, character, Caso ocorra algum erro na execução da função, a variável será preenchida com sua descrição. +@param <@cwarning>, character, Caso ocorra algum alerta \(warning\) durante a execução da função, a variável será preenchida com sua descrição. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/wsdlparser +/*/ +binary function wsdlparser(cwsdl, alocaltype, alocalmsg, alocalport, alocalbind, alocalserv, alocalname, alocalimport, cerror, cwarning) +return + + +/*/{Protheus.doc} xmlc14n +Esta função permite aplicar o algoritmo canonicalization C14N na string que contém um XML. + +@type binary function +@sintax XmlC14N(, , <@cError>, <@cWarning>) => character +@return character, Retorna o XML recodificado na forma canonical. + +@param , character, Indica o conteúdo XML que assumirá a formato canonical. +@param , character, Reservado para implementação futura. Deve ser informada uma string em branco. +@param <@cerror>, character, Retorna uma descrição de erro, em caso de falha no Parser. +@param <@cwarning>, character, Retorna uma descrição de advertência emitida pelo Parser. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/xmlc14n +/*/ +binary function xmlc14n(cxml, coption, cerror, cwarning) +return + + +/*/{Protheus.doc} xmlc14nfile +Esta função permite aplicar o algoritmo canonicalization C14N em um arquivo que contém um XML. + +@type binary function +@sintax XmlC14NFile(, , <@cError>, <@cWarning>) => character +@return character, Retorna o XML recodificado na forma canonical. + +@param , character, Indica caminho do arquivo XML que assumirá a formato canonical. +@param , character, Reservado para implementação futura. Deve ser informada uma string em branco. +@param <@cerror>, character, Retorna uma descrição de erro, em caso de falha no Parser. +@param <@cwarning>, character, Retorna uma descrição de advertência emitida pelo Parser. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/xmlc14nfile +/*/ +binary function xmlc14nfile(cfile, coption, cerror, cwarning) +return + + +/*/{Protheus.doc} xmlchildcount +Retorna a quantidade de nós existentes, a partir de um elemento\(nó\) pai informado como parâmetro. Sintaxe \[code\] XmlChildCount \( < oParent> \) --> nChild \[code\] + +@type binary function +@sintax XmlChildCount() => numeric +@return numeric, Retorna o número de elementos encontrados. + +@param , object, Indica o elemento XML que realizará a contagem dos elementos filhos. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/xmlchildcount +/*/ +binary function xmlchildcount(oparent) +return + + +/*/{Protheus.doc} xmlchildex +Retorna um ou mais nós da estrutura, de acordo com o nome do elemento procurado. + +@type binary function +@sintax XmlChildEx(, ) => variant +@return variant, Retorna o objeto do nó, se a função encontrar apenas um elemento, ou um array de nós, se possuir mais de um elemento do mesmo nome; caso contrário, o retorno será nulo. + +@param , object, Indica o nó que será utilizado para iniciar a procura do elemento procurado. +@param , character, Indica o nome do elemento que será procurado. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/xmlchildex +/*/ +binary function xmlchildex(oparent, cprocura) +return + + +/*/{Protheus.doc} xmlclonenode +Clonar um node do XML. + +@type binary function +@sintax XmlCloneNode(<@oParent>, ) => logical +@return logical, quando for possivel realizar a operação de clonar Retorna Verdadeiro\(.T.\), quando não for possivel retorna Falso\(.F.\) + +@param <@oparent>, object, Indica o nó que recebera o clone +@param , character, Indica o elemento que sera clonado +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/xmlclonenode +/*/ +binary function xmlclonenode(oparent, celement) +return + + +/*/{Protheus.doc} xmldelnode +Exclui um nó de um objeto XML - eXtensible Markup Language \(Linguagem extensível de formatação\). + +@type binary function +@sintax XmlDelNode(<@oParent>, <@oParent>) => logical +@return logical, Retorna verdadeiro \(.T.\), se encontrar um elemento e excluí-lo; caso contrário, falso \(.F.\). + +@param <@oparent>, object, Indica o nó pai do elemento que será excluído. +@param <@oparent>, character, Indica o Nome do elemento que sera excluido. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/xmldelnode +/*/ +binary function xmldelnode(oparent, oparent) +return + + +/*/{Protheus.doc} xmlfvldsch +Realiza a validação de um arquivo XML utilizando um XSD \(XML Schema Definition\). + +@type binary function +@sintax XmlFVldSch(, , <@cError>, <@cWarning>) => logical +@return logical, Retorna verdadeiro \(.T.\) caso o arquivo XML for validado a partir do XSD e, caso contrário, retorna falso \(.F.\) + +@param , character, Indica o arquivo XML que será validado +@param , character, Indica o arquivo XSD utilizado na validação do XML +@param <@cerror>, character, Indica a variável que será preenchida com a descrição do erro observado durante a validação do XML +@param <@cwarning>, character, Indica a variável que será preenchida com a descrição do alerta observado durante a validação do XML +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/xmlfvldsch +/*/ +binary function xmlfvldsch(cxml, cxsd, cerror, cwarning) +return + + +/*/{Protheus.doc} xmlgetchild +Retorna um elemento filho da estrutura. + +@type binary function +@sintax XmlGetChild(, ) => object +@return object, Retorna o objeto que representa o filho da estrutura, de acordo com o índice passado no parâmetro + +@param , object, Indica o nó no qual será utilizado como base para obter um nó filho. +@param , numeric, Indica o índice do nó que desejamos obter. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/xmlgetchild +/*/ +binary function xmlgetchild(oparent, nchild) +return + + +/*/{Protheus.doc} xmlgetparent +Retorna um nó que representa o nó pai do elemento especificado por parâmetro. + +@type binary function +@sintax XmlGetParent([oNode]) => object +@return object, Retorna um objeto posicionado no nó, de acordo com o parâmetro . + +@param [onode], codeblock, Indica o nó no qual será utilizado como referência para o retorno do nó pai. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/xmlgetparent +/*/ +binary function xmlgetparent(onode) +return + + +/*/{Protheus.doc} xmlnewnode +Cria um novo nó a partir de um ponto qualquer no XML - EXtensible Markup Language \(Linguagem extensível de formatação\). Sintaxe \[code\] XmlNewNode \( , , , \) --> Nil \[code\] + +@type binary function +@sintax XmlNewNode(, , , ) => NIL +@param , object, Indica o local onde será inserido o novo nó XML. +@param , character, Indica o nome do elemento \(nó\) no XML. +@param , character, Indica o nome real do nó XML. +@param , character, Indica o tipo de nó XML que será criado. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/xmlnewnode +/*/ +binary function xmlnewnode(oparent, celementname, crealname, ctype) +return + + +/*/{Protheus.doc} xmlnode2arr +Transforma em array um objeto \(nó\) da estrutura do XML - eXtensible Markup Language \(Linguagem extensível de formatação\). Sintaxe \[code\] XmlNode2Arr \( < oRoot>, < cNode> \) --> lRet \[code\] + +@type binary function +@sintax XmlNode2Arr(, ) => NIL +@param , object, Indica o elemento \(nó\) que será utilizado como raiz para iniciar a busca do elemento a ser transformado em array. +@param , character, Indica o elemento procurado que será transformado em array na estrutura. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/xmlnode2arr +/*/ +binary function xmlnode2arr(oroot, cnode) +return + + +/*/{Protheus.doc} xmlparser +Retorna um objeto, que possui uma estrutura XML, passado por parâmetro. Sintaxe \[code\] XmlParser\( \[ cXml \], \[ cReplace \], \[ cError \], \[ cWarning \] \) \[code\] + +@type binary function +@sintax XmlParser(, , , ) => object +@return object, Retorna um objeto com a estrutura de acordo com o XML. + +@param , character, Indica uma string que contém o código XML. +@param , character, Indica o valor que será atribuído como prefixo para a nomenclatura das propriedades do objeto XML em Advpl a partir dos nomes dos nodes do documento XML. Será usando também na substituição de qualquer caractere usado no nome do node XML que não faça parte da nomenclatura de uma variável Adppl, como espaços em branco por exemplo. +@param , character, Caso ocorra algum erro durante execução da função, a variável será preenchida com a descrição do erro ocorrido. +@param , character, Caso ocorra alguma advertência durante execução da função, a variável será preenchida com a descrição da advertência ocorrida. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/xmlparser +/*/ +binary function xmlparser(cxml, creplace, cerror, cwarning) +return + + +/*/{Protheus.doc} xmlparserfile +Esta função permite retornar um objeto, que possui uma estrutura XML, recebido de um arquivo por parâmetro. Sintaxe \[code\] XmlParserFileFile \( , , <@cError>, <@cWarning> \) --> oXML \[code\] + +@type binary function +@sintax XmlParserFile(, , , ) => object +@return object, Um objeto com a estrutura de acordo com o XML. + +@param , character, Representa o dir etório \(a partir do rootpath\) e o nome de um arquivo \*.xml. +@param , character, Representa o valor que será substituído, pelos caracteres de espaço em branco, na especificação do nó XML. +@param , character, Caso ocorra algum erro na execução da função, a variável será preenchida com sua descrição. +@param , character, Caso ocorra algum alerta \(warning\) durante a execução da função, a variável será preenchida com sua descrição. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/xmlparserfile +/*/ +binary function xmlparserfile(cfile, creplace, cerror, cwarning) +return + + +/*/{Protheus.doc} xmlsvldsch +Executa a validação de um XML como string com relação a um arquivo XSD \(Schema\). + +@type binary function +@sintax XmlSVldSch(, , <@cError>, <@cWarning>) => logical +@return logical, Retorna verdadeiro \(.T.\), se o XML for válido, caso contrário, retorna falso \(.F.\). + +@param , character, Indica o valor XML como string que será validado, pode ser passado uma variável string com conteúdo XML. +@param , character, Indica o arquivo XSD com path para validação do arquivo XML. +@param <@cerror>, character, Caso ocorra algum erro durante a validação do arquivo XML, a variável será preenchida com a descrição do erro ocorrido. +@param <@cwarning>, character, Caso ocorra algum alerta 'Warning' durante validação do arquivo XML, a variável será preenchida com a descrição do 'Warning' ocorrido. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/xmlsvldsch +/*/ +binary function xmlsvldsch(cxml, cschemapath, cerror, cwarning) +return + + +/*/{Protheus.doc} year +Retorna o ano correspondente a uma data. + +@type binary function +@sintax year() => numeric +@return numeric, Retorna o ano correspondente a data informada, inclusive os dígitos referente ao século, na forma de um valor numérico de quatro dígitos. + +@param , date, Indica a data que será convertida. +@author [VP Tecnologia](https://tdn.totvs.com/display/tec) - [TOTVS S.A.](https://www.totvs.com/) +@see https://tdn.totvs.com/display/tec/year +/*/ +binary function year(ddate) +return + + diff --git a/.vscode/launch.json b/.vscode/launch.json new file mode 100644 index 0000000..8f978b6 --- /dev/null +++ b/.vscode/launch.json @@ -0,0 +1,20 @@ +{ + "version": "0.2.0", + "configurations": [ + { + "type": "totvs_language_debug", + "request": "launch", + "name": "TOTVS Language Debug", + "program": "${command:AskForProgramName}", + "cwb": "${workspaceFolder}", + "smartclientBin": "../totvs/bin/smartclient/smartclient.exe", + "isMultiSession": true, + "enableTableSync": true, + "extendFeatures": { + "charDetails": false + } + } + ], + "lastProgramExecuted": "", + "lastProgramArguments": [] +} \ No newline at end of file diff --git a/.vscode/settings.json b/.vscode/settings.json new file mode 100644 index 0000000..aa86c45 --- /dev/null +++ b/.vscode/settings.json @@ -0,0 +1,4 @@ +{ + "totvsLanguageServer.welcomePage": false, + "totvsLanguageServer.editor.linter.includes": "C:\\25-04-14-P12-SMARTCLIENT_BUILD 20.3.2.12_WINDOWS_X64\\include" +} \ No newline at end of file diff --git a/__pycache__/recebiveis_report_importer.cpython-313.pyc b/__pycache__/recebiveis_report_importer.cpython-313.pyc new file mode 100644 index 0000000..35018cd Binary files /dev/null and b/__pycache__/recebiveis_report_importer.cpython-313.pyc differ diff --git a/enrich_paytype_backfill.py b/enrich_paytype_backfill.py deleted file mode 100644 index 131e0b1..0000000 --- a/enrich_paytype_backfill.py +++ /dev/null @@ -1,152 +0,0 @@ -""" -Backfill de paymentType para todos os Numero_Pedido em Grgb_vendas_report -que ainda não constam em Grgb_installment_paytype. - -Pode ser interrompido e re-executado a qualquer momento — retoma de onde parou. -""" -import re -import time -import requests -from typing import Optional - -from installments_reader import Auth, get_installments_page - -# ─── CONFIG ─────────────────────────────────────────────────────────────────── -SQL_CONN = ( - "DRIVER={ODBC Driver 17 for SQL Server};" - "SERVER=10.77.77.10;" - "DATABASE=GINSENG;" - "UID=andrey;" - "PWD=88253332;" - "TrustServerCertificate=yes;" -) - -INSTALLMENT_GROUP_COL = "Numero_Pedido" -RATE_LIMIT_S = 1.5 -PRINT_EVERY = 1 -# ────────────────────────────────────────────────────────────────────────────── - - -def _conn_str() -> str: - s = SQL_CONN.rstrip(";") - if not re.search(r"(?i)\bEncrypt\b", s): - s += ";Encrypt=no" - return s + ";" - - -def _ensure_paytype_table(cur) -> None: - cur.execute(""" -IF OBJECT_ID('dbo.Grgb_installment_paytype', 'U') IS NULL -BEGIN - CREATE TABLE dbo.Grgb_installment_paytype ( - InstallmentGroupCode VARCHAR(50) NOT NULL PRIMARY KEY, - PaymentType VARCHAR(80) NULL, - ConsultadoEm DATETIME2 NOT NULL DEFAULT SYSUTCDATETIME() - ) -END -""") - - -def _load_pending(cur) -> list[str]: - cur.execute(f""" -SELECT DISTINCT [{INSTALLMENT_GROUP_COL}] -FROM dbo.Grgb_vendas_report -WHERE [{INSTALLMENT_GROUP_COL}] IS NOT NULL - AND [{INSTALLMENT_GROUP_COL}] <> '' - AND [{INSTALLMENT_GROUP_COL}] NOT IN ( - SELECT InstallmentGroupCode FROM dbo.Grgb_installment_paytype - ) -ORDER BY [{INSTALLMENT_GROUP_COL}] -""") - return [str(r[0]) for r in cur.fetchall()] - - -def _query_payment_type( - session: requests.Session, - auth: Auth, - group_code: str, -) -> Optional[str]: - """Usa get_installments_page do installments_reader (headers + retry corretos).""" - try: - body = get_installments_page( - session=session, - auth=auth, - start_date=None, - end_date=None, - installment_change=None, - mediator_code=None, - page=1, - installment_group_code=group_code, - ) - installments = body.get("data", {}).get("installments") or [] - if installments: - return str(installments[0].get("paymentType") or "") - except Exception as exc: - print(f"[erro] groupCode={group_code}: {exc}") - return None - - -def _save(cur, group_code: str, payment_type: Optional[str]) -> None: - cur.execute( - "INSERT INTO dbo.Grgb_installment_paytype (InstallmentGroupCode, PaymentType) " - "VALUES (?, ?)", - group_code, payment_type, - ) - - -def main() -> None: - import pyodbc - - conn_str = _conn_str() - - cn = pyodbc.connect(conn_str, timeout=60) - cn.autocommit = False - cur = cn.cursor() - _ensure_paytype_table(cur) - cn.commit() - pending = _load_pending(cur) - cur.close(); cn.close() - - total = len(pending) - print(f"[backfill] {total} pedidos pendentes de paymentType") - if not total: - print("[backfill] nada a fazer.") - return - - session = requests.Session() - session.trust_env = False - auth = Auth(session) - - ok = erros = 0 - for i, group_code in enumerate(pending, 1): - payment_type = _query_payment_type(session, auth, group_code) - - cn = pyodbc.connect(conn_str, timeout=60) - cn.autocommit = False - cur = cn.cursor() - try: - _save(cur, group_code, payment_type) - cn.commit() - ok += 1 - except Exception as exc: - cn.rollback() - print(f"[erro] sql groupCode={group_code}: {exc}") - erros += 1 - finally: - cur.close(); cn.close() - - if i % PRINT_EVERY == 0 or i == total: - pct = i / total * 100 - print( - f"[backfill] {i}/{total} ({pct:.1f}%)" - f" ok={ok} erros={erros}" - f" ultimo={group_code} paymentType={payment_type}" - ) - - time.sleep(RATE_LIMIT_S) - - print(f"\n[backfill] concluido: {ok} gravados, {erros} erros") - - -if __name__ == "__main__": - main() diff --git a/recebiveis_report_importer.py b/recebiveis_report_importer.py index 2d4d7d2..49ab66b 100644 --- a/recebiveis_report_importer.py +++ b/recebiveis_report_importer.py @@ -43,9 +43,9 @@ ALL_MEDIATOR_CODES = [ "24293", "24447", "24451", "24457", "24458", "4494", ] -INCREMENTAL = True # True = modo diário incremental -START_DATE = "2026-01-01" # usado apenas se INCREMENTAL = False -END_DATE = "2026-01-31" # usado apenas se INCREMENTAL = False +INCREMENTAL = True # True = modo diário incremental +START_DATE = "2025-12-01" # usado apenas se INCREMENTAL = False +END_DATE = "2026-06-22" # usado apenas se INCREMENTAL = False INCREMENTAL_DEFAULT_START = "2026-01-01" # data inicial no primeiro run incremental DATA_TYPE = "VENDAS" @@ -58,7 +58,7 @@ _SCRIPT_DIR = os.path.dirname(os.path.abspath(__file__)) WATERMARK_FILE = os.path.join(_SCRIPT_DIR, "vendas_watermark.json") IMPORT_BATCH_SIZE = 500 # linhas por lote no SQL Server -ENRICH_PAYMENT_TYPES = True # True = consulta API de parcelas para preencher paymentType +ENRICH_PAYMENT_TYPES = False # True = consulta API de parcelas para preencher paymentType # Nome da coluna em Grgb_vendas_report que contém o installmentGroupCode. # Verifique rodando: SELECT TOP 1 * FROM dbo.Grgb_vendas_report INSTALLMENT_GROUP_COL = "Numero_Pedido" @@ -621,11 +621,13 @@ def _build_chunks(start_date: str, end_date: str) -> list[tuple[str, str]]: def main() -> None: - start_date, end_date = _resolve_date_range() - - if not start_date: - print("[info] dados já estão atualizados até ontem, nada a importar.") - return + if INCREMENTAL: + start_date, end_date = _resolve_date_range() + if not start_date: + print("[info] dados já estão atualizados até ontem, nada a importar.") + return + else: + start_date, end_date = START_DATE, END_DATE print(f"[info] período a importar: {start_date} .. {end_date}") diff --git a/test_installment.py b/test_installment.py deleted file mode 100644 index fe86eb8..0000000 --- a/test_installment.py +++ /dev/null @@ -1,1045 +0,0 @@ -""" -Teste manual: digita um Numero_Pedido e consulta o paymentType na API. -""" -import requests -from installments_reader import Auth, get_installments_page - - -def main() -> None: - session = requests.Session() - session.trust_env = False - auth = Auth(session) - - # ── troque o valor abaixo para testar ── - codigos = [ - '488897167', - '488900751', - '489046144', -'489068635', -'489068635', -'489182708', -'489182708', -'489176675', -'489176675', -'489287708', -'489287708', -'489302682', -'489302682', -'489304522', -'489304522', -'489416528', -'489416528', -'489469622', -'489469622', -'489504266', -'489504266', -'489569575', -'489569575', -'489650051', -'489650051', -'489650916', -'489650916', -'489558752', -'489558752', -'489613544', -'489613544', -'489770485', -'489770485', -'489833835', -'489833835', -'489859925', -'489859925', -'489866953', -'489866953', -'489976274', -'489976274', -'489976566', -'489976566', -'490028441', -'490028441', -'489994132', -'489994132', -'490115712', -'490115712', -'490158554', -'490158554', -'490182408', -'490182408', -'490310969', -'490310969', -'490290148', -'490290148', -'490364961', -'490364961', -'490468502', -'490468502', -'490412991', -'490412991', -'490377513', -'490377513', -'490449347', -'490449347', -'490578607', -'490578607', -'490586602', -'490586602', -'490615182', -'490615182', -'490636921', -'490636921', -'490767854', -'490767854', -'490821622', -'490821622', -'490730454', -'490730454', -'490796778', -'490796778', -'490786154', -'490786154', -'488832795', -'488832795', -'488844457', -'488844457', -'488840876', -'488840876', -'488849098', -'488849098', -'488832688', -'488832688', -'488809343', -'488809343', -'488819937', -'488819937', -'488838155', -'488838155', -'488877308', -'488877308', -'488869375', -'488869375', -'488871171', -'488871171', -'488837494', -'488837494', -'488910189', -'488910189', -'488918937', -'488918937', -'488948287', -'488948287', -'488951131', -'488951131', -'488951733', -'488951733', -'488952602', -'488952602', -'488954098', -'488954098', -'488955447', -'488955447', -'488934039', -'488934039', -'488893798', -'488893798', -'488957552', -'488957552', -'488945349', -'488945349', -'488971901', -'488971901', -'488978793', -'488978793', -'488991246', -'488991246', -'488981985', -'488981985', -'489115478', -'489115478', -'489150599', -'489150599', -'489124360', -'489124360', -'489102571', -'489102571', -'489204623', -'489204623', -'489168018', -'489168018', -'489218340', -'489218340', -'489193775', -'489193775', -'489053190', -'489053190', -'489174079', -'489174079', -'489227990', -'489227990', -'489258514', -'489258514', -'489276471', -'489276471', -'489174767', -'489174767', -'489173480', -'489173480', -'489229122', -'489229122', -'489099356', -'489099356', -'489350877', -'489350877', -'489353647', -'489353647', -'489379264', -'489379264', -'489367879', -'489367879', -'489279195', -'489279195', -'489389477', -'489389477', -'489405101', -'489405101', -'489406153', -'489406153', -'489377734', -'489377734', -'489483968', -'489483968', -'489501177', -'489501177', -'489461542', -'489461542', -'489515886', -'489515886', -'489443577', -'489443577', -'489286734', -'489286734', -'489532352', -'489532352', -'489383427', -'489383427', -'489394568', -'489394568', -'489541936', -'489541936', -'489429744', -'489429744', -'489563444', -'489563444', -'489569024', -'489569024', -'489512070', -'489512070', -'489462988', -'489462988', -'489587081', -'489587081', -'489461274', -'489461274', -'489047492', -'489047492', -'489597627', -'489597627', -'489504102', -'489504102', -'489568205', -'489568205', -'489604339', -'489604339', -'489660616', -'489660616', -'489638892', -'489638892', -'489672383', -'489672383', -'489681679', -'489681679', -'489564847', -'489564847', -'489697391', -'489697391', -'489579518', -'489579518', -'489617874', -'489617874', -'489484025', -'489484025', -'489583883', -'489583883', -'489714125', -'489714125', -'489717894', -'489717894', -'489468239', -'489468239', -'489627988', -'489627988', -'489370097', -'489370097', -'489725709', -'489725709', -'489597728', -'489597728', -'489832626', -'489832626', -'489683678', -'489683678', -'489828935', -'489828935', -'489794823', -'489794823', -'489815685', -'489815685', -'489305306', -'489305306', -'489839132', -'489839132', -'489836311', -'489836311', -'489902136', -'489902136', -'489904417', -'489904417', -'489805498', -'489805498', -'489807613', -'489807613', -'489749932', -'489749932', -'489825423', -'489825423', -'489869731', -'489869731', -'489935510', -'489935510', -'489870051', -'489870051', -'489916407', -'489916407', -'489968301', -'489968301', -'490009269', -'490009269', -'489958607', -'489958607', -'490022611', -'490022611', -'490027889', -'490027889', -'489424918', -'489424918', -'490122064', -'490122064', -'489864977', -'489864977', -'489876193', -'489876193', -'489895530', -'489895530', -'490135701', -'490135701', -'489931466', -'489931466', -'489969305', -'489969305', -'490151941', -'490151941', -'489981333', -'489981333', -'490168091', -'490168091', -'490170344', -'490170344', -'489517623', -'489517623', -'490178089', -'490178089', -'490186647', -'490186647', -'490100807', -'490100807', -'490102254', -'490102254', -'490166532', -'490166532', -'490065410', -'490065410', -'490223525', -'490223525', -'490168722', -'490168722', -'490232543', -'490232543', -'490241513', -'490241513', -'490115167', -'490115167', -'490170975', -'490170975', -'490246221', -'490246221', -'490139487', -'490139487', -'490275325', -'490275325', -'490211095', -'490211095', -'490214240', -'490214240', -'490227265', -'490227265', -'490244136', -'490244136', -'490256520', -'490256520', -'490325729', -'490325729', -'490329448', -'490329448', -'490147256', -'490147256', -'490304214', -'490304214', -'490341193', -'490341193', -'490344662', -'490344662', -'490277018', -'490277018', -'490299624', -'490299624', -'490376613', -'490376613', -'490383021', -'490383021', -'490385566', -'490385566', -'490396628', -'490396628', -'490385689', -'490385689', -'490402005', -'490402005', -'490232196', -'490232196', -'490300785', -'490300785', -'490456319', -'490456319', -'490364772', -'490364772', -'490487581', -'490487581', -'490395721', -'490395721', -'490513951', -'490513951', -'490517955', -'490517955', -'490491484', -'490491484', -'490429140', -'490429140', -'490489726', -'490489726', -'490548409', -'490548409', -'490579931', -'490579931', -'490572638', -'490572638', -'490586386', -'490586386', -'490334619', -'490334619', -'490517727', -'490517727', -'490613404', -'490613404', -'490692411', -'490692411', -'490561010', -'490561010', -'490666985', -'490666985', -'490729602', -'490729602', -'490724654', -'490724654', -'490708235', -'490708235', -'490765453', -'490765453', -'490740205', -'490740205', -'490667361', -'490667361', -'490701466', -'490701466', -'490798923', -'490798923', -'490806229', -'490806229', -'490766676', -'490766676', -'490407567', -'490407567', -'490816837', -'490816837', -'490745937', -'490745937', -'490754960', -'490754960', -'490778775', -'490778775', -'490810815', -'490810815', -'490840568', -'490840568', -'490688153', -'490688153', -'490726267', -'490726267', -'490691898', -'490691898', -'490725653', -'490725653', -'490012216', -'490012216', -'488859494', -'488859494', -'488824857', -'488824857', -'488825162', -'488825162', -'488876914', -'488876914', -'488949239', -'488949239', -'488926843', -'488926843', -'488927119', -'488927119', -'488947467', -'488947467', -'488957390', -'488957390', -'489080787', -'489080787', -'489101687', -'489101687', -'489001560', -'489001560', -'489081505', -'489081505', -'489172160', -'489172160', -'489473637', -'489473637', -'489246344', -'489246344', -'489455459', -'489455459', -'489405041', -'489405041', -'489481801', -'489481801', -'489504996', -'489504996', -'489447686', -'489447686', -'489392926', -'489392926', -'489457037', -'489457037', -'489108743', -'489108743', -'489543566', -'489543566', -'489556971', -'489556971', -'489696822', -'489696822', -'489717549', -'489717549', -'489653913', -'489653913', -'489764781', -'489764781', -'489816454', -'489816454', -'489722596', -'489722596', -'490007201', -'490007201', -'490020898', -'490020898', -'490133032', -'490133032', -'489922866', -'489922866', -'490187003', -'490187003', -'490294269', -'490294269', -'490255562', -'490255562', -'490272248', -'490272248', -'490375398', -'490375398', -'489649804', -'489649804', -'490456579', -'490456579', -'490461583', -'490461583', -'490508291', -'490508291', -'490447494', -'490447494', -'490451683', -'490451683', -'490533536', -'490533536', -'490370631', -'490370631', -'490552756', -'490552756', -'490571115', -'490571115', -'490468814', -'490468814', -'490507594', -'490507594', -'490713077', -'490713077', -'490646556', -'490646556', -'490547756', -'490547756', -'490791993', -'490791993', -'490788921', -'490788921', -'490622836', -'490622836', -'488832697', -'488832697', -'488830110', -'488830110', -'488887190', -'488887190', -'488872641', -'488872641', -'488944800', -'488944800', -'489044879', -'489044879', -'489001990', -'489001990', -'489106945', -'489106945', -'488976791', -'488976791', -'489048241', -'489048241', -'489111894', -'489111894', -'489224155', -'489224155', -'489144704', -'489144704', -'489163154', -'489163154', -'489222239', -'489222239', -'489270950', -'489270950', -'489310802', -'489310802', -'489410388', -'489410388', -'489426600', -'489426600', -'489428833', -'489428833', -'489459101', -'489459101', -'489567904', -'489567904', -'489521037', -'489521037', -'489481576', -'489481576', -'489482463', -'489482463', -'489458451', -'489458451', -'489771029', -'489771029', -'489993460', -'489993460', -'489987792', -'489987792', -'490072042', -'490072042', -'490143505', -'490143505', -'490225942', -'490225942', -'490294807', -'490294807', -'490252170', -'490252170', -'490284387', -'490284387', -'490308775', -'490308775', -'490292066', -'490292066', -'490334466', -'490334466', -'490316126', -'490316126', -'490444414', -'490444414', -'490511013', -'490511013', -'490525310', -'490525310', -'490528299', -'490528299', -'490529408', -'490529408', -'490585358', -'490585358', -'490675100', -'490675100', -'490585046', -'490585046', -'490568370', -'490568370', -'490661679', -'490661679', -'490663777', -'490663777', -'490667174', -'490667174', -'490630814', -'490630814', -'490647115', -'490647115', -'490629448', -'490629448', -'490702446', -'490702446', -'490704007', -'490704007', -'490710089', -'490710089', -'490834889', -'490834889', -'490720824', -'490720824', -'489928621', -'489928621', -'489928621', -'489928621', -'488835445', -'488835445', -'488843239', -'488843239', -'488848524', -'488848524', -'488811116', -'488811116', -'488879604', -'488879604', -'488849941', -'488849941', -'488946022', -'488946022', -'488963960', -'488963960', -'489001997', -'489001997', -'488980316', -'488980316', -'489016201', -'489016201', -'489088097', -'489088097', -'489039411', -'489039411', -'489113265', -'489113265', -'488971870', -'488971870', -'489017205', -'489017205', -'489067343', -'489067343', -'488956960', -'488956960', -'489144659', -'489144659', -'488940394', -'488940394', -'489009800', -'489009800', -'489085609', -'489085609', -'489125944', -'489125944', -'489081097', -'489081097', -'489122266', -'489122266', -'489185975', -'489185975', -'489129206', -'489129206', -'489144808', -'489144808', -'489185174', -'489185174', -'489197067', -'489197067', -'489200334', -'489200334', -'489189515', -'489189515', -'489165068', -'489165068', -'489156720', -'489156720', -'489134779', -'489134779', -'489030453', -'489030453', -'489197030', -'489197030', -'489055479', -'489055479', -'489172163', -'489172163', -'489277761', -'489277761', -'489298878', -'489298878', -'489307023', -'489307023', -'489315633', -'489315633', -'489250616', -'489250616', -'489326716', -'489326716', -'489198570', -'489198570', -'489304192', -'489304192', -'489305116', -'489305116', -'489287417', -'489287417', -'489327952', -'489327952', -'489396128', -'489396128', -'489246610', -'489246610', -'489310979', -'489310979', -'489416517', -'489416517', -'489417717', -'489417717', -'489330583', -'489330583', -'489478760', -'489478760', -'489479941', -'489479941', -'489405600', -'489405600', -'489488216', -'489488216', -'489326059', -'489326059', -'489088128', -'489088128', -'489334406', -'489334406', -'489481213', -'489481213', -'489483570', -'489483570', -'489484003', -'489484003', -'489487711', -'489487711', -'489432072', -'489432072', -'489520497', -'489520497', -'489471005', -'489471005', -'489473472', -'489473472', -'489483896', -'489483896', -'489560560', -'489560560', -'489563135', -'489563135', -'489572950', -'489572950', -'489547813', -'489547813', -'489525280', -'489525280', -'489591705', -'489591705', -'489650526', -'489650526', -'489679159', -'489679159', -'489682118', -'489682118', -'489683434', -'489683434', -'489683659', -'489683659', -'489363507', -'489363507', -'489622498', -'489622498', -'489675489', -'489675489', -'489632644', -'489632644', -'489675063', -'489675063', -'489680657', -'489680657', -'489343097', -'489343097', -'489749848', -'489749848', -'489773388', -'489773388', -'489844566', -'489844566', -'489857669', -'489857669', -'489840363', -'489840363', -'489856550', -'489856550', -'489872983', -'489872983', -'489879366', -'489879366', -'489815124', -'489815124', -'489785271', -'489785271', -'489904518', -'489904518', -'489808211', -'489808211', -'489924670', -'489924670', -'489940910', -'489940910', -'489452669', -'489452669', -'489882482', -'489882482', -'489983646', -'489983646', -'489985985', -'489985985', -'489952858', -'489952858', -'490020540', -'490020540', -'490025166', -'490025166', -'490014493', -'490014493', -'490020570', -'490020570', -'490030627', -'490030627', -'490128389', -'490128389', -'490132593', -'490132593', -'489958498', -'489958498', -'490140271', -'490140271', -'489979295', -'489979295', -'490091894', -'490091894', -'490195656', -'490195656', -'489685871', -'489685871', -'490203496', -'490203496', -'490214534', -'490214534', -'489185302', -'489185302', -'490224264', -'490224264', -'490202966', -'490202966', -'489879144', -'489879144', -'490291870', -'490291870', -'490185439', -'490185439' - - ] - - for group_code in codigos: - - print(f"Consultando {group_code}...") - try: - body = get_installments_page( - session=session, - auth=auth, - start_date=None, - end_date=None, - installment_change=None, - mediator_code=None, - page=1, - installment_group_code=group_code, - ) - installments = body.get("data", {}).get("installments") or [] - if not installments: - print(" Nenhuma parcela encontrada.") - else: - for p in installments: - print( - f" parcela {p.get('installmentNumber')} " - f"paymentType={p.get('paymentType')} " - f"vencimento={p.get('dueDate')} " - f"valor={p.get('originalAmount')}" - ) - except Exception as exc: - print(f" Erro: {exc}") - - -if __name__ == "__main__": - main()