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

JetExternalRestore2A

関数
対象インスタンス指定で外部バックアップから復元する(ANSI版)。
DLLESENT.dll文字セットANSI (-A)呼出規約winapi

シグネチャ

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

INT JetExternalRestore2A(
    CHAR* szCheckpointFilePath,
    CHAR* szLogPath,
    JET_RSTMAP_A* rgrstmap,   // optional
    INT crstfilemap,
    CHAR* szBackupLogPath,
    JET_LOGINFO_A* pLogInfo,
    CHAR* szTargetInstanceName,   // optional
    CHAR* szTargetInstanceLogPath,   // optional
    CHAR* szTargetInstanceCheckpointPath,   // optional
    JET_PFNSTATUS pfn
);

パラメーター

名前型方向説明
szCheckpointFilePathCHAR*in復元時に使用するチェックポイントファイルのパスを指す終端付きANSI文字列ポインタ。
szLogPathCHAR*in復元に使用するログファイルが格納されたディレクトリのパスを指す終端付きANSI文字列ポインタ。
rgrstmapJET_RSTMAP_A*inoptionalバックアップ元と復元先のデータベースパス対応を保持するJET_RSTMAP_A配列のポインタ。
crstfilemapINTinrgrstmap配列の要素数を指定する値。
szBackupLogPathCHAR*inバックアップ時のログが格納されたディレクトリのパスを指す終端付きANSI文字列ポインタ。
pLogInfoJET_LOGINFO_A*inout適用するログ世代範囲などを指定するJET_LOGINFO_A構造体ポインタ。NULL可。
szTargetInstanceNameCHAR*inoptional復元先インスタンス名を指す終端付きANSI文字列ポインタ。NULL可。
szTargetInstanceLogPathCHAR*inoptional復元先インスタンスのログパスを指す終端付きANSI文字列ポインタ。NULL可。
szTargetInstanceCheckpointPathCHAR*inoptional復元先インスタンスのチェックポイントパスを指す終端付きANSI文字列ポインタ。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  (ANSI / -A)
#include <windows.h>

INT JetExternalRestore2A(
    CHAR* szCheckpointFilePath,
    CHAR* szLogPath,
    JET_RSTMAP_A* rgrstmap,   // optional
    INT crstfilemap,
    CHAR* szBackupLogPath,
    JET_LOGINFO_A* pLogInfo,
    CHAR* szTargetInstanceName,   // optional
    CHAR* szTargetInstanceLogPath,   // optional
    CHAR* szTargetInstanceCheckpointPath,   // optional
    JET_PFNSTATUS pfn
);
[DllImport("ESENT.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern int JetExternalRestore2A(
    IntPtr szCheckpointFilePath,   // CHAR*
    IntPtr szLogPath,   // CHAR*
    IntPtr rgrstmap,   // JET_RSTMAP_A* optional
    int crstfilemap,   // INT
    IntPtr szBackupLogPath,   // CHAR*
    IntPtr pLogInfo,   // JET_LOGINFO_A* in/out
    IntPtr szTargetInstanceName,   // CHAR* optional
    IntPtr szTargetInstanceLogPath,   // CHAR* optional
    IntPtr szTargetInstanceCheckpointPath,   // CHAR* optional
    IntPtr pfn   // JET_PFNSTATUS
);
<DllImport("ESENT.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function JetExternalRestore2A(
    szCheckpointFilePath As IntPtr,   ' CHAR*
    szLogPath As IntPtr,   ' CHAR*
    rgrstmap As IntPtr,   ' JET_RSTMAP_A* optional
    crstfilemap As Integer,   ' INT
    szBackupLogPath As IntPtr,   ' CHAR*
    pLogInfo As IntPtr,   ' JET_LOGINFO_A* in/out
    szTargetInstanceName As IntPtr,   ' CHAR* optional
    szTargetInstanceLogPath As IntPtr,   ' CHAR* optional
    szTargetInstanceCheckpointPath As IntPtr,   ' CHAR* optional
    pfn As IntPtr   ' JET_PFNSTATUS
) As Integer
End Function
' szCheckpointFilePath : CHAR*
' szLogPath : CHAR*
' rgrstmap : JET_RSTMAP_A* optional
' crstfilemap : INT
' szBackupLogPath : CHAR*
' pLogInfo : JET_LOGINFO_A* in/out
' szTargetInstanceName : CHAR* optional
' szTargetInstanceLogPath : CHAR* optional
' szTargetInstanceCheckpointPath : CHAR* optional
' pfn : JET_PFNSTATUS
Declare PtrSafe Function JetExternalRestore2A Lib "esent" ( _
    ByVal szCheckpointFilePath As LongPtr, _
    ByVal szLogPath As LongPtr, _
    ByVal rgrstmap As LongPtr, _
    ByVal crstfilemap As Long, _
    ByVal szBackupLogPath As LongPtr, _
    ByVal pLogInfo As LongPtr, _
    ByVal szTargetInstanceName As LongPtr, _
    ByVal szTargetInstanceLogPath As LongPtr, _
    ByVal szTargetInstanceCheckpointPath As LongPtr, _
    ByVal pfn As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

JetExternalRestore2A = ctypes.windll.esent.JetExternalRestore2A
JetExternalRestore2A.restype = ctypes.c_int
JetExternalRestore2A.argtypes = [
    ctypes.POINTER(ctypes.c_byte),  # szCheckpointFilePath : CHAR*
    ctypes.POINTER(ctypes.c_byte),  # szLogPath : CHAR*
    ctypes.c_void_p,  # rgrstmap : JET_RSTMAP_A* optional
    ctypes.c_int,  # crstfilemap : INT
    ctypes.POINTER(ctypes.c_byte),  # szBackupLogPath : CHAR*
    ctypes.c_void_p,  # pLogInfo : JET_LOGINFO_A* in/out
    ctypes.POINTER(ctypes.c_byte),  # szTargetInstanceName : CHAR* optional
    ctypes.POINTER(ctypes.c_byte),  # szTargetInstanceLogPath : CHAR* optional
    ctypes.POINTER(ctypes.c_byte),  # szTargetInstanceCheckpointPath : CHAR* optional
    ctypes.c_void_p,  # pfn : JET_PFNSTATUS
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ESENT.dll')
JetExternalRestore2A = Fiddle::Function.new(
  lib['JetExternalRestore2A'],
  [
    Fiddle::TYPE_VOIDP,  # szCheckpointFilePath : CHAR*
    Fiddle::TYPE_VOIDP,  # szLogPath : CHAR*
    Fiddle::TYPE_VOIDP,  # rgrstmap : JET_RSTMAP_A* optional
    Fiddle::TYPE_INT,  # crstfilemap : INT
    Fiddle::TYPE_VOIDP,  # szBackupLogPath : CHAR*
    Fiddle::TYPE_VOIDP,  # pLogInfo : JET_LOGINFO_A* in/out
    Fiddle::TYPE_VOIDP,  # szTargetInstanceName : CHAR* optional
    Fiddle::TYPE_VOIDP,  # szTargetInstanceLogPath : CHAR* optional
    Fiddle::TYPE_VOIDP,  # szTargetInstanceCheckpointPath : CHAR* optional
    Fiddle::TYPE_VOIDP,  # pfn : JET_PFNSTATUS
  ],
  Fiddle::TYPE_INT)
#[link(name = "esent")]
extern "system" {
    fn JetExternalRestore2A(
        szCheckpointFilePath: *mut i8,  // CHAR*
        szLogPath: *mut i8,  // CHAR*
        rgrstmap: *mut JET_RSTMAP_A,  // JET_RSTMAP_A* optional
        crstfilemap: i32,  // INT
        szBackupLogPath: *mut i8,  // CHAR*
        pLogInfo: *mut JET_LOGINFO_A,  // JET_LOGINFO_A* in/out
        szTargetInstanceName: *mut i8,  // CHAR* optional
        szTargetInstanceLogPath: *mut i8,  // CHAR* optional
        szTargetInstanceCheckpointPath: *mut i8,  // CHAR* 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.Ansi)]
public static extern int JetExternalRestore2A(IntPtr szCheckpointFilePath, IntPtr szLogPath, IntPtr rgrstmap, int crstfilemap, IntPtr szBackupLogPath, IntPtr pLogInfo, IntPtr szTargetInstanceName, IntPtr szTargetInstanceLogPath, IntPtr szTargetInstanceCheckpointPath, IntPtr pfn);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ESENT_JetExternalRestore2A' -Namespace Win32 -PassThru
# $api::JetExternalRestore2A(szCheckpointFilePath, szLogPath, rgrstmap, crstfilemap, szBackupLogPath, pLogInfo, szTargetInstanceName, szTargetInstanceLogPath, szTargetInstanceCheckpointPath, pfn)
#uselib "ESENT.dll"
#func global JetExternalRestore2A "JetExternalRestore2A" sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr
; JetExternalRestore2A varptr(szCheckpointFilePath), varptr(szLogPath), varptr(rgrstmap), crstfilemap, varptr(szBackupLogPath), varptr(pLogInfo), varptr(szTargetInstanceName), varptr(szTargetInstanceLogPath), varptr(szTargetInstanceCheckpointPath), pfn   ; 戻り値は stat
; szCheckpointFilePath : CHAR* -> "sptr"
; szLogPath : CHAR* -> "sptr"
; rgrstmap : JET_RSTMAP_A* optional -> "sptr"
; crstfilemap : INT -> "sptr"
; szBackupLogPath : CHAR* -> "sptr"
; pLogInfo : JET_LOGINFO_A* in/out -> "sptr"
; szTargetInstanceName : CHAR* optional -> "sptr"
; szTargetInstanceLogPath : CHAR* optional -> "sptr"
; szTargetInstanceCheckpointPath : CHAR* optional -> "sptr"
; pfn : JET_PFNSTATUS -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "ESENT.dll"
#cfunc global JetExternalRestore2A "JetExternalRestore2A" var, var, var, int, var, var, var, var, var, sptr
; res = JetExternalRestore2A(szCheckpointFilePath, szLogPath, rgrstmap, crstfilemap, szBackupLogPath, pLogInfo, szTargetInstanceName, szTargetInstanceLogPath, szTargetInstanceCheckpointPath, pfn)
; szCheckpointFilePath : CHAR* -> "var"
; szLogPath : CHAR* -> "var"
; rgrstmap : JET_RSTMAP_A* optional -> "var"
; crstfilemap : INT -> "int"
; szBackupLogPath : CHAR* -> "var"
; pLogInfo : JET_LOGINFO_A* in/out -> "var"
; szTargetInstanceName : CHAR* optional -> "var"
; szTargetInstanceLogPath : CHAR* optional -> "var"
; szTargetInstanceCheckpointPath : CHAR* optional -> "var"
; pfn : JET_PFNSTATUS -> "sptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; INT JetExternalRestore2A(CHAR* szCheckpointFilePath, CHAR* szLogPath, JET_RSTMAP_A* rgrstmap, INT crstfilemap, CHAR* szBackupLogPath, JET_LOGINFO_A* pLogInfo, CHAR* szTargetInstanceName, CHAR* szTargetInstanceLogPath, CHAR* szTargetInstanceCheckpointPath, JET_PFNSTATUS pfn)
#uselib "ESENT.dll"
#cfunc global JetExternalRestore2A "JetExternalRestore2A" var, var, var, int, var, var, var, var, var, intptr
; res = JetExternalRestore2A(szCheckpointFilePath, szLogPath, rgrstmap, crstfilemap, szBackupLogPath, pLogInfo, szTargetInstanceName, szTargetInstanceLogPath, szTargetInstanceCheckpointPath, pfn)
; szCheckpointFilePath : CHAR* -> "var"
; szLogPath : CHAR* -> "var"
; rgrstmap : JET_RSTMAP_A* optional -> "var"
; crstfilemap : INT -> "int"
; szBackupLogPath : CHAR* -> "var"
; pLogInfo : JET_LOGINFO_A* in/out -> "var"
; szTargetInstanceName : CHAR* optional -> "var"
; szTargetInstanceLogPath : CHAR* optional -> "var"
; szTargetInstanceCheckpointPath : CHAR* optional -> "var"
; pfn : JET_PFNSTATUS -> "intptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	esent = windows.NewLazySystemDLL("ESENT.dll")
	procJetExternalRestore2A = esent.NewProc("JetExternalRestore2A")
)

// szCheckpointFilePath (CHAR*), szLogPath (CHAR*), rgrstmap (JET_RSTMAP_A* optional), crstfilemap (INT), szBackupLogPath (CHAR*), pLogInfo (JET_LOGINFO_A* in/out), szTargetInstanceName (CHAR* optional), szTargetInstanceLogPath (CHAR* optional), szTargetInstanceCheckpointPath (CHAR* optional), pfn (JET_PFNSTATUS)
r1, _, err := procJetExternalRestore2A.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 JetExternalRestore2A(
  szCheckpointFilePath: Pointer;   // CHAR*
  szLogPath: Pointer;   // CHAR*
  rgrstmap: Pointer;   // JET_RSTMAP_A* optional
  crstfilemap: Integer;   // INT
  szBackupLogPath: Pointer;   // CHAR*
  pLogInfo: Pointer;   // JET_LOGINFO_A* in/out
  szTargetInstanceName: Pointer;   // CHAR* optional
  szTargetInstanceLogPath: Pointer;   // CHAR* optional
  szTargetInstanceCheckpointPath: Pointer;   // CHAR* optional
  pfn: Pointer   // JET_PFNSTATUS
): Integer; stdcall;
  external 'ESENT.dll' name 'JetExternalRestore2A';
result := DllCall("ESENT\JetExternalRestore2A"
    , "Ptr", szCheckpointFilePath   ; CHAR*
    , "Ptr", szLogPath   ; CHAR*
    , "Ptr", rgrstmap   ; JET_RSTMAP_A* optional
    , "Int", crstfilemap   ; INT
    , "Ptr", szBackupLogPath   ; CHAR*
    , "Ptr", pLogInfo   ; JET_LOGINFO_A* in/out
    , "Ptr", szTargetInstanceName   ; CHAR* optional
    , "Ptr", szTargetInstanceLogPath   ; CHAR* optional
    , "Ptr", szTargetInstanceCheckpointPath   ; CHAR* optional
    , "Ptr", pfn   ; JET_PFNSTATUS
    , "Int")   ; return: INT
●JetExternalRestore2A(szCheckpointFilePath, szLogPath, rgrstmap, crstfilemap, szBackupLogPath, pLogInfo, szTargetInstanceName, szTargetInstanceLogPath, szTargetInstanceCheckpointPath, pfn) = DLL("ESENT.dll", "int JetExternalRestore2A(void*, void*, void*, int, void*, void*, void*, void*, void*, void*)")
# 呼び出し: JetExternalRestore2A(szCheckpointFilePath, szLogPath, rgrstmap, crstfilemap, szBackupLogPath, pLogInfo, szTargetInstanceName, szTargetInstanceLogPath, szTargetInstanceCheckpointPath, pfn)
# szCheckpointFilePath : CHAR* -> "void*"
# szLogPath : CHAR* -> "void*"
# rgrstmap : JET_RSTMAP_A* optional -> "void*"
# crstfilemap : INT -> "int"
# szBackupLogPath : CHAR* -> "void*"
# pLogInfo : JET_LOGINFO_A* in/out -> "void*"
# szTargetInstanceName : CHAR* optional -> "void*"
# szTargetInstanceLogPath : CHAR* optional -> "void*"
# szTargetInstanceCheckpointPath : CHAR* optional -> "void*"
# pfn : JET_PFNSTATUS -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "esent" fn JetExternalRestore2A(
    szCheckpointFilePath: [*c]i8, // CHAR*
    szLogPath: [*c]i8, // CHAR*
    rgrstmap: [*c]JET_RSTMAP_A, // JET_RSTMAP_A* optional
    crstfilemap: i32, // INT
    szBackupLogPath: [*c]i8, // CHAR*
    pLogInfo: [*c]JET_LOGINFO_A, // JET_LOGINFO_A* in/out
    szTargetInstanceName: [*c]i8, // CHAR* optional
    szTargetInstanceLogPath: [*c]i8, // CHAR* optional
    szTargetInstanceCheckpointPath: [*c]i8, // CHAR* optional
    pfn: ?*anyopaque // JET_PFNSTATUS
) callconv(std.os.windows.WINAPI) i32;
proc JetExternalRestore2A(
    szCheckpointFilePath: ptr int8,  # CHAR*
    szLogPath: ptr int8,  # CHAR*
    rgrstmap: ptr JET_RSTMAP_A,  # JET_RSTMAP_A* optional
    crstfilemap: int32,  # INT
    szBackupLogPath: ptr int8,  # CHAR*
    pLogInfo: ptr JET_LOGINFO_A,  # JET_LOGINFO_A* in/out
    szTargetInstanceName: ptr int8,  # CHAR* optional
    szTargetInstanceLogPath: ptr int8,  # CHAR* optional
    szTargetInstanceCheckpointPath: ptr int8,  # CHAR* optional
    pfn: pointer  # JET_PFNSTATUS
): int32 {.importc: "JetExternalRestore2A", stdcall, dynlib: "ESENT.dll".}
pragma(lib, "esent");
extern(Windows)
int JetExternalRestore2A(
    byte* szCheckpointFilePath,   // CHAR*
    byte* szLogPath,   // CHAR*
    JET_RSTMAP_A* rgrstmap,   // JET_RSTMAP_A* optional
    int crstfilemap,   // INT
    byte* szBackupLogPath,   // CHAR*
    JET_LOGINFO_A* pLogInfo,   // JET_LOGINFO_A* in/out
    byte* szTargetInstanceName,   // CHAR* optional
    byte* szTargetInstanceLogPath,   // CHAR* optional
    byte* szTargetInstanceCheckpointPath,   // CHAR* optional
    void* pfn   // JET_PFNSTATUS
);
ccall((:JetExternalRestore2A, "ESENT.dll"), stdcall, Int32,
      (Ptr{Int8}, Ptr{Int8}, Ptr{JET_RSTMAP_A}, Int32, Ptr{Int8}, Ptr{JET_LOGINFO_A}, Ptr{Int8}, Ptr{Int8}, Ptr{Int8}, Ptr{Cvoid}),
      szCheckpointFilePath, szLogPath, rgrstmap, crstfilemap, szBackupLogPath, pLogInfo, szTargetInstanceName, szTargetInstanceLogPath, szTargetInstanceCheckpointPath, pfn)
# szCheckpointFilePath : CHAR* -> Ptr{Int8}
# szLogPath : CHAR* -> Ptr{Int8}
# rgrstmap : JET_RSTMAP_A* optional -> Ptr{JET_RSTMAP_A}
# crstfilemap : INT -> Int32
# szBackupLogPath : CHAR* -> Ptr{Int8}
# pLogInfo : JET_LOGINFO_A* in/out -> Ptr{JET_LOGINFO_A}
# szTargetInstanceName : CHAR* optional -> Ptr{Int8}
# szTargetInstanceLogPath : CHAR* optional -> Ptr{Int8}
# szTargetInstanceCheckpointPath : CHAR* optional -> Ptr{Int8}
# pfn : JET_PFNSTATUS -> Ptr{Cvoid}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t JetExternalRestore2A(
    int8_t* szCheckpointFilePath,
    int8_t* szLogPath,
    void* rgrstmap,
    int32_t crstfilemap,
    int8_t* szBackupLogPath,
    void* pLogInfo,
    int8_t* szTargetInstanceName,
    int8_t* szTargetInstanceLogPath,
    int8_t* szTargetInstanceCheckpointPath,
    void* pfn);
]]
local esent = ffi.load("esent")
-- esent.JetExternalRestore2A(szCheckpointFilePath, szLogPath, rgrstmap, crstfilemap, szBackupLogPath, pLogInfo, szTargetInstanceName, szTargetInstanceLogPath, szTargetInstanceCheckpointPath, pfn)
-- szCheckpointFilePath : CHAR*
-- szLogPath : CHAR*
-- rgrstmap : JET_RSTMAP_A* optional
-- crstfilemap : INT
-- szBackupLogPath : CHAR*
-- pLogInfo : JET_LOGINFO_A* in/out
-- szTargetInstanceName : CHAR* optional
-- szTargetInstanceLogPath : CHAR* optional
-- szTargetInstanceCheckpointPath : CHAR* optional
-- pfn : JET_PFNSTATUS
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('ESENT.dll');
const JetExternalRestore2A = lib.func('__stdcall', 'JetExternalRestore2A', 'int32_t', ['int8_t *', 'int8_t *', 'void *', 'int32_t', 'int8_t *', 'void *', 'int8_t *', 'int8_t *', 'int8_t *', 'void *']);
// JetExternalRestore2A(szCheckpointFilePath, szLogPath, rgrstmap, crstfilemap, szBackupLogPath, pLogInfo, szTargetInstanceName, szTargetInstanceLogPath, szTargetInstanceCheckpointPath, pfn)
// szCheckpointFilePath : CHAR* -> 'int8_t *'
// szLogPath : CHAR* -> 'int8_t *'
// rgrstmap : JET_RSTMAP_A* optional -> 'void *'
// crstfilemap : INT -> 'int32_t'
// szBackupLogPath : CHAR* -> 'int8_t *'
// pLogInfo : JET_LOGINFO_A* in/out -> 'void *'
// szTargetInstanceName : CHAR* optional -> 'int8_t *'
// szTargetInstanceLogPath : CHAR* optional -> 'int8_t *'
// szTargetInstanceCheckpointPath : CHAR* optional -> 'int8_t *'
// pfn : JET_PFNSTATUS -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
// コールバック(関数ポインタ)は koffi.proto/koffi.register で型を定義して渡す(素の void* では JS 関数を渡せない)。
const lib = Deno.dlopen("ESENT.dll", {
  JetExternalRestore2A: { parameters: ["pointer", "pointer", "pointer", "i32", "pointer", "pointer", "pointer", "pointer", "pointer", "pointer"], result: "i32" },
});
// lib.symbols.JetExternalRestore2A(szCheckpointFilePath, szLogPath, rgrstmap, crstfilemap, szBackupLogPath, pLogInfo, szTargetInstanceName, szTargetInstanceLogPath, szTargetInstanceCheckpointPath, pfn)
// szCheckpointFilePath : CHAR* -> "pointer"
// szLogPath : CHAR* -> "pointer"
// rgrstmap : JET_RSTMAP_A* optional -> "pointer"
// crstfilemap : INT -> "i32"
// szBackupLogPath : CHAR* -> "pointer"
// pLogInfo : JET_LOGINFO_A* in/out -> "pointer"
// szTargetInstanceName : CHAR* optional -> "pointer"
// szTargetInstanceLogPath : CHAR* optional -> "pointer"
// szTargetInstanceCheckpointPath : CHAR* optional -> "pointer"
// pfn : JET_PFNSTATUS -> "pointer"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t JetExternalRestore2A(
    int8_t* szCheckpointFilePath,
    int8_t* szLogPath,
    void* rgrstmap,
    int32_t crstfilemap,
    int8_t* szBackupLogPath,
    void* pLogInfo,
    int8_t* szTargetInstanceName,
    int8_t* szTargetInstanceLogPath,
    int8_t* szTargetInstanceCheckpointPath,
    void* pfn);
C, "ESENT.dll");
// $ffi->JetExternalRestore2A(szCheckpointFilePath, szLogPath, rgrstmap, crstfilemap, szBackupLogPath, pLogInfo, szTargetInstanceName, szTargetInstanceLogPath, szTargetInstanceCheckpointPath, pfn);
// szCheckpointFilePath : CHAR*
// szLogPath : CHAR*
// rgrstmap : JET_RSTMAP_A* optional
// crstfilemap : INT
// szBackupLogPath : CHAR*
// pLogInfo : JET_LOGINFO_A* in/out
// szTargetInstanceName : CHAR* optional
// szTargetInstanceLogPath : CHAR* optional
// szTargetInstanceCheckpointPath : CHAR* 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.ASCII_OPTIONS);
    int JetExternalRestore2A(
        byte[] szCheckpointFilePath,   // CHAR*
        byte[] szLogPath,   // CHAR*
        Pointer rgrstmap,   // JET_RSTMAP_A* optional
        int crstfilemap,   // INT
        byte[] szBackupLogPath,   // CHAR*
        Pointer pLogInfo,   // JET_LOGINFO_A* in/out
        byte[] szTargetInstanceName,   // CHAR* optional
        byte[] szTargetInstanceLogPath,   // CHAR* optional
        byte[] szTargetInstanceCheckpointPath,   // CHAR* optional
        Callback pfn   // JET_PFNSTATUS
    );
}
@[Link("esent")]
lib LibESENT
  fun JetExternalRestore2A = JetExternalRestore2A(
    szCheckpointFilePath : Int8*,   # CHAR*
    szLogPath : Int8*,   # CHAR*
    rgrstmap : JET_RSTMAP_A*,   # JET_RSTMAP_A* optional
    crstfilemap : Int32,   # INT
    szBackupLogPath : Int8*,   # CHAR*
    pLogInfo : JET_LOGINFO_A*,   # JET_LOGINFO_A* in/out
    szTargetInstanceName : Int8*,   # CHAR* optional
    szTargetInstanceLogPath : Int8*,   # CHAR* optional
    szTargetInstanceCheckpointPath : Int8*,   # CHAR* 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 JetExternalRestore2ANative = Int32 Function(Pointer<Int8>, Pointer<Int8>, Pointer<Void>, Int32, Pointer<Int8>, Pointer<Void>, Pointer<Int8>, Pointer<Int8>, Pointer<Int8>, Pointer<Void>);
typedef JetExternalRestore2ADart = int Function(Pointer<Int8>, Pointer<Int8>, Pointer<Void>, int, Pointer<Int8>, Pointer<Void>, Pointer<Int8>, Pointer<Int8>, Pointer<Int8>, Pointer<Void>);
final JetExternalRestore2A = DynamicLibrary.open('ESENT.dll')
    .lookupFunction<JetExternalRestore2ANative, JetExternalRestore2ADart>('JetExternalRestore2A');
// szCheckpointFilePath : CHAR* -> Pointer<Int8>
// szLogPath : CHAR* -> Pointer<Int8>
// rgrstmap : JET_RSTMAP_A* optional -> Pointer<Void>
// crstfilemap : INT -> Int32
// szBackupLogPath : CHAR* -> Pointer<Int8>
// pLogInfo : JET_LOGINFO_A* in/out -> Pointer<Void>
// szTargetInstanceName : CHAR* optional -> Pointer<Int8>
// szTargetInstanceLogPath : CHAR* optional -> Pointer<Int8>
// szTargetInstanceCheckpointPath : CHAR* optional -> Pointer<Int8>
// pfn : JET_PFNSTATUS -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function JetExternalRestore2A(
  szCheckpointFilePath: Pointer;   // CHAR*
  szLogPath: Pointer;   // CHAR*
  rgrstmap: Pointer;   // JET_RSTMAP_A* optional
  crstfilemap: Integer;   // INT
  szBackupLogPath: Pointer;   // CHAR*
  pLogInfo: Pointer;   // JET_LOGINFO_A* in/out
  szTargetInstanceName: Pointer;   // CHAR* optional
  szTargetInstanceLogPath: Pointer;   // CHAR* optional
  szTargetInstanceCheckpointPath: Pointer;   // CHAR* optional
  pfn: Pointer   // JET_PFNSTATUS
): Integer; stdcall;
  external 'ESENT.dll' name 'JetExternalRestore2A';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

let jetexternalrestore2a =
  foreign "JetExternalRestore2A"
    ((ptr int8_t) @-> (ptr int8_t) @-> (ptr void) @-> int32_t @-> (ptr int8_t) @-> (ptr void) @-> (ptr int8_t) @-> (ptr int8_t) @-> (ptr int8_t) @-> (ptr void) @-> returning int32_t)
(* szCheckpointFilePath : CHAR* -> (ptr int8_t) *)
(* szLogPath : CHAR* -> (ptr int8_t) *)
(* rgrstmap : JET_RSTMAP_A* optional -> (ptr void) *)
(* crstfilemap : INT -> int32_t *)
(* szBackupLogPath : CHAR* -> (ptr int8_t) *)
(* pLogInfo : JET_LOGINFO_A* in/out -> (ptr void) *)
(* szTargetInstanceName : CHAR* optional -> (ptr int8_t) *)
(* szTargetInstanceLogPath : CHAR* optional -> (ptr int8_t) *)
(* szTargetInstanceCheckpointPath : CHAR* optional -> (ptr int8_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 ("JetExternalRestore2A" jet-external-restore2-a :convention :stdcall) :int32
  (sz-checkpoint-file-path :pointer)   ; CHAR*
  (sz-log-path :pointer)   ; CHAR*
  (rgrstmap :pointer)   ; JET_RSTMAP_A* optional
  (crstfilemap :int32)   ; INT
  (sz-backup-log-path :pointer)   ; CHAR*
  (p-log-info :pointer)   ; JET_LOGINFO_A* in/out
  (sz-target-instance-name :pointer)   ; CHAR* optional
  (sz-target-instance-log-path :pointer)   ; CHAR* optional
  (sz-target-instance-checkpoint-path :pointer)   ; CHAR* optional
  (pfn :pointer))   ; JET_PFNSTATUS
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $JetExternalRestore2A = Win32::API::More->new('ESENT',
    'int JetExternalRestore2A(LPVOID szCheckpointFilePath, LPVOID szLogPath, LPVOID rgrstmap, int crstfilemap, LPVOID szBackupLogPath, LPVOID pLogInfo, LPVOID szTargetInstanceName, LPVOID szTargetInstanceLogPath, LPVOID szTargetInstanceCheckpointPath, LPVOID pfn)');
# my $ret = $JetExternalRestore2A->Call($szCheckpointFilePath, $szLogPath, $rgrstmap, $crstfilemap, $szBackupLogPath, $pLogInfo, $szTargetInstanceName, $szTargetInstanceLogPath, $szTargetInstanceCheckpointPath, $pfn);
# szCheckpointFilePath : CHAR* -> LPVOID
# szLogPath : CHAR* -> LPVOID
# rgrstmap : JET_RSTMAP_A* optional -> LPVOID
# crstfilemap : INT -> int
# szBackupLogPath : CHAR* -> LPVOID
# pLogInfo : JET_LOGINFO_A* in/out -> LPVOID
# szTargetInstanceName : CHAR* optional -> LPVOID
# szTargetInstanceLogPath : CHAR* optional -> LPVOID
# szTargetInstanceCheckpointPath : CHAR* optional -> LPVOID
# pfn : JET_PFNSTATUS -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# コールバック(関数ポインタ)は Perl sub を直接渡せません。Win32::API::Callback を使用してください。

関連項目

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