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
);

The actual syntax of this function varies between its ANSI and Unicode implementations. For more information, see Win32 Internet Functions Syntax.

Parameters

hConnect

Valid HINTERNET handle to an FTP session.

lpszFileName

Address of a null-terminated string that contains the name of the file to access on the remote system.

dwAccess

Unsigned long integer value that determines how the file will be accessed. This can be GENERIC_READ or GENERIC_WRITE, but not both.

dwFlags

Unsigned long integer value that contains the 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 any one of the following values:

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.

INTERNET_FLAG_HYPERLINK

INTERNET_FLAG_NEED_FILE

INTERNET_FLAG_RELOAD

INTERNET_FLAG_RESYNCHRONIZE

dwContext

Address of an unsigned long integer value 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 get 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.

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 partially or fully qualified file names relative to the current directory.

Function Information

Windows NT	Use version 4.0. Implemented as ANSI and Unicode functions.
Windows	Use Windows 95 and later. Implemented as ANSI and Unicode functions.
Header	Wininet.h
Import library	Wininet.lib
Minimum availability	Internet Explorer 3.0 (ANSI only), 5 (ANSI and Unicode)

Windows CE

Windows CE	Use version 2.12 and later. Implemented as ANSI and Unicode functions.
Minimum availability	Internet Explorer 4.0

See Also

Microsoft Win32 Internet Functions Overview, FTP Sessions, Microsoft Win32 Internet Functions Reference, FTP Functions