MsiEnumComponentQualifiersA 関数 (msi.h)

  • [アーティクル]

MsiEnumComponentQualifiers 関数は、指定されたコンポーネントのアドバタイズされた修飾子を列挙します。 この関数は、呼び出されるたびに 1 つの修飾子を取得します。

構文

UINT MsiEnumComponentQualifiersA(
  [in]      LPCSTR  szComponent,
  [in]      DWORD   iIndex,
  [out]     LPSTR   lpQualifierBuf,
  [in, out] LPDWORD pcchQualifierBuf,
  [out]     LPSTR   lpApplicationDataBuf,
  [in, out] LPDWORD pcchApplicationDataBuf
);

パラメーター

[in] szComponent

修飾子を列挙するコンポーネントを指定します。

[in] iIndex

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

[out] lpQualifierBuf

修飾子コードを受け取るバッファーへのポインター。

[in, out] pcchQualifierBuf

lpQualifierBuf パラメーターが指すバッファーのサイズを文字単位で指定する変数へのポインター。 入力時に、このサイズには終端の null 文字を含める必要があります。 戻り値には null 文字は含まれません。

[out] lpApplicationDataBuf

修飾子のアプリケーション登録済みデータを受け取るバッファーへのポインター。 このパラメーターには、null を指定できます。

[in, out] pcchApplicationDataBuf

lpApplicationDataBuf パラメーターが指すバッファーのサイズを文字単位で指定する変数へのポインター。 入力時に、このサイズには終端の null 文字を含める必要があります。 戻り値には null 文字は含まれません。 このパラメーターは、 lpApplicationDataBuf パラメーターが null の場合にのみ null にすることができます。

戻り値

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

解説

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

MsiEnumComponentQualifiers が返されると、pcchQualifierBuf パラメーターには、バッファーに格納されている修飾子文字列の長さが含まれます。 返されるカウントには、終端の null 文字は含まれません。 バッファーの大きさが十分でない場合、 MsiEnumComponentQualifiers はERROR_MORE_DATAを返します。このパラメーターには、null 文字をカウントせずに文字列のサイズ (文字単位) が含まれます。 pcchDescriptionBuf にも同じメカニズムが適用されます。

MsiEnumComponentQualifiers を複数回呼び出して、コンポーネントのすべてのアドバタイズされた修飾子を列挙する場合、各呼び出しは同じスレッドから行う必要があります。

注意

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

要件

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

関連項目

システム状態関数