FtpOpenFile function

Initiates access to a remote file on an FTP server for reading or writing.

Syntax

HINTERNET FtpOpenFile(
  _In_ HINTERNET hConnect,
  _In_ LPCTSTR   lpszFileName,
  _In_ DWORD     dwAccess,
  _In_ DWORD     dwFlags,
  _In_ DWORD_PTR dwContext
);

Parameters

hConnect [in]

Handle to an FTP session.

lpszFileName [in]

Pointer to a null-terminated string that contains the name of the file to be accessed.

dwAccess [in]

File access. This parameter can be GENERIC_READ or GENERIC_WRITE, but not both.

dwFlags [in]

Conditions under which the transfers occur. The application should select one transfer type and any of the flags that indicate how the caching of the file will be controlled.

The transfer type can be one of the following values.

Value	Meaning
FTP_TRANSFER_TYPE_ASCII	Transfers the file using FTP's ASCII (Type A) transfer method. Control and formatting information is converted to local equivalents.
FTP_TRANSFER_TYPE_BINARY	Transfers the file using FTP's Image (Type I) transfer method. The file is transferred exactly as it exists with no changes. This is the default transfer method.
FTP_TRANSFER_TYPE_UNKNOWN	Defaults to FTP_TRANSFER_TYPE_BINARY.
INTERNET_FLAG_TRANSFER_ASCII	Transfers the file as ASCII.
INTERNET_FLAG_TRANSFER_BINARY	Transfers the file as binary.

 

The following values are used to control the caching of the file. The application can use one or more of these values.

Value	Meaning
INTERNET_FLAG_HYPERLINK	Forces a reload if there was no Expires time and no LastModified time returned from the server when determining whether to reload the item from the network.
INTERNET_FLAG_NEED_FILE	Causes a temporary file to be created if the file cannot be cached.
INTERNET_FLAG_RELOAD	Forces a download of the requested file, object, or directory listing from the origin server, not from the cache.
INTERNET_FLAG_RESYNCHRONIZE	Reloads HTTP resources if the resource has been modified since the last time it was downloaded. All FTP resources are reloaded. Windows XP and Windows Server 2003 R2 and earlier:  Gopher resources are also reloaded.

 

dwContext [in]

Pointer to a variable that contains the application-defined value that associates this search with any application data. This is only used if the application has already called InternetSetStatusCallback to set up a status callback function.

Return value

Returns a handle if successful, or NULL otherwise. To retrieve a specific error message, call GetLastError.

Remarks

After calling FtpOpenFile and until calling InternetCloseHandle, all other calls to FTP functions on the same FTP session handle will fail and set the error message to ERROR_FTP_TRANSFER_IN_PROGRESS. After the calling application has finished using the HINTERNET handle returned by FtpOpenFile, it must be closed using the InternetCloseHandle function.

Only one file can be open in a single FTP session. Therefore, no file handle is returned and the application simply uses the FTP session handle when necessary.

The lpszFileName parameter can be either a partially or fully qualified file name relative to the current directory.

Like all other aspects of the WinINet API, this function cannot be safely called from within DllMain or the constructors and destructors of global objects.

Requirements

See also

FTP Sessions

WinINet Functions