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

MsiDatabaseExportA

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

シグネチャ

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

DWORD MsiDatabaseExportA(
    MSIHANDLE hDatabase,
    LPCSTR szTableName,
    LPCSTR szFolderPath,
    LPCSTR szFileName
);

パラメーター

名前方向説明
hDatabaseMSIHANDLEinMsiOpenDatabase で取得したデータベースへのハンドル。
szTableNameLPCSTRinエクスポートするテーブルの名前。
szFolderPathLPCSTRinアーカイブファイルを格納するフォルダーの名前。
szFileNameLPCSTRinエクスポートされるテーブルアーカイブファイルの名前。

戻り値の型: DWORD

公式ドキュメント

MsiDatabaseExport 関数は、開いているデータベースから Microsoft Installer のテーブルをテキストアーカイブファイルへエクスポートします。(ANSI)

戻り値

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

戻り値 説明
ERROR_BAD_PATHNAME
無効なパスが関数に渡されました。
ERROR_FUNCTION_FAILED
関数が失敗しました。
ERROR_INVALID_HANDLE
無効または非アクティブなハンドルが指定されました。
ERROR_INVALID_PARAMETER
無効なパラメーターが関数に渡されました。
ERROR_SUCCESS
関数が成功しました。

解説(Remarks)

テーブルにストリームが含まれている場合、 MsiDatabaseExport は各ストリームを個別のファイルにエクスポートします。

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

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

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

メモ

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

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 MsiDatabaseExportA(
    MSIHANDLE hDatabase,
    LPCSTR szTableName,
    LPCSTR szFolderPath,
    LPCSTR szFileName
);
[DllImport("msi.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern uint MsiDatabaseExportA(
    uint hDatabase,   // MSIHANDLE
    [MarshalAs(UnmanagedType.LPStr)] string szTableName,   // LPCSTR
    [MarshalAs(UnmanagedType.LPStr)] string szFolderPath,   // LPCSTR
    [MarshalAs(UnmanagedType.LPStr)] string szFileName   // LPCSTR
);
<DllImport("msi.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function MsiDatabaseExportA(
    hDatabase As UInteger,   ' MSIHANDLE
    <MarshalAs(UnmanagedType.LPStr)> szTableName As String,   ' LPCSTR
    <MarshalAs(UnmanagedType.LPStr)> szFolderPath As String,   ' LPCSTR
    <MarshalAs(UnmanagedType.LPStr)> szFileName As String   ' LPCSTR
) As UInteger
End Function
' hDatabase : MSIHANDLE
' szTableName : LPCSTR
' szFolderPath : LPCSTR
' szFileName : LPCSTR
Declare PtrSafe Function MsiDatabaseExportA Lib "msi" ( _
    ByVal hDatabase As Long, _
    ByVal szTableName As String, _
    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

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

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

var (
	msi = windows.NewLazySystemDLL("msi.dll")
	procMsiDatabaseExportA = msi.NewProc("MsiDatabaseExportA")
)

// hDatabase (MSIHANDLE), szTableName (LPCSTR), szFolderPath (LPCSTR), szFileName (LPCSTR)
r1, _, err := procMsiDatabaseExportA.Call(
	uintptr(hDatabase),
	uintptr(unsafe.Pointer(windows.BytePtrFromString(szTableName))),
	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 MsiDatabaseExportA(
  hDatabase: DWORD;   // MSIHANDLE
  szTableName: PAnsiChar;   // LPCSTR
  szFolderPath: PAnsiChar;   // LPCSTR
  szFileName: PAnsiChar   // LPCSTR
): DWORD; stdcall;
  external 'msi.dll' name 'MsiDatabaseExportA';
result := DllCall("msi\MsiDatabaseExportA"
    , "UInt", hDatabase   ; MSIHANDLE
    , "AStr", szTableName   ; LPCSTR
    , "AStr", szFolderPath   ; LPCSTR
    , "AStr", szFileName   ; LPCSTR
    , "UInt")   ; return: DWORD
●MsiDatabaseExportA(hDatabase, szTableName, szFolderPath, szFileName) = DLL("msi.dll", "dword MsiDatabaseExportA(dword, char*, char*, char*)")
# 呼び出し: MsiDatabaseExportA(hDatabase, szTableName, szFolderPath, szFileName)
# hDatabase : MSIHANDLE -> "dword"
# szTableName : LPCSTR -> "char*"
# szFolderPath : LPCSTR -> "char*"
# szFileName : LPCSTR -> "char*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "msi" fn MsiDatabaseExportA(
    hDatabase: u32, // MSIHANDLE
    szTableName: [*c]const u8, // LPCSTR
    szFolderPath: [*c]const u8, // LPCSTR
    szFileName: [*c]const u8 // LPCSTR
) callconv(std.os.windows.WINAPI) u32;
proc MsiDatabaseExportA(
    hDatabase: uint32,  # MSIHANDLE
    szTableName: cstring,  # LPCSTR
    szFolderPath: cstring,  # LPCSTR
    szFileName: cstring  # LPCSTR
): uint32 {.importc: "MsiDatabaseExportA", stdcall, dynlib: "msi.dll".}
pragma(lib, "msi");
extern(Windows)
uint MsiDatabaseExportA(
    uint hDatabase,   // MSIHANDLE
    const(char)* szTableName,   // LPCSTR
    const(char)* szFolderPath,   // LPCSTR
    const(char)* szFileName   // LPCSTR
);
ccall((:MsiDatabaseExportA, "msi.dll"), stdcall, UInt32,
      (UInt32, Cstring, Cstring, Cstring),
      hDatabase, szTableName, szFolderPath, szFileName)
# hDatabase : MSIHANDLE -> UInt32
# szTableName : LPCSTR -> Cstring
# szFolderPath : LPCSTR -> Cstring
# szFileName : LPCSTR -> Cstring
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t MsiDatabaseExportA(
    uint32_t hDatabase,
    const char* szTableName,
    const char* szFolderPath,
    const char* szFileName);
]]
local msi = ffi.load("msi")
-- msi.MsiDatabaseExportA(hDatabase, szTableName, szFolderPath, szFileName)
-- hDatabase : MSIHANDLE
-- szTableName : LPCSTR
-- szFolderPath : LPCSTR
-- szFileName : LPCSTR
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('msi.dll');
const MsiDatabaseExportA = lib.func('__stdcall', 'MsiDatabaseExportA', 'uint32_t', ['uint32_t', 'str', 'str', 'str']);
// MsiDatabaseExportA(hDatabase, szTableName, szFolderPath, szFileName)
// hDatabase : MSIHANDLE -> 'uint32_t'
// szTableName : LPCSTR -> 'str'
// szFolderPath : LPCSTR -> 'str'
// szFileName : LPCSTR -> 'str'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("msi.dll", {
  MsiDatabaseExportA: { parameters: ["u32", "buffer", "buffer", "buffer"], result: "u32" },
});
// lib.symbols.MsiDatabaseExportA(hDatabase, szTableName, szFolderPath, szFileName)
// hDatabase : MSIHANDLE -> "u32"
// szTableName : LPCSTR -> "buffer"
// 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 MsiDatabaseExportA(
    uint32_t hDatabase,
    const char* szTableName,
    const char* szFolderPath,
    const char* szFileName);
C, "msi.dll");
// $ffi->MsiDatabaseExportA(hDatabase, szTableName, szFolderPath, szFileName);
// hDatabase : MSIHANDLE
// szTableName : LPCSTR
// 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 MsiDatabaseExportA(
        int hDatabase,   // MSIHANDLE
        String szTableName,   // LPCSTR
        String szFolderPath,   // LPCSTR
        String szFileName   // LPCSTR
    );
}
@[Link("msi")]
lib Libmsi
  fun MsiDatabaseExportA = MsiDatabaseExportA(
    hDatabase : UInt32,   # MSIHANDLE
    szTableName : UInt8*,   # LPCSTR
    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 MsiDatabaseExportANative = Uint32 Function(Uint32, Pointer<Utf8>, Pointer<Utf8>, Pointer<Utf8>);
typedef MsiDatabaseExportADart = int Function(int, Pointer<Utf8>, Pointer<Utf8>, Pointer<Utf8>);
final MsiDatabaseExportA = DynamicLibrary.open('msi.dll')
    .lookupFunction<MsiDatabaseExportANative, MsiDatabaseExportADart>('MsiDatabaseExportA');
// hDatabase : MSIHANDLE -> Uint32
// szTableName : LPCSTR -> Pointer<Utf8>
// szFolderPath : LPCSTR -> Pointer<Utf8>
// szFileName : LPCSTR -> Pointer<Utf8>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function MsiDatabaseExportA(
  hDatabase: DWORD;   // MSIHANDLE
  szTableName: PAnsiChar;   // LPCSTR
  szFolderPath: PAnsiChar;   // LPCSTR
  szFileName: PAnsiChar   // LPCSTR
): DWORD; stdcall;
  external 'msi.dll' name 'MsiDatabaseExportA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

let msidatabaseexporta =
  foreign "MsiDatabaseExportA"
    (uint32_t @-> string @-> string @-> string @-> returning uint32_t)
(* hDatabase : MSIHANDLE -> uint32_t *)
(* szTableName : LPCSTR -> string *)
(* 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 ("MsiDatabaseExportA" msi-database-export-a :convention :stdcall) :uint32
  (h-database :uint32)   ; MSIHANDLE
  (sz-table-name :string)   ; LPCSTR
  (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 $MsiDatabaseExportA = Win32::API::More->new('msi',
    'DWORD MsiDatabaseExportA(DWORD hDatabase, LPCSTR szTableName, LPCSTR szFolderPath, LPCSTR szFileName)');
# my $ret = $MsiDatabaseExportA->Call($hDatabase, $szTableName, $szFolderPath, $szFileName);
# hDatabase : MSIHANDLE -> DWORD
# szTableName : LPCSTR -> LPCSTR
# szFolderPath : LPCSTR -> LPCSTR
# szFileName : LPCSTR -> LPCSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

文字セット違い