Métodos do conector FTP

  • Versão de lançamento: Yokohama
  • Atualizado 30 de jan. de 2025
  • 5 min. de leitura

    • 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 parâmetros apropriados.

    Definir configuração

    Define os File Transfer Protocol detalhes de acesso ao servidor. 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?
    URL URL do File Transfer Protocol Dados em Cadeia de caracteres Nenhum(a) Sim
    Nome do usuário Nome de usuário para acessar o servidor File Transfer Protocol. Dados em Cadeia de caracteres Nenhum(a) Sim
    Senha Senha para acessar o servidor File Transfer Protocol. Dados em Cadeia de caracteres Nenhum(a) Sim

    CriarPasta

    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?
    FolderName Caminho no servidor File Transfer Protocol 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 foi criada, caso contrário, retorna falso. Saída de dados Booliano Nenhum(a) 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?
    RemoteFilePath Caminho para o arquivo que você deseja remover no servidor File Transfer Protocol. 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

    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?
    RemoteFolderPath Caminho para a pasta no servidor File Transfer Protocol, 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

    Baixar arquivo

    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?
    ArquivoRemoto 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 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 o servidor File Transfer Protocol expira. Dados em Números inteiros 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

    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?
    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 em que a pasta será baixada. Dados em Cadeia de caracteres Nenhum(a) Sim
    Tempo limite Tempo após o qual a solicitação para o servidor File Transfer Protocol expira. Dados em Números inteiros 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

    ObterListaDeArquivos

    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?
    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

    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?
    RemoteFilePath Caminho para o arquivo no servidor File Transfer Protocol e o nome do arquivo. Dados em Cadeia de caracteres Nenhum(a) Sim
    NewNameofFile Caminho para o arquivo no servidor 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, retorna falso. Saída de dados Booliano Não aplicável Não aplicável

    RenomearPasta

    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?
    PastaRemota Caminho para a pasta no servidor File Transfer Protocol e o nome da pasta. Dados em Cadeia de caracteres Nenhum(a) Sim
    NewNameofFolder Caminho para a pasta no servidor 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, retorna falso. Saída de dados Booliano 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?
    LocalFilePath Caminho para o arquivo na unidade local. Dados em Cadeia de caracteres Nenhum(a) Sim
    RemoteFilePath Caminho para o local no servidor File Transfer Protocol. 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

    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?
    LocalFolderPath Caminho para a pasta na unidade local. Dados em Cadeia de caracteres Nenhum(a) Sim
    RemoteFolderPath Caminho para o local no servidor File Transfer Protocol. 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