FtpRenameFile

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

Inetftp.dll is available only for Intel x86 processors.

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

Runs on Versions Defined in Include Link to
Windows CE OS 2.0 and later Wininet.h   Wininet.lib

Note   This API is part of the complete Windows CE OS package as provided by Microsoft. The functionality of a particular platform is determined by the original equipment manufacturer (OEM) and some devices may not support this API.

See Also

GetLastError

 Last updated on Tuesday, July 13, 2004

© 1992-2000 Microsoft Corporation. All rights reserved.