Функция SetupCommitFileQueueA (setupapi.h)

Статья
11/20/2024

[Эта функция доступна для использования в операционных системах, указанных в разделе "Требования". Он может быть изменен или недоступен в последующих версиях. SetupAPI больше не следует использовать для установки приложений. Вместо этого используйте установщик Windows для разработки установщиков приложений. SetupAPI по-прежнему используется для установки драйверов устройств.]

Функция SetupCommitFileQueue выполняет операции с файлами в очереди файлов установки.

Рекомендуется собрать все необходимые операции файлов для очереди файлов и зафиксировать очередь только один раз, так как очередь файлов невозможно повторно использовать после фиксации. Если после фиксации требуется дополнительная обработка очереди, то дескриптор очереди должен быть закрыт и создана новая очередь файлов. Дополнительные сведения см. в разделе Фиксация очереди.

Если файл изменен, вызывающий эту функцию должен иметь права на запись в целевой каталог.

Синтаксис

WINSETUPAPI BOOL SetupCommitFileQueueA(
  [in] HWND                Owner,
  [in] HSPFILEQ            QueueHandle,
  [in] PSP_FILE_CALLBACK_A MsgHandler,
  [in] PVOID               Context
);

Параметры

[in] Owner

Необязательный дескриптор окна для использования в качестве родительского элемента всех диалоговых окон хода выполнения.

[in] QueueHandle

Обработайте очередь файла установки, как возвращается SetupOpenFileQueue.

[in] MsgHandler

Указатель на необязательную процедуру обратного вызова, чтобы получать уведомления о различных важных событиях, которые находятся в обработке очереди. Дополнительные сведения см. в статье Подпрограмма обратного вызова очереди по умолчанию или FileCallback Если подпрограмма обратного вызова null, SetupCommitFileQueue возвращает TRUE, а ошибка — 0 или NO_ERROR.

[in] Context

Значение, переданное функции обратного вызова, предоставленной параметром MsgHandler. Если подпрограмма обратного вызова по умолчанию указана как msgHandler, этот контекст должен быть контекстом, возвращаемым из SetupInitDefaultQueueCallback или SetupInitDefaultQueueCallbackEx.

Возвращаемое значение

Если функция выполнена успешно, возвращаемое значение является ненулевое значение.

Если функция завершается ошибкой, возвращаемое значение равно нулю. Чтобы получить расширенные сведения об ошибке, вызовите GetLastError.

Замечания

Подпрограмма обратного вызова, указанная в MsgHandler, должна быть совместима с параметрами, которые SetupCommitFileQueue переданы в него во время фиксации очереди.

Если Юникод определен в приложении обратного вызова, и вы указываете MsgHandler в качестве подпрограммы обратного вызова очереди по умолчанию, подпрограмма обратного вызова ожидает параметры Юникода. В противном случае подпрограмма обратного вызова очереди по умолчанию ожидает параметры ANSI.

Заметка

Заголовок setupapi.h определяет SetupCommitFileQueue как псевдоним, который автоматически выбирает версию ANSI или Юникод этой функции на основе определения константы препроцессора ЮНИКОДа. Сочетание использования псевдонима, нейтрального для кодирования, с кодом, не зависящим от кодирования, может привести к несоответствиям, которые приводят к ошибкам компиляции или среды выполнения. Дополнительные сведения см. в соглашениях о прототипах функций.

Требования

Требование	Ценность
минимальные поддерживаемые клиентские	Windows XP [только классические приложения]
минимальный поддерживаемый сервер	Windows Server 2003 [только классические приложения]
целевая платформа	Виндоус
заголовка	setupapi.h
библиотеки	Setupapi.lib
DLL	Setupapi.dll

См. также

Функции

Обзор

SetupCloseFileQueue

Поделиться через