FtpRenameFile function

Renames a file stored on the FTP server.

Syntax


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

Parameters

hConnect [in]: Handle to an FTP session.
lpszExisting [in]: Pointer to a null-terminated string that contains the name of the file to be renamed.
lpszNew [in]: Pointer to 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.

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.

Note WinINet does not support server implementations. In addition, it should not be used from a service. For server implementations or services use Microsoft Windows HTTP Services (WinHTTP).

Requirements

Minimum supported client	Windows 2000 Professional [desktop apps only]
Minimum supported server	Windows 2000 Server [desktop apps only]
Header	Wininet.h
Library	Wininet.lib
DLL	Wininet.dll
Unicode and ANSI names	FtpRenameFileW (Unicode) and FtpRenameFileA (ANSI)