Skip to content

Files

Latest commit

Steven Clementsdrewbatgit
Steven Clements
and
Jul 12, 2022
586165c · Jul 12, 2022

History

History
111 lines (80 loc) · 5.29 KB

nf-setupapi-setupinitdefaultqueuecallbackex.md

File metadata and controls

111 lines (80 loc) · 5.29 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 req.apiset
NF:setupapi.SetupInitDefaultQueueCallbackEx
SetupInitDefaultQueueCallbackEx function (setupapi.h)
Initializes the context used by the default queue callback routine included with the Setup API in the same manner as SetupInitDefaultQueueCallback, except that an additional window is provided to the callback function to accept progress messages.
SetupInitDefaultQueueCallbackEx
SetupInitDefaultQueueCallbackEx function [Setup API]
_setupapi_setupinitdefaultqueuecallbackex
setup.setupinitdefaultqueuecallbackex
setupapi/SetupInitDefaultQueueCallbackEx
setup\setupinitdefaultqueuecallbackex.htm
setup
9376f55b-55ee-4064-8aed-264c43db0c7d
12/05/2018
SetupInitDefaultQueueCallbackEx, SetupInitDefaultQueueCallbackEx function [Setup API], _setupapi_setupinitdefaultqueuecallbackex, setup.setupinitdefaultqueuecallbackex, setupapi/SetupInitDefaultQueueCallbackEx
setupapi.h
Windows
Windows XP [desktop apps only]
Windows Server 2003 [desktop apps only]
Setupapi.lib
Setupapi.dll
Windows
19H1
SetupInitDefaultQueueCallbackEx
setupapi/SetupInitDefaultQueueCallbackEx
c++
APIRef
kbSyntax
DllExport
Setupapi.dll
Ext-MS-Win-SetupAPI-ClassInstallers-L1-1-2.dll
SetupInitDefaultQueueCallbackEx
ext-ms-win-setupapi-classinstallers-l1-1-2 (introduced in Windows 10, version 10.0.14393)

SetupInitDefaultQueueCallbackEx 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 SetupInitDefaultQueueCallbackEx function initializes the context used by the default queue callback routine included with the Setup API in the same manner as SetupInitDefaultQueueCallback, except that an additional window is provided to the callback function to accept progress messages.

-parameters

-param OwnerWindow [in]

Handle to the window to use as the parent of any dialog boxes generated by the default callback routine.

-param AlternateProgressWindow [in]

Handle to a window that receives the progress messages. To prevent progress messages from being displayed, you can specify this parameter to be INVALID_HANDLE_VALUE.

-param ProgressMessage [in]

Message that is sent to AlternateProgressWindow when the copy queue is started, and each time a file is copied.

-param Reserved1 [in]

First message parameter that is sent to the AlternateProgressWindow by the default callback routine.

-param Reserved2 [in]

Second message parameter that is sent to the AlternateProgressWindow by the default callback routine.

-returns

SetupInitDefaultQueueCallbackEx returns a pointer to the context used by the default queue callback routine. This function can only fail if there is insufficient memory. If this function fails, it returns NULL and does not set the last-error code for the thread.

-remarks

When the queue starts to commit the copy subqueue, the default queue callback routine sends a message to the window specified in AlternateProgressWindow. Reserved1 has the value 0, and Reserved2 contains a pointer to the number of enqueued file copy operations.

For each file copy operation completed, the default queue callback routine sends a message to AlternateProgressWindow, which can be used to 'tick' the progress bar. Reserved1 has the value 1, and Reserved2 is zero.

SetupInitDefaultQueueCallbackEx can be used to get the default behavior for disk prompting, error handling, and so on, and also provide a gauge embedded in a wizard page or other specialized dialog box.

Regardless of whether you initialized the context used by the default queue callback routine with SetupInitDefaultQueueCallback or SetupInitDefaultQueueCallbackEx, after the queued operations have finished processing, call SetupTermDefaultQueueCallback to release the resources allocated in initializing the context structure. For more information see Initializing and Terminating the Callback Context.

-see-also

Functions

Overview

SetupInitDefaultQueueCallback