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

JetRestoreInstanceW

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

シグネチャ

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

INT JetRestoreInstanceW(
    JET_INSTANCE instance,
    WORD* sz,
    WORD* szDest,   // optional
    JET_PFNSTATUS pfn   // optional
);

パラメーター

名前型方向説明
instanceJET_INSTANCEin復元先となるインスタンスを識別するJET_INSTANCEハンドル。
szWORD*in復元元バックアップが格納されたディレクトリのパスを指す終端付きUnicode文字列ポインタ。
szDestWORD*inoptional復元先ディレクトリのパスを指す終端付きUnicode文字列ポインタ。NULLで元の場所に復元する。
pfnJET_PFNSTATUSinoptional進捗通知を受け取るステータスコールバック関数(JET_PFNSTATUS)。NULL可。

戻り値の型: INT

各言語での呼び出し定義

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

INT JetRestoreInstanceW(
    JET_INSTANCE instance,
    WORD* sz,
    WORD* szDest,   // optional
    JET_PFNSTATUS pfn   // optional
);
[DllImport("ESENT.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern int JetRestoreInstanceW(
    UIntPtr instance,   // JET_INSTANCE
    ref ushort sz,   // WORD*
    IntPtr szDest,   // WORD* optional
    IntPtr pfn   // JET_PFNSTATUS optional
);
<DllImport("ESENT.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function JetRestoreInstanceW(
    instance As UIntPtr,   ' JET_INSTANCE
    ByRef sz As UShort,   ' WORD*
    szDest As IntPtr,   ' WORD* optional
    pfn As IntPtr   ' JET_PFNSTATUS optional
) As Integer
End Function
' instance : JET_INSTANCE
' sz : WORD*
' szDest : WORD* optional
' pfn : JET_PFNSTATUS optional
Declare PtrSafe Function JetRestoreInstanceW Lib "esent" ( _
    ByVal instance As LongPtr, _
    ByRef sz As Integer, _
    ByVal szDest 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

JetRestoreInstanceW = ctypes.windll.esent.JetRestoreInstanceW
JetRestoreInstanceW.restype = ctypes.c_int
JetRestoreInstanceW.argtypes = [
    ctypes.c_size_t,  # instance : JET_INSTANCE
    ctypes.POINTER(ctypes.c_ushort),  # sz : WORD*
    ctypes.POINTER(ctypes.c_ushort),  # szDest : WORD* optional
    ctypes.c_void_p,  # pfn : JET_PFNSTATUS optional
]
require 'fiddle'
require 'fiddle/import'

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

var (
	esent = windows.NewLazySystemDLL("ESENT.dll")
	procJetRestoreInstanceW = esent.NewProc("JetRestoreInstanceW")
)

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

extern "esent" fn JetRestoreInstanceW(
    instance: usize, // JET_INSTANCE
    sz: [*c]u16, // WORD*
    szDest: [*c]u16, // WORD* optional
    pfn: ?*anyopaque // JET_PFNSTATUS optional
) callconv(std.os.windows.WINAPI) i32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc JetRestoreInstanceW(
    instance: uint,  # JET_INSTANCE
    sz: ptr uint16,  # WORD*
    szDest: ptr uint16,  # WORD* optional
    pfn: pointer  # JET_PFNSTATUS optional
): int32 {.importc: "JetRestoreInstanceW", stdcall, dynlib: "ESENT.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "esent");
extern(Windows)
int JetRestoreInstanceW(
    size_t instance,   // JET_INSTANCE
    ushort* sz,   // WORD*
    ushort* szDest,   // WORD* optional
    void* pfn   // JET_PFNSTATUS optional
);
ccall((:JetRestoreInstanceW, "ESENT.dll"), stdcall, Int32,
      (Csize_t, Ptr{UInt16}, Ptr{UInt16}, Ptr{Cvoid}),
      instance, sz, szDest, pfn)
# instance : JET_INSTANCE -> Csize_t
# sz : WORD* -> Ptr{UInt16}
# szDest : WORD* optional -> Ptr{UInt16}
# pfn : JET_PFNSTATUS optional -> Ptr{Cvoid}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
int32_t JetRestoreInstanceW(
    uintptr_t instance,
    uint16_t* sz,
    uint16_t* szDest,
    void* pfn);
]]
local esent = ffi.load("esent")
-- esent.JetRestoreInstanceW(instance, sz, szDest, pfn)
-- instance : JET_INSTANCE
-- sz : WORD*
-- szDest : WORD* optional
-- pfn : JET_PFNSTATUS optional
-- 構造体/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 JetRestoreInstanceW = lib.func('__stdcall', 'JetRestoreInstanceW', 'int32_t', ['uintptr_t', 'uint16_t *', 'uint16_t *', 'void *']);
// JetRestoreInstanceW(instance, sz, szDest, pfn)
// instance : JET_INSTANCE -> 'uintptr_t'
// sz : WORD* -> 'uint16_t *'
// szDest : WORD* optional -> 'uint16_t *'
// pfn : JET_PFNSTATUS optional -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
// コールバック(関数ポインタ)は koffi.proto/koffi.register で型を定義して渡す(素の void* では JS 関数を渡せない)。
const lib = Deno.dlopen("ESENT.dll", {
  JetRestoreInstanceW: { parameters: ["usize", "pointer", "pointer", "pointer"], result: "i32" },
});
// lib.symbols.JetRestoreInstanceW(instance, sz, szDest, pfn)
// instance : JET_INSTANCE -> "usize"
// sz : WORD* -> "pointer"
// szDest : WORD* optional -> "pointer"
// pfn : JET_PFNSTATUS optional -> "pointer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t JetRestoreInstanceW(
    size_t instance,
    uint16_t* sz,
    uint16_t* szDest,
    void* pfn);
C, "ESENT.dll");
// $ffi->JetRestoreInstanceW(instance, sz, szDest, pfn);
// instance : JET_INSTANCE
// sz : WORD*
// szDest : WORD* optional
// pfn : JET_PFNSTATUS optional
// 構造体/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 JetRestoreInstanceW(
        long instance,   // JET_INSTANCE
        ShortByReference sz,   // WORD*
        ShortByReference szDest,   // WORD* optional
        Callback pfn   // JET_PFNSTATUS optional
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("esent")]
lib LibESENT
  fun JetRestoreInstanceW = JetRestoreInstanceW(
    instance : LibC::SizeT,   # JET_INSTANCE
    sz : UInt16*,   # WORD*
    szDest : UInt16*,   # WORD* optional
    pfn : Void*   # JET_PFNSTATUS optional
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef JetRestoreInstanceWNative = Int32 Function(UintPtr, Pointer<Uint16>, Pointer<Uint16>, Pointer<Void>);
typedef JetRestoreInstanceWDart = int Function(int, Pointer<Uint16>, Pointer<Uint16>, Pointer<Void>);
final JetRestoreInstanceW = DynamicLibrary.open('ESENT.dll')
    .lookupFunction<JetRestoreInstanceWNative, JetRestoreInstanceWDart>('JetRestoreInstanceW');
// instance : JET_INSTANCE -> UintPtr
// sz : WORD* -> Pointer<Uint16>
// szDest : WORD* optional -> Pointer<Uint16>
// pfn : JET_PFNSTATUS optional -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function JetRestoreInstanceW(
  instance: NativeUInt;   // JET_INSTANCE
  sz: Pointer;   // WORD*
  szDest: Pointer;   // WORD* optional
  pfn: Pointer   // JET_PFNSTATUS optional
): Integer; stdcall;
  external 'ESENT.dll' name 'JetRestoreInstanceW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "JetRestoreInstanceW"
  c_JetRestoreInstanceW :: CUIntPtr -> Ptr Word16 -> Ptr Word16 -> Ptr () -> IO Int32
-- instance : JET_INSTANCE -> CUIntPtr
-- sz : WORD* -> Ptr Word16
-- szDest : WORD* optional -> Ptr Word16
-- pfn : JET_PFNSTATUS optional -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let jetrestoreinstancew =
  foreign "JetRestoreInstanceW"
    (size_t @-> (ptr uint16_t) @-> (ptr uint16_t) @-> (ptr void) @-> returning int32_t)
(* instance : JET_INSTANCE -> size_t *)
(* sz : WORD* -> (ptr uint16_t) *)
(* szDest : WORD* optional -> (ptr uint16_t) *)
(* pfn : JET_PFNSTATUS optional -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library esent (t "ESENT.dll"))
(cffi:use-foreign-library esent)

(cffi:defcfun ("JetRestoreInstanceW" jet-restore-instance-w :convention :stdcall) :int32
  (instance :uint64)   ; JET_INSTANCE
  (sz :pointer)   ; WORD*
  (sz-dest :pointer)   ; WORD* optional
  (pfn :pointer))   ; JET_PFNSTATUS optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $JetRestoreInstanceW = Win32::API::More->new('ESENT',
    'int JetRestoreInstanceW(WPARAM instance, LPVOID sz, LPVOID szDest, LPVOID pfn)');
# my $ret = $JetRestoreInstanceW->Call($instance, $sz, $szDest, $pfn);
# instance : JET_INSTANCE -> WPARAM
# sz : WORD* -> LPVOID
# szDest : WORD* optional -> LPVOID
# pfn : JET_PFNSTATUS optional -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# コールバック(関数ポインタ)は Perl sub を直接渡せません。Win32::API::Callback を使用してください。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

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