Manuais:UniDANFE/Integrando o UniDANFE ao ERP/MetodosDLL
Métodos da DLL dfe.dll
Essa é a forma mais elegante que os sistemas ERP usarão para gerar o Documento Auxiliar.
A DLL dfe.dll do UniDANFE deve ser linkada ao sistema ERP, que fará a integração utilizando o conjunto de métodos disponíveis na biblioteca.
Método | Parâmetros | Descrição | Exemplos | Retorno |
---|---|---|---|---|
DFEINIT | (STRING Ação)
Ação: sempre "dfe" |
Inicializa a geração do documento auxiliar | dfeInit("dfe") | |
DFESETPARAMETRO | (STRING Parâmetro, STRING Valor)
Parâmetro: nome ou abreviação do parâmetro a ser passado ao UniDANFE. Idênticos aos usados na integração via chamadas (RUN) ao UniDANFE.exe. NOTA: todos os parâmetros devem ser escritos em sua forma completa e não na forma abreviada. Valor: valor do parâmetro |
Passa os parâmetros de geração, impressão e distribuição do DFE.
Deve-se escrever uma chamada à esse método para cada parâmetro a ser enviado. |
dfeSetParametro("arquivo", "c:\Unimake\Uninfe\0101010101010101010101-procNFe.xml")
dfeSetParametro("imprimir", "0") dfeSetParametro("copias", "2") dfeSetParametro("email", "[email protected]") |
|
DFEEXECUTA | Executa a ação, gerando o DFE.
Esse método deve ser chamado após a passagem de todos os parâmetros. |
dfeSetParametro('arquivo', 'meuarquivo.xml')
dfeExecuta() |
||
DFEGETERRO | Retorna o erro ocorrido na geração, ou em branco se tudo correu bem.
Nota: se não for possível ler o retorno desse método, utilizar a forma de leitura de erros em arquivo. Para isso, enviar os parâmetros: dfeSetParametro("saidaerros", "A") -> desvia a saída de erros para arquivo dfeSetParametro("arquivoerro", arquivo) -> define o arquivo que de erros que deverá ser criado. |
dfeExecuta()
IF dfeGetErro() = "" MESSAGE("O documento auxiliar foi gerado com sucesso!") ELSE MESSAGE(dfeGetErro()) END |
STRING
| |
DFEKILL | Finaliza a geração do documento auxiliar, liberando a memória utilizada. | dfeKill() |
|
Exemplo:
dfeInit("dfe") dfeSetParametro("arquivo", "c:\Unimake\Uninfe\0101010101010101010101-procNFe.xml") dfeSetParametro("imprimir", "0") dfeSetParametro("copias", "2") dfeSetParametro("email", "[email protected]") dfeExecuta() IF dfeGetErro() = "" MESSAGE("O documento auxiliar foi gerado com sucesso!") ELSE MESSAGE(dfeGetErro()) END dfeKill()
Alguns parâmetros usando BSTRING no lugar de STRING. Utilizado em algumas linguagens que não conseguem enviar o tipo STRING.
Método | Parâmetros | Descrição | Exemplos | Retorno |
---|---|---|---|---|
DFEINITB | (BSTRING Ação) | Idêntico ao método DFEINIT(). | dfeInitB("dfe") | |
DFESETPARAMETROB | (BSTRING Parâmetro, BSTRING Valor) | Idêntico ao método DFESETPARAMETRO(). | dfeSetParametroB("arquivo", "c:\Unimake\Uninfe\010101010101-procNFe.xml") |