CFtpConnection::GetFile

BOOL GetFile (LPCTSTR pstrRemoteFile, LPCTSTR pstrLocalFile, BOOL bFailIfExists = TRUE, DWORD dwAttributes = FILE_ATTRIBUTE_NORMAL, DWORD dwFlags = FTP_TRANSFER_TYPE_BINARY, DWORD dwContext = 1);

Valeur de retour

Différent de zéro en cas de succès ; sinon 0. Si l'appel échoue, la fonction Win32 GetLastError peut être appelée pour déterminer la cause de l'erreur.

Paramètres

pstrRemoteFile

Un pointeur vers une chaîne terminée par null, contenant le nom d'un fichier à récupérer depuis le serveur FTP.

pstrLocalFile

Un pointeur vers une chaîne terminée par null, contenant le nom du fichier à créer sur le système local.

bFailIfExists

Indique si le nom de fichier peut déjà être utilisé par un fichier existant. Si le nom de fichier local existe déjà et que ce paramètre est TRUE, GetFile échoue. Sinon, GetFile effacera la copie existante du fichier.

dwAttributes

Indique les attributs du fichier. Cela peut être n'importe quelle combinaison des indicateurs suivants de FILE_ATTRIBUTE_ *.

• FILE_ATTRIBUTE_ARCHIVE  ;  Le fichier est un fichier d'archive. Les applications utilisent cet attribut pour marquer les fichiers pour la sauvegarde ou la suppression.
  
  
• FILE_ATTRIBUTE_COMPRESSED  ;  Le fichier ou le répertoire est compressé. Pour un fichier, compression signifie que toutes les données dans le fichier est compressé. Pour un répertoire, la compression est la valeur par défaut pour les fichiers nouvellement créés et les sous-répertoires.
  
  
• FILE_ATTRIBUTE_DIRECTORY  ;  Le fichier est un répertoire.
  
  
• FILE_ATTRIBUTE_&NORMALnbsp ;  Le fichier n'a aucuns autres attributs définie. Cet attribut est valide uniquement si utilisé seul. Tous les autres attributs de fichier substituent FILE_ATTRIBUTE_NORMAL:
  
  
• FILE_ATTRIBUTE_HIDDE&Nnbsp ;  Le fichier est masqué. C'est ne pas pour être inclus dans une liste de répertoires ordinaires.
  
  
• FILE_ATTRIBUTE_READO&NLYnbsp ;  Le fichier est en lecture seule. Les applications peuvent lire le fichier mais ne peut pas écrire pour elle ou supprimez-le.
  
  
• FILE_ATTRIBUTE_SYSTEM  ;  Le fichier est partie 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 seulement si absolument nécessaire. La plupart des données du fichier reste en mémoire sans être vidées dans les médias parce que le fichier sera bientôt supprimé.

dwFlags

Spécifie les conditions dans lesquelles se produit le transfert. Ce paramètre peut être l'une des valeurs dwFlags décrits dans FtpGetFile dans le SDK de la plate-forme.

dwContext

L'identificateur de contexte pour la récupération du fichier. Voir les remarques pour plus d'informations sur dwContext.

Remarques

Appelez cette fonction membre pour obtenir un fichier à partir d'un serveur FTP et de le stocker sur l'ordinateur local.

GetFile est une routine de haut niveau qui gère tous les frais généraux associé à la lecture d'un fichier d'un serveur FTP et en stockant localement. Applications qui ne récupérer les données de fichier, ou qui nécessitent un contrôle étroit sur le transfert de fichiers, devrait utiliser OpenFile et CInternetFile::Read place.

Si dwFlags est FILE_TRANSFER_TYPE_ASCII, traduction des données du fichier convertit également contrôle et mise en forme des caractères équivalents de Windows. Le transfert de la valeur par défaut est le mode 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 soit partiellement qualifiés noms de fichiers dans le répertoire actuel ou pleinement qualifiés. Une barre oblique inverse (\) ou une barre oblique (/) peut être utilisé comme séparateur pour chaque nom de répertoire. GetFile traduit les séparateurs de nom de répertoire pour les caractères appropriés avant leur utilisation.

Substituer la valeur par défaut de dwContext pour définir l'identificateur de contexte pour une valeur de votre choix. L'identificateur de contexte est associé à cette opération spécifique de l'objet CFtpConnection créé par son objet CInternetSession . La valeur est retournée au CInternetSession::OnStatusCallback d'État sur l'opération à laquelle il est identifié. Consultez l'article premiers pas Internet : WinInet pour plus d'informations sur l'identificateur de contexte.

Aperçu CFtpConnection |nbsp ; Membres de la classe | Graphique de la hiérarchie

Voir aussi  ;CInternetConnection