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

SFTPDwld1( < sFileName >, < sRemotePath >, < sServer >, < sUser >, < sPassword > )

Parâmetros

Nome	Tipo	Descrição	Obrigatório
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

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

Retorno

Nome	Tipo	Descrição
nResult	numérico	0 = Sucesso \| Quanquer retorno diferente de zero indica falha na operação

Exemplos

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

user function exemplo()

// 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", "passwaord")

if ( nStatus != 0 )
	Conout("Não foi possível transferir o arquivo - Erro "+cvaltochar(nStatus))
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