Métodos de conector FTP

  • Versão de lançamento: Zurich
  • Atualizado 31 de jul. de 2025
  • 5 min. de leitura

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

    SetConfiguration

    Define o. File Transfer Protocol detalhes de acesso ao servidor. Primeiro, você deve executar este método.

    Para fornecer entradas para os parâmetros, consulte Configure as 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?
    URL URL do File Transfer Protocol Dados em Cadeia de caracteres Nenhum(a) Sim
    Nome do usuário Nome de usuário para acessar File Transfer Protocol servidor. Dados em Cadeia de caracteres Nenhum(a) Sim
    Senha Senha para acessar File Transfer Protocol servidor. Dados em Cadeia de caracteres Nenhum(a) Sim

    CreateFolder

    Cria uma pasta no File Transfer Protocol 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?
    FolderName Caminho no File Transfer Protocol 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, retornará Falso. Saída de dados Booliano Nenhum(a) Não aplicável

    ExcluteFile

    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?
    RemoteFilePath Caminho para o arquivo que você deseja remover no File Transfer Protocol servidor. Dados em Cadeia de caracteres Nenhum(a) Sim
    Retornar Retorna Verdadeiro se o arquivo for excluído, caso contrário, retornará Falso. Saída de dados Booliano Não aplicável Não aplicável

    ExcluirPasta

    Exclui a pasta especificada em File Transfer Protocol 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 File Transfer Protocol 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, retornará Falso. Saída de dados Booliano Não aplicável Não aplicável

    BaixarArquivo

    Baixa um arquivo do File Transfer Protocol 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 File Transfer Protocol e o nome do arquivo. Dados em Cadeia de caracteres Nenhum(a) Sim
    LocalFile Caminho na unidade local para onde o arquivo será baixado. Dados em Cadeia de caracteres Nenhum(a) Sim
    Tempo limite Tempo após o qual a solicitação para File Transfer Protocol tempo limite do servidor. Dados em Inteiro Nenhum(a) Não
    Retornar Retorna Verdadeiro se o arquivo for baixado, caso contrário, retornará Falso. Saída de dados Booliano Nenhum(a) Não aplicável

    BaixarPasta

    Baixa uma pasta do File Transfer Protocol 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 File Transfer Protocol e o nome da pasta. Dados em Cadeia de caracteres Nenhum(a) Sim
    LocalFolderPath Caminho na unidade local para onde a pasta será baixada. Dados em Cadeia de caracteres Nenhum(a) Sim
    Tempo limite Tempo após o qual a solicitação para File Transfer Protocol tempo limite do servidor. Dados em Inteiro Nenhum(a) Não
    Retornar Retorna Verdadeiro se a pasta for baixada, caso contrário, retornará Falso. Saída de dados Booliano Nenhum(a) Não aplicável

    GetFileList

    Retorna a lista de arquivos em uma pasta no File Transfer Protocol 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 File Transfer Protocol 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

    RenameFile

    Renomeia um arquivo no File Transfer Protocol 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?
    RemoteFilePath Caminho para o arquivo no File Transfer Protocol e o nome do arquivo. Dados em Cadeia de caracteres Nenhum(a) Sim
    NewNameofFile Caminho para o arquivo no File Transfer Protocol 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

    RenameFolder

    Renomeia uma pasta no File Transfer Protocol servidor.

    Para fornecer entradas para os parâmetros, consulte Configure as 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?
    Pasta remota Caminho para a pasta no File Transfer Protocol e o nome da pasta. Dados em Cadeia de caracteres Nenhum(a) Sim
    NewNomeDoPasta Caminho para a pasta no File Transfer Protocol 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 File Transfer Protocol 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
    RemoteFilePath Caminho para o local no File Transfer Protocol servidor. Dados em Cadeia de caracteres Nenhum(a) Sim
    Retornar Retorna Verdadeiro se o arquivo for carregado, caso contrário, retornará Falso. Saída de dados Booliano Não aplicável Não aplicável

    UploadFolder

    Carrega uma pasta da unidade local para File Transfer Protocol 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 File Transfer Protocol servidor. Dados em Cadeia de caracteres Nenhum(a) Sim
    Retornar Retorna Verdadeiro se a pasta for carregada, caso contrário, retornará Falso. Saída de dados Booliano Não aplicável Não aplicável