ホーム › System.ApplicationInstallationAndServicing › MsiProvideQualifiedComponentW

MsiProvideQualifiedComponentW

関数

カテゴリと修飾子で指定したコンポーネントのパスを取得し、必要なら起動時インストールする。

DLLmsi.dll文字セットUnicode (-W)呼出規約winapi対応OSwindows8.0

シグネチャ

// msi.dll  (Unicode / -W)
#include <windows.h>

DWORD MsiProvideQualifiedComponentW(
    LPCWSTR szCategory,
    LPCWSTR szQualifier,
    DWORD dwInstallMode,
    LPWSTR lpPathBuf,   // optional
    DWORD* pcchPathBuf   // optional
);

パラメーター

名前

型

方向

説明

szCategory

LPCWSTR

要求するコンポーネントのコンポーネント ID を指定します。これはコンポーネント自体の GUID ではなく、 PublishComponent テーブルの ComponentId 列のように、正しい機能を提供するサーバーを指す場合があります。

szQualifier

LPCWSTR

アドバタイズされるコンポーネントの一覧( PublishComponent テーブル)への修飾子を指定します。

dwInstallMode

DWORD

インストールモードを定義します。このパラメーターには、次のいずれかの値を指定できます。

値	意味
INSTALLMODE_DEFAULT	コンポーネントを提供し、その提供に必要なインストールを実行します。要求された機能またはその親機能内のコンポーネントのキーファイルが存在しない場合は、 MsiReinstallFeature を使用し、次のフラグビットを設定して機能を再インストールします: REINSTALLMODE_FILEMISSING、REINSTALLMODE_FILEOLDERVERSION、REINSTALLMODE_FILEVERIFY、REINSTALLMODE_MACHINEDATA、REINSTALLMODE_USERDATA、REINSTALLMODE_SHORTCUT。
INSTALLMODE_EXISTING	機能が存在する場合にのみコンポーネントを提供します。それ以外の場合は ERROR_FILE_NOT_FOUND を返します。このモードは、コンポーネントのキーファイルが存在することを検証します。
INSTALLMODE_NODETECTION	機能が存在する場合にのみコンポーネントを提供します。それ以外の場合は ERROR_FILE_NOT_FOUND を返します。このモードはコンポーネントが登録されていることのみを確認し、コンポーネントのキーファイルが存在することは検証しません。
REINSTALLMODE フラグの組み合わせ	このパラメーターを dwReinstallMode パラメーターとして使用して MsiReinstallFeature を呼び出して機能を再インストールし、その後コンポーネントを提供します。
INSTALLMODE_NOSOURCERESOLUTION	機能のインストール状態が INSTALLSTATE_LOCAL の場合にのみコンポーネントを提供します。機能のインストール状態が INSTALLSTATE_SOURCE の場合は ERROR_INSTALL_SOURCE_ABSENT を返します。それ以外の場合は ERROR_FILE_NOT_FOUND を返します。このモードはコンポーネントが登録されていることのみを確認し、キーファイルが存在することは検証しません。

lpPathBuf

LPWSTR

outoptional

コンポーネントへのパスを受け取る変数へのポインター。このパラメーターは null にすることができます。

pcchPathBuf

DWORD*

inoutoptional

lpPathBuf パラメーターが指すバッファーのサイズ(文字数)を指定する変数へのポインター。入力時には、終端の null 文字用の領域を含むバッファー全体のサイズを指定します。渡されたバッファーが小さすぎる場合、返される文字数には終端の null 文字は含まれません。

lpPathBuf が null の場合、pcchBuf も null にすることができます。

戻り値の型: DWORD

公式ドキュメント

MsiProvideQualifiedComponent 関数は、修飾コンポーネントの完全なコンポーネントパスを返し、必要なインストールを実行します。この関数は、必要に応じてソースの指定を要求し、機能の使用回数をインクリメントします。(Unicode)

戻り値

値	意味
ERROR_INDEX_ABSENT	コンポーネント修飾子が無効であるか、存在しません。
ERROR_SUCCESS	関数は正常に完了しました。
ERROR_FILE_NOT_FOUND	機能が存在しないか、破損しています。このエラーは dwInstallMode = INSTALLMODE_EXISTING の場合に返されます。
ERROR_UNKNOWN_COMPONENT	指定されたコンポーネントは不明です。
アクションに関連するエラー	エラーコードを参照してください。
初期化エラー	初期化に関連するエラーが発生しました。

解説(Remarks)

MsiProvideQualifiedComponent 関数が成功すると、pcchPathBuf パラメーターには lpPathBuf 内の文字列の長さが格納されます。

破損したファイルや誤ったバージョンのファイルを含むコンポーネントを持つ機能は、ユーザーが明示的に再インストールするか、アプリケーションが MsiReinstallFeature を呼び出して再インストールする必要があります。

メモ

msi.h ヘッダーは MsiProvideQualifiedComponent を、UNICODE プリプロセッサ定数の定義に基づいてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして定義します。エンコーディング非依存のエイリアスの使用と、エンコーディング非依存ではないコードを混在させると、コンパイルエラーや実行時エラーを引き起こす不整合につながる可能性があります。詳細については、関数プロトタイプの規則を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// msi.dll  (Unicode / -W)
#include <windows.h>

DWORD MsiProvideQualifiedComponentW(
    LPCWSTR szCategory,
    LPCWSTR szQualifier,
    DWORD dwInstallMode,
    LPWSTR lpPathBuf,   // optional
    DWORD* pcchPathBuf   // optional
);

[DllImport("msi.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern uint MsiProvideQualifiedComponentW(
    [MarshalAs(UnmanagedType.LPWStr)] string szCategory,   // LPCWSTR
    [MarshalAs(UnmanagedType.LPWStr)] string szQualifier,   // LPCWSTR
    uint dwInstallMode,   // DWORD
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpPathBuf,   // LPWSTR optional, out
    IntPtr pcchPathBuf   // DWORD* optional, in/out
);

<DllImport("msi.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function MsiProvideQualifiedComponentW(
    <MarshalAs(UnmanagedType.LPWStr)> szCategory As String,   ' LPCWSTR
    <MarshalAs(UnmanagedType.LPWStr)> szQualifier As String,   ' LPCWSTR
    dwInstallMode As UInteger,   ' DWORD
    <MarshalAs(UnmanagedType.LPWStr)> lpPathBuf As System.Text.StringBuilder,   ' LPWSTR optional, out
    pcchPathBuf As IntPtr   ' DWORD* optional, in/out
) As UInteger
End Function

' szCategory : LPCWSTR
' szQualifier : LPCWSTR
' dwInstallMode : DWORD
' lpPathBuf : LPWSTR optional, out
' pcchPathBuf : DWORD* optional, in/out
Declare PtrSafe Function MsiProvideQualifiedComponentW Lib "msi" ( _
    ByVal szCategory As LongPtr, _
    ByVal szQualifier As LongPtr, _
    ByVal dwInstallMode As Long, _
    ByVal lpPathBuf As LongPtr, _
    ByVal pcchPathBuf As LongPtr) As Long
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

MsiProvideQualifiedComponentW = ctypes.windll.msi.MsiProvideQualifiedComponentW
MsiProvideQualifiedComponentW.restype = wintypes.DWORD
MsiProvideQualifiedComponentW.argtypes = [
    wintypes.LPCWSTR,  # szCategory : LPCWSTR
    wintypes.LPCWSTR,  # szQualifier : LPCWSTR
    wintypes.DWORD,  # dwInstallMode : DWORD
    wintypes.LPWSTR,  # lpPathBuf : LPWSTR optional, out
    ctypes.POINTER(wintypes.DWORD),  # pcchPathBuf : DWORD* optional, in/out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('msi.dll')
MsiProvideQualifiedComponentW = Fiddle::Function.new(
  lib['MsiProvideQualifiedComponentW'],
  [
    Fiddle::TYPE_VOIDP,  # szCategory : LPCWSTR
    Fiddle::TYPE_VOIDP,  # szQualifier : LPCWSTR
    -Fiddle::TYPE_INT,  # dwInstallMode : DWORD
    Fiddle::TYPE_VOIDP,  # lpPathBuf : LPWSTR optional, out
    Fiddle::TYPE_VOIDP,  # pcchPathBuf : DWORD* optional, in/out
  ],
  -Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "msi")]
extern "system" {
    fn MsiProvideQualifiedComponentW(
        szCategory: *const u16,  // LPCWSTR
        szQualifier: *const u16,  // LPCWSTR
        dwInstallMode: u32,  // DWORD
        lpPathBuf: *mut u16,  // LPWSTR optional, out
        pcchPathBuf: *mut u32  // DWORD* optional, in/out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("msi.dll", CharSet = CharSet.Unicode)]
public static extern uint MsiProvideQualifiedComponentW([MarshalAs(UnmanagedType.LPWStr)] string szCategory, [MarshalAs(UnmanagedType.LPWStr)] string szQualifier, uint dwInstallMode, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpPathBuf, IntPtr pcchPathBuf);
"@
$api = Add-Type -MemberDefinition $sig -Name 'msi_MsiProvideQualifiedComponentW' -Namespace Win32 -PassThru
# $api::MsiProvideQualifiedComponentW(szCategory, szQualifier, dwInstallMode, lpPathBuf, pcchPathBuf)

#uselib "msi.dll"
#func global MsiProvideQualifiedComponentW "MsiProvideQualifiedComponentW" wptr, wptr, wptr, wptr, wptr
; MsiProvideQualifiedComponentW szCategory, szQualifier, dwInstallMode, varptr(lpPathBuf), varptr(pcchPathBuf)   ; 戻り値は stat
; szCategory : LPCWSTR -> "wptr"
; szQualifier : LPCWSTR -> "wptr"
; dwInstallMode : DWORD -> "wptr"
; lpPathBuf : LPWSTR optional, out -> "wptr"
; pcchPathBuf : DWORD* optional, in/out -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "msi.dll"
#cfunc global MsiProvideQualifiedComponentW "MsiProvideQualifiedComponentW" wstr, wstr, int, var, var
; res = MsiProvideQualifiedComponentW(szCategory, szQualifier, dwInstallMode, lpPathBuf, pcchPathBuf)
; szCategory : LPCWSTR -> "wstr"
; szQualifier : LPCWSTR -> "wstr"
; dwInstallMode : DWORD -> "int"
; lpPathBuf : LPWSTR optional, out -> "var"
; pcchPathBuf : DWORD* optional, in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "msi.dll"
#cfunc global MsiProvideQualifiedComponentW "MsiProvideQualifiedComponentW" wstr, wstr, int, sptr, sptr
; res = MsiProvideQualifiedComponentW(szCategory, szQualifier, dwInstallMode, varptr(lpPathBuf), varptr(pcchPathBuf))
; szCategory : LPCWSTR -> "wstr"
; szQualifier : LPCWSTR -> "wstr"
; dwInstallMode : DWORD -> "int"
; lpPathBuf : LPWSTR optional, out -> "sptr"
; pcchPathBuf : DWORD* optional, in/out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。