Win32 API 日本語リファレンス
ホームSystem.ApplicationInstallationAndServicing › MsiDatabaseImportW

MsiDatabaseImportW

関数
テキストアーカイブからデータベースにテーブルをインポートする。
DLLmsi.dll文字セットUnicode (-W)呼出規約winapi対応OSwindows8.0

シグネチャ

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

DWORD MsiDatabaseImportW(
    MSIHANDLE hDatabase,
    LPCWSTR szFolderPath,
    LPCWSTR szFileName
);

パラメーター

名前方向説明
hDatabaseMSIHANDLEinMsiOpenDatabase から取得したデータベースへのハンドル。
szFolderPathLPCWSTRinアーカイブファイルが格納されているフォルダーへのパスを指定します。
szFileNameLPCWSTRinインポートするファイルの名前を指定します。

戻り値の型: DWORD

公式ドキュメント

MsiDatabaseImport 関数は、インストーラーのテキストアーカイブファイルを、開いているデータベーステーブルにインポートします。(Unicode)

戻り値

MsiDatabaseImport 関数は、次の値のいずれかを返します。

解説(Remarks)

MsiDatabaseImport 関数を使用して、_SummaryInformation という名前のテキストアーカイブテーブルをインストーラーデータベースにインポートすると、"05SummaryInformation" ストリームが書き込まれます。このストリームには、Windows エクスプローラーで表示でき、COM によって定義される標準プロパティが含まれます。テーブルの行は、プロパティ ID 番号と対応するデータ値のペアとしてプロパティストリームに書き込まれます。 Summary Information Stream Property Set を参照してください。_SummaryInformation の日付と時刻は、YYYY/MM/DD hh::mm::ss の形式です。たとえば、1999/03/22 15:25:45 のようになります。テーブルにバイナリストリームが含まれる場合、ストリームの名前はデータフィールドに格納され、実際のストリームはテーブルと同じ名前のサブフォルダー内にあるその名前のファイルから取得されます。

MsiDatabaseExport によってデータベースからエクスポートされたテキストアーカイブファイルは、バージョン管理システムでの使用を目的としており、データを編集する手段として使用することは想定されていません。その目的のために設計されたデータベース API 関数およびツールを使用してください。テキストアーカイブファイル内の制御文字は、ファイル区切り文字との競合を避けるために変換されることに注意してください。テキストアーカイブファイルに非 ASCII データが含まれる場合、そのデータのコードページが刻印され、まったく同じコードページのデータベース、または中立のデータベースにのみインポートできます。中立のデータベースは、インポートされたファイルのコードページに設定されます。_ForceCodepage という名前の擬似テーブルをインポートすることで、データベースを特定のコードページに無条件に設定できます。そのようなファイルの形式は次のとおりです。2 行の空白行に続いて、数値のコードページ、タブ区切り文字、および正確な文字列 _ForceCodepage を含む行を記述します。

この関数はカスタムアクションから呼び出すことはできません。カスタムアクションからこの関数を呼び出すと、関数は失敗します。

関数が失敗した場合は、MsiGetLastErrorRecord を使用して拡張エラー情報を取得できます。

メモ

msiquery.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして MsiDatabaseImport を定義します。エンコーディング中立のエイリアスの使用を、エンコーディング中立でないコードと混在させると、コンパイルエラーまたは実行時エラーを引き起こす不整合が発生する可能性があります。詳細については、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 MsiDatabaseImportW(
    MSIHANDLE hDatabase,
    LPCWSTR szFolderPath,
    LPCWSTR szFileName
);
[DllImport("msi.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern uint MsiDatabaseImportW(
    uint hDatabase,   // MSIHANDLE
    [MarshalAs(UnmanagedType.LPWStr)] string szFolderPath,   // LPCWSTR
    [MarshalAs(UnmanagedType.LPWStr)] string szFileName   // LPCWSTR
);
<DllImport("msi.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function MsiDatabaseImportW(
    hDatabase As UInteger,   ' MSIHANDLE
    <MarshalAs(UnmanagedType.LPWStr)> szFolderPath As String,   ' LPCWSTR
    <MarshalAs(UnmanagedType.LPWStr)> szFileName As String   ' LPCWSTR
) As UInteger
End Function
' hDatabase : MSIHANDLE
' szFolderPath : LPCWSTR
' szFileName : LPCWSTR
Declare PtrSafe Function MsiDatabaseImportW Lib "msi" ( _
    ByVal hDatabase As Long, _
    ByVal szFolderPath As LongPtr, _
    ByVal szFileName 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

MsiDatabaseImportW = ctypes.windll.msi.MsiDatabaseImportW
MsiDatabaseImportW.restype = wintypes.DWORD
MsiDatabaseImportW.argtypes = [
    wintypes.DWORD,  # hDatabase : MSIHANDLE
    wintypes.LPCWSTR,  # szFolderPath : LPCWSTR
    wintypes.LPCWSTR,  # szFileName : LPCWSTR
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('msi.dll')
MsiDatabaseImportW = Fiddle::Function.new(
  lib['MsiDatabaseImportW'],
  [
    -Fiddle::TYPE_INT,  # hDatabase : MSIHANDLE
    Fiddle::TYPE_VOIDP,  # szFolderPath : LPCWSTR
    Fiddle::TYPE_VOIDP,  # szFileName : LPCWSTR
  ],
  -Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "msi")]
extern "system" {
    fn MsiDatabaseImportW(
        hDatabase: u32,  // MSIHANDLE
        szFolderPath: *const u16,  // LPCWSTR
        szFileName: *const u16  // LPCWSTR
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("msi.dll", CharSet = CharSet.Unicode)]
public static extern uint MsiDatabaseImportW(uint hDatabase, [MarshalAs(UnmanagedType.LPWStr)] string szFolderPath, [MarshalAs(UnmanagedType.LPWStr)] string szFileName);
"@
$api = Add-Type -MemberDefinition $sig -Name 'msi_MsiDatabaseImportW' -Namespace Win32 -PassThru
# $api::MsiDatabaseImportW(hDatabase, szFolderPath, szFileName)
#uselib "msi.dll"
#func global MsiDatabaseImportW "MsiDatabaseImportW" wptr, wptr, wptr
; MsiDatabaseImportW hDatabase, szFolderPath, szFileName   ; 戻り値は stat
; hDatabase : MSIHANDLE -> "wptr"
; szFolderPath : LPCWSTR -> "wptr"
; szFileName : LPCWSTR -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "msi.dll"
#cfunc global MsiDatabaseImportW "MsiDatabaseImportW" int, wstr, wstr
; res = MsiDatabaseImportW(hDatabase, szFolderPath, szFileName)
; hDatabase : MSIHANDLE -> "int"
; szFolderPath : LPCWSTR -> "wstr"
; szFileName : LPCWSTR -> "wstr"
; DWORD MsiDatabaseImportW(MSIHANDLE hDatabase, LPCWSTR szFolderPath, LPCWSTR szFileName)
#uselib "msi.dll"
#cfunc global MsiDatabaseImportW "MsiDatabaseImportW" int, wstr, wstr
; res = MsiDatabaseImportW(hDatabase, szFolderPath, szFileName)
; hDatabase : MSIHANDLE -> "int"
; szFolderPath : LPCWSTR -> "wstr"
; szFileName : LPCWSTR -> "wstr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	msi = windows.NewLazySystemDLL("msi.dll")
	procMsiDatabaseImportW = msi.NewProc("MsiDatabaseImportW")
)

// hDatabase (MSIHANDLE), szFolderPath (LPCWSTR), szFileName (LPCWSTR)
r1, _, err := procMsiDatabaseImportW.Call(
	uintptr(hDatabase),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(szFolderPath))),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(szFileName))),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function MsiDatabaseImportW(
  hDatabase: DWORD;   // MSIHANDLE
  szFolderPath: PWideChar;   // LPCWSTR
  szFileName: PWideChar   // LPCWSTR
): DWORD; stdcall;
  external 'msi.dll' name 'MsiDatabaseImportW';
result := DllCall("msi\MsiDatabaseImportW"
    , "UInt", hDatabase   ; MSIHANDLE
    , "WStr", szFolderPath   ; LPCWSTR
    , "WStr", szFileName   ; LPCWSTR
    , "UInt")   ; return: DWORD
●MsiDatabaseImportW(hDatabase, szFolderPath, szFileName) = DLL("msi.dll", "dword MsiDatabaseImportW(dword, char*, char*)")
# 呼び出し: MsiDatabaseImportW(hDatabase, szFolderPath, szFileName)
# hDatabase : MSIHANDLE -> "dword"
# szFolderPath : LPCWSTR -> "char*"
# szFileName : LPCWSTR -> "char*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。
const std = @import("std");

extern "msi" fn MsiDatabaseImportW(
    hDatabase: u32, // MSIHANDLE
    szFolderPath: [*c]const u16, // LPCWSTR
    szFileName: [*c]const u16 // LPCWSTR
) callconv(std.os.windows.WINAPI) u32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc MsiDatabaseImportW(
    hDatabase: uint32,  # MSIHANDLE
    szFolderPath: WideCString,  # LPCWSTR
    szFileName: WideCString  # LPCWSTR
): uint32 {.importc: "MsiDatabaseImportW", stdcall, dynlib: "msi.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "msi");
extern(Windows)
uint MsiDatabaseImportW(
    uint hDatabase,   // MSIHANDLE
    const(wchar)* szFolderPath,   // LPCWSTR
    const(wchar)* szFileName   // LPCWSTR
);
ccall((:MsiDatabaseImportW, "msi.dll"), stdcall, UInt32,
      (UInt32, Cwstring, Cwstring),
      hDatabase, szFolderPath, szFileName)
# hDatabase : MSIHANDLE -> UInt32
# szFolderPath : LPCWSTR -> Cwstring
# szFileName : LPCWSTR -> Cwstring
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
uint32_t MsiDatabaseImportW(
    uint32_t hDatabase,
    const uint16_t* szFolderPath,
    const uint16_t* szFileName);
]]
local msi = ffi.load("msi")
-- msi.MsiDatabaseImportW(hDatabase, szFolderPath, szFileName)
-- hDatabase : MSIHANDLE
-- szFolderPath : LPCWSTR
-- szFileName : LPCWSTR
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。
const koffi = require('koffi');
const lib = koffi.load('msi.dll');
const MsiDatabaseImportW = lib.func('__stdcall', 'MsiDatabaseImportW', 'uint32_t', ['uint32_t', 'str16', 'str16']);
// MsiDatabaseImportW(hDatabase, szFolderPath, szFileName)
// hDatabase : MSIHANDLE -> 'uint32_t'
// szFolderPath : LPCWSTR -> 'str16'
// szFileName : LPCWSTR -> 'str16'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("msi.dll", {
  MsiDatabaseImportW: { parameters: ["u32", "buffer", "buffer"], result: "u32" },
});
// lib.symbols.MsiDatabaseImportW(hDatabase, szFolderPath, szFileName)
// hDatabase : MSIHANDLE -> "u32"
// szFolderPath : LPCWSTR -> "buffer"
// szFileName : LPCWSTR -> "buffer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t MsiDatabaseImportW(
    uint32_t hDatabase,
    const uint16_t* szFolderPath,
    const uint16_t* szFileName);
C, "msi.dll");
// $ffi->MsiDatabaseImportW(hDatabase, szFolderPath, szFileName);
// hDatabase : MSIHANDLE
// szFolderPath : LPCWSTR
// szFileName : LPCWSTR
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。
import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;

public interface Msi extends StdCallLibrary {
    Msi INSTANCE = Native.load("msi", Msi.class, W32APIOptions.UNICODE_OPTIONS);
    int MsiDatabaseImportW(
        int hDatabase,   // MSIHANDLE
        WString szFolderPath,   // LPCWSTR
        WString szFileName   // LPCWSTR
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("msi")]
lib Libmsi
  fun MsiDatabaseImportW = MsiDatabaseImportW(
    hDatabase : UInt32,   # MSIHANDLE
    szFolderPath : UInt16*,   # LPCWSTR
    szFileName : UInt16*   # LPCWSTR
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef MsiDatabaseImportWNative = Uint32 Function(Uint32, Pointer<Utf16>, Pointer<Utf16>);
typedef MsiDatabaseImportWDart = int Function(int, Pointer<Utf16>, Pointer<Utf16>);
final MsiDatabaseImportW = DynamicLibrary.open('msi.dll')
    .lookupFunction<MsiDatabaseImportWNative, MsiDatabaseImportWDart>('MsiDatabaseImportW');
// hDatabase : MSIHANDLE -> Uint32
// szFolderPath : LPCWSTR -> Pointer<Utf16>
// szFileName : LPCWSTR -> Pointer<Utf16>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function MsiDatabaseImportW(
  hDatabase: DWORD;   // MSIHANDLE
  szFolderPath: PWideChar;   // LPCWSTR
  szFileName: PWideChar   // LPCWSTR
): DWORD; stdcall;
  external 'msi.dll' name 'MsiDatabaseImportW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "MsiDatabaseImportW"
  c_MsiDatabaseImportW :: Word32 -> CWString -> CWString -> IO Word32
-- hDatabase : MSIHANDLE -> Word32
-- szFolderPath : LPCWSTR -> CWString
-- szFileName : LPCWSTR -> CWString
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let msidatabaseimportw =
  foreign "MsiDatabaseImportW"
    (uint32_t @-> (ptr uint16_t) @-> (ptr uint16_t) @-> returning uint32_t)
(* hDatabase : MSIHANDLE -> uint32_t *)
(* szFolderPath : LPCWSTR -> (ptr uint16_t) *)
(* szFileName : LPCWSTR -> (ptr uint16_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library msi (t "msi.dll"))
(cffi:use-foreign-library msi)

(cffi:defcfun ("MsiDatabaseImportW" msi-database-import-w :convention :stdcall) :uint32
  (h-database :uint32)   ; MSIHANDLE
  (sz-folder-path (:string :encoding :utf-16le))   ; LPCWSTR
  (sz-file-name (:string :encoding :utf-16le)))   ; LPCWSTR
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $MsiDatabaseImportW = Win32::API::More->new('msi',
    'DWORD MsiDatabaseImportW(DWORD hDatabase, LPCWSTR szFolderPath, LPCWSTR szFileName)');
# my $ret = $MsiDatabaseImportW->Call($hDatabase, $szFolderPath, $szFileName);
# hDatabase : MSIHANDLE -> DWORD
# szFolderPath : LPCWSTR -> LPCWSTR
# szFileName : LPCWSTR -> LPCWSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い