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ão | 1.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
Descrição
Método construtor da classe.
Retorno
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
Nome | Tipo | Descrição | Default | Obrigatório | Referência |
cEmp | Caractere | Código da empresa |
|
|
|
cFil | Caractere | Código da filial |
|
|
|
cModulo | Caractere | Código do modulo |
|
|
|
aTabelas | Array | Array de string com a relação de alias das tabelas que deverão ser abertas |
|
|
|
cFunName | Caractere | Estabelece 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
Nome | Tipo | Descrição | Default | Obrigatório | Referência |
lByEmpFil | Lógico | Define 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
Nome | Tipo | Descrição | Default | Obrigatório | Referência |
lByEmpFilcRotina | Lógico | Define 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
Nome | Tipo | Descrição | Default | Obrigatório | Referência |
lByEmpFil | Lógico | Define 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
Nome | Tipo | Descrição | Default | Obrigatório | Referência |
lByEmpFil | Lógico | Define 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
Nome | Tipo | Descrição | Default | Obrigatório | Referência |
aProfile | Array | Estrutura do array profile é dinâmica e deve ser definida pelo desenvolvedor. | X | Caractere | Nome 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
Nome | Tipo | Descrição | Default | Obrigatório | Referência |
cProfile | Caracteres | Estrutura 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çãoObs.: Utilizado como chave na gravação do profile Parâmetros
Nome | Tipo | Descrição | Default | Obrigatório | Referência |
cProgram | Caracteres | Programa que está em execução | X | SetTask
Sintaxe
FWPROFILE():SetTask(<cTask >)-> NIL
Descrição
Indica a tarefa que está em execuçãoObs.: Utilizado como chave na gravação do profile Parâmetros
Nome | Tipo | Descrição | Default | Obrigatório | Referência |
cTask | Caracteres | Tarefa que está em execução | X | 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
Nome | Tipo | Descrição | Default | Obrigatório | Referência |
cTypeCaracteres | Tipo da tarefa que está em execução | X | SetUser
Numérico | Número de tentativas de reconexão | 3 |
|
|
SetTimeOut
Sintaxe
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
Nome | Tipo | Descrição | Default | Obrigatório | Referência |
cUserCaracteres | Usuário que está configurando a tarefa | X | 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 profileObs.: Disponível na lib 20240226 ou superior
Numérico | Indica 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
Nome | Tipo | Descrição | Default | Obrigatório | Referência |
cCompany | Caracteres | Grupo de empresas de leitura/gravação no profile | X | 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
Nome | Tipo | Descrição | Default | Obrigatório | Referência |
cBranch | Caracteres | Filial de leitura/gravação no profile | X