SetupQueueRename function

[This function is available for use in the operating systems indicated in the Requirements section. It may be altered or unavailable in subsequent versions. SetupAPI should no longer be used for installing applications. Instead, use the Windows Installer for developing application installers. SetupAPI continues to be used for installing device drivers.]

The SetupQueueRename function places an individual file rename operation on a setup file queue.

Syntax


BOOL SetupQueueRename(
  _In_ HSPFILEQ QueueHandle,
  _In_ PCTSTR   SourcePath,
  _In_ PCTSTR   SourceFileName,
  _In_ PCTSTR   TargetPath,
  _In_ PCTSTR   TargetFileName
);

Parameters

QueueHandle [in]

Handle to a setup file queue, as returned by SetupOpenFileQueue.

SourcePath [in]

Pointer to a null-terminated string that specifies the source path of the file to be renamed. If SourceFileName is not specified, SourcePath is assumed to be the full path.

SourceFileName [in]

Pointer to a null-terminated string that specifies the file name part of the file to be renamed. If not specified, SourcePath is the full path.

TargetPath [in]

Pointer to a null-terminated string that specifies the target directory. When this parameter is specified, the rename operation is actually a move operation. If TargetPath is not specified, the file is renamed but remains in its current location.

TargetFileName [in]

Pointer to a null-terminated string that specifies the new name for the source file.

Return value

If the function succeeds, the return value is a nonzero value.

If the function fails, the return value is zero. To get extended error information, call GetLastError.

Remarks

Because rename operations are assumed to take place on fixed media, the user will not be prompted when the queue is committed.

Requirements

Minimum supported client

Windows XP [desktop apps only]

Minimum supported server

Windows Server 2003 [desktop apps only]

Header

Setupapi.h

Library

Setupapi.lib

DLL

Setupapi.dll

Unicode and ANSI names

SetupQueueRenameW (Unicode) and SetupQueueRenameA (ANSI)

See also

Overview
Functions
SetupQueueDelete
SetupQueueCopy
SetupQueueRenameSection

 

 

Show: