Documento de API
Produto: | Datasul |
Ocorrência: | Documentação de API |
Nome Físico | prghur/fpp/fpapi046.p |
Objetivo
Retornar as funções cadastradas.
Funcionamento
A API fpapi046 deve ser executada de forma persistente.
Sintaxe para executar a API em modo persistente:
run prghur/fpp/fpapi046.p persistent set h-handle.
A variável denominada h-handle irá receber o “handle” do programa, permitindo o acesso aos “métodos” internos da API.
Tabelas Temporárias
Nos atributos das tabelas temporárias de entrada e saída:
Tabela Temporária | Descrição | Entrada/Saída |
tt-Funcao | Contém as funções cadastradas na base de dados | Saída |
Atributo | Tipo | Formato | Descrição | Obrigatório | Evolução |
cdnFuncao | Inteiro | >>,>>9 | Código da função | Sim | 2.10 |
desFuncao | Caracter | x(36) | Descrição da função | Sim | 2.10 |
Tabela Temporária | Descrição | Entrada/Saída |
tt-erro | Contém código e descrição do erro | Saída |
Atributo | Tipo | Formato | Descrição | Obrigatório | Evolução |
Code | Inteiro | Zz9 | Código do erro | Sim | 2.10 |
Description | Caracter | X(60) | Descrição do erro | Sim | 2.10 |
Métodos
Quando a API/BO for executada em modo persistente, os seguintes métodos estarão disponíveis para execução:
Método Básico
procedure piFuncao
Requisito | Inexistente. | |
Sintaxe | run procedure piFuncao in h-handle (output table tt-Funcao, output table tt-erro). | |
Descrição | O método retornará os motivos de estabilidade. | |
| Parâmetros | Descrição |
| tt-Funcao tt-erro | Temp-table com as funções cadastradas Erros do processo. |
Retorno | Temp-tables tt-Funcao e tt-erro populadas. As mensagens possíveis para este método são: "Não existem funções cadastradas!" |
Método Negócio