SetupDefaultQueueCallback

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. 

UINT SetupDefaultQueueCallback(
  PVOID Context,  // context used by the default callback routine
  UINT Notification,
                  // queue notification
  UINT Param1,    // additional notification information
  UINT Param2     // additional notification information
);

Parameters

Context
Supplies a pointer to the context initialized by the SetupInitDefaultQueueCallback or SetupInitDefaultQueueCallbackEx functions.
Notification
Supplies the notification of a queue action. This parameter can be one of the following values:
SPFILENOTIFY_STARTQUEUE Started enqueued file operations.
SPFILENOTIFY_ENDQUEUE Finished enqueued file operations.
SPFILENOTIFY_STARTSUBQUEUE Started a copy, rename, or delete subqueue.
SPFILENOTIFY_ENDSUBQUEUE Finished a copy, rename, or delete subqueue.
SPFILENOTIFY_STARTRENAME Started a rename operation.
SPFILENOTIFY_ENDRENAME Finished a rename operation.
SPFILENOTIFY_RENAMEERROR Encountered an error while renaming a file.
SPFILENOTIFY_STARTDELETE Started a delete operation.
SPFILENOTIFY_ENDDELETE Finished a delete operation.
SPFILENOTIFY_DELETEERROR Encountered an error while deleting a file.
SPFILENOTIFY_STARTCOPY Started a copy operation.
SPFILENOTIFY_ENDCOPY Finished a copy operation.
SPFILENOTIFY_COPYERROR Encountered an error while copying a file.
SPFILENOTIFY_NEEDMEDIA New media is required.
SPFILENOTIFY_LANGMISMATCH Existing target file is in a different language than the source.
SPFILENOTIFY_TARGETEXISTS Target file exists.
SPFILENOTIFY_TARGETNEWER Existing target file is newer than source.

Param1
Specifies additional message information. The content of this parameter depends on the value of the Notification parameter.
Param2
Specifies additional message information. The content of this parameter depends on the value of the Notification parameter.

Return Values

Returns an unsigned integer to SetupCommitFileQueue that can be the following values.

File Directive Description
FILEOP_ABORT Abort the operation.
FILEOP_DOIT Perform the file operation.
FILEOP_SKIP Skip the operation.
FILEOP_RETRY Retry the operation.
FILEOP_NEWPATH Get 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.

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