Os métodos do conector FTP executam várias ações no servidor File Transfer Protocol como parte de uma automação. Para habilitar os métodos, você deve fornecer os parâmetros apropriados.

Definir configuração

Define os detalhes de acesso ao servidor File Transfer Protocol. Você deve executar este método primeiro.

Para fornecer entradas para os parâmetros, consulte Configurar propriedades da porta.

Tabela 1. Parâmetros do método SetConfiguration

Parâmetro	Descrição	Tipo de porta de dados	Tipo de dados	Valor-padrão	Obrigatório?	Anotações
URL	URL do File Transfer Protocol	Dados em	Cadeia de caracteres	Nenhum	Sim
Nome do usuário	Nome de usuário para acessar o servidor File Transfer Protocol.	Dados em	Cadeia de caracteres	Nenhum	Sim
Senha	Senha para acessar o servidor File Transfer Protocol.	Dados em	Cadeia de caracteres	Nenhum	Sim

Criar Pasta

Cria uma pasta no servidor File Transfer Protocol.

Para fornecer entradas para os parâmetros, consulte Configurar propriedades da porta.

Tabela 2. Parâmetros do método CreateFolder

Parâmetro	Descrição	Tipo de porta de dados	Tipo de dados	Valor-padrão	Obrigatório?	Anotações
Nome da Pasta	Caminho no servidor File Transfer Protocol em que a pasta será criada com o nome da pasta.	Dados em	Cadeia de caracteres	Nenhum	Sim
Retornar	Retorna Verdadeiro se a pasta for criada, caso contrário, retorna Falso.	Dados esgotados	Booleano	Nenhum	Não aplicável

Excluir arquivo

Exclui um arquivo no servidor FTP.

Para fornecer entradas para os parâmetros, consulte Configurar propriedades da porta.

Tabela 3. Parâmetros do método DeleteFile

Parâmetro	Descrição	Tipo de porta de dados	Tipo de dados	Valor-padrão	Obrigatório?	Anotações
RemoteFilePath	Caminho para o arquivo que você deseja remover no servidor File Transfer Protocol.	Dados em	Cadeia de caracteres	Nenhum	Sim
Retornar	Retorna Verdadeiro se o arquivo for excluído, caso contrário, retorna Falso.	Dados esgotados	Booleano	Não aplicável	Não aplicável

Excluir pasta

Exclui a pasta especificada no servidor File Transfer Protocol.

Para fornecer entradas para os parâmetros, consulte Configurar propriedades da porta.

Tabela 4. Parâmetros do método DeleteFolder

Parâmetro	Descrição	Tipo de porta de dados	Tipo de dados	Valor-padrão	Obrigatório?	Anotações
RemoteFolderPath	Caminho para a pasta no servidor File Transfer Protocol, incluindo o nome da pasta.	Dados em	Cadeia de caracteres	Nenhum	Sim
Retornar	Retorna Verdadeiro se a pasta for excluída, caso contrário, retorna Falso.	Dados esgotados	Booleano	Não aplicável	Não aplicável

DownloadArquivo

Baixa um arquivo do servidor File Transfer Protocol para a unidade local.

Para fornecer entradas para os parâmetros, consulte Configurar propriedades da porta.

Tabela 5. Parâmetros do método DownloadFile

Parâmetro	Descrição	Tipo de porta de dados	Tipo de dados	Valor-padrão	Obrigatório?	Anotações
ArquivoRemoto	Caminho para o arquivo no File Transfer Protocol e o nome do arquivo.	Dados em	Cadeia de caracteres	Nenhum	Sim
LocalFile	Caminho na unidade local de onde o arquivo será baixado.	Dados em	Cadeia de caracteres	Nenhum	Sim
Tempo Limite	Tempo após o qual a solicitação para o servidor File Transfer Protocol expira.	Dados em	Inteiro	Nenhum	Não
Retornar	Retorna Verdadeiro se o arquivo for baixado, caso contrário, retorna Falso.	Dados esgotados	Booleano	Nenhum	Não aplicável

DownloadFolder

Baixa uma pasta do servidor File Transfer Protocol para a unidade local.

Para fornecer entradas para os parâmetros, consulte Configurar propriedades da porta.

Tabela 6. Parâmetros do método DownloadFolder

Parâmetro	Descrição	Tipo de porta de dados	Tipo de dados	Valor-padrão	Obrigatório?	Anotações
RemoteFolderPath	Caminho para a pasta no File Transfer Protocol e o nome da pasta.	Dados em	Cadeia de caracteres	Nenhum	Sim
LocalFolderPath	Caminho na unidade local de onde a pasta será baixada.	Dados em	Cadeia de caracteres	Nenhum	Sim
Tempo Limite	Tempo após o qual a solicitação para o servidor File Transfer Protocol expira.	Dados em	Inteiro	Nenhum	Não
Retornar	Retorna Verdadeiro se a pasta for baixada, caso contrário, retorna Falso.	Dados esgotados	Booleano	Nenhum	Não aplicável

ObterLista de arquivos

Retorna a lista de arquivos em uma pasta no servidor File Transfer Protocol.

Para fornecer entradas para os parâmetros, consulte Configurar propriedades da porta.

Tabela 7. Parâmetros do método GetFileList

Parâmetro	Descrição	Tipo de porta de dados	Tipo de dados	Valor-padrão	Obrigatório?	Anotações
RemoteFolderPath	Caminho para a pasta no File Transfer Protocol e o nome da pasta.	Dados em	Cadeia de caracteres	Nenhum	Sim
Retornar	Retorna a lista de arquivos na pasta.	Dados esgotados	Cadeia de caracteres	Não aplicável	Não aplicável

Renomear arquivo

Renomeia um arquivo no servidor File Transfer Protocol.

Para fornecer entradas para os parâmetros, consulte Configurar propriedades da porta.

Tabela 8. Parâmetros do método RenameFile

Parâmetro	Descrição	Tipo de porta de dados	Tipo de dados	Valor-padrão	Obrigatório?	Anotações
RemoteFilePath	Caminho para o arquivo no servidor File Transfer Protocol e o nome do arquivo.	Dados em	Cadeia de caracteres	Nenhum	Sim
NewNameofFile	Caminho para o arquivo no servidor File Transfer Protocol e o novo nome do arquivo.	Dados em	Cadeia de caracteres	Nenhum	Sim
Retornar	Retorna Verdadeiro se o nome do arquivo for alterado, caso contrário, retorna Falso.	Dados esgotados	Booleano	Não aplicável	Não aplicável

Renomear Pasta

Renomeia uma pasta no servidor File Transfer Protocol.

Para fornecer entradas para os parâmetros, consulte Configurar propriedades da porta.

Tabela 9. Parâmetros do método RenameFolder

Parâmetro	Descrição	Tipo de porta de dados	Tipo de dados	Valor-padrão	Obrigatório?	Anotações
Pastaremota	Caminho para a pasta no servidor File Transfer Protocol e o nome da pasta.	Dados em	Cadeia de caracteres	Nenhum	Sim
NewNameofFolder	Caminho para a pasta no servidor File Transfer Protocol e o novo nome da pasta.	Dados em	Cadeia de caracteres	Nenhum	Sim
Retornar	Retorna Verdadeiro se o nome da pasta for alterado, caso contrário, retorna Falso.	Dados esgotados	Booleano	Não aplicável	Não aplicável

Carregar arquivo

Carrega um arquivo da unidade local para o servidor File Transfer Protocol.

Para fornecer entradas para os parâmetros, consulte Configurar propriedades da porta.

Tabela 10. Parâmetros do método UploadFile

Parâmetro	Descrição	Tipo de porta de dados	Tipo de dados	Valor-padrão	Obrigatório?	Anotações
LocalFilePath	Caminho para o arquivo na unidade local.	Dados em	Cadeia de caracteres	Nenhum	Sim
RemoteFilePath	Caminho para o local no servidor File Transfer Protocol.	Dados em	Cadeia de caracteres	Nenhum	Sim
Retornar	Retorna Verdadeiro se o arquivo for carregado, caso contrário, retorna Falso.	Dados esgotados	Booleano	Não aplicável	Não aplicável

Carregar pasta

Carrega uma pasta da unidade local para o servidor File Transfer Protocol.

Para fornecer entradas para os parâmetros, consulte Configurar propriedades da porta.

Tabela 11. Parâmetros do método UploadFolder

Parâmetro	Descrição	Tipo de porta de dados	Tipo de dados	Valor-padrão	Obrigatório?	Anotações
LocalFolderPath	Caminho para a pasta na unidade local.	Dados em	Cadeia de caracteres	Nenhum	Sim
RemoteFolderPath	Caminho para o local no servidor File Transfer Protocol.	Dados em	Cadeia de caracteres	Nenhum	Sim
Retornar	Retorna Verdadeiro se a pasta for carregada, caso contrário, retorna Falso.	Dados esgotados	Booleano	Não aplicável	Não aplicável