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

Статья
11/20/2024

Функция MsiLocateComponent возвращает полный путь к установленному компоненту без кода продукта. Эта функция пытается определить продукт с помощью MsiGetProductCode, но не гарантируется найти правильный продукт для вызывающего объекта. MsiGetComponentPath всегда следует вызывать по возможности.

Синтаксис

INSTALLSTATE MsiLocateComponentA(
  [in]      LPCSTR  szComponent,
  [out]     LPSTR   lpPathBuf,
  [in, out] LPDWORD pcchBuf
);

Параметры

[in] szComponent

Указывает идентификатор компонента, который должен находиться.

[out] lpPathBuf

Указатель на переменную, получающую путь к компоненту. Переменная включает завершающий символ NULL.

[in, out] pcchBuf

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

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

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

Ценность	Значение
INSTALLSTATE_NOTUSED	Запрошенный компонент отключен на компьютере.
INSTALLSTATE_ABSENT	Компонент не установлен. См. примечания.
INSTALLSTATE_INVALIDARG	Один из параметров функции недопустим.
INSTALLSTATE_LOCAL	Компонент устанавливается локально.
INSTALLSTATE_MOREDATA	Предоставленный буфер был слишком мал.
INSTALLSTATE_SOURCE	Компонент устанавливается для запуска из источника.
INSTALLSTATE_SOURCEABSENT	Источник компонента недоступен.
INSTALLSTATE_UNKNOWN	Код продукта или идентификатор компонента неизвестен. См. примечания.

Замечания

Функция msiLocateComponent может возвращать INSTALLSTATE_ABSENT или INSTALL_STATE_UNKNOWN по следующим причинам:

INSTALLSTATE_ABSENT
Приложение не обеспечило правильность установки функции путем вызова MsiUseFeature и при необходимости MsiConfigureFeature.
INSTALLSTATE_UNKNOWN
Функция не опубликована. Приложение должно было определить это ранее путем вызова MsiQueryFeatureState или MsiEnumFeatures. Приложение выполняет эти вызовы во время инициализации. Приложение должно использовать только функции, известные как опубликованные. Так как INSTALLSTATE_UNKNOWN должны были быть возвращены MsiUseFeature, либо MsiUseFeature не был вызван, либо его возвращаемое значение было неправильно проверено.

Заметка

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

Требования

Требование	Ценность
минимальные поддерживаемые клиентские	Установщик 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".
целевая платформа	Виндоус
заголовка	msi.h
библиотеки	Msi.lib
DLL	Msi.dll

См. также

функций Component-Specific

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