SetupQueueDelete

The SetupQueueDelete function places an individual file delete operation on a setup file queue.

BOOL SetupQueueDelete(
  HSPFILEQ QueueHandle,  // handle to the file queue
  PCTSTR PathPart1,      // path to the file to delete
  PCTSTR PathPart2       // optional, additional path info
);
 

Parameters

QueueHandle

Supplies a handle to a setup file queue, as returned by SetupOpenFileQueue.

PathPart1

Supplies the first part of the path of the file to be deleted. If PathPart2 is not specified, PathPart1 is the full path of the file to be deleted.

PathPart2

This optional parameter supplies the second part of the path of the file to be deleted. This is appended to PathPart1 to form the full path of the file to be deleted. The function checks for and collapses duplicated path separators when it combines PathPart1 and PathPart2.

Return Values

If the function succeeds, the return value is a non-zero value.

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

Remarks

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

QuickInfo

  Windows NT: Use version 4.0 and later.
  Windows: Use Windows 95 and later.
  Windows CE: Unsupported.
  Header: Declared in setupapi.h.
  Import Library: Link with setupapi.lib.

See Also

Overview, Functions, SetupQueueCopy, SetupQueueDeleteSection, SetupQueueRename