MsiGetComponentPathA 関数 (msi.h)

  • [アーティクル]

MsiGetComponentPath 関数は、インストールされているコンポーネントへの完全なパスを返します。 コンポーネントのキー パスがレジストリ キーの場合、レジストリ キーが返されます。

構文

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

パラメーター

[in] szProduct

クライアント製品の製品コードを指定します。

[in] szComponent

配置するコンポーネントのコンポーネント ID を指定します。

[out] lpPathBuf

コンポーネントへのパスを受け取る変数へのポインター。 このパラメーターには、null を指定できます。 コンポーネントがレジストリ キーの場合、レジストリ ルートは数字で表されます。 これがレジストリ サブキー パスの場合は、キー パスの末尾に円記号が付きます。 これがレジストリ値のキー パスの場合、末尾に円記号はありません。 たとえば、HKEY_CURRENT_USERSOFTWARE\Microsoft の 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] pcchBuf

lpPathBuf パラメーターが指すバッファーのサイズを文字単位で指定する変数へのポインター。 入力時には、終端の null 文字のスペースを含む、バッファーのフル サイズです。 渡されたバッファーが小さすぎる場合、返されるカウントには終端の null 文字は含まれません。

lpPathBuf が null の場合、pcchBuf は null にすることができます。

戻り値

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

値 説明
INSTALLSTATE_NOTUSED
 要求されているコンポーネントは、コンピューターで無効になっています。
INSTALLSTATE_ABSENT
 コンポーネントがインストールされていません。
INSTALLSTATE_INVALIDARG
 関数パラメーターの 1 つが無効です。
INSTALLSTATE_LOCAL
 コンポーネントはローカルにインストールされます。
INSTALLSTATE_SOURCE
 コンポーネントは、ソースから実行するためにインストールされます。
INSTALLSTATE_SOURCEABSENT
 コンポーネント ソースにアクセスできません。
INSTALLSTATE_UNKNOWN
 製品コードまたはコンポーネント ID が不明です。

解説

MsiGetComponentPath 関数が成功すると、pcchBuf パラメーターには lpPathBuf 内の文字列の長さが含まれます。

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

  • INSTALLSTATE_ABSENT

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

  • INSTALLSTATE_UNKNOWN

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

Note

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

要件

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

関連項目

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