SFTPDirLs

Retorna uma lista ( Array ) de arquivos e pastas armazenados em um servidor SFTP, a partir do caminho ( servidor / path ) informados.

Sintaxe

aResult := SFTPDirLs( < sServer >, < sRemotePath >, < sUser >, < sPassword > , [ @sError] )

Parâmetros

Nome	Tipo	Descrição	Obrigatório	Referência
sServer	caractere	Endereço ( nome do host ou IP ) do servidor de SFTP	X
sRemotePath	caractere	Caminho completo do servidor de SFTP a ser verificado.	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

Nome	Tipo	Descrição
aResult	array	Retorna um array de strings, cada elemento corresponde a um arquivo e/ou pasta localizados no caminho informado. Em caso de erro, retorna um número indicando a razão de falha de execução.

Exemplos

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

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

// O exemplo abaixo obtém a lista de arquivos e pastas armazenados no endereço 
// sftp://cloud1.dominio.com/home/user 

aFiles := SFTPDirLS("cloud1.dominio.com", "/home/user","user", "password", @cErrorMsg)

if ( valtype(aFiles) != 'A' )
	Conout("Falha na execução : 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