SetupQueueDeleteA function (setupapi.h)
[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 SetupQueueDelete function places an individual file delete operation on a setup file queue.
Syntax
WINSETUPAPI BOOL SetupQueueDeleteA(
[in] HSPFILEQ QueueHandle,
[in] PCSTR PathPart1,
[in] PCSTR PathPart2
);
Parameters
[in] QueueHandle
Handle to a setup file queue, as returned by SetupOpenFileQueue.
[in] PathPart1
Pointer to a null-terminated string that specifies the first part of the path of the file to be deleted. If PathPart2 is NULL, PathPart1 is the full path of the file to be deleted.
[in] PathPart2
Pointer to a null-terminated string that specifies the second part of the path of the file to be deleted. This parameter may be NULL. 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 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 delete operations are assumed to take place on fixed media, the user will not be prompted when the queue is committed.
Note
The setupapi.h header defines SetupQueueDelete as an alias which automatically selects the ANSI or Unicode version of this function based on the definition of the UNICODE preprocessor constant. Mixing usage of the encoding-neutral alias with code that not encoding-neutral can lead to mismatches that result in compilation or runtime errors. For more information, see Conventions for Function Prototypes.
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client | Windows XP [desktop apps only] |
| Minimum supported server | Windows Server 2003 [desktop apps only] |
| Target Platform | Windows |
| Header | setupapi.h |
| Library | Setupapi.lib |
| DLL | Setupapi.dll |