MsiEnumClientsExA 関数 (msi.h)

  • [アーティクル]

MsiEnumClientsEx 関数は、指定したコンポーネントを使用するインストール済みアプリケーションを列挙します。 関数は、アプリケーションが呼び出されるたびに 製品コード を取得します。

Windows インストーラー 4.5 以前: サポートされていません。 この関数は、Windows インストーラー 5.0 以降で使用できます。

構文

UINT MsiEnumClientsExA(
  [in]                LPCSTR            szComponent,
  [in, optional]      LPCSTR            szUserSid,
  [in]                DWORD             dwContext,
  [in]                DWORD             dwProductIndex,
  [out, optional]     CHAR [39]         szProductBuf,
  [out, optional]     MSIINSTALLCONTEXT *pdwInstalledContext,
  [out, optional]     LPSTR             szSid,
  [in, out, optional] LPDWORD           pcchSid
);

パラメーター

[in] szComponent

コンポーネントを識別するコンポーネント コード GUID。 関数は、このコンポーネントを使用するアプリケーションを列挙します。

[in, optional] szUserSid

セキュリティ識別子 (SID) を含む null で終わる文字列値。アプリケーションの列挙は、この SID によって識別されるユーザーに拡張されます。 特殊な SID 文字列 s-1-1-0 (Everyone) は、システム内のすべてのユーザーのすべてのアプリケーションを列挙します。 s-1-1-0 以外の SID 値は、特定のユーザーのユーザー SID を指定し、指定したユーザーによってインストールされたアプリケーションのインスタンスを列挙します。

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] dwContext

指定したインストール コンテキストにインストールされているアプリケーションのインスタンスに列挙を拡張するフラグ。 列挙には、 szUserSid で識別されたユーザーによってインストールされるアプリケーションのインスタンスのみが含まれます。

これは、次の値の組み合わせにすることができます。

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

[in] dwProductIndex

取得するアプリケーションのインデックスを指定します。 このパラメーターの値は、関数の最初の呼び出しでゼロ (0) である必要があります。 後続の呼び出しごとに、インデックスを 1 ずつインクリメントする必要があります。 インデックスは、前の関数の呼び出しが ERROR_SUCCESSを返す場合にのみインクリメントする必要があります。

[out, optional] szProductBuf

アプリケーションの製品コードを受け取る文字列値。 この場所のバッファーの長さは、製品コードを含む null で終わる文字列値を保持するのに十分な大きさにする必要があります。 最初の 38 文字の TCHAR 文字はコンポーネントの GUID を受け取り、39 番目の文字は終端の NULL 文字を受け取ります。

[out, optional] pdwInstalledContext

アプリケーションのインストール コンテキストを示す フラグ。

これは、次の値の組み合わせにすることができます。

Context 説明
MSIINSTALLCONTEXT_USERMANAGED
1
 アプリケーションは、ユーザーごとに管理されるインストール コンテキストでインストールされます。
MSIINSTALLCONTEXT_USERUNMANAGED
2
 アプリケーションは、ユーザーごとのアンマネージド インストール コンテキストにインストールされます。
MSIINSTALLCONTEXT_MACHINE
4
 アプリケーションは、マシンごとのインストール インストール コンテキストにあります。

[out, optional] szSid

アプリケーションをインストールしたユーザーを識別するセキュリティ識別子 (SID) を受け取ります。 アプリケーションのこのインスタンスがコンピューターごとのインストール コンテキストに存在する場合、場所は空の文字列値を受け取ります。

バッファーの長さは、SID を含む null で終わる文字列値を保持するのに十分な大きさにする必要があります。 バッファーが小さすぎる場合、関数は ERROR_MORE_DATA を返し、 pcchSid が指す場所は、終端の NULL 文字を含まない SID 内の TCHAR の数を受け取ります。

szSid が NULL に設定され、pcchSid がメモリ内の場所への有効なポインターである場合、関数は ERROR_SUCCESSを返し、その場所は、終端の null 文字を含まない SID 内の TCHAR の数を受け取ります。 その後、関数を再度呼び出して値を取得し、 szSid バッファーのサイズが *pcchSid + 1 文字を含むのに十分な大きさに変更されます。

SID の種類 説明
空の文字列
 アプリケーションは、コンピューターごとのインストール コンテキストでインストールされます。
ユーザー SID
 製品をインストールしたユーザーの SID。

[in, out, optional] pcchSid

SID 内の TCHAR の数を指定する変数を含むメモリ内の場所へのポインター。終端の null 文字は含まれません。 関数が戻るときに、この変数は、関数が SID を正常にコピーし、 szSid が指すバッファーの場所に null 文字を終了できるかどうかに関係なく、要求された SID のサイズに設定されます。 サイズは、要求された値の TCHAR の数として返されます。終端の null 文字は含まれません。

このパラメーターは、szSid も NULL の場合にのみ NULL に設定できます。それ以外の場合、関数は ERROR_INVALID_PARAMETERを返します。 szSid と pcchSid の両方が NULL に設定されている場合、SID 値を取得せずに、SID が存在する場合、関数はERROR_SUCCESSを返します。

戻り値

MsiEnumClientsEx 関数は、次のいずれかの値を返します。

リターン コード 説明
ERROR_ACCESS_DENIED
 現在のユーザー以外のユーザーによってインストールされたアプリケーションのコンポーネントを列挙するには、Administratator 特権が必要です。
ERROR_BAD_CONFIGURATION
 構成データが破損しています。
ERROR_INVALID_PARAMETER
 無効なパラメーターが関数に渡されます。
ERROR_NO_MORE_ITEMS
 列挙するアプリケーションはこれ以上ありません。
ERROR_SUCCESS
 関数が正常に実行されました。
ERROR_MORE_DATA
 指定されたバッファーが小さすぎて値全体を保持できませんでした。
ERROR_FUNCTION_FAILED
 関数が失敗しました。

解説

注意

msi.h ヘッダーは、MSIEnumClientsEx をエイリアスとして定義し、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