Métodos de conector de FTP

  • Versão de lançamento: Australia
  • Atualizado 12 de mar. de 2026
  • 5 min. de leitura

    • Os métodos do conector de FTP executam várias ações no Protocolo de transferência de arquivo (FTP) servidor como parte de uma automação. Para habilitar os métodos, você deve fornecer os parâmetros apropriados.

    Definir Configuração

    Define o. Protocolo de transferência de arquivo (FTP) detalhes de acesso ao servidor. Você deve executar este método primeiro.

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

    Tabela 1. Definir parâmetros do método Configuration
    Parâmetro Descrição Tipo de porta de dados Tipo de dados Valor padrão Obrigatório?
    URL URL do Protocolo de transferência de arquivo (FTP) Dados em Cadeia de caracteres Nenhum(a) Sim
    Nome do usuário Nome de usuário para acessar o. Protocolo de transferência de arquivo (FTP) servidor. Dados em Cadeia de caracteres Nenhum(a) Sim
    Senha Senha para acessar o. Protocolo de transferência de arquivo (FTP) servidor. Dados em Cadeia de caracteres Nenhum(a) Sim

    Criar Pasta

    Cria uma pasta no Protocolo de transferência de arquivo (FTP) servidor.

    Para fornecer entradas para os parâmetros, consulte Configure as 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?
    NomePasta Caminho no Protocolo de transferência de arquivo (FTP) servidor em que a pasta será criada com o nome da pasta. Dados em Cadeia de caracteres Nenhum(a) Sim
    Retornar Retorna Verdadeiro se a pasta for criada, caso contrário, retorna Falso. Saída de dados Booliano Nenhum(a) Não aplicável

    Arquivo excluído

    Exclui um arquivo no servidor FTP.

    Para fornecer entradas para os parâmetros, consulte Configure as 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?
    FilePath remoto Caminho para o arquivo que você deseja remover no Protocolo de transferência de arquivo (FTP) servidor. Dados em Cadeia de caracteres Nenhum(a) Sim
    Retornar Retorna Verdadeiro se o arquivo for excluído, caso contrário, retorna Falso. Saída de dados Booliano Não aplicável Não aplicável

    ExcluirPasta

    Exclui a pasta especificada no Protocolo de transferência de arquivo (FTP) servidor.

    Para fornecer entradas para os parâmetros, consulte Configure as 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?
    RemoteFolderPath Caminho para a pasta no Protocolo de transferência de arquivo (FTP) servidor, incluindo o nome da pasta. Dados em Cadeia de caracteres Nenhum(a) Sim
    Retornar Retorna Verdadeiro se a pasta for excluída, caso contrário, retorna Falso. Saída de dados Booliano Não aplicável Não aplicável

    Download de arquivo

    Baixa um arquivo do Protocolo de transferência de arquivo (FTP) servidor para a unidade local.

    Para fornecer entradas para os parâmetros, consulte Configure as 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?
    Arquivo remoto Caminho para o arquivo no Protocolo de transferência de arquivo (FTP) e o nome do arquivo. Dados em Cadeia de caracteres Nenhum(a) Sim
    Arquivo local Caminho na unidade local em que o arquivo será baixado. Dados em Cadeia de caracteres Nenhum(a) Sim
    Tempo limite Tempo após o qual a solicitação para Protocolo de transferência de arquivo (FTP) tempo limite do servidor. Dados em Inteiro Nenhum(a) Não
    Retornar Retorna Verdadeiro se o arquivo for baixado, caso contrário, retorna Falso. Saída de dados Booliano Nenhum(a) Não aplicável

    BaixarPasta

    Baixa uma pasta do Protocolo de transferência de arquivo (FTP) servidor para a unidade local.

    Para fornecer entradas para os parâmetros, consulte Configure as 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?
    RemoteFolderPath Caminho para a pasta no Protocolo de transferência de arquivo (FTP) e o nome da pasta. Dados em Cadeia de caracteres Nenhum(a) Sim
    LocalFolderPath Caminho na unidade local onde a pasta será baixada. Dados em Cadeia de caracteres Nenhum(a) Sim
    Tempo limite Tempo após o qual a solicitação para Protocolo de transferência de arquivo (FTP) tempo limite do servidor. Dados em Inteiro Nenhum(a) Não
    Retornar Retorna Verdadeiro se a pasta for baixada, caso contrário, retorna Falso. Saída de dados Booliano Nenhum(a) Não aplicável

    GetFileList

    Retorna a lista de arquivos em uma pasta no Protocolo de transferência de arquivo (FTP) servidor.

    Para fornecer entradas para os parâmetros, consulte Configure as 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?
    RemoteFolderPath Caminho para a pasta no Protocolo de transferência de arquivo (FTP) e o nome da pasta. Dados em Cadeia de caracteres Nenhum(a) Sim
    Retornar Retorna a lista de arquivos na pasta. Saída de dados Cadeia de caracteres Não aplicável Não aplicável

    RenomeArquivo

    Renomeia um arquivo no Protocolo de transferência de arquivo (FTP) servidor.

    Para fornecer entradas para os parâmetros, consulte Configure as 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?
    FilePath remoto Caminho para o arquivo no Protocolo de transferência de arquivo (FTP) e o nome do arquivo. Dados em Cadeia de caracteres Nenhum(a) Sim
    NomedoArquivo Caminho para o arquivo no Protocolo de transferência de arquivo (FTP) e o novo nome do arquivo. Dados em Cadeia de caracteres Nenhum(a) Sim
    Retornar Retorna Verdadeiro se o nome do arquivo for alterado, caso contrário, retornará Falso. Saída de dados Booliano Não aplicável Não aplicável

    RenomePasta

    Renomeia uma pasta no Protocolo de transferência de arquivo (FTP) servidor.

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

    Tabela 9. RenameFolder parâmetros do método
    Parâmetro Descrição Tipo de porta de dados Tipo de dados Valor padrão Obrigatório?
    Pasta remota Caminho para a pasta no Protocolo de transferência de arquivo (FTP) e o nome da pasta. Dados em Cadeia de caracteres Nenhum(a) Sim
    NomedoPasta Caminho para a pasta no Protocolo de transferência de arquivo (FTP) e o novo nome da pasta. Dados em Cadeia de caracteres Nenhum(a) Sim
    Retornar Retorna Verdadeiro se o nome da pasta for alterado, caso contrário, retornará Falso. Saída de dados Booliano Não aplicável Não aplicável

    UploadFile

    Carrega um arquivo da unidade local para Protocolo de transferência de arquivo (FTP) servidor.

    Para fornecer entradas para os parâmetros, consulte Configure as 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?
    LocalFilePath Caminho para o arquivo na unidade local. Dados em Cadeia de caracteres Nenhum(a) Sim
    FilePath remoto Caminho para o local no Protocolo de transferência de arquivo (FTP) servidor. Dados em Cadeia de caracteres Nenhum(a) Sim
    Retornar Retorna Verdadeiro se o arquivo for carregado, caso contrário, retorna Falso. Saída de dados Booliano Não aplicável Não aplicável

    UploadFolder

    Carrega uma pasta da unidade local para Protocolo de transferência de arquivo (FTP) servidor.

    Para fornecer entradas para os parâmetros, consulte Configure as 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?
    LocalFolderPath Caminho para a pasta na unidade local. Dados em Cadeia de caracteres Nenhum(a) Sim
    RemoteFolderPath Caminho para o local no Protocolo de transferência de arquivo (FTP) servidor. Dados em Cadeia de caracteres Nenhum(a) Sim
    Retornar Retorna Verdadeiro se a pasta for carregada, caso contrário, retorna Falso. Saída de dados Booliano Não aplicável Não aplicável