MsiEnumClientsA 関数 (msi.h)

  • [アーティクル]

MsiEnumClients 関数は、インストールされている特定のコンポーネントのクライアントを列挙します。 関数は、呼び出されるたびに 1 つの製品コードを取得します。

構文

UINT MsiEnumClientsA(
  [in]  LPCSTR szComponent,
  [in]  DWORD  iProductIndex,
  [out] LPSTR  lpProductBuf
);

パラメーター

[in] szComponent

クライアントを列挙するコンポーネントを指定します。

[in] iProductIndex

取得するクライアントのインデックスを指定します。 このパラメーターは、 MsiEnumClients 関数の最初の呼び出しでは 0 にし、その後の呼び出しではインクリメントする必要があります。 クライアントは順序付けされないため、新しいクライアントには任意のインデックスがあります。 つまり、関数は任意の順序でクライアントを返すことができます。

[out] lpProductBuf

製品コードを受け取るバッファーへのポインター。 このバッファーの長さは 39 文字にする必要があります。 最初の 38 文字は GUID 用で、最後の文字は終端の null 文字用です。

戻り値

値 説明
ERROR_BAD_CONFIGURATION
 構成データが破損しています。
ERROR_INVALID_PARAMETER
 無効なパラメーターが関数に渡されました。
ERROR_NO_MORE_ITEMS
 返すクライアントはありません。
ERROR_NOT_ENOUGH_MEMORY
 システムに、操作を完了するための十分なメモリがありません。 Windows Server 2003 で使用できます。
ERROR_SUCCESS
 値が列挙されました。
ERROR_UNKNOWN_COMPONENT
 指定されたコンポーネントが不明です。

解説

クライアントを列挙するには、アプリケーションは最初に、iProductIndex パラメーターを 0 に設定して MsiEnumClients 関数を呼び出す必要があります。 その後、アプリケーションは iProductIndex パラメーターをインクリメントし、クライアントがなくなったまで MsiEnumClients を呼び出す必要があります (つまり、関数がERROR_NO_MORE_ITEMSを返すまで)。

MsiEnumClients に対して複数の呼び出しを行ってすべてのコンポーネントのクライアントを列挙する場合、各呼び出しは同じスレッドから行う必要があります。

注意

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

要件

   
サポートされている最小のクライアント 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

関連項目

システム状態関数