Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

Classe: FWRPC


Compatível Países:Todos
Sistemas Operacionais:Todos
Compatível às Bases de Dados:Todos
Nível de Acesso:Nível 1 (Acesso Clientes)
Idiomas:Português, Inglês, Espanhol
Versão1.0


Descrição
Classe de controle de conexão RPC sem transação com controle de recorrência em caso de falha de conexão em qualquer situação.


New

Sintaxe
FWRPC():New()-> oSelf

Descrição
Método construtor da classe.


Retorno
oSelf Objeto da classe.
Connect

Sintaxe
FWRPC():Connect()-> lResult

Descrição
Método que estabelece a conexão com o servidor alvo.


Retorno
Retorna um valor lógico informando se foi possível estabelecer a conexão, sendo Verdadeiro (.T.) indicando sucesso e Falso (.F.) falha.
SetEnv

Sintaxe
FWRPC():SetEnv(<cEmp>, <cFil>, <cModulo>, <aTabelas>, <cFunName>)-> lResult

Descrição
Método que prepara o ambiente no servidor alvo.

Parâmetros

NomeTipoDescriçãoDefaultObrigatórioReferência
cEmpCaractereCódigo da empresa


cFilCaractereCódigo da filial


cModuloCaractereCódigo do modulo


aTabelasArrayArray de string com a relação de alias das tabelas que deverão ser abertas


cFunNameCaractereEstabelece a rotina de execução no servidor alvo




Retorno
lResult Informa se a preparação do ambiente foi realizada com sucesso quando o retorno é Verdadeiro (.T.) e falha quando o retorno é Falso (.F.).
LoadCallProc

Sintaxe
FWPROFILEFWRPC():Load(<lByEmpFil >)-> aProfile
Descrição
Carrega as configurações armazenadas no profile
Parâmetros
NomeTipoDescriçãoDefaultObrigatórioReferêncialByEmpFilLógicoDefine se as configurações serão carregadas por empresa e filial..F. 
Retorno
aProfile Estrutura do array profile é dinâmica e deve ser definida na gravação.
LoadStrProfile
CallProc(cRotina, Param01, Param02, ... Param26)-> xResult

Descrição
Método de execução de uma rotina no servidor alvo.
Sintaxe
FWPROFILE():LoadStrProfile(<lByEmpFil >)-> cMemo
Descrição
Carrega as configurações armazenadas no profile


Parâmetros


NomeTipoDescriçãoDefaultObrigatórioReferência
lByEmpFilcRotinaLógicoDefine se as configurações serão carregadas por empresa e filial..F.
 
Retorno
cMemo Conteúdo do campo MEMO armazenado no profile
Save
Sintaxe
FWPROFILE():Save(<lByEmpFil >)-> NIL
Descrição
Salva as configurações realizadas no profile
Parâmetros
NomeTipoDescriçãoDefaultObrigatórioReferêncialByEmpFilLógicoDefine se as configurações serão carregadas por empresa e filial..F. 
Delete
Sintaxe
FWPROFILE():Delete(<lByEmpFil >)-> NIL
Descrição
Deleta as configurações do profile
Parâmetros
NomeTipoDescriçãoDefaultObrigatórioReferêncialByEmpFilLógicoDefine se as configurações serão carregadas por empresa e filial..F. 
SetProfile
Sintaxe
FWPROFILE():SetProfile(<aProfile >)-> NIL
Descrição
Indica um array contendo os dados que devem ser armazenados no profile do usuário
Parâmetros
NomeTipoDescriçãoDefaultObrigatórioReferênciaaProfileArrayEstrutura do array profile é dinâmica e deve ser definida pelo desenvolvedor.X
CaractereNome da rotina que deverá ser executada


Param01 ao Param26
Parâmetros que serão utilizados na execução da rotina alvo.



 Exemplo:
FWRPC:CallProc( 'U_MinhaRotina', <primeiro_parâmetro_U_MinhaRotina>, <segundo_parâmetro_U_MinhaRotina>)
Podendo receber até 26 Parâmetros onde o tipo do dado deve respeitar o valor esperado na rotina alvo.

Retorno
xResult: indica o retorno que a rotina alvo que foi chamada.
Disconnect

Sintaxe
FWRPC():Disconnect()-> lResult

Descrição
Executa a desconexão com o servidor alvo.


Retorno
lResult retorna verdadeiro (.T.) ao realizar a desconexão.
SetRetryConnect

Sintaxe
FWRPC():SetRetryConnect(<nRetry>
 
SetStringProfile
Sintaxe
FWPROFILE():SetStringProfile(<cProfile >)-> NIL
Descrição
Indica uma string que irá ser gravada como conteúdo do profile.
Parâmetros
NomeTipoDescriçãoDefaultObrigatórioReferênciacProfileCaracteresEstrutura do array profile é dinâmica e deve ser definida pelo desenvolvedor.X 
SetProgram
Sintaxe
FWPROFILE():SetProgram(<cProgram >)-> NIL
Descrição
Indica o programa que está em execução
Obs.: Utilizado como chave na gravação do profile
Parâmetros
NomeTipoDescriçãoDefaultObrigatórioReferênciacProgramCaracteresPrograma que está em execuçãoX 
SetTask
Sintaxe
FWPROFILE():SetTask(<cTask >)-> NIL
Descrição
Indica a tarefa que está em execução
Obs.: Utilizado como chave na gravação do profile
Parâmetros
NomeTipoDescriçãoDefaultObrigatórioReferênciacTaskCaracteresTarefa que está em execuçãoX

Observação
A string enviada é limitada a 10 caracteres

 
SetType
Sintaxe
FWPROFILE():SetType(<cType >)-> NIL

Descrição
Estabelece o número máximo de tentativas de reconexões com os servidores alvo.Indica o tipo de tarefa que está em execução
Obs.: Utilizado como chave na gravação do profile


Parâmetros


NomeTipoDescriçãoDefaultObrigatórioReferência
cType
nRetry
CaracteresTipo da tarefa que está em execuçãoX 
SetUser
NuméricoNúmero de tentativas de reconexão3


SetTimeOut

Sintaxe
FWRPC
Sintaxe
FWPROFILE():SetUserSetTimeOut(<cUser ><nTimeOut>)-> NIL

Descrição
Indica Estabelece o usuário que está configurando a tarefa
Obs.: Utilizado como chave na gravação do profiletempo que será atribuído ao timeout de conexão.


Parâmetros


NomeTipoDescriçãoDefaultObrigatórioReferência
cUser
nTimeOut
CaracteresUsuário que está configurando a tarefaX 
Destroy
Sintaxe
FWPROFILE():Destroy()-> NIL
Descrição
Destroy o objeto e suas referencias a outros objetos.

SetCompany

Sintaxe
FWPROFILE():SetCompany( <cCompany> )-> NILDescrição
Permite indicar o grupo de empresa que será feita a leitura/gravação do profile
Obs.: Disponível na lib 20240226 ou superior
NuméricoIndica o tempo em segundos de time-out para a conexão ser estabelecida. Caso não especificado ( Default = 0 ), o tempo de retorno depende do sistema operacional e da condição de erro encontrada na tentativa de estabelecer a conexão. Por exemplo, no caso do servidor de destino da conexão estar desligado, ou seja colocado um IP que não esteja na rede, a operação de conexão demora de 20 a 30 segundos para retornar uma condição de falha.0

Parâmetros

NomeTipoDescriçãoDefaultObrigatórioReferênciacCompanyCaracteresGrupo de empresas de leitura/gravação no profileX

SetBranch

Sintaxe
FWPROFILE():SetBranch( <cBranch> )-> NIL

Descrição
Permite indicar a filial que será feita a leitura/gravação do profile
Obs.: Disponível na lib 20240226 ou superior

Parâmetros

NomeTipoDescriçãoDefaultObrigatórioReferênciacBranchCaracteresFilial de leitura/gravação no profileX