FtpRenameFile Function

---

Renames a file stored on the FTP server.

Syntax

BOOL FtpRenameFile(
    IN HINTERNET hConnect,
    IN LPCTSTR lpszExisting,
    IN LPCTSTR lpszNew
);

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.

lpszExisting

Address of a null-terminated string that contains the name of the file that will have its name changed on the remote FTP server.

lpszNew

Address of a null-terminated string that contains the new name for the remote file.

Return Value

Returns TRUE if successful, or FALSE otherwise. To get a specific error message, call GetLastError.

Remarks

The lpszExisting and lpszNew parameters 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