MsiGetComponentPathExA 関数 (msi.h)

  • [アーティクル]

MsiGetComponentPathEx 関数は、インストール済みのコンポーネントへの完全なパスを返します。 コンポーネントのキー パスがレジストリ キーの場合、関数はレジストリ キーを返します。

この関数は、既存の MsiGetComponentPath 関数を拡張して、ユーザー アカウントとインストール コンテキスト間でコンポーネントを検索できるようにします。

構文

INSTALLSTATE MsiGetComponentPathExA(
  [in]                LPCSTR            szProductCode,
  [in]                LPCSTR            szComponentCode,
  [in, optional]      LPCSTR            szUserSid,
  [in, optional]      MSIINSTALLCONTEXT dwContext,
  [out, optional]     LPSTR             lpOutPathBuffer,
  [in, out, optional] LPDWORD           pcchOutPathBuffer
);

パラメーター

[in] szProductCode

アプリケーションの製品コード GUID を指定する null で終わる文字列値。 関数は、このアプリケーションで使用されるインストール済みコンポーネントのパスを取得します。

[in] szComponentCode

コンポーネント コード GUID を指定する null で終わる文字列値。 関数は、このコンポーネント コードを持つインストール済みコンポーネントのパスを取得します。

[in, optional] szUserSid

システム内のユーザーのセキュリティ識別子 (SID) を指定する null で終わる文字列値。 関数は、この SID によって識別されるユーザー アカウントにインストールされているアプリケーションのインストール済みコンポーネントのパスを取得します。 特殊な SID 文字列 s-1-1-0 (Everyone) は、システム内のすべてのユーザーを指定します。 このパラメーターが NULL の場合、関数は現在ログオンしているユーザー専用のインストール済みコンポーネントのパスを取得します。

SID の種類 意味
NULL
 現在ログオンしているユーザーを指定します。
ユーザー SID
 システム内の特定のユーザーを指定します。 ユーザー SID の例として、"S-1-3-64-2415071341-1358098788-3127455600-2561" があります。
s-1-1-0
 システム内のすべてのユーザーを指定します。
 
メモ 特殊な SID 文字列 s-1-5-18 (システム) を使用して、コンピューターごとのインストール コンテキストにインストールされているアプリケーションを検索することはできません。 SID 値を s-1-5-18 に設定すると 、ERROR_INVALID_PARAMETERが返されます。 dwContext が MSIINSTALLCONTEXT_MACHINE のみに設定されている場合、szUserSid は NULL である必要があります。
 

[in, optional] dwContext

インストール コンテキストを指定する フラグ。 関数は、指定したインストール コンテキストにインストールされているアプリケーションのインストール済みコンポーネントのパスを取得します。 このパラメーターは、次の値と組み合わせて使用できます。

Context 意味
MSIINSTALLCONTEXT_USERMANAGED
1
 ユーザーごとに管理されるインストール コンテキストにインストールされているアプリケーションを含めます。
MSIINSTALLCONTEXT_USERUNMANAGED
2
 ユーザーごとのアンマネージド インストール コンテキストにインストールされたアプリケーションを含めます。
MSIINSTALLCONTEXT_MACHINE
4
 コンピューターごとのインストール コンテキストにインストールされているアプリケーションを含めます。 dwInstallContext がMSIINSTALLCONTEXT_MACHINEのみに設定されている場合、szUserSID パラメーターは NULL である必要があります。

[out, optional] lpOutPathBuffer

コンポーネントへのパスを受け取る文字列値。 このパラメーターは、NULL でもかまいません。 コンポーネントがレジストリ キーの場合、レジストリ ルートは数字で表されます。 これがレジストリ サブキー パスの場合は、キー パスの末尾に円記号があります。 これがレジストリ値のキー パスの場合、末尾に円記号はありません。 たとえば、microsoftHKEY_CURRENT_USER SOFTWARE\ の 32 ビット オペレーティング システム上の\レジストリパスは、"01:\SOFTWARE\Microsoft" として返されます。 32 ビット オペレーティング システムで返されるレジストリ ルートは、次の表に示すように定義されています。

メモ 64 ビット オペレーティング システムでは、32 ビット オペレーティング システムのレジストリ キー パスと区別するために、この表の数値レジストリ ルートに値 20 が追加されます。 たとえば、コンポーネント パスが 64 ビット オペレーティング システムのレジストリ キーである場合、 HKEY_CURRENT_USER\SOFTWARE\Microsoft のレジストリ キー パスは "21:\SOFTWARE\Microsoft\" として返されます。
 
Root 説明
HKEY_CLASSES_ROOT
 00
HKEY_CURRENT_USER
 01
HKEY_LOCAL_MACHINE
 02
HKEY_USERS
 03

[in, out, optional] pcchOutPathBuffer

szPathBuf パラメーターが指すバッファーのサイズを受け取る場所へのポインター (TCHAR)。 この場所の値は、終端の null 文字を含む文字列内の TCHAR の数に設定する必要があります。 バッファーのサイズが小さすぎる場合、このパラメーターは、カウントに終端の null 文字を含めずに、文字列値の長さを受け取ります。

戻り値

MsiGetComponentPathEx 関数は、次の値を返します。

値 意味
INSTALLSTATE_NOTUSED
 要求されているコンポーネントは、コンピューター上で無効になっています。
INSTALLSTATE_BADCONFIG
 構成データが破損しています。
INSTALLSTATE_ABSENT
 コンポーネントがインストールされていません。
INSTALLSTATE_INVALIDARG
 関数パラメーターの 1 つが無効です。
INSTALLSTATE_LOCAL
 コンポーネントはローカルにインストールされます。
INSTALLSTATE_SOURCE
 コンポーネントは、ソースから実行するためにインストールされます。
INSTALLSTATE_SOURCEABSENT
 コンポーネント ソースにアクセスできません。
INSTALLSTATE_UNKNOWN
 製品コードまたはコンポーネント ID が不明です。
INSTALLSTATE_BROKEN
 コンポーネントが破損しているか、何らかの方法で部分的に見つからないので、修復が必要です。

注釈

MsiGetComponentPathEx 関数は、次の理由により、INSTALLSTATE_ABSENTまたはINSTALL_STATE_UNKNOWNを返す場合があります。

  • INSTALLSTATE_ABSENT

    アプリケーションは、MsiUseFeature と必要に応じて MsiConfigureFeature を呼び出すことによって、機能がインストールされたことを正しく確認できませんでした。

  • INSTALLSTATE_UNKNOWN

    この機能は公開されていません。 アプリケーションでは、 MsiQueryFeatureState または MsiEnumFeatures を呼び出して、これを以前に決定 しておく必要があります。 アプリケーションは、初期化中にこれらの呼び出しを行います。 アプリケーションでは、公開されていることがわかっている機能のみを使用する必要があります。 INSTALLSTATE_UNKNOWNは MsiUseFeature によっても返される必要があるため、 MsiUseFeature が呼び出されなかったか、その戻り値が正しくチェックされませんでした。

注意

msi.h ヘッダーは、MSIGetComponentPathEx をエイリアスとして定義し、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI または Unicode バージョンを自動的に選択します。 エンコードに依存しないエイリアスをエンコードニュートラルでないコードと組み合わせて使用すると、コンパイルまたはランタイム エラーが発生する不一致が発生する可能性があります。 詳細については、「 関数プロトタイプの規則」を参照してください。

要件

要件 値
サポートされている最小のクライアント Windows Server 2012、Windows 8、Windows Server 2008 R2、または Windows 7 の Windows インストーラー 5.0。 Windows インストーラーのバージョンに必要な最小の Windows Service Pack については、Windows インストーラーの実行時の要件に関する記事を参照してください。
対象プラットフォーム Windows
ヘッダー msi.h
Library Msi.lib
[DLL] Msi.dll

こちらもご覧ください

コンポーネント固有の関数