The CPackage::RenameFile function renames the specified file in the package.

BOOL RenameFile(
	DWORD dwFilePlatform,		// file platform
	DWORD dwFileChecksum,		// file checksum
	LPCTSTR lpszOldName,		// old file name in package
	LPCTSTR lpszNewName		// new file name in package
);

Parameters

dwFilePlatform

[in] Specifies the target platform for the file.

 

This may be one of the following values:

Value	Description
PACKAGE_FILE_PLATFORM_DEFAULT	Rename the file which is targeted for the current platform.
PACKAGE_FILE_PLATFORM_WIN95	The file may be applied to a system running Windows 95.
PACKAGE_FILE_PLATFORM_WIN98	The file may be applied to a system running Windows 98 or Windows 98 SE.
PACKAGE_FILE_PLATFORM_WINME	The file may be applied to a system running Windows ME.
PACKAGE_FILE_PLATFORM_WINNT40	The file may be applied to a system running Windows NT 4.0.
PACKAGE_FILE_PLATFORM_WIN2000	The file may be applied to a system running Windows 2000.
PACKAGE_FILE_PLATFORM_WINXP	The file may be applied to a system running Windows XP.
PACKAGE_FILE_PLATFORM_WIN2003	The files may be applied to a system running Windows Server 2003.

In addition to the above platform-specific values, there are predefined values which specify platform groups:

 

Value	Description
PACKAGE_FILE_PLATFORM_WIN32	The file may be applied to any 32-bit version of the Windows operating system.
PACKAGE_FILE_PLATFORM_WIN9X	The file may be applied to any system running Windows 95, Windows 98 or Windows ME. The file will not be applied on a system running Windows NT, Windows 2000 or Windows XP.
PACKAGE_FILE_PLATFORM_WINNT	The file may be applied to any system running Windows NT, Windows 2000 or Windows XP. The file will not be applied on a system running Windows 95, Windows 98 or Windows ME.
PACKAGE_FILE_PLATFORM_WINDOWS	The files may be applied to any system running any version of Microsoft Windows.

dwFileChecksum

[in] Specifies the 32-bit checksum for the file. If the package contains multiple file versions, this value is used to uniquely identify the file. This parameter is ignored if the PACKAGE_OPTION_MULTIPLE_VERSIONS package option has not been enabled or if the parameter value is zero.

 

lpszOldName

[in] A pointer to a null-terminated string which specifies the package file to be renamed.

 

lpszNewName

[in] A pointer to a null-terminated string which specifies the new file name.

Return Values

If the CPackage::RenameFile function succeeds, it will return a non-zero value.

If the function fails, it will return a value of zero. To get extended error information, call GetLastError.

Remarks

To determine the current file name and installation path for the package file, use the CPackage::GetFileInformation function. To change the installation directory for the file, use the CPackage::SetFileDirectory function.

This function can be used to change the relative directory specification for the file. If no subdirectory is specified, the file will be applied to the root installation directory.

Although it is possible to rename the file using an absolute directory path, this is not recommended. All paths should be relative to the installation directory specified for the file.

Requirements

Windows NT/2000/XP: Requires Windows NT 4.0 SP3 or later.
Windows 95/98: Requires Windows 95 or later.
Header: Include apatch.h.
Library: Use apatch32.lib.
Unicode: Implemented as Unicode and ANSI versions on Windows NT/2000/XP.

See Also

CPackage::GetFileInformation, CPackage::SetFileDirectory