MsiEnumComponentsA 関数 (msi.h)

  • [アーティクル]

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

構文

UINT MsiEnumComponentsA(
  [in]  DWORD iComponentIndex,
  [out] LPSTR lpComponentBuf
);

パラメーター

[in] iComponentIndex

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

[out] lpComponentBuf

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

戻り値

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

注釈

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

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

注意

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

こちらもご覧ください

システム状態関数