FtpRenameFileA function (wininet.h)

Article
02/22/2024

Renames a file stored on the FTP server.

Syntax

BOOL FtpRenameFileA(
  [in] HINTERNET hConnect,
  [in] LPCSTR    lpszExisting,
  [in] LPCSTR    lpszNew
);

Parameters

[in] hConnect

Handle to an FTP session.

[in] lpszExisting

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

[in] lpszNew

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

Note

The wininet.h header defines FtpRenameFile as an alias which automatically selects the ANSI or Unicode version of this function based on the definition of the UNICODE preprocessor constant. Mixing usage of the encoding-neutral alias with code that not encoding-neutral can lead to mismatches that result in compilation or runtime errors. For more information, see Conventions for Function Prototypes.

Requirements

Requirement	Value
Minimum supported client	Windows 2000 Professional [desktop apps only]
Minimum supported server	Windows 2000 Server [desktop apps only]
Target Platform	Windows
Header	wininet.h
Library	Wininet.lib
DLL	Wininet.dll