MsiEnumComponentsExA 関数 (msi.h)
MsiEnumComponentsEx 関数は、インストールされているコンポーネントを列挙します。 この関数は、呼び出されるたびに 1 つのコンポーネントのコンポーネント コードを取得します。 コンポーネント コードは、コンポーネント、バージョン、言語に固有の文字列 GUID です。
Windows インストーラー 4.5 以前の: サポートされていません。 この関数は、Windows インストーラー 5.0 以降で使用できます。
構文
UINT MsiEnumComponentsExA(
[in, optional] LPCSTR szUserSid,
[in] DWORD dwContext,
[in] DWORD dwIndex,
[out, optional] CHAR [39] szInstalledComponentCode,
[out, optional] MSIINSTALLCONTEXT *pdwInstalledContext,
[out, optional] LPSTR szSid,
[in, out] LPDWORD pcchSid
);
パラメーター
[in, optional] szUserSid
セキュリティ識別子 (SID) を含む null で終わる文字列。インストールされているコンポーネントの列挙は、この SID によって識別されるユーザーに拡張されます。 特殊な SID 文字列 s-1-1-0 (Everyone) は、システム内のすべてのユーザーのすべての製品にインストールされているすべてのコンポーネントの列挙体を指定します。 s-1-1-0 以外の SID 値は、特定のユーザーのユーザー SID を指定し、指定されたユーザーによってインストールされたアプリケーションのインスタンスに列挙を制限します。
| SID の種類 | 意味 |
|---|---|
|
現在ログオンしているユーザーを指定します。 |
|
システム内の特定のユーザーの列挙。 ユーザー SID の例として、"S-1-3-64-2415071341-1358098788-3127455600-2561" があります。 |
|
システム内のすべてのユーザーを指定します。 |
特殊な SID 文字列 s-1-5-18 (システム) を使用して、コンピューターごとのインストール コンテキストでインストールされたアプリケーションを列挙することはできません。 SID 値を s-1-5-18 に設定すると、ERROR_INVALID_PARAMETERが返されます。 dwContext
[in] dwContext
インストールされているコンポーネントの列挙を、指定したインストール コンテキストでインストールされている製品のインスタンスに制限するフラグ。 列挙には、szUserSidで指定されたユーザーによってインストールされた製品インスタンスのみが含まれます。
[in] dwIndex
取得するコンポーネントのインデックスを指定します。 MsiEnumComponentsEx 関数への最初の呼び出しでは、このパラメーター
[out, optional] szInstalledComponentCode
インストールされているコンポーネントのコンポーネント コード GUID を受け取る出力バッファー。 バッファーの長さは、コンポーネント コードを含む null で終わる文字列値を保持するのに十分な大きさにする必要があります。 最初の 38 TCHAR 文字はコンポーネントの GUID を受け取り、39 番目の文字は終端の NULL 文字を受け取ります。
[out, optional] pdwInstalledContext
コンポーネントをインストールしたアプリケーションのインストール コンテキストを示すフラグ。
[out, optional] szSid
コンポーネントを所有するアプリケーションをインストールしたユーザーを識別するセキュリティ識別子 (SID) を受け取ります。 アプリケーションのこのインスタンスがコンピューターごとのインストール コンテキストでインストールされている場合、場所は空の文字列を受け取ります。
この場所のバッファーの長さは、SID を含む null で終わる文字列値を保持するのに十分な大きさにする必要があります。 バッファーが小さすぎる場合、関数は
| SID の種類 | 意味 |
|---|---|
|
アプリケーションは、コンピューターごとのインストール コンテキストでインストールされます。 |
|
アプリケーションをインストールしたシステム内のユーザーの SID。 |
[in, out] pcchSid
SID 内の TCHAR の数を受け取ります。終端の null 文字は含まれません。 関数が戻るときに、関数が SID を正常にコピーし、szSidが指すバッファー位置に null 文字を終了できるかどうかに関係なく、この変数は要求された SID のサイズ
このパラメーターは、
戻り値
MsiEnumProductsEx 関数は、次のいずれかの値を返します。
| リターン コード | 形容 |
|---|---|
|
現在のユーザー以外のユーザーによってインストールされたアプリケーションのコンポーネントを列挙するには、管理者特権が必要です。 |
|
構成データが破損しています。 |
|
無効なパラメーターが関数に渡されます。 |
|
列挙するコンポーネントはこれ以上ありません。 |
|
関数は成功しました。 |
|
指定されたバッファーが小さすぎて値全体を保持できませんでした。 |
|
関数が失敗しました。 |
備考
手記
msi.h ヘッダーは、MSIEnumComponentsEx を、UNICODE プリプロセッサ定数の定義に基づいてこの関数の ANSI または Unicode バージョンを自動的に選択するエイリアスとして定義します。 エンコードに依存しないエイリアスをエンコードに依存しないコードと組み合わせて使用すると、コンパイルエラーやランタイム エラーが発生する不一致が発生する可能性があります。 詳細については、「関数プロトタイプの 規則」を参照してください。
必要条件
| 要件 | 価値 |
|---|---|
| サポートされる最小クライアント | Windows Server 2012、Windows 8、Windows Server 2008 R2、または Windows 7 の Windows インストーラー 5.0。 Windows インストーラーのバージョンで必要な最小 Windows Service Pack の詳細については、Windows インストーラーの Run-Time 要件を参照してください。 |
| ターゲット プラットフォーム の |
ウィンドウズ |
| ヘッダー | msi.h |
| ライブラリ | Msi.lib |
| DLL | Msi.dll |