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 が MSIINSTALLCONTEXT_MACHINE のみに設定されている場合、szUserSid は NULL である必要があります。
[in] dwContext
インストールされているコンポーネントの列挙を、指定したインストール コンテキストにインストールされている製品のインスタンスに制限するフラグ。 列挙には、 szUserSid で指定されたユーザーによってインストールされた製品インスタンスのみが含まれます。
[in] dwIndex
取得するコンポーネントのインデックスを指定します。 MsiEnumComponentsEx 関数の最初の呼び出しでは、このパラメーターは 0 である必要があります。 後続の呼び出しごとに、インデックスを 1 ずつインクリメントする必要があります。 インデックスは、関数の前の呼び出しがERROR_SUCCESSを返す場合にのみインクリメントする必要があります。 コンポーネントは順序付けされておらず、関数から任意の順序で返すことができます。
[out, optional] szInstalledComponentCode
インストールされているコンポーネントのコンポーネント コード GUID を受け取る出力バッファー。 バッファーの長さは、コンポーネント コードを含む null で終わる文字列値を保持するのに十分な大きさにする必要があります。 最初の 38 文字の TCHAR はコンポーネントの GUID を受け取り、39 番目の文字は終端の NULL 文字を受け取ります。
[out, optional] pdwInstalledContext
コンポーネントをインストールしたアプリケーションをインストール コンテキストに提供するフラグ。
[out, optional] szSid
コンポーネントを所有するアプリケーションをインストールしたユーザーを識別するセキュリティ識別子 (SID) を受け取ります。 アプリケーションのこのインスタンスがマシンごとのインストール コンテキストにインストールされている場合、場所は空の文字列を受け取ります。
この場所のバッファーの長さは、SID を含む null で終わる文字列値を保持するのに十分な大きさにする必要があります。 バッファーが小さすぎる場合、関数は ERROR_MORE_DATA を返し、 pcchSid が指す場所は、終了する NULL 文字を含めず、SID 内の TCHAR の数を受け取ります。
szSid が NULL に設定され、pcchSid がメモリ内の場所への有効なポインターである場合、この関数は ERROR_SUCCESSを返し、終了する null 文字を含まない SID 内の TCHAR の数を受け取ります。 関数を再度呼び出して値を取得し、 *pcchSid + 1 文字を含むのに十分なサイズの szSid バッファーをサイズ変更できます。
| SID の種類 | 意味 |
|---|---|
|
アプリケーションは、コンピューターごとのインストール コンテキストでインストールされます。 |
|
アプリケーションをインストールしたシステム内のユーザーの SID。 |
[in, out] pcchSid
SID 内の TCHAR の数を受け取ります。終端の null 文字は含まれません。 関数が戻ると、関数が SID を正常にコピーし、null 文字を szSid が指すバッファーの場所に終了できるかどうかに関係なく、この変数は要求された SID のサイズに設定されます。 サイズは、要求された値の TCHAR の数として返されます。終端の null 文字は含まれません。
このパラメーターは、szSid も NULL の場合にのみ NULL に設定できます。それ以外の場合、関数はERROR_INVALID_PARAMETERを返します。 szSid と pcchSid の両方が NULL に設定されている場合、SID が存在する場合は、SID 値を取得せずに、ERROR_SUCCESSが返されます。
戻り値
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 インストーラーの実行時の要件に関する記事を参照してください。 |
| 対象プラットフォーム | Windows |
| ヘッダー | msi.h |
| Library | Msi.lib |
| [DLL] | Msi.dll |