SetupCommitFileQueue

The SetupCommitFileQueue function performs file operations enqueued on a setup file queue.

BOOL SetupCommitFileQueue(
  HWND Owner,                    // optional; parent window
  HSPFILEQ QueueHandle,          // handle to the file queue
  PSP_FILE_CALLBACK MsgHandler,  // callback routine to use
  PVOID Context                  // passed to callback routine
);
 

Parameters

Owner

This optional parameter supplies the handle of a window to use as the parent of any progress dialog boxes.

QueueHandle

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

MsgHandler

Supplies a callback routine to be notified of various significant events in the queue processing. For more information, see "Default Queue Callback Routine."

Context

Supplies a value that is passed to the callback function supplied by the MsgHandler parameter. If the default callback routine has been specified as MsgHandler, this context must be the context returned from SetupInitDefaultQueueCallback or SetupInitDefaultQueueCallbackEx.

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

The callback routine specified in MsgHandler should be compatible with the the parameters that SetupCommitFileQueue passed to it during a queue commit.

If Unicode is defined in your callback application, and you specifiy MsgHandler as the default queue callback routine, the callback routine will expect Unicode parameters. Otherwise, the default queue callback routine will expect ANSI parameters.

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, SetupCloseFileQueue