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_* 定数の組み合わせである必要があります。
| フラグ | 説明 |
|---|---|
|
ソースはネットワークの種類です。 |
|
ソースは URL の種類です。 |
|
szProductCodeOrPatchCode は製品コードです。 |
|
szProductCodeOrPatchCode はパッチ コードです。 |
[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 を複数回呼び出す場合、各呼び出しは同じスレッドから行う必要があります。
管理者は、すべてのユーザーに対して、ユーザーごとのアンマネージド インストールとマネージド インストール、マシンごとのインストール、およびユーザーごとのマネージド インストールを列挙できます。 管理者は、他のユーザーのユーザーごとのアンマネージド インストールを列挙できません。 管理者以外は、ユーザーごとのアンマネージド インストールとマネージド インストールとマシンごとのインストールのみを列挙できます。
注意
msi.h ヘッダーは、MSISourceListEnumSources をエイリアスとして定義します。このエイリアスは、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 インストーラー 3.0 以降。 Windows インストーラーのバージョンに必要な最小の Windows Service Pack については、Windows インストーラーの実行時の要件に関する記事を参照してください。 |
| 対象プラットフォーム | Windows |
| ヘッダー | msi.h |
| Library | Msi.lib |
| [DLL] | Msi.dll |
こちらもご覧ください
フィードバック
以下は間もなく提供いたします。2024 年を通じて、コンテンツのフィードバック メカニズムとして GitHub の issue を段階的に廃止し、新しいフィードバック システムに置き換えます。 詳細については、「https://aka.ms/ContentUserFeedback」を参照してください。
フィードバックの送信と表示