Win32 API 日本語リファレンス
ホーム › Storage.Jet › JetExternalRestore2W

JetExternalRestore2W

関数
対象インスタンス指定で外部バックアップから復元する(Unicode版)。
DLLESENT.dll文字セットUnicode (-W)呼出規約winapi
📘 Microsoft Learn (日本語) · English

シグネチャ

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

INT JetExternalRestore2W(
    WORD* szCheckpointFilePath,
    WORD* szLogPath,
    JET_RSTMAP_W* rgrstmap,   // optional
    INT crstfilemap,
    WORD* szBackupLogPath,
    JET_LOGINFO_W* pLogInfo,
    WORD* szTargetInstanceName,   // optional
    WORD* szTargetInstanceLogPath,   // optional
    WORD* szTargetInstanceCheckpointPath,   // optional
    JET_PFNSTATUS pfn
);

パラメーター

名前型方向説明
szCheckpointFilePathWORD*in復元時に使用するチェックポイントファイルのパスを指す終端付きUnicode文字列ポインタ。
szLogPathWORD*in復元に使用するログファイルが格納されたディレクトリのパスを指す終端付きUnicode文字列ポインタ。
rgrstmapJET_RSTMAP_W*inoptionalバックアップ元と復元先のデータベースパス対応を保持するJET_RSTMAP_W配列のポインタ。
crstfilemapINTinrgrstmap配列の要素数を指定する値。
szBackupLogPathWORD*inバックアップ時のログが格納されたディレクトリのパスを指す終端付きUnicode文字列ポインタ。
pLogInfoJET_LOGINFO_W*inout適用するログ世代範囲などを指定するJET_LOGINFO_W構造体ポインタ。NULL可。
szTargetInstanceNameWORD*inoptional復元先インスタンス名を指す終端付きUnicode文字列ポインタ。NULL可。
szTargetInstanceLogPathWORD*inoptional復元先インスタンスのログパスを指す終端付きUnicode文字列ポインタ。NULL可。
szTargetInstanceCheckpointPathWORD*inoptional復元先インスタンスのチェックポイントパスを指す終端付きUnicode文字列ポインタ。NULL可。
pfnJET_PFNSTATUSin進捗通知を受け取るステータスコールバック関数(JET_PFNSTATUS)。NULL可。

戻り値の型: INT

公式ドキュメント

JetExternalRestore2 関数は、外部バックアップ API で取得した外部バックアップを復元し、循環ログ操作で使用するチェックポイントを提供します。これはハードリカバリーと呼ばれるもので、JetInit 関数が実行するソフトリカバリーと似ていますが、異なる処理です。

戻り値

この関数は JET_ERR データ型を返し、その値は次のリターンコードのいずれかです。発生し得る ESE エラーの詳細については、Extensible Storage Engine Errors および Error Handling Parameters を参照してください。

リターンコード

説明

JET_errSuccess

操作は正常に完了しました。

JET_errBadRestoreTargetInstance

指定された szTargetInstanceLogPath が、初期化済みのインスタンスに属していません。このエラーは Windows XP 以降でのみ返されます。

JET_errDatabaseCorrupted

データベースが破損しているか、認識できないファイルであることを示します。

JET_errEndingRestoreLogTooLow

szBackupLogPath 内のログファイルのいずれかが、genHigh または pLogInfo.ulGenHigh で指定された値より大きいログ世代を持つ場合に、このエラーが返されます。

JET_errFileNotFound

要求されたファイルが指定されたパスに見つからず、開くことができなかったため、操作は失敗しました。

JET_errInvalidParameter

指定されたパラメーターのいずれかに予期しない値が含まれていたか、他のパラメーターの値と組み合わせたときに意味をなさない値が含まれていました。これは JetExternalRestore などで、szTargetCheckpointPath と szTargetInstanceLogPath の両方が指定されているか、または両方とも指定されていない、のいずれでもない場合に発生します。つまり、これらは一致している必要があり、両方を指定するか、両方とも指定しないかのいずれかでなければなりません。

JET_errInvalidPath

指定されたパスが見つからなかったため、操作は失敗しました。

JET_errOutOfMemory

操作を完了するのに十分なメモリを割り当てられなかったため、操作は失敗しました。

JET_errRestoreOfNonBackupDatabase

復元時に指定されたデータベースファイルが、外部バックアップでバックアップされたデータベースではない場合に、このエラーが返されます。

JET_errRunningInOneInstanceMode

データベースエンジンは、単一インスタンスモードでは外部復元またはハードリカバリーを実行できません。このエラーは Windows XP 以降でのみ返されます。

JET_errStartingRestoreLogTooHigh

szBackupLogPath 内のログファイルのいずれかが、genLow または pLogInfo.ulGenLow で指定された値より小さいログ世代を持つ場合に、このエラーが返されます。

成功した場合、rgrstmap に含まれるすべてのデータベースは完全に復旧され、クリーンな状態 (整合性のある状態) になります。この時点で、データベースを既存のインスタンスに再マウントできます。

失敗した場合、エンジンはデータベースを復旧できませんでした。データベースは無効な状態にあり、ハードリカバリーを再試行するには、データベース全体を再度復元する必要があります。通常、このような状況の原因は、ディスクまたはログの破損、その他の形態のログ管理の誤り、あるいはログセットが連続していないことです。

解説

JetExternalRestore を参照してください。

要件

要件 値

クライアント

Windows Vista または Windows XP が必要です。

サーバー

Windows Server 2008 または Windows Server 2003 が必要です。

ヘッダー

Esent.h で宣言されています。

ライブラリ

ESENT.lib を使用します。

DLL

ESENT.dll が必要です。

Unicode

JetExternalRestore2W (Unicode) および JetExternalRestore2A (ANSI) として実装されています。

関連項目

JET_ERR
JET_LOGINFO
JET_PFNSTATUS
JET_RSTMAP
JetBeginExternalBackup
JetExternalRestore
JetInit

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

各言語での呼び出し定義

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

INT JetExternalRestore2W(
    WORD* szCheckpointFilePath,
    WORD* szLogPath,
    JET_RSTMAP_W* rgrstmap,   // optional
    INT crstfilemap,
    WORD* szBackupLogPath,
    JET_LOGINFO_W* pLogInfo,
    WORD* szTargetInstanceName,   // optional
    WORD* szTargetInstanceLogPath,   // optional
    WORD* szTargetInstanceCheckpointPath,   // optional
    JET_PFNSTATUS pfn
);
[DllImport("ESENT.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern int JetExternalRestore2W(
    ref ushort szCheckpointFilePath,   // WORD*
    ref ushort szLogPath,   // WORD*
    IntPtr rgrstmap,   // JET_RSTMAP_W* optional
    int crstfilemap,   // INT
    ref ushort szBackupLogPath,   // WORD*
    IntPtr pLogInfo,   // JET_LOGINFO_W* in/out
    IntPtr szTargetInstanceName,   // WORD* optional
    IntPtr szTargetInstanceLogPath,   // WORD* optional
    IntPtr szTargetInstanceCheckpointPath,   // WORD* optional
    IntPtr pfn   // JET_PFNSTATUS
);
<DllImport("ESENT.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function JetExternalRestore2W(
    ByRef szCheckpointFilePath As UShort,   ' WORD*
    ByRef szLogPath As UShort,   ' WORD*
    rgrstmap As IntPtr,   ' JET_RSTMAP_W* optional
    crstfilemap As Integer,   ' INT
    ByRef szBackupLogPath As UShort,   ' WORD*
    pLogInfo As IntPtr,   ' JET_LOGINFO_W* in/out
    szTargetInstanceName As IntPtr,   ' WORD* optional
    szTargetInstanceLogPath As IntPtr,   ' WORD* optional
    szTargetInstanceCheckpointPath As IntPtr,   ' WORD* optional
    pfn As IntPtr   ' JET_PFNSTATUS
) As Integer
End Function
' szCheckpointFilePath : WORD*
' szLogPath : WORD*
' rgrstmap : JET_RSTMAP_W* optional
' crstfilemap : INT
' szBackupLogPath : WORD*
' pLogInfo : JET_LOGINFO_W* in/out
' szTargetInstanceName : WORD* optional
' szTargetInstanceLogPath : WORD* optional
' szTargetInstanceCheckpointPath : WORD* optional
' pfn : JET_PFNSTATUS
Declare PtrSafe Function JetExternalRestore2W Lib "esent" ( _
    ByRef szCheckpointFilePath As Integer, _
    ByRef szLogPath As Integer, _
    ByVal rgrstmap As LongPtr, _
    ByVal crstfilemap As Long, _
    ByRef szBackupLogPath As Integer, _
    ByVal pLogInfo As LongPtr, _
    ByVal szTargetInstanceName As LongPtr, _
    ByVal szTargetInstanceLogPath As LongPtr, _
    ByVal szTargetInstanceCheckpointPath As LongPtr, _
    ByVal pfn 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

JetExternalRestore2W = ctypes.windll.esent.JetExternalRestore2W
JetExternalRestore2W.restype = ctypes.c_int
JetExternalRestore2W.argtypes = [
    ctypes.POINTER(ctypes.c_ushort),  # szCheckpointFilePath : WORD*
    ctypes.POINTER(ctypes.c_ushort),  # szLogPath : WORD*
    ctypes.c_void_p,  # rgrstmap : JET_RSTMAP_W* optional
    ctypes.c_int,  # crstfilemap : INT
    ctypes.POINTER(ctypes.c_ushort),  # szBackupLogPath : WORD*
    ctypes.c_void_p,  # pLogInfo : JET_LOGINFO_W* in/out
    ctypes.POINTER(ctypes.c_ushort),  # szTargetInstanceName : WORD* optional
    ctypes.POINTER(ctypes.c_ushort),  # szTargetInstanceLogPath : WORD* optional
    ctypes.POINTER(ctypes.c_ushort),  # szTargetInstanceCheckpointPath : WORD* optional
    ctypes.c_void_p,  # pfn : JET_PFNSTATUS
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ESENT.dll')
JetExternalRestore2W = Fiddle::Function.new(
  lib['JetExternalRestore2W'],
  [
    Fiddle::TYPE_VOIDP,  # szCheckpointFilePath : WORD*
    Fiddle::TYPE_VOIDP,  # szLogPath : WORD*
    Fiddle::TYPE_VOIDP,  # rgrstmap : JET_RSTMAP_W* optional
    Fiddle::TYPE_INT,  # crstfilemap : INT
    Fiddle::TYPE_VOIDP,  # szBackupLogPath : WORD*
    Fiddle::TYPE_VOIDP,  # pLogInfo : JET_LOGINFO_W* in/out
    Fiddle::TYPE_VOIDP,  # szTargetInstanceName : WORD* optional
    Fiddle::TYPE_VOIDP,  # szTargetInstanceLogPath : WORD* optional
    Fiddle::TYPE_VOIDP,  # szTargetInstanceCheckpointPath : WORD* optional
    Fiddle::TYPE_VOIDP,  # pfn : JET_PFNSTATUS
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "esent")]
extern "system" {
    fn JetExternalRestore2W(
        szCheckpointFilePath: *mut u16,  // WORD*
        szLogPath: *mut u16,  // WORD*
        rgrstmap: *mut JET_RSTMAP_W,  // JET_RSTMAP_W* optional
        crstfilemap: i32,  // INT
        szBackupLogPath: *mut u16,  // WORD*
        pLogInfo: *mut JET_LOGINFO_W,  // JET_LOGINFO_W* in/out
        szTargetInstanceName: *mut u16,  // WORD* optional
        szTargetInstanceLogPath: *mut u16,  // WORD* optional
        szTargetInstanceCheckpointPath: *mut u16,  // WORD* optional
        pfn: *const core::ffi::c_void  // JET_PFNSTATUS
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("ESENT.dll", CharSet = CharSet.Unicode)]
public static extern int JetExternalRestore2W(ref ushort szCheckpointFilePath, ref ushort szLogPath, IntPtr rgrstmap, int crstfilemap, ref ushort szBackupLogPath, IntPtr pLogInfo, IntPtr szTargetInstanceName, IntPtr szTargetInstanceLogPath, IntPtr szTargetInstanceCheckpointPath, IntPtr pfn);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ESENT_JetExternalRestore2W' -Namespace Win32 -PassThru
# $api::JetExternalRestore2W(szCheckpointFilePath, szLogPath, rgrstmap, crstfilemap, szBackupLogPath, pLogInfo, szTargetInstanceName, szTargetInstanceLogPath, szTargetInstanceCheckpointPath, pfn)
#uselib "ESENT.dll"
#func global JetExternalRestore2W "JetExternalRestore2W" wptr, wptr, wptr, wptr, wptr, wptr, wptr, wptr, wptr, wptr
; JetExternalRestore2W varptr(szCheckpointFilePath), varptr(szLogPath), varptr(rgrstmap), crstfilemap, varptr(szBackupLogPath), varptr(pLogInfo), varptr(szTargetInstanceName), varptr(szTargetInstanceLogPath), varptr(szTargetInstanceCheckpointPath), pfn   ; 戻り値は stat
; szCheckpointFilePath : WORD* -> "wptr"
; szLogPath : WORD* -> "wptr"
; rgrstmap : JET_RSTMAP_W* optional -> "wptr"
; crstfilemap : INT -> "wptr"
; szBackupLogPath : WORD* -> "wptr"
; pLogInfo : JET_LOGINFO_W* in/out -> "wptr"
; szTargetInstanceName : WORD* optional -> "wptr"
; szTargetInstanceLogPath : WORD* optional -> "wptr"
; szTargetInstanceCheckpointPath : WORD* optional -> "wptr"
; pfn : JET_PFNSTATUS -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数: 
#uselib "ESENT.dll"
#cfunc global JetExternalRestore2W "JetExternalRestore2W" var, var, var, int, var, var, var, var, var, sptr
; res = JetExternalRestore2W(szCheckpointFilePath, szLogPath, rgrstmap, crstfilemap, szBackupLogPath, pLogInfo, szTargetInstanceName, szTargetInstanceLogPath, szTargetInstanceCheckpointPath, pfn)
; szCheckpointFilePath : WORD* -> "var"
; szLogPath : WORD* -> "var"
; rgrstmap : JET_RSTMAP_W* optional -> "var"
; crstfilemap : INT -> "int"
; szBackupLogPath : WORD* -> "var"
; pLogInfo : JET_LOGINFO_W* in/out -> "var"
; szTargetInstanceName : WORD* optional -> "var"
; szTargetInstanceLogPath : WORD* optional -> "var"
; szTargetInstanceCheckpointPath : WORD* optional -> "var"
; pfn : JET_PFNSTATUS -> "sptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数: 
; INT JetExternalRestore2W(WORD* szCheckpointFilePath, WORD* szLogPath, JET_RSTMAP_W* rgrstmap, INT crstfilemap, WORD* szBackupLogPath, JET_LOGINFO_W* pLogInfo, WORD* szTargetInstanceName, WORD* szTargetInstanceLogPath, WORD* szTargetInstanceCheckpointPath, JET_PFNSTATUS pfn)
#uselib "ESENT.dll"
#cfunc global JetExternalRestore2W "JetExternalRestore2W" var, var, var, int, var, var, var, var, var, intptr
; res = JetExternalRestore2W(szCheckpointFilePath, szLogPath, rgrstmap, crstfilemap, szBackupLogPath, pLogInfo, szTargetInstanceName, szTargetInstanceLogPath, szTargetInstanceCheckpointPath, pfn)
; szCheckpointFilePath : WORD* -> "var"
; szLogPath : WORD* -> "var"
; rgrstmap : JET_RSTMAP_W* optional -> "var"
; crstfilemap : INT -> "int"
; szBackupLogPath : WORD* -> "var"
; pLogInfo : JET_LOGINFO_W* in/out -> "var"
; szTargetInstanceName : WORD* optional -> "var"
; szTargetInstanceLogPath : WORD* optional -> "var"
; szTargetInstanceCheckpointPath : WORD* optional -> "var"
; pfn : JET_PFNSTATUS -> "intptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	esent = windows.NewLazySystemDLL("ESENT.dll")
	procJetExternalRestore2W = esent.NewProc("JetExternalRestore2W")
)

// szCheckpointFilePath (WORD*), szLogPath (WORD*), rgrstmap (JET_RSTMAP_W* optional), crstfilemap (INT), szBackupLogPath (WORD*), pLogInfo (JET_LOGINFO_W* in/out), szTargetInstanceName (WORD* optional), szTargetInstanceLogPath (WORD* optional), szTargetInstanceCheckpointPath (WORD* optional), pfn (JET_PFNSTATUS)
r1, _, err := procJetExternalRestore2W.Call(
	uintptr(szCheckpointFilePath),
	uintptr(szLogPath),
	uintptr(rgrstmap),
	uintptr(crstfilemap),
	uintptr(szBackupLogPath),
	uintptr(pLogInfo),
	uintptr(szTargetInstanceName),
	uintptr(szTargetInstanceLogPath),
	uintptr(szTargetInstanceCheckpointPath),
	uintptr(pfn),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // INT
function JetExternalRestore2W(
  szCheckpointFilePath: Pointer;   // WORD*
  szLogPath: Pointer;   // WORD*
  rgrstmap: Pointer;   // JET_RSTMAP_W* optional
  crstfilemap: Integer;   // INT
  szBackupLogPath: Pointer;   // WORD*
  pLogInfo: Pointer;   // JET_LOGINFO_W* in/out
  szTargetInstanceName: Pointer;   // WORD* optional
  szTargetInstanceLogPath: Pointer;   // WORD* optional
  szTargetInstanceCheckpointPath: Pointer;   // WORD* optional
  pfn: Pointer   // JET_PFNSTATUS
): Integer; stdcall;
  external 'ESENT.dll' name 'JetExternalRestore2W';
result := DllCall("ESENT\JetExternalRestore2W"
    , "Ptr", szCheckpointFilePath   ; WORD*
    , "Ptr", szLogPath   ; WORD*
    , "Ptr", rgrstmap   ; JET_RSTMAP_W* optional
    , "Int", crstfilemap   ; INT
    , "Ptr", szBackupLogPath   ; WORD*
    , "Ptr", pLogInfo   ; JET_LOGINFO_W* in/out
    , "Ptr", szTargetInstanceName   ; WORD* optional
    , "Ptr", szTargetInstanceLogPath   ; WORD* optional
    , "Ptr", szTargetInstanceCheckpointPath   ; WORD* optional
    , "Ptr", pfn   ; JET_PFNSTATUS
    , "Int")   ; return: INT
●JetExternalRestore2W(szCheckpointFilePath, szLogPath, rgrstmap, crstfilemap, szBackupLogPath, pLogInfo, szTargetInstanceName, szTargetInstanceLogPath, szTargetInstanceCheckpointPath, pfn) = DLL("ESENT.dll", "int JetExternalRestore2W(void*, void*, void*, int, void*, void*, void*, void*, void*, void*)")
# 呼び出し: JetExternalRestore2W(szCheckpointFilePath, szLogPath, rgrstmap, crstfilemap, szBackupLogPath, pLogInfo, szTargetInstanceName, szTargetInstanceLogPath, szTargetInstanceCheckpointPath, pfn)
# szCheckpointFilePath : WORD* -> "void*"
# szLogPath : WORD* -> "void*"
# rgrstmap : JET_RSTMAP_W* optional -> "void*"
# crstfilemap : INT -> "int"
# szBackupLogPath : WORD* -> "void*"
# pLogInfo : JET_LOGINFO_W* in/out -> "void*"
# szTargetInstanceName : WORD* optional -> "void*"
# szTargetInstanceLogPath : WORD* optional -> "void*"
# szTargetInstanceCheckpointPath : WORD* optional -> "void*"
# pfn : JET_PFNSTATUS -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。
const std = @import("std");

extern "esent" fn JetExternalRestore2W(
    szCheckpointFilePath: [*c]u16, // WORD*
    szLogPath: [*c]u16, // WORD*
    rgrstmap: [*c]JET_RSTMAP_W, // JET_RSTMAP_W* optional
    crstfilemap: i32, // INT
    szBackupLogPath: [*c]u16, // WORD*
    pLogInfo: [*c]JET_LOGINFO_W, // JET_LOGINFO_W* in/out
    szTargetInstanceName: [*c]u16, // WORD* optional
    szTargetInstanceLogPath: [*c]u16, // WORD* optional
    szTargetInstanceCheckpointPath: [*c]u16, // WORD* optional
    pfn: ?*anyopaque // JET_PFNSTATUS
) callconv(std.os.windows.WINAPI) i32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc JetExternalRestore2W(
    szCheckpointFilePath: ptr uint16,  # WORD*
    szLogPath: ptr uint16,  # WORD*
    rgrstmap: ptr JET_RSTMAP_W,  # JET_RSTMAP_W* optional
    crstfilemap: int32,  # INT
    szBackupLogPath: ptr uint16,  # WORD*
    pLogInfo: ptr JET_LOGINFO_W,  # JET_LOGINFO_W* in/out
    szTargetInstanceName: ptr uint16,  # WORD* optional
    szTargetInstanceLogPath: ptr uint16,  # WORD* optional
    szTargetInstanceCheckpointPath: ptr uint16,  # WORD* optional
    pfn: pointer  # JET_PFNSTATUS
): int32 {.importc: "JetExternalRestore2W", stdcall, dynlib: "ESENT.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "esent");
extern(Windows)
int JetExternalRestore2W(
    ushort* szCheckpointFilePath,   // WORD*
    ushort* szLogPath,   // WORD*
    JET_RSTMAP_W* rgrstmap,   // JET_RSTMAP_W* optional
    int crstfilemap,   // INT
    ushort* szBackupLogPath,   // WORD*
    JET_LOGINFO_W* pLogInfo,   // JET_LOGINFO_W* in/out
    ushort* szTargetInstanceName,   // WORD* optional
    ushort* szTargetInstanceLogPath,   // WORD* optional
    ushort* szTargetInstanceCheckpointPath,   // WORD* optional
    void* pfn   // JET_PFNSTATUS
);
ccall((:JetExternalRestore2W, "ESENT.dll"), stdcall, Int32,
      (Ptr{UInt16}, Ptr{UInt16}, Ptr{JET_RSTMAP_W}, Int32, Ptr{UInt16}, Ptr{JET_LOGINFO_W}, Ptr{UInt16}, Ptr{UInt16}, Ptr{UInt16}, Ptr{Cvoid}),
      szCheckpointFilePath, szLogPath, rgrstmap, crstfilemap, szBackupLogPath, pLogInfo, szTargetInstanceName, szTargetInstanceLogPath, szTargetInstanceCheckpointPath, pfn)
# szCheckpointFilePath : WORD* -> Ptr{UInt16}
# szLogPath : WORD* -> Ptr{UInt16}
# rgrstmap : JET_RSTMAP_W* optional -> Ptr{JET_RSTMAP_W}
# crstfilemap : INT -> Int32
# szBackupLogPath : WORD* -> Ptr{UInt16}
# pLogInfo : JET_LOGINFO_W* in/out -> Ptr{JET_LOGINFO_W}
# szTargetInstanceName : WORD* optional -> Ptr{UInt16}
# szTargetInstanceLogPath : WORD* optional -> Ptr{UInt16}
# szTargetInstanceCheckpointPath : WORD* optional -> Ptr{UInt16}
# pfn : JET_PFNSTATUS -> Ptr{Cvoid}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
int32_t JetExternalRestore2W(
    uint16_t* szCheckpointFilePath,
    uint16_t* szLogPath,
    void* rgrstmap,
    int32_t crstfilemap,
    uint16_t* szBackupLogPath,
    void* pLogInfo,
    uint16_t* szTargetInstanceName,
    uint16_t* szTargetInstanceLogPath,
    uint16_t* szTargetInstanceCheckpointPath,
    void* pfn);
]]
local esent = ffi.load("esent")
-- esent.JetExternalRestore2W(szCheckpointFilePath, szLogPath, rgrstmap, crstfilemap, szBackupLogPath, pLogInfo, szTargetInstanceName, szTargetInstanceLogPath, szTargetInstanceCheckpointPath, pfn)
-- szCheckpointFilePath : WORD*
-- szLogPath : WORD*
-- rgrstmap : JET_RSTMAP_W* optional
-- crstfilemap : INT
-- szBackupLogPath : WORD*
-- pLogInfo : JET_LOGINFO_W* in/out
-- szTargetInstanceName : WORD* optional
-- szTargetInstanceLogPath : WORD* optional
-- szTargetInstanceCheckpointPath : WORD* optional
-- pfn : JET_PFNSTATUS
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。
const koffi = require('koffi');
const lib = koffi.load('ESENT.dll');
const JetExternalRestore2W = lib.func('__stdcall', 'JetExternalRestore2W', 'int32_t', ['uint16_t *', 'uint16_t *', 'void *', 'int32_t', 'uint16_t *', 'void *', 'uint16_t *', 'uint16_t *', 'uint16_t *', 'void *']);
// JetExternalRestore2W(szCheckpointFilePath, szLogPath, rgrstmap, crstfilemap, szBackupLogPath, pLogInfo, szTargetInstanceName, szTargetInstanceLogPath, szTargetInstanceCheckpointPath, pfn)
// szCheckpointFilePath : WORD* -> 'uint16_t *'
// szLogPath : WORD* -> 'uint16_t *'
// rgrstmap : JET_RSTMAP_W* optional -> 'void *'
// crstfilemap : INT -> 'int32_t'
// szBackupLogPath : WORD* -> 'uint16_t *'
// pLogInfo : JET_LOGINFO_W* in/out -> 'void *'
// szTargetInstanceName : WORD* optional -> 'uint16_t *'
// szTargetInstanceLogPath : WORD* optional -> 'uint16_t *'
// szTargetInstanceCheckpointPath : WORD* optional -> 'uint16_t *'
// pfn : JET_PFNSTATUS -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
// コールバック(関数ポインタ)は koffi.proto/koffi.register で型を定義して渡す(素の void* では JS 関数を渡せない)。
const lib = Deno.dlopen("ESENT.dll", {
  JetExternalRestore2W: { parameters: ["pointer", "pointer", "pointer", "i32", "pointer", "pointer", "pointer", "pointer", "pointer", "pointer"], result: "i32" },
});
// lib.symbols.JetExternalRestore2W(szCheckpointFilePath, szLogPath, rgrstmap, crstfilemap, szBackupLogPath, pLogInfo, szTargetInstanceName, szTargetInstanceLogPath, szTargetInstanceCheckpointPath, pfn)
// szCheckpointFilePath : WORD* -> "pointer"
// szLogPath : WORD* -> "pointer"
// rgrstmap : JET_RSTMAP_W* optional -> "pointer"
// crstfilemap : INT -> "i32"
// szBackupLogPath : WORD* -> "pointer"
// pLogInfo : JET_LOGINFO_W* in/out -> "pointer"
// szTargetInstanceName : WORD* optional -> "pointer"
// szTargetInstanceLogPath : WORD* optional -> "pointer"
// szTargetInstanceCheckpointPath : WORD* optional -> "pointer"
// pfn : JET_PFNSTATUS -> "pointer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t JetExternalRestore2W(
    uint16_t* szCheckpointFilePath,
    uint16_t* szLogPath,
    void* rgrstmap,
    int32_t crstfilemap,
    uint16_t* szBackupLogPath,
    void* pLogInfo,
    uint16_t* szTargetInstanceName,
    uint16_t* szTargetInstanceLogPath,
    uint16_t* szTargetInstanceCheckpointPath,
    void* pfn);
C, "ESENT.dll");
// $ffi->JetExternalRestore2W(szCheckpointFilePath, szLogPath, rgrstmap, crstfilemap, szBackupLogPath, pLogInfo, szTargetInstanceName, szTargetInstanceLogPath, szTargetInstanceCheckpointPath, pfn);
// szCheckpointFilePath : WORD*
// szLogPath : WORD*
// rgrstmap : JET_RSTMAP_W* optional
// crstfilemap : INT
// szBackupLogPath : WORD*
// pLogInfo : JET_LOGINFO_W* in/out
// szTargetInstanceName : WORD* optional
// szTargetInstanceLogPath : WORD* optional
// szTargetInstanceCheckpointPath : WORD* optional
// pfn : JET_PFNSTATUS
// 構造体/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 Esent extends StdCallLibrary {
    Esent INSTANCE = Native.load("esent", Esent.class, W32APIOptions.UNICODE_OPTIONS);
    int JetExternalRestore2W(
        ShortByReference szCheckpointFilePath,   // WORD*
        ShortByReference szLogPath,   // WORD*
        Pointer rgrstmap,   // JET_RSTMAP_W* optional
        int crstfilemap,   // INT
        ShortByReference szBackupLogPath,   // WORD*
        Pointer pLogInfo,   // JET_LOGINFO_W* in/out
        ShortByReference szTargetInstanceName,   // WORD* optional
        ShortByReference szTargetInstanceLogPath,   // WORD* optional
        ShortByReference szTargetInstanceCheckpointPath,   // WORD* optional
        Callback pfn   // JET_PFNSTATUS
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("esent")]
lib LibESENT
  fun JetExternalRestore2W = JetExternalRestore2W(
    szCheckpointFilePath : UInt16*,   # WORD*
    szLogPath : UInt16*,   # WORD*
    rgrstmap : JET_RSTMAP_W*,   # JET_RSTMAP_W* optional
    crstfilemap : Int32,   # INT
    szBackupLogPath : UInt16*,   # WORD*
    pLogInfo : JET_LOGINFO_W*,   # JET_LOGINFO_W* in/out
    szTargetInstanceName : UInt16*,   # WORD* optional
    szTargetInstanceLogPath : UInt16*,   # WORD* optional
    szTargetInstanceCheckpointPath : UInt16*,   # WORD* optional
    pfn : Void*   # JET_PFNSTATUS
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef JetExternalRestore2WNative = Int32 Function(Pointer<Uint16>, Pointer<Uint16>, Pointer<Void>, Int32, Pointer<Uint16>, Pointer<Void>, Pointer<Uint16>, Pointer<Uint16>, Pointer<Uint16>, Pointer<Void>);
typedef JetExternalRestore2WDart = int Function(Pointer<Uint16>, Pointer<Uint16>, Pointer<Void>, int, Pointer<Uint16>, Pointer<Void>, Pointer<Uint16>, Pointer<Uint16>, Pointer<Uint16>, Pointer<Void>);
final JetExternalRestore2W = DynamicLibrary.open('ESENT.dll')
    .lookupFunction<JetExternalRestore2WNative, JetExternalRestore2WDart>('JetExternalRestore2W');
// szCheckpointFilePath : WORD* -> Pointer<Uint16>
// szLogPath : WORD* -> Pointer<Uint16>
// rgrstmap : JET_RSTMAP_W* optional -> Pointer<Void>
// crstfilemap : INT -> Int32
// szBackupLogPath : WORD* -> Pointer<Uint16>
// pLogInfo : JET_LOGINFO_W* in/out -> Pointer<Void>
// szTargetInstanceName : WORD* optional -> Pointer<Uint16>
// szTargetInstanceLogPath : WORD* optional -> Pointer<Uint16>
// szTargetInstanceCheckpointPath : WORD* optional -> Pointer<Uint16>
// pfn : JET_PFNSTATUS -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function JetExternalRestore2W(
  szCheckpointFilePath: Pointer;   // WORD*
  szLogPath: Pointer;   // WORD*
  rgrstmap: Pointer;   // JET_RSTMAP_W* optional
  crstfilemap: Integer;   // INT
  szBackupLogPath: Pointer;   // WORD*
  pLogInfo: Pointer;   // JET_LOGINFO_W* in/out
  szTargetInstanceName: Pointer;   // WORD* optional
  szTargetInstanceLogPath: Pointer;   // WORD* optional
  szTargetInstanceCheckpointPath: Pointer;   // WORD* optional
  pfn: Pointer   // JET_PFNSTATUS
): Integer; stdcall;
  external 'ESENT.dll' name 'JetExternalRestore2W';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "JetExternalRestore2W"
  c_JetExternalRestore2W :: Ptr Word16 -> Ptr Word16 -> Ptr () -> Int32 -> Ptr Word16 -> Ptr () -> Ptr Word16 -> Ptr Word16 -> Ptr Word16 -> Ptr () -> IO Int32
-- szCheckpointFilePath : WORD* -> Ptr Word16
-- szLogPath : WORD* -> Ptr Word16
-- rgrstmap : JET_RSTMAP_W* optional -> Ptr ()
-- crstfilemap : INT -> Int32
-- szBackupLogPath : WORD* -> Ptr Word16
-- pLogInfo : JET_LOGINFO_W* in/out -> Ptr ()
-- szTargetInstanceName : WORD* optional -> Ptr Word16
-- szTargetInstanceLogPath : WORD* optional -> Ptr Word16
-- szTargetInstanceCheckpointPath : WORD* optional -> Ptr Word16
-- pfn : JET_PFNSTATUS -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let jetexternalrestore2w =
  foreign "JetExternalRestore2W"
    ((ptr uint16_t) @-> (ptr uint16_t) @-> (ptr void) @-> int32_t @-> (ptr uint16_t) @-> (ptr void) @-> (ptr uint16_t) @-> (ptr uint16_t) @-> (ptr uint16_t) @-> (ptr void) @-> returning int32_t)
(* szCheckpointFilePath : WORD* -> (ptr uint16_t) *)
(* szLogPath : WORD* -> (ptr uint16_t) *)
(* rgrstmap : JET_RSTMAP_W* optional -> (ptr void) *)
(* crstfilemap : INT -> int32_t *)
(* szBackupLogPath : WORD* -> (ptr uint16_t) *)
(* pLogInfo : JET_LOGINFO_W* in/out -> (ptr void) *)
(* szTargetInstanceName : WORD* optional -> (ptr uint16_t) *)
(* szTargetInstanceLogPath : WORD* optional -> (ptr uint16_t) *)
(* szTargetInstanceCheckpointPath : WORD* optional -> (ptr uint16_t) *)
(* pfn : JET_PFNSTATUS -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library esent (t "ESENT.dll"))
(cffi:use-foreign-library esent)

(cffi:defcfun ("JetExternalRestore2W" jet-external-restore2-w :convention :stdcall) :int32
  (sz-checkpoint-file-path :pointer)   ; WORD*
  (sz-log-path :pointer)   ; WORD*
  (rgrstmap :pointer)   ; JET_RSTMAP_W* optional
  (crstfilemap :int32)   ; INT
  (sz-backup-log-path :pointer)   ; WORD*
  (p-log-info :pointer)   ; JET_LOGINFO_W* in/out
  (sz-target-instance-name :pointer)   ; WORD* optional
  (sz-target-instance-log-path :pointer)   ; WORD* optional
  (sz-target-instance-checkpoint-path :pointer)   ; WORD* optional
  (pfn :pointer))   ; JET_PFNSTATUS
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $JetExternalRestore2W = Win32::API::More->new('ESENT',
    'int JetExternalRestore2W(LPVOID szCheckpointFilePath, LPVOID szLogPath, LPVOID rgrstmap, int crstfilemap, LPVOID szBackupLogPath, LPVOID pLogInfo, LPVOID szTargetInstanceName, LPVOID szTargetInstanceLogPath, LPVOID szTargetInstanceCheckpointPath, LPVOID pfn)');
# my $ret = $JetExternalRestore2W->Call($szCheckpointFilePath, $szLogPath, $rgrstmap, $crstfilemap, $szBackupLogPath, $pLogInfo, $szTargetInstanceName, $szTargetInstanceLogPath, $szTargetInstanceCheckpointPath, $pfn);
# szCheckpointFilePath : WORD* -> LPVOID
# szLogPath : WORD* -> LPVOID
# rgrstmap : JET_RSTMAP_W* optional -> LPVOID
# crstfilemap : INT -> int
# szBackupLogPath : WORD* -> LPVOID
# pLogInfo : JET_LOGINFO_W* in/out -> LPVOID
# szTargetInstanceName : WORD* optional -> LPVOID
# szTargetInstanceLogPath : WORD* optional -> LPVOID
# szTargetInstanceCheckpointPath : WORD* optional -> LPVOID
# pfn : JET_PFNSTATUS -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# コールバック(関数ポインタ)は Perl sub を直接渡せません。Win32::API::Callback を使用してください。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い
類似 API
使用する型