Função FtpGetFileW (wininet.h)
Recupera um arquivo do servidor FTP e o armazena sob o nome de arquivo especificado, criando um novo arquivo local no processo.
Sintaxe
BOOL FtpGetFileW(
[in] HINTERNET hConnect,
[in] LPCWSTR lpszRemoteFile,
[in] LPCWSTR lpszNewFile,
[in] BOOL fFailIfExists,
[in] DWORD dwFlagsAndAttributes,
[in] DWORD dwFlags,
[in] DWORD_PTR dwContext
);
Parâmetros
[in] hConnect
Manipule para uma sessão FTP.
[in] lpszRemoteFile
Ponteiro para uma cadeia de caracteres terminada em nulo que contém o nome do arquivo a ser recuperado.
[in] lpszNewFile
Ponteiro para uma cadeia de caracteres terminada em nulo que contém o nome do arquivo a ser criado no sistema local.
[in] fFailIfExists
Indica se a função deve continuar se já existir um arquivo local do nome especificado. Se fFailIfExists for TRUE e o arquivo local existir, FtpGetFile falhará.
[in] dwFlagsAndAttributes
Atributos de arquivo para o novo arquivo. Esse parâmetro pode ser qualquer combinação dos sinalizadores FILE_ATTRIBUTE_* usados pela função CreateFile .
[in] dwFlags
Controla como a função manipulará o download do arquivo. O primeiro conjunto de valores de sinalizador indica as condições sob as quais a transferência ocorre. Esses sinalizadores de tipo de transferência podem ser usados em combinação com o segundo conjunto de sinalizadores que controlam o cache.
O aplicativo pode selecionar um desses valores de tipo de transferência.
Os sinalizadores a seguir determinam como o cache desse arquivo será feito. Qualquer combinação dos sinalizadores a seguir pode ser usada com o sinalizador de tipo de transferência.
[in] dwContext
Ponteiro para uma variável que contém o valor definido pelo aplicativo que associa essa pesquisa a todos os dados do aplicativo. Isso será usado somente se o aplicativo já tiver chamado InternetSetStatusCallback para configurar um status função de retorno de chamada.
Retornar valor
Retornará TRUE se tiver êxito ou FALSE caso contrário. Para obter uma mensagem de erro específica, chame GetLastError.
Comentários
FtpGetFile é uma rotina de alto nível que lida com toda a contabilidade e sobrecarga associada à leitura de um arquivo de um servidor FTP e ao armazená-lo localmente. Um aplicativo que precisa recuperar apenas dados de arquivo ou que exija um controle próximo sobre a transferência de arquivos deve usar as funções FtpOpenFile e InternetReadFile .
Se o parâmetro dwFlagsespecificar FTP_TRANSFER_TYPE_ASCII, a tradução dos dados do arquivo converterá caracteres de controle e formatação em equivalentes locais. A transferência padrão é o modo binário, em que o arquivo é baixado no mesmo formato em que é armazenado no servidor.
LpszRemoteFile e lpszNewFile podem ser nomes de arquivo parcial ou totalmente qualificados em relação ao diretório atual.
Como todos os outros aspectos da API WinINet, essa função não pode ser chamada com segurança de dentro de DllMain ou dos construtores e destruidores de objetos globais.
Observação
O cabeçalho wininet.h define FtpGetFile como um alias que seleciona automaticamente a versão ANSI ou Unicode dessa função com base na definição da constante de pré-processador UNICODE. Misturar o uso do alias neutro de codificação com código que não seja neutro em codificação pode levar a incompatibilidades que resultam em erros de compilação ou de runtime. Para obter mais informações, consulte Convenções para protótipos de função.
Requisitos
Requisito | Valor |
---|---|
Cliente mínimo com suporte | Windows 2000 Professional [somente aplicativos da área de trabalho] |
Servidor mínimo com suporte | Windows 2000 Server [somente aplicativos da área de trabalho] |
Plataforma de Destino | Windows |
Cabeçalho | wininet.h |
Biblioteca | Wininet.lib |
DLL | Wininet.dll |