SFTPDwld1

Faz o download de um arquivo via protocolo SFTP para o Totvs Application Server, utilizando autenticação SFTP por usuário e senha.

Sintaxe

 nStatus := SFTPDwld1( < sFileName >, < sRemotePath >, < sServer >, < sUser >, < sPassword > , [ @sError] )

Parâmetros

Nome	Tipo	Descrição	Obrigatório	Referência
sFileName	caractere	Nome do arquivo a ser criado pelo download. ()**	X
sRemotePath	caractere	Nome do arquivo – caminho completo – a ser baixado do servidor de SFTP	X
sServer	caractere	Endereço ( nome do host ou IP ) do servidor de SFTP	X
sUser	caractere	Nome do usuário SFTP para autenticação	X
sPassword	caractere	Senha do usuário SFTP para autenticação	X
sError	caractere	Obtém por referência uma string contendo detalhes em caso de falha na execução da função		X

(**) O nome do arquivo segue o padrão de arquivos a partir do ROOTPATH do ambiente em uso no Totvs Application Server.

Retorno

Tipo	Código de Status	Descrição do Status
numérico	0	Sucesso na operação
numérico	-1111	Caminho de arquivo inválido
numérico	-1112	Falha ao abrir o arquivo
numérico	79	Erro na camada SSH
numérico	82	O servidor rejeitou a chave pública fornecida
numérico	83	Chave de host inválida
numérico	84	Nome de usuário ou senha inválidos
numérico	85	Falha ao inicializar o SSH
numérico	86	Erro ao ler o arquivo local para upload SFTP
numérico	87	Erro SSH geral
numérico	88	Falha ao carregar uma biblioteca libcurve necessária
numérico	89	Erro com o arquivo de hosts conhecidos
numérico	90	Erro do agente SSH
numérico	91	A chave pública do host remoto não foi encontrada
numérico	92	A conexão com o host remoto foi negada
numérico	93	Ocorreu um erro de protocolo SSH
numérico	94	Caminho de arquivo inválido para operação SFTP
numérico	96	Autoridade de certificação desconhecida no SSH
numérico	101	O acesso ao recurso remoto foi negado
numérico	102	A chave pública fornecida para autenticação não foi verificada

Exemplos

Exemplo de implementação do download de arquivo utilizando autenticação por usuário e senha.

user function exemplo()
local nStatus, cErrorMsg := ''

// O exemplo abaixo faz download do arquivo "meufile.txt", localizado no servidor de sftp "cloud1.dominio.com"
// no caminho "/home/user/", criando o arquivo "meuarquivo.txt" na pasta "\downloads\" 
// a partir do RootPath do ambiente do TOTVS Application Server em uso .

nStatus := SFTPDwld1("\downloads\meuarquivo.txt", "/home/user/meufile.txt", "cloud1.dominio.com", "user", "password", @cErrorMsg)

if ( nStatus != 0 )
	Conout("Não foi possível transferir o arquivo : Erro "+cErrorMsg)
endif

return

Abrangência

Função disponível, na linguagem TLPP, para build superior a 19.3.1.7.

IMPORTANTE: Utilizar preferencialmente na linguagem TLPP pois o suporte desta função no AdvPL está sendo descontinuado.

Árvore de páginas