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

MsiDatabaseImportA

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

シグネチャ

// msi.dll  (ANSI / -A)
#include <windows.h>

DWORD MsiDatabaseImportA(
    MSIHANDLE hDatabase,
    LPCSTR szFolderPath,
    LPCSTR szFileName
);

パラメーター

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

戻り値の型: DWORD

公式ドキュメント

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

戻り値

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

解説(Remarks)

MsiDatabaseImport 関数を使用して、_SummaryInformation という名前のテキストアーカイブテーブルをインストーラーデータベースにインポートすると、"\u000505SummaryInformation" ストリームが書き込まれます。このストリームには、Windows Explorer で表示でき、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 を含む 1 行。

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

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

メモ

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

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

各言語での呼び出し定義

// msi.dll  (ANSI / -A)
#include <windows.h>

DWORD MsiDatabaseImportA(
    MSIHANDLE hDatabase,
    LPCSTR szFolderPath,
    LPCSTR szFileName
);
[DllImport("msi.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern uint MsiDatabaseImportA(
    uint hDatabase,   // MSIHANDLE
    [MarshalAs(UnmanagedType.LPStr)] string szFolderPath,   // LPCSTR
    [MarshalAs(UnmanagedType.LPStr)] string szFileName   // LPCSTR
);
<DllImport("msi.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function MsiDatabaseImportA(
    hDatabase As UInteger,   ' MSIHANDLE
    <MarshalAs(UnmanagedType.LPStr)> szFolderPath As String,   ' LPCSTR
    <MarshalAs(UnmanagedType.LPStr)> szFileName As String   ' LPCSTR
) As UInteger
End Function
' hDatabase : MSIHANDLE
' szFolderPath : LPCSTR
' szFileName : LPCSTR
Declare PtrSafe Function MsiDatabaseImportA Lib "msi" ( _
    ByVal hDatabase As Long, _
    ByVal szFolderPath As String, _
    ByVal szFileName As String) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

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

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

var (
	msi = windows.NewLazySystemDLL("msi.dll")
	procMsiDatabaseImportA = msi.NewProc("MsiDatabaseImportA")
)

// hDatabase (MSIHANDLE), szFolderPath (LPCSTR), szFileName (LPCSTR)
r1, _, err := procMsiDatabaseImportA.Call(
	uintptr(hDatabase),
	uintptr(unsafe.Pointer(windows.BytePtrFromString(szFolderPath))),
	uintptr(unsafe.Pointer(windows.BytePtrFromString(szFileName))),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function MsiDatabaseImportA(
  hDatabase: DWORD;   // MSIHANDLE
  szFolderPath: PAnsiChar;   // LPCSTR
  szFileName: PAnsiChar   // LPCSTR
): DWORD; stdcall;
  external 'msi.dll' name 'MsiDatabaseImportA';
result := DllCall("msi\MsiDatabaseImportA"
    , "UInt", hDatabase   ; MSIHANDLE
    , "AStr", szFolderPath   ; LPCSTR
    , "AStr", szFileName   ; LPCSTR
    , "UInt")   ; return: DWORD
●MsiDatabaseImportA(hDatabase, szFolderPath, szFileName) = DLL("msi.dll", "dword MsiDatabaseImportA(dword, char*, char*)")
# 呼び出し: MsiDatabaseImportA(hDatabase, szFolderPath, szFileName)
# hDatabase : MSIHANDLE -> "dword"
# szFolderPath : LPCSTR -> "char*"
# szFileName : LPCSTR -> "char*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "msi" fn MsiDatabaseImportA(
    hDatabase: u32, // MSIHANDLE
    szFolderPath: [*c]const u8, // LPCSTR
    szFileName: [*c]const u8 // LPCSTR
) callconv(std.os.windows.WINAPI) u32;
proc MsiDatabaseImportA(
    hDatabase: uint32,  # MSIHANDLE
    szFolderPath: cstring,  # LPCSTR
    szFileName: cstring  # LPCSTR
): uint32 {.importc: "MsiDatabaseImportA", stdcall, dynlib: "msi.dll".}
pragma(lib, "msi");
extern(Windows)
uint MsiDatabaseImportA(
    uint hDatabase,   // MSIHANDLE
    const(char)* szFolderPath,   // LPCSTR
    const(char)* szFileName   // LPCSTR
);
ccall((:MsiDatabaseImportA, "msi.dll"), stdcall, UInt32,
      (UInt32, Cstring, Cstring),
      hDatabase, szFolderPath, szFileName)
# hDatabase : MSIHANDLE -> UInt32
# szFolderPath : LPCSTR -> Cstring
# szFileName : LPCSTR -> Cstring
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t MsiDatabaseImportA(
    uint32_t hDatabase,
    const char* szFolderPath,
    const char* szFileName);
]]
local msi = ffi.load("msi")
-- msi.MsiDatabaseImportA(hDatabase, szFolderPath, szFileName)
-- hDatabase : MSIHANDLE
-- szFolderPath : LPCSTR
-- szFileName : LPCSTR
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('msi.dll');
const MsiDatabaseImportA = lib.func('__stdcall', 'MsiDatabaseImportA', 'uint32_t', ['uint32_t', 'str', 'str']);
// MsiDatabaseImportA(hDatabase, szFolderPath, szFileName)
// hDatabase : MSIHANDLE -> 'uint32_t'
// szFolderPath : LPCSTR -> 'str'
// szFileName : LPCSTR -> 'str'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("msi.dll", {
  MsiDatabaseImportA: { parameters: ["u32", "buffer", "buffer"], result: "u32" },
});
// lib.symbols.MsiDatabaseImportA(hDatabase, szFolderPath, szFileName)
// hDatabase : MSIHANDLE -> "u32"
// szFolderPath : LPCSTR -> "buffer"
// szFileName : LPCSTR -> "buffer"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t MsiDatabaseImportA(
    uint32_t hDatabase,
    const char* szFolderPath,
    const char* szFileName);
C, "msi.dll");
// $ffi->MsiDatabaseImportA(hDatabase, szFolderPath, szFileName);
// hDatabase : MSIHANDLE
// szFolderPath : LPCSTR
// szFileName : LPCSTR
// 構造体/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.ASCII_OPTIONS);
    int MsiDatabaseImportA(
        int hDatabase,   // MSIHANDLE
        String szFolderPath,   // LPCSTR
        String szFileName   // LPCSTR
    );
}
@[Link("msi")]
lib Libmsi
  fun MsiDatabaseImportA = MsiDatabaseImportA(
    hDatabase : UInt32,   # MSIHANDLE
    szFolderPath : UInt8*,   # LPCSTR
    szFileName : UInt8*   # LPCSTR
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

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

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

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

(cffi:defcfun ("MsiDatabaseImportA" msi-database-import-a :convention :stdcall) :uint32
  (h-database :uint32)   ; MSIHANDLE
  (sz-folder-path :string)   ; LPCSTR
  (sz-file-name :string))   ; LPCSTR
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $MsiDatabaseImportA = Win32::API::More->new('msi',
    'DWORD MsiDatabaseImportA(DWORD hDatabase, LPCSTR szFolderPath, LPCSTR szFileName)');
# my $ret = $MsiDatabaseImportA->Call($hDatabase, $szFolderPath, $szFileName);
# hDatabase : MSIHANDLE -> DWORD
# szFolderPath : LPCSTR -> LPCSTR
# szFileName : LPCSTR -> LPCSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

文字セット違い