CFtpConnection::GetFile

Llame a esta función miembro para obtener un archivo de un servidor FTP y almacenarlo en el equipo 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 
);

Parámetros

  • pstrRemoteFile
    Un puntero a una cadena terminada en null que contiene el nombre de un archivo para recuperar del servidor FTP.

  • pstrLocalFile
    Un puntero a una cadena terminada en null que contiene el nombre del archivo para crear en el sistema local.

  • bFailIfExists
    indica si el nombre de archivo se puede utilizar ya por un archivo existente.Si existe el nombre del archivo local todavía, y este parámetro es TRUE, GetFile falla.Si no, GetFile borrará la copia existente del archivo.

  • dwAttributes
    Indica los atributos del archivo.Puede ser cualquier combinación de los siguientes indicadores de FILE_ATTRIBUTE_*.

    • El archivo de FILE_ATTRIBUTE_ARCHIVE The es un archivo de almacenamiento.Las aplicaciones utilizan este atributo para marcar los archivos para incluirlos en copias de seguridad o eliminación.

    • Se comprime el archivo o directorio de FILE_ATTRIBUTE_COMPRESSED The.Para un archivo, la compresión significa que todos los datos del archivo está cifrado.Para un directorio, la compresión es el valor predeterminado para los archivos y subdirectorios creados recientemente.

    • El archivo de FILE_ATTRIBUTE_DIRECTORY The es un directorio.

    • El archivo de FILE_ATTRIBUTE_NORMAL no establecido ningún otro atributo.Este atributo sólo es válido si se utiliza por sí solo.Todos los demás atributos de archivo reemplazan FILE_ATTRIBUTE_NORMAL:

    • El archivo está oculto de FILE_ATTRIBUTE_HIDDEN The.No debe incluir en una lista de directorios normal.

    • El archivo de FILE_ATTRIBUTE_READONLY The es de sólo lectura.Las aplicaciones pueden leer el archivo pero no pueden escribir o eliminarlo.

    • El archivo de FILE_ATTRIBUTE_SYSTEM Z es parte de o lo utiliza exclusivamente el sistema operativo.

    • El archivo de FILE_ATTRIBUTE_TEMPORARY The se utiliza para el almacenamiento temporal.Las aplicaciones deben escribir en el archivo si es absolutamente necesario.La mayoría de los datos del archivo permanecen en memoria sin ser vaciado en medios porque el archivo pronto se eliminará.

  • dwFlags
    Especifica las condiciones en las que la transferencia aparece.Este parámetro puede ser cualquiera de los valores de dwFlags descritos en FtpGetFile en Windows SDK.

  • dwContext
    El identificador del contexto para la recuperación de archivos.Vea Comentarios para obtener más información sobre dwContext.

Valor devuelto

Distinto de cero si correctamente; si no 0.Si se produce un error en la llamada, la función GetLastError de Win32 se puede llamar para determinar la causa del error.

Comentarios

GetFile es una rutina de alto nivel que administra toda la sobrecarga asociada a leer un archivo de un servidor FTP y almacenarlos localmente.Las aplicaciones que recuperan sólo datos de archivo, o que requieren el control estricto sobre la descarga de archivos, deben utilizar OpenFile y CInternetFile:: lectura en su lugar.

Si dwFlags es FILE_TRANSFER_TYPE_ASCII, la traducción de datos de archivo también convierte los caracteres de control y de formato a los equivalentes de Windows.La transferencia predeterminada es el modo binario, donde el archivo se descarga en el mismo formato que está almacenado en el servidor.

pstrRemoteFile y pstrLocalFile pueden ser nombres de archivo en relación con el directorio actual o completo parcialmente completos.Una barra diagonal inversa (\) o una barra diagonal (/) se puede utilizar como separador de directorio para cualquier nombre.GetFile traduce los separadores de nombre de directorio a los caracteres apropiados antes de utilizarlos.

Reemplace el valor predeterminado de dwContext para establecer el identificador de contexto a un parámetro de elegir.El identificador de contexto es asociado a esta operación específica del objeto de CFtpConnection creado por el objeto de CInternetSession .El valor se devuelve a CInternetSession:: OnStatusCallback para proporcionar el estado de la operación a la que se identifica.Vea el artículo Primeros pasos de internet: WinInet para obtener más información sobre el identificador del contexto.

Requisitos

encabezado: afxinet.h

Vea también

Referencia

Clase de CFtpConnection

Gráfico de jerarquía

Clase de CInternetConnection