ホーム › System.ApplicationInstallationAndServicing › MsiProvideAssemblyW

MsiProvideAssemblyW

関数

指定したアセンブリのパスを取得し、必要なら起動時にインストールする。

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

シグネチャ

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

DWORD MsiProvideAssemblyW(
    LPCWSTR szAssemblyName,
    LPCWSTR szAppContext,   // optional
    DWORD dwInstallMode,
    MSIASSEMBLYINFO dwAssemblyInfo,
    LPWSTR lpPathBuf,   // optional
    DWORD* pcchPathBuf   // optional
);

パラメーター

名前

型

方向

説明

szAssemblyName

LPCWSTR

アセンブリ名を表す文字列です。

szAppContext

LPCWSTR

inoptional

グローバルアセンブリの場合は null に設定します。プライベートアセンブリの場合は、szAppContext にアプリケーション構成ファイルのフルパス、またはそのアセンブリのプライベート対象であるアプリケーションの実行可能ファイルのフルパスを設定します。

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 を返します。このモードでは、コンポーネントが登録されていることのみを確認し、コンポーネントのキーファイルが存在することは検証しません。
INSTALLMODE_NOSOURCERESOLUTION	機能のインストール状態が INSTALLSTATE_LOCAL の場合にのみコンポーネントを提供します。機能のインストール状態が INSTALLSTATE_SOURCE の場合は ERROR_INSTALL_SOURCE_ABSENT を返します。それ以外の場合は ERROR_FILE_NOT_FOUND を返します。このモードでは、コンポーネントが登録されていることのみを確認し、キーファイルが存在することは検証しません。
INSTALLMODE_NODETECTION_ANY	インストール済みの製品のいずれかに機能が存在する場合にコンポーネントを提供します。それ以外の場合は ERROR_FILE_NOT_FOUND を返します。このモードでは、コンポーネントが登録されていることのみを確認し、コンポーネントのキーファイルが存在することは検証しません。このフラグは INSTALLMODE_NODETECTION フラグに似ていますが、INSTALLMODE_NODETECTION フラグが最後の製品を対象とするのに対し、このフラグではアセンブリをインストールした任意の製品を確認する点が異なります。このフラグは MsiProvideAssembly でのみ使用できます。
REINSTALLMODE フラグの組み合わせ	このパラメーターを dwReinstallMode パラメーターとして MsiReinstallFeature を呼び出して機能を再インストールし、その後コンポーネントを提供します。

dwAssemblyInfo

MSIASSEMBLYINFO

アセンブリ情報とアセンブリの種類です。次のいずれかの値を設定します。

値	意味
MSIASSEMBLYINFO_NETASSEMBLY 0	.NET アセンブリ
MSIASSEMBLYINFO_WIN32ASSEMBLY 1	Win32 アセンブリ

lpPathBuf

LPWSTR

outoptional

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

pcchPathBuf

DWORD*

inoutoptional

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

lpPathBuf が null の場合、pcchPathBuf も null にできます。

戻り値の型: DWORD

公式ドキュメント

MsiProvideAssembly 関数は、アセンブリを含む Windows Installer コンポーネントへのフルパスを返します。この関数はソースの入力を求め、必要なインストールを実行します。MsiProvideAssembly は機能の使用回数をインクリメントします。(Unicode)

戻り値

値	意味
ERROR_BAD_CONFIGURATION	構成データが破損しています。
ERROR_FILE_NOT_FOUND	機能が存在しないか、破損しています。このエラーは dwInstallMode = INSTALLMODE_EXISTING の場合に返されます。
ERROR_INSTALL_FAILURE	インストールに失敗しました。
ERROR_INSTALL_NOTUSED	要求されたコンポーネントは、このコンピューター上で無効になっています。
ERROR_INVALID_PARAMETER	無効なパラメーターが関数に渡されました。
ERROR_SUCCESS	関数は正常に完了しました。
ERROR_UNKNOWN_FEATURE	機能 ID が既知の機能を識別しません。
ERROR_UNKNOWN_COMPONENT	コンポーネント ID が既知のコンポーネントを指定していません。
ERROR_UNKNOWN_PRODUCT	製品コードが既知の製品を識別しません。
INSTALLSTATE_UNKNOWN	認識されない製品または機能名が関数に渡されました。
ERROR_MORE_DATA	バッファーオーバーフローが返されました。
ERROR_NOT_ENOUGH_MEMORY	システムにこの操作を完了するための十分なメモリがありません。Windows Server 2003 で利用可能です。
ERROR_INSTALL_SOURCE_ABSENT	ソースを検出できませんでした。

詳細については、 Displayed Error Messages を参照してください。

解説(Remarks)

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

INSTALLMODE_EXISTING オプションは REINSTALLMODE フラグと組み合わせて使用することはできません。

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

メモ

msi.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして MsiProvideAssembly を定義しています。エンコーディング中立のエイリアスを、エンコーディング中立でないコードと混在して使用すると、不整合が生じ、コンパイルエラーや実行時エラーの原因となることがあります。詳細については、Conventions for Function Prototypes を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 MsiProvideAssemblyW(
    LPCWSTR szAssemblyName,
    LPCWSTR szAppContext,   // optional
    DWORD dwInstallMode,
    MSIASSEMBLYINFO dwAssemblyInfo,
    LPWSTR lpPathBuf,   // optional
    DWORD* pcchPathBuf   // optional
);

[DllImport("msi.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern uint MsiProvideAssemblyW(
    [MarshalAs(UnmanagedType.LPWStr)] string szAssemblyName,   // LPCWSTR
    [MarshalAs(UnmanagedType.LPWStr)] string szAppContext,   // LPCWSTR optional
    uint dwInstallMode,   // DWORD
    uint dwAssemblyInfo,   // MSIASSEMBLYINFO
    [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 MsiProvideAssemblyW(
    <MarshalAs(UnmanagedType.LPWStr)> szAssemblyName As String,   ' LPCWSTR
    <MarshalAs(UnmanagedType.LPWStr)> szAppContext As String,   ' LPCWSTR optional
    dwInstallMode As UInteger,   ' DWORD
    dwAssemblyInfo As UInteger,   ' MSIASSEMBLYINFO
    <MarshalAs(UnmanagedType.LPWStr)> lpPathBuf As System.Text.StringBuilder,   ' LPWSTR optional, out
    pcchPathBuf As IntPtr   ' DWORD* optional, in/out
) As UInteger
End Function

' szAssemblyName : LPCWSTR
' szAppContext : LPCWSTR optional
' dwInstallMode : DWORD
' dwAssemblyInfo : MSIASSEMBLYINFO
' lpPathBuf : LPWSTR optional, out
' pcchPathBuf : DWORD* optional, in/out
Declare PtrSafe Function MsiProvideAssemblyW Lib "msi" ( _
    ByVal szAssemblyName As LongPtr, _
    ByVal szAppContext As LongPtr, _
    ByVal dwInstallMode As Long, _
    ByVal dwAssemblyInfo 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

MsiProvideAssemblyW = ctypes.windll.msi.MsiProvideAssemblyW
MsiProvideAssemblyW.restype = wintypes.DWORD
MsiProvideAssemblyW.argtypes = [
    wintypes.LPCWSTR,  # szAssemblyName : LPCWSTR
    wintypes.LPCWSTR,  # szAppContext : LPCWSTR optional
    wintypes.DWORD,  # dwInstallMode : DWORD
    wintypes.DWORD,  # dwAssemblyInfo : MSIASSEMBLYINFO
    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')
MsiProvideAssemblyW = Fiddle::Function.new(
  lib['MsiProvideAssemblyW'],
  [
    Fiddle::TYPE_VOIDP,  # szAssemblyName : LPCWSTR
    Fiddle::TYPE_VOIDP,  # szAppContext : LPCWSTR optional
    -Fiddle::TYPE_INT,  # dwInstallMode : DWORD
    -Fiddle::TYPE_INT,  # dwAssemblyInfo : MSIASSEMBLYINFO
    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 MsiProvideAssemblyW(
        szAssemblyName: *const u16,  // LPCWSTR
        szAppContext: *const u16,  // LPCWSTR optional
        dwInstallMode: u32,  // DWORD
        dwAssemblyInfo: u32,  // MSIASSEMBLYINFO
        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 MsiProvideAssemblyW([MarshalAs(UnmanagedType.LPWStr)] string szAssemblyName, [MarshalAs(UnmanagedType.LPWStr)] string szAppContext, uint dwInstallMode, uint dwAssemblyInfo, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpPathBuf, IntPtr pcchPathBuf);
"@
$api = Add-Type -MemberDefinition $sig -Name 'msi_MsiProvideAssemblyW' -Namespace Win32 -PassThru
# $api::MsiProvideAssemblyW(szAssemblyName, szAppContext, dwInstallMode, dwAssemblyInfo, lpPathBuf, pcchPathBuf)

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

出力引数:

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