Функция MsiProvideComponentA (msi.h)

  • Статья

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

Синтаксис

UINT MsiProvideComponentA(
  [in]      LPCSTR  szProduct,
  [in]      LPCSTR  szFeature,
  [in]      LPCSTR  szComponent,
  [in]      DWORD   dwInstallMode,
  [out]     LPSTR   lpPathBuf,
  [in, out] LPDWORD pcchPathBuf
);

Параметры

[in] szProduct

Указывает код продукта, содержащего компонент с необходимым компонентом.

[in] szFeature

Указывает идентификатор компонента с необходимым компонентом.

[in] szComponent

Указывает код компонента необходимого компонента.

[in] dwInstallMode

Определяет режим установки. Этот параметр может принимать одно из указанных ниже значений.

Значение Значение
INSTALLMODE_DEFAULT
 Укажите компонент и выполните установку, необходимую для предоставления компонента. Если файл ключа компонента в запрошенном компоненте или родительском компоненте отсутствует, переустановите компонент с помощью MsiReinstallFeature со следующими битами флагов: REINSTALLMODE_FILEMISSING, REINSTALLMODE_FILEOLDERVERSION, REINSTALLMODE_FILEVERIFY, REINSTALLMODE_MACHINEDATA, REINSTALLMODE_USERDATA и REINSTALLMODE_SHORTCUT.
INSTALLMODE_EXISTING
 Укажите компонент, только если функция существует. В противном случае возвращается ERROR_FILE_NOT_FOUND.

Этот режим проверяет, существует ли файл ключа компонента.
INSTALLMODE_NODETECTION
 Укажите компонент, только если функция существует. В противном случае возвращается ERROR_FILE_NOT_FOUND.

Этот режим только проверяет, зарегистрирован ли компонент, и не проверяет, существует ли файл ключа компонента.
сочетание флагов REINSTALLMODE
 Вызовите MsiReinstallFeature , чтобы переустановить компонент, используя этот параметр для параметра dwReinstallMode , а затем укажите компонент .
INSTALLMODE_NOSOURCERESOLUTION
 Укажите компонент, только если состояние установки компонента INSTALLSTATE_LOCAL. Если состояние установки компонента INSTALLSTATE_SOURCE, верните ERROR_INSTALL_SOURCE_ABSENT. В противном случае возвращается ERROR_FILE_NOT_FOUND. Этот режим только проверяет, зарегистрирован ли компонент и не проверяет, существует ли файл ключа.

[out] lpPathBuf

Указатель на переменную, получающую путь к компоненту. Этот параметр может быть нулевым.

[in, out] pcchPathBuf

Указатель на переменную, указывающую размер буфера в символах, на который указывает параметр lpPathBuf . Во входных данных это полный размер буфера, включая пробел для завершающего символа NULL. Если переданный буфер слишком мал, возвращаемое число не включает завершающий символ NULL.

Если lpPathBuf имеет значение NULL, pcchBuf может иметь значение NULL.

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

Значение Значение
ERROR_BAD_CONFIGURATION
 Данные конфигурации повреждены.
ERROR_FILE_NOT_FOUND
 Функция отсутствует или не работает. Эта ошибка возвращается для dwInstallMode = INSTALLMODE_EXISTING.
ERROR_INSTALL_FAILURE
 Сбой установки.
ERROR_INSTALL_NOTUSED
 Запрашиваемый компонент отключен на компьютере.
ERROR_INVALID_PARAMETER
 В функцию передан недопустимый параметр.
ERROR_SUCCESS
 Функция успешно завершена.
ERROR_UNKNOWN_FEATURE
 Идентификатор компонента не идентифицирует известный компонент.
ERROR_UNKNOWN_PRODUCT
 Код продукта не идентифицирует известный продукт.
INSTALLSTATE_UNKNOWN
 В функцию был передан нераспознанный продукт или имя функции.
ERROR_MORE_DATA
 Возвращается переполнение буфера.
ERROR_INSTALL_SOURCE_ABSENT
 Не удается обнаружить источник.
 

Дополнительные сведения см. в разделе Отображаемые сообщения об ошибках.

Комментарии

После успешного выполнения функции MsiProvideComponent параметр pcchPathBuf содержит длину строки в lpPathBuf.

Функция MsiProvideComponent объединяет функциональные возможности MsiUseFeature, MsiConfigureFeature и MsiGetComponentPath. Чтобы упростить последовательность вызовов, можно использовать функцию MsiProvideComponent . Однако, так как эта функция увеличивает количество использования, используйте ее с осторожностью, чтобы предотвратить неточное количество использования. Функция MsiProvideComponent также обеспечивает меньшую гибкость, чем ряд отдельных вызовов.

Если приложение восстанавливается после непредвиденной ситуации, вероятно, оно уже вызывало MsiUseFeature и увеличило количество использования. В этом случае приложение должно вызывать MsiConfigureFeature вместо MsiProvideComponent , чтобы избежать повторного увеличения счетчика.

Параметр INSTALLMODE_EXISTING нельзя использовать в сочетании с флагом REINSTALLMODE.

Компоненты с компонентами, содержащими поврежденный файл или неправильную версию файла, должны быть явно переустановены пользователем или путем вызова приложения MsiReinstallFeature.

Примечание

Заголовок msi.h определяет MsiProvideComponent в качестве псевдонима, который автоматически выбирает версию ANSI или Юникод этой функции на основе определения константы препроцессора UNICODE. Сочетание использования псевдонима, не зависящий от кодировки, с кодом, не зависящим от кодировки, может привести к несоответствиям, которые приводят к ошибкам компиляции или среды выполнения. Дополнительные сведения см. в разделе Соглашения для прототипов функций.

Требования

Требование Значение
Минимальная версия клиента Установщик Windows 5.0 в Windows Server 2012, Windows 8, Windows Server 2008 R2 или Windows 7. Установщик Windows 4.0 или Установщик Windows 4.5 в Windows Server 2008 или Windows Vista. Установщик Windows в Windows Server 2003 или Windows XP. Сведения о минимальном пакете обновления Windows, необходимом для версии установщика Windows, см. в статье Требования к установщику Windows Run-Time.
Целевая платформа Windows
Header msi.h
Библиотека Msi.lib
DLL Msi.dll

См. также раздел

Функции, зависящие от компонентов

Установка нескольких пакетов