SetupQueueRename
[New
- Windows NT]
The SetupQueueRename
function places an individual file rename operation on a setup file queue.
BOOL SetupQueueRename(
|
HSPFILEQ QueueHandle, |
// handle to the
file queue |
|
PCTSTR SourcePath, |
// path to the
file to rename |
|
PCTSTR SourceFileName, |
// optional,
source filename |
|
PCTSTR TargetPath, |
// optional, new
path for file |
|
PCTSTR TargetFileName |
// optional, new
name for file |
|
); |
|
Parameters
QueueHandle
Supplies a
handle to a setup file queue, as returned by SetupOpenFileQueue.
SourcePath
Supplies the
source path of the file to be renamed. If SourceFileName is not
specified, SourcePath is assumed to be the full path.
SourceFileName
This optional
parameter supplies the filename part of the file to be renamed. If not
specified, SourcePath is the full path.
TargetPath
This optional
parameter supplies the target directory and the rename operation is actually a
mover operation. If TargetPath is not specified, the file is renamed but
remains in its current location.
TargetFileName
This optional
parameter supplies the name of the new name for the source file.
Return Values
If the
function succeeds, the return value is TRUE.
If the
function fails, the return value is FALSE. To get extended error information,
call GetLastError.
Remarks
Since rename
operations are assumed to take place on fixed media, the user will not be
prompted when the queue is committed.
See Also