SetupDefaultQueueCallbackA 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 SetupDefaultQueueCallback function is the default queue callback routine included with the Setup API. You can use it to process notifications sent by the SetupCommitFileQueue function.
Syntax
WINSETUPAPI UINT SetupDefaultQueueCallbackA(
[in] PVOID Context,
[in] UINT Notification,
[in] UINT_PTR Param1,
[in] UINT_PTR Param2
);
Parameters
[in] Context
Pointer to the context initialized by the SetupInitDefaultQueueCallback or SetupInitDefaultQueueCallbackEx functions.
[in] Notification
Notification of a queue action. This parameter can be one of the values shown in the following table.
[in] Param1
Additional message information. The content of this parameter depends on the value of the Notification parameter.
[in] Param2
Additional message information. The content of this parameter depends on the value of the Notification parameter.
Return value
Returns an unsigned integer to SetupCommitFileQueue that can be the one of the values shown in the following table.
Return code | Description |
---|---|
|
Aborts the operation. |
|
Performs the file operation. |
|
Skips the operation. |
|
Retries the operation. |
|
Gets a new path for the operation. |
To get extended error information, call GetLastError.
Remarks
The SetupDefaultQueueCallback function is usually only called explicitly by a custom queue callback routine. The custom callback handles a subset of the queue commit notifications and calls the SetupDefaultQueueCallback function to handle the rest of the notifications.
For more information see, Queue Notifications.
Note
The setupapi.h header defines SetupDefaultQueueCallback 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 |
API set | ext-ms-win-setupapi-classinstallers-l1-1-2 (introduced in Windows 10, version 10.0.14393) |