Skip to content

Latest commit

 

History

History
111 lines (75 loc) · 4.11 KB

nf-setupapi-setupqueuedeletew.md

File metadata and controls

111 lines (75 loc) · 4.11 KB
UID title description helpviewer_keywords old-location tech.root ms.assetid ms.date ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames req.redist ms.custom f1_keywords dev_langs topic_type api_type api_location api_name
NF:setupapi.SetupQueueDeleteW
SetupQueueDeleteW function (setupapi.h)
The SetupQueueDelete function places an individual file delete operation on a setup file queue. (Unicode)
SetupQueueDelete
SetupQueueDelete function [Setup API]
SetupQueueDeleteW
_setupapi_setupqueuedelete
setup.setupqueuedelete
setupapi/SetupQueueDelete
setupapi/SetupQueueDeleteW
setup\setupqueuedelete.htm
setup
21cdaf05-c4fb-4130-baa5-31baf5391ece
12/05/2018
SetupQueueDelete, SetupQueueDelete function [Setup API], SetupQueueDeleteA, SetupQueueDeleteW, _setupapi_setupqueuedelete, setup.setupqueuedelete, setupapi/SetupQueueDelete, setupapi/SetupQueueDeleteA, setupapi/SetupQueueDeleteW
setupapi.h
Windows
Windows XP [desktop apps only]
Windows Server 2003 [desktop apps only]
SetupQueueDeleteW (Unicode) and SetupQueueDeleteA (ANSI)
Setupapi.lib
Setupapi.dll
Windows
19H1
SetupQueueDeleteW
setupapi/SetupQueueDeleteW
c++
APIRef
kbSyntax
DllExport
Setupapi.dll
SetupQueueDelete
SetupQueueDeleteA
SetupQueueDeleteW

SetupQueueDeleteW function

-description

[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.

-parameters

-param QueueHandle [in]

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

-param PathPart1 [in]

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.

-param PathPart2 [in]

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.

-returns

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.

-see-also

Functions

Overview

SetupQueueCopy

SetupQueueDeleteSection

SetupQueueRename