Функция DismAddPackage

Статья
12/20/2024

Добавляет один .cab или .msu файл в образ Windows.

Синтаксис

HRESULT WINAPI DismAddPackage(
  _In_     DismSession            Session,
  _In_     PCWSTR                 PackagePath,
  _In_     BOOL                   IgnoreCheck,
  _In_     BOOL                   PreventPending,
  _In_opt_ HANDLE                 CancelEvent,
  _In_opt_ DISM_PROGRESS_CALLBACK Progress,
  _In_opt_ PVOID                  UserData
);

Параметры

сеанс [in]
Допустимый DismSession. DismSession должен быть связан с изображением. Сеанс можно связать с изображением с помощью DismOpenSession.

PackagePath [in]
Относительный или абсолютный путь к добавленным .cab или MSU-файлу или папке, содержащей развернутые файлы одного .cab файла.

IgnoreCheck [in]
Логическое значение, указывающее, следует ли игнорировать внутренние проверки применимости, которые выполняются при добавлении пакета.

Ценность	Описание
ИСТИНА	Игнорировать внутренние проверки применимости.
ЛОЖЬ	Не игнорируйте внутренние проверки применимости.

PreventPending [в]
Логическое значение, указывающее, следует ли добавлять пакет, если у него есть ожидаемые онлайн-действия.

Ценность	Описание
ПРАВДА	Запретить установку пакета с ожидающими онлайн-операциями.
ЛОЖЬ	Разрешить установку пакета с незавершенными действиями, запланированными в интернете.

CancelEvent [in, необязательный]
Необязательный. Вы можете задать CancelEvent для этой функции, чтобы отменить выполнение операции при сигнале клиента. Если CancelEvent приходит на этапе, когда операция не может быть отменена, операция продолжится и будет возвращать код успешного выполнения. Если получено CancelEvent и операция отменена, состояние изображения неизвестно. Перед продолжением или отменой изменений необходимо проверить состояние изображения и снова запустить его.

Прогресс [в, необязательно]
Необязательный. Указатель на определяемый клиентом DismProgressCallback.

UserData [входящий, опционально]
Необязательный. Определяемые пользователем пользовательские данные.

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

Если функция выполнена успешно, возвращаемое значение S_OK. Функция также может возвращать одно из следующих значений при успешном выполнении:

Возвращаемый код	Описание
(HRESULT)ERROR_SUCCESS_REBOOT_REQUIRED (Требуется перезагрузка системы)	Если сеанс онлайн, необходимо перезапустить компьютер.
DISMAPI_S_RELOAD_IMAGE_SESSION_REQUIRED	Необходимо перезагрузить сеанс.

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

Замечания

В онлайн-образ можно добавлять файлы только .cab. Файлы .cab или .msu можно добавить в автономный образ.

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

Пример

HRESULT hr = S_OK;
hr = DismAddPackage(Session, "C:\\packages\\calc.cab", FALSE, FALSE, NULL, NULL, NULL);

Требования

Требование	Описание
Поддерживаемые хост-платформы	API DISM можно использовать в любой операционной системе, поддерживаемой пакетом средств оценки и развертывания Windows (Windows ADK). Дополнительные сведения см. в техническом справочнике Windows ADK.
Поддерживаемые платформы изображений	Windows 7, Windows Server 2008 R2, Windows PE 3.0, Windows 8, Windows Server 2012, Среда предустановки Windows (Windows PE) 4.0, Windows 8.1, Windows Server 2012 R2, Windows 10, Windows Server 2016
Минимальный поддерживаемый клиент	Windows 7 [только настольные приложения]
Минимальный поддерживаемый сервер	Windows Server 2008 R2 [только настольные приложения]
Заголовок	DismAPI.h
Библиотека	DismAPI.lib
DLL	DismAPI.dll