CFtpConnection::GetFile
Appelez la fonction membre pour obtenir un fichier d'un serveur FTP et l'enregistrer sur l'ordinateur local.
BOOL GetFile(
LPCTSTR pstrRemoteFile,
LPCTSTR pstrLocalFile,
BOOL bFailIfExists = TRUE,
DWORD dwAttributes = FILE_ATTRIBUTE_NORMAL,
DWORD dwFlags = FTP_TRANSFER_TYPE_BINARY,
DWORD_PTR dwContext = 1
);
Paramètres
pstrRemoteFile
Un pointeur vers une chaîne terminée par le caractère NULL qui contient le nom d'un fichier pour extraire du serveur FTP.pstrLocalFile
Un pointeur vers une chaîne terminée par le caractère NULL contenant le nom du fichier à créer sur le système local.bFailIfExists
Indique si le nom de fichier peut être déjà utilisé par un fichier existant. Si le nom de fichier local existe déjà, et ce paramètre est TRUE, GetFile échoue. Sinon, GetFile effacera la copie du fichier existant.dwAttributes
Indique les attributs du fichier. Cela peut être toute combinaison des balises suivantes de FILE_ATTRIBUTE_*.FILE_ATTRIBUTE_ARCHIVE le fichier est un fichier d'archivage. Les applications utilisent cet attribut pour marquer les fichiers pour la sauvegarde ou la suppression.
FILE_ATTRIBUTE_COMPRESSED le fichier ou le dossier est compressé. Pour un fichier, la compression signifie que toutes les données du fichier sont compressées. Pour un dossier, la compression est la valeur par défaut pour les fichiers et sous-répertoires nouvellement créée.
FILE_ATTRIBUTE_DIRECTORY le fichier est un répertoire.
FILE_ATTRIBUTE_NORMAL le fichier n'a aucun attribut défini. Cet attribut est valide uniquement s'il est utilisé seul. Tous les autres attributs de fichier substituent FILE_ATTRIBUTE_NORMAL :
FILE_ATTRIBUTE_HIDDEN le fichier est masqué. Il ne doit pas être inclus dans une liste de répertoires ordinaires.
FILE_ATTRIBUTE_READONLY le fichier est en lecture seule. Les applications peuvent lire le fichier mais ne peut pas y écrire ou le supprimer.
FILE_ATTRIBUTE_SYSTEM le fichier fait partie de ou est utilisé exclusivement par le système d'exploitation.
FILE_ATTRIBUTE_TEMPORARY le fichier est utilisé pour le stockage temporaire. Les applications doivent écrire dans le fichier uniquement si absolument nécessaire. La plupart des données du fichier reste dans la mémoire sans être vidé le média parce que le fichier sera bientôt supprimé.
dwFlags
Spécifie les conditions dans lesquelles le transfert se produit. Ce paramètre peut s'agir de l'une des valeurs d' dwFlags décrites dans FtpGetFile dans Kit de développement logiciel Windows.dwContext
l'identificateur de contexte pour la récupération de fichier. Consultez Notes pour plus d'informations sur dwContext.
Valeur de retour
Une valeur différente de zéro si l'opération a réussi ; sinon 0. Si l'appel échoue, la fonction GetLastError Win32 peut être appelée pour déterminer la cause de l'erreur.
Notes
GetFile est une routine de niveau supérieur qui gère toute la charge mémoire associée à lire un fichier d'un serveur FTP et le stocker en local. Les applications qui récupèrent uniquement les données du fichier, ou qui requièrent un contrôle strict de transfert de fichiers, doivent utiliser OpenFile et CInternetFile::Read à la place.
Si dwFlags est FILE_TRANSFER_TYPE_ASCII, translation convertit contrôle de données du fichier également caractères et de disposition des équivalents de windows. Le transfert par défaut est état binaire, où le fichier est téléchargé dans le même format qu'il est stocké sur le serveur.
pstrRemoteFile et pstrLocalFile peuvent être les noms du fichier par rapport à le répertoire actif ou partiellement qualifiés complets. Une barre oblique inverse (\) ou une barre oblique (/) peut être utilisée comme séparateur de répertoire pour l'un ou l'autre de nom. GetFile traduit les séparateurs de nom de dossier aux caractères appropriés pour qu'ils soient utilisés.
Remplacez la valeur par défaut d' dwContext pour définir l'ID de contexte à une valeur de votre choix. L'identificateur de contexte est associé à cette opération spécifique de l'objet d' CFtpConnection créé par son objet de CInternetSession . La valeur est retournée à CInternetSession::OnStatusCallback pour fournir le rapport état de l'exécution avec laquelle il est identifié. Consultez l'article Premières étapes Internet : WinInet pour plus d'informations sur l'identificateur de contexte.
Configuration requise
Header: afxinet.h