FtpRenameFile

  • Article

This function renames a file stored on the FTP server.

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

Parameters

  • hConnect
    [in] Valid handle to an FTP session.
  • lpszExisting
    [in] Long pointer to a null-terminated string that contains the file name to be changed on the remote FTP server.
  • lpszNew
    [in] Long pointer to a null-terminated string that contains the new name for the remote file.

Return Values

TRUE indicates success. FALSE indicates failure. To get extended error data, call GetLastError.

Remarks

The lpszExisting and lpszNew parameters can be either partially or fully qualified file names relative to the current directory. A backward slash (\) or forward slash (/) can be used as the directory separator for either name. FtpRenameFile translates the directory name separators to the appropriate character before they are used.

Requirements

OS Versions: Windows CE 2.0 and later.
Header: Wininet.h.
Link Library: Wininet.lib.

See Also

WinInet Functions

Last updated on Wednesday, April 13, 2005

© 2005 Microsoft Corporation. All rights reserved.