Documento de API
Produto: | Datasul |
Ocorrência: | Documentação de API |
Nome Físico | crmapi\apiCrmAnexo.p |
Objetivo
Manipulação do arquivo físico do anexo
Tabelas Temporárias
Atributos das tabelas temporárias de entrada e saída:
ttAnexo | [Descrição da tabela] | ||||
Atributo | Tipo | Formato | Descrição | Obr. | |
Num_id | Int |
| Id do Anexo |
| |
Nom_arq | Char |
| Nome do arquivo |
| |
Dsl_arq_docto | Char |
| Caminho completo do arquivo |
| |
Dat_atualiz | Date |
| Data da inserção |
|
Métodos
Métodos básicos
Método: carregarAnexos
Descrição: Carregar os anexos
Requisitos:
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
Idi_tip_anexo | Int |
| X |
|
| Tipo do anexo |
Num_id_reg | Int |
| X |
|
| Registro associado |
ttAnexo | Tt |
|
| X |
| Temp-table de retorno |
Método: veirificaPathAnexo
Descrição: Verifica a exitencia do parâmetro de path no CRM
Requisitos:
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
l-pathOk | Log |
|
| X |
| Path encontrado |
Método: anexaArquivos
Descrição: Anexar o arquivo
Requisitos:
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
Arquivo | Char |
| X |
|
| Nome do arquivo |
Diretório | Char |
| X |
|
| Caminho completo do arquivo |
Idi_tip_anexo | Int |
| X |
|
| Tipo do anexo |
Num_id_reg | Int |
| X |
|
| Registro associado ao anexo |
l-ok | Log |
|
| X |
| Arquivo anexado |
Método: copyFile
Descrição: Faz a copia do arquivo para o diretório indicado
Requisitos:
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
Sourcefilename | Char |
| X |
|
| Arquivo de origem |
Copyfilename | Char |
| X |
|
| Caminho completo de destinno |
Creturn | Char |
|
| X |
| Mensagem de retorno da cópia efetuada |
Método: piCriaCaminho
Descrição: Cria os diretórios fisicamente de acordo com o parâmetro passado
Requisitos:
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
Pcaminho | Char |
| X |
|
| Caminho a ser criado os diretorios |
Método: excluiAnexo
Descrição: Exclui o anexo
Requisitos:
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
Num_id | Int |
| X |
|
| Id do anexo a ser excluído |
Método: excluiArquivo
Descrição: Exclui fisicamente o arquivo do anexo
Requisitos:
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
Filepath | Char |
| X |
|
| Caminho completo do arquivo |
l-ok | Log |
|
| X |
| Retorno da exclusão do arquivo |
Método: visualizarArquivo
Descrição: Visualiza o arquivo do anexo
Requisitos:
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
Filepath | Char |
| X |
|
| Caminho completo do arquivo |
l-ok | Log |
|
| X |
| Retorno da exclusão do arquivo |