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

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

Синтаксис

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

Параметры

[in] szProduct

Указывает код продукта для клиентского продукта.

[in] szComponent

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

[out] lpPathBuf

Указатель на переменную, получающую путь к компоненту. Этот параметр может быть нулевым. Если компонент является разделом реестра, корневые элементы реестра представляются числовым образом. Если это путь к подразделу реестра, в конце пути к ключу имеется обратная косая черта. Если это путь к разделу значения реестра, обратная косая черта в конце отсутствует. Например, путь к реестру в 32-разрядной операционной системе HKEY_CURRENT_USER\SOFTWARE\Microsoft возвращается как "01:\SOFTWARE\Microsoft". Корневые элементы реестра, возвращаемые в 32-разрядных операционных системах, определяются, как показано в следующей таблице.

Примечание В 64-разрядных операционных системах к корням числовых реестров в этой таблице добавляется значение 20, чтобы отличать их от путей к разделу реестра в 32-разрядных операционных системах. Например, путь к разделу реестра HKEY_CURRENT_USER\SOFTWARE\Microsoft возвращается как "21:\SOFTWARE\Microsoft\", если путь к компоненту является разделом реестра в 64-разрядной операционной системе.
 
Root Значение
HKEY_CLASSES_ROOT
00
HKEY_CURRENT_USER
01
HKEY_LOCAL_MACHINE
02
HKEY_USERS
03

[in, out] pcchBuf

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

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

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

Функция MsiGetComponentPath возвращает следующие значения.

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

Комментарии

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

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

  • INSTALLSTATE_ABSENT

    Приложение не правильно убедилось, что компонент установлен, вызвав MsiUseFeature и, при необходимости, MsiConfigureFeature.

  • INSTALLSTATE_UNKNOWN

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

Примечание

Заголовок msi.h определяет MsiGetComponentPath в качестве псевдонима, который автоматически выбирает версию 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

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

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