| 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()-> 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.)
Load
Sintaxe
FWPROFILE():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
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 |
| lByEmpFil | 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 |
|
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ção
Obs.: 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ção
Obs.: 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
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 |
| cType | Caracteres | Tipo da tarefa que está em execução |
| X |
|
SetUser
Sintaxe
FWPROFILE():SetUser(<cUser >)-> NIL
Descrição
Indica o usuário que está configurando a tarefa
Obs.: Utilizado como chave na gravação do profile
Parâmetros
| Nome | Tipo | Descrição | Default | Obrigatório | Referência |
| cUser | Caracteres | 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> )-> NIL
Descrição
Permite indicar o grupo de empresa que será feita a leitura/gravação do profileObs.: Disponível na lib 20240226 ou superior
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 |
|