Produto: | Datasul |
Ocorrência: | Documentação de API |
| Nome Físico | crmapi\apiCrmEtiq.p |
Gerar etiqueta.
Atributos das tabelas temporárias de entrada e saída:
tt-etiq | [Descrição da tabela] | |||
Atributo | Tipo | Formato | Descrição | Obr. |
num_etiq | Int |
| Número da etiqueta |
|
num_id_pessoa | Int |
| Código de Pessoa |
|
idi_linha | Int |
| Número da linha |
|
idi_coluna | Int |
| Número da coluna na linha |
|
des_campo | Char |
| Descrição |
|
valor | Char |
| Valor |
|
tt-erro | [Descrição da tabela] | |||
Atributo | Tipo | Formato | Descrição | Obr. |
titulo |
|
| Título do erro |
|
msg |
|
| Descrição do erro |
|
Métodos básicos
Método: createEtiq.
Descrição: Método que cria a etiqueta.
Requisitos: Nenhum.
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
pi-public | Char |
| X |
|
| Código do público |
pi-etiq | Char |
| X |
|
| Código da etiqueta |
c-msgErro | Char |
|
| X |
| Retorno de erro |
Método: criaPdf.
Descrição: Método que cria o pdf.
Requisitos: Nenhum.
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
ttEtiq | tt |
| X |
|
| Temp-table com os campos da etiqueta |
ttErro | tt |
|
| X |
| Retorno de erro |
Método: showCurrentUser.
Descrição: Retorna o usuário logado.
Requisitos: Nenhum.
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
i-user | Int |
|
| X |
| Retorno com o código de usuário |
Método: returnLogPadrao.
Descrição: Retorna o código da etiqueta padrão.
Requisitos: Nenhum.
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
c-numId | Char |
|
| X |
| Retorna o código da etiqueta padrão |
Método: returnError.
Descrição: Retorna os erros que houveram na criação da etiqueta.
Requisitos: Nenhum.
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
i-numIdEtiq | Int |
| X |
|
| Código da etiqueta |
ttErro | tt |
|
| X |
| Retorno de erros |
Método: ValidIncludeFieldMessage.
Descrição: Valida se pode incluir o campo mensagem no atributo da etiqueta.
Requisitos: Nenhum.
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
numId | Int |
| X |
|
| Código da etiqueta |
numIdPai | Int |
| X |
|
| Código da etiqueta |
pl-incluir | Log |
|
| X |
| Retorno |
