MsiSourceListEnumSourcesW 関数 (msi.h)

MsiSourceListEnumSources 関数は、指定されたパッチまたは製品のソース リスト内のソースを列挙します。

構文

UINT MsiSourceListEnumSourcesW(
  [in]                LPCWSTR           szProductCodeOrPatchCode,
  [in, optional]      LPCWSTR           szUserSid,
  [in]                MSIINSTALLCONTEXT dwContext,
  [in]                DWORD             dwOptions,
  [in]                DWORD             dwIndex,
  [in, optional]      LPWSTR            szSource,
  [in, out, optional] LPDWORD           pcchSource
);

パラメーター

[in] szProductCodeOrPatchCode

製品またはパッチの ProductCode またはパッチ GUID。 null で終わる文字列を使用します。 文字列が 39 文字を超える場合、関数は失敗し、ERROR_INVALID_PARAMETERを返します。 このパラメーターを NULL にすることはできません。

[in, optional] szUserSid

製品またはパッチを含むユーザー アカウントを指定する文字列 SID。 SID は検証も解決もされません。 SID が正しくないと、ERROR_UNKNOWN_PRODUCTまたはERROR_UNKNOWN_PATCHが返される可能性があります。 マシン コンテキストを参照する場合、 szUserSID は NULL で、 dwContext はMSIINSTALLCONTEXT_MACHINEする必要があります。

[in] dwContext

製品またはパッチ インスタンスのコンテキスト。 このパラメーターには、次のいずれかの値を含めることができます。

[in] dwOptions

dwOptions 値は、szProductCodeOrPatchCode 値の解釈とクリアするソースの種類を決定します。 このパラメーターは、次のいずれかのMSISOURCETYPE_* 定数と、次のMSICODE_* 定数の組み合わせである必要があります。

[in] dwIndex

取得するソースのインデックス。 このパラメーターは、 MsiSourceListEnumSources 関数の最初の呼び出しでは 0 (ゼロ) にし、その後の呼び出しで関数がERROR_NO_MORE_ITEMSを返すまでインクリメントする必要があります。 前の呼び出しがERROR_SUCCESS返された場合にのみ、インデックスをインクリメントする必要があります。

[in, optional] szSource

列挙されるソースへのパスを受け取るバッファーへのポインター。 このバッファーは、受信した値を格納するのに十分な大きさにする必要があります。 バッファーが小さすぎる場合、関数は ERROR_MORE_DATAを返し、終了 NULL 文字を含まない値の TCHAR の数に *pcchSource を設定します。

szSource が NULL に設定され、pcchSource が有効なポインターに設定されている場合、この関数は ERROR_SUCCESSを返し、終了する NULL 文字を含まない値の TCHAR の数に *pcchSource を設定します。 その後、関数を再度呼び出して値を取得し、*pcchSource + 1 文字を格納するのに十分な大きさの szSource バッファーを使用できます。

szSource と pcchSource の両方が NULL に設定されている場合、値が存在する場合、関数は値を取得せずにERROR_SUCCESSを返します。

[in, out, optional] pcchSource

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

このパラメーターは、szSource も NULL である場合にのみ NULL に設定できます。それ以外の場合、関数はERROR_INVALID_PARAMETERを返します。

戻り値

MsiSourceListEnumSources 関数は、次の値を返します。

注釈

1 つの製品インスタンスのすべてのソースを列挙するために MsiSourceListEnumSources を複数回呼び出す場合、各呼び出しは同じスレッドから行う必要があります。

管理者は、すべてのユーザーに対して、ユーザーごとのアンマネージド インストールとマネージド インストール、マシンごとのインストール、およびユーザーごとのマネージド インストールを列挙できます。 管理者は、他のユーザーのユーザーごとのアンマネージド インストールを列挙できません。 管理者以外は、ユーザーごとのアンマネージド インストールとマネージド インストールとマシンごとのインストールのみを列挙できます。

要件

こちらもご覧ください

インストール コンテキスト

Windows インストーラー 2.0 以前ではサポートされていません

ProductCode