ホーム › Storage.Jet › JetBackupInstanceW
JetBackupInstanceW
関数指定したインスタンスをバックアップする(Unicode版)。
シグネチャ
// ESENT.dll (Unicode / -W)
#include <windows.h>
INT JetBackupInstanceW(
JET_INSTANCE instance,
WORD* szBackupPath,
DWORD grbit,
JET_PFNSTATUS pfnStatus // optional
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| instance | JET_INSTANCE | in | バックアップ対象のインスタンスを識別するJET_INSTANCEハンドル。 |
| szBackupPath | WORD* | in | バックアップ出力先ディレクトリのパスを指す終端付きUnicode文字列ポインタ。 |
| grbit | DWORD | in | バックアップ動作を制御するビットフラグ。増分や完全などを指定する。 |
| pfnStatus | JET_PFNSTATUS | inoptional | 進捗通知を受け取るステータスコールバック関数(JET_PFNSTATUS)。NULL可。 |
戻り値の型: INT
各言語での呼び出し定義
// ESENT.dll (Unicode / -W)
#include <windows.h>
INT JetBackupInstanceW(
JET_INSTANCE instance,
WORD* szBackupPath,
DWORD grbit,
JET_PFNSTATUS pfnStatus // optional
);[DllImport("ESENT.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern int JetBackupInstanceW(
UIntPtr instance, // JET_INSTANCE
ref ushort szBackupPath, // WORD*
uint grbit, // DWORD
IntPtr pfnStatus // JET_PFNSTATUS optional
);<DllImport("ESENT.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function JetBackupInstanceW(
instance As UIntPtr, ' JET_INSTANCE
ByRef szBackupPath As UShort, ' WORD*
grbit As UInteger, ' DWORD
pfnStatus As IntPtr ' JET_PFNSTATUS optional
) As Integer
End Function' instance : JET_INSTANCE
' szBackupPath : WORD*
' grbit : DWORD
' pfnStatus : JET_PFNSTATUS optional
Declare PtrSafe Function JetBackupInstanceW Lib "esent" ( _
ByVal instance As LongPtr, _
ByRef szBackupPath As Integer, _
ByVal grbit As Long, _
ByVal pfnStatus 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
JetBackupInstanceW = ctypes.windll.esent.JetBackupInstanceW
JetBackupInstanceW.restype = ctypes.c_int
JetBackupInstanceW.argtypes = [
ctypes.c_size_t, # instance : JET_INSTANCE
ctypes.POINTER(ctypes.c_ushort), # szBackupPath : WORD*
wintypes.DWORD, # grbit : DWORD
ctypes.c_void_p, # pfnStatus : JET_PFNSTATUS optional
]require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('ESENT.dll')
JetBackupInstanceW = Fiddle::Function.new(
lib['JetBackupInstanceW'],
[
Fiddle::TYPE_UINTPTR_T, # instance : JET_INSTANCE
Fiddle::TYPE_VOIDP, # szBackupPath : WORD*
-Fiddle::TYPE_INT, # grbit : DWORD
Fiddle::TYPE_VOIDP, # pfnStatus : JET_PFNSTATUS optional
],
Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"#[link(name = "esent")]
extern "system" {
fn JetBackupInstanceW(
instance: usize, // JET_INSTANCE
szBackupPath: *mut u16, // WORD*
grbit: u32, // DWORD
pfnStatus: *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 JetBackupInstanceW(UIntPtr instance, ref ushort szBackupPath, uint grbit, IntPtr pfnStatus);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ESENT_JetBackupInstanceW' -Namespace Win32 -PassThru
# $api::JetBackupInstanceW(instance, szBackupPath, grbit, pfnStatus)#uselib "ESENT.dll"
#func global JetBackupInstanceW "JetBackupInstanceW" wptr, wptr, wptr, wptr
; JetBackupInstanceW instance, varptr(szBackupPath), grbit, pfnStatus ; 戻り値は stat
; instance : JET_INSTANCE -> "wptr"
; szBackupPath : WORD* -> "wptr"
; grbit : DWORD -> "wptr"
; pfnStatus : JET_PFNSTATUS optional -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。出力引数:
#uselib "ESENT.dll" #cfunc global JetBackupInstanceW "JetBackupInstanceW" sptr, var, int, sptr ; res = JetBackupInstanceW(instance, szBackupPath, grbit, pfnStatus) ; instance : JET_INSTANCE -> "sptr" ; szBackupPath : WORD* -> "var" ; grbit : DWORD -> "int" ; pfnStatus : JET_PFNSTATUS optional -> "sptr" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "ESENT.dll" #cfunc global JetBackupInstanceW "JetBackupInstanceW" sptr, sptr, int, sptr ; res = JetBackupInstanceW(instance, varptr(szBackupPath), grbit, pfnStatus) ; instance : JET_INSTANCE -> "sptr" ; szBackupPath : WORD* -> "sptr" ; grbit : DWORD -> "int" ; pfnStatus : JET_PFNSTATUS optional -> "sptr" ; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
出力引数:
; INT JetBackupInstanceW(JET_INSTANCE instance, WORD* szBackupPath, DWORD grbit, JET_PFNSTATUS pfnStatus) #uselib "ESENT.dll" #cfunc global JetBackupInstanceW "JetBackupInstanceW" intptr, var, int, intptr ; res = JetBackupInstanceW(instance, szBackupPath, grbit, pfnStatus) ; instance : JET_INSTANCE -> "intptr" ; szBackupPath : WORD* -> "var" ; grbit : DWORD -> "int" ; pfnStatus : JET_PFNSTATUS optional -> "intptr" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。; INT JetBackupInstanceW(JET_INSTANCE instance, WORD* szBackupPath, DWORD grbit, JET_PFNSTATUS pfnStatus) #uselib "ESENT.dll" #cfunc global JetBackupInstanceW "JetBackupInstanceW" intptr, intptr, int, intptr ; res = JetBackupInstanceW(instance, varptr(szBackupPath), grbit, pfnStatus) ; instance : JET_INSTANCE -> "intptr" ; szBackupPath : WORD* -> "intptr" ; grbit : DWORD -> "int" ; pfnStatus : JET_PFNSTATUS optional -> "intptr" ; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは varptr(変数))。
import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
esent = windows.NewLazySystemDLL("ESENT.dll")
procJetBackupInstanceW = esent.NewProc("JetBackupInstanceW")
)
// instance (JET_INSTANCE), szBackupPath (WORD*), grbit (DWORD), pfnStatus (JET_PFNSTATUS optional)
r1, _, err := procJetBackupInstanceW.Call(
uintptr(instance),
uintptr(szBackupPath),
uintptr(grbit),
uintptr(pfnStatus),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // INTfunction JetBackupInstanceW(
instance: NativeUInt; // JET_INSTANCE
szBackupPath: Pointer; // WORD*
grbit: DWORD; // DWORD
pfnStatus: Pointer // JET_PFNSTATUS optional
): Integer; stdcall;
external 'ESENT.dll' name 'JetBackupInstanceW';result := DllCall("ESENT\JetBackupInstanceW"
, "UPtr", instance ; JET_INSTANCE
, "Ptr", szBackupPath ; WORD*
, "UInt", grbit ; DWORD
, "Ptr", pfnStatus ; JET_PFNSTATUS optional
, "Int") ; return: INT●JetBackupInstanceW(instance, szBackupPath, grbit, pfnStatus) = DLL("ESENT.dll", "int JetBackupInstanceW(int, void*, dword, void*)")
# 呼び出し: JetBackupInstanceW(instance, szBackupPath, grbit, pfnStatus)
# instance : JET_INSTANCE -> "int"
# szBackupPath : WORD* -> "void*"
# grbit : DWORD -> "dword"
# pfnStatus : 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 JetBackupInstanceW(
instance: usize, // JET_INSTANCE
szBackupPath: [*c]u16, // WORD*
grbit: u32, // DWORD
pfnStatus: ?*anyopaque // JET_PFNSTATUS optional
) callconv(std.os.windows.WINAPI) i32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。proc JetBackupInstanceW(
instance: uint, # JET_INSTANCE
szBackupPath: ptr uint16, # WORD*
grbit: uint32, # DWORD
pfnStatus: pointer # JET_PFNSTATUS optional
): int32 {.importc: "JetBackupInstanceW", stdcall, dynlib: "ESENT.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。pragma(lib, "esent");
extern(Windows)
int JetBackupInstanceW(
size_t instance, // JET_INSTANCE
ushort* szBackupPath, // WORD*
uint grbit, // DWORD
void* pfnStatus // JET_PFNSTATUS optional
);ccall((:JetBackupInstanceW, "ESENT.dll"), stdcall, Int32,
(Csize_t, Ptr{UInt16}, UInt32, Ptr{Cvoid}),
instance, szBackupPath, grbit, pfnStatus)
# instance : JET_INSTANCE -> Csize_t
# szBackupPath : WORD* -> Ptr{UInt16}
# grbit : DWORD -> UInt32
# pfnStatus : JET_PFNSTATUS optional -> Ptr{Cvoid}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。local ffi = require("ffi")
ffi.cdef[[
int32_t JetBackupInstanceW(
uintptr_t instance,
uint16_t* szBackupPath,
uint32_t grbit,
void* pfnStatus);
]]
local esent = ffi.load("esent")
-- esent.JetBackupInstanceW(instance, szBackupPath, grbit, pfnStatus)
-- instance : JET_INSTANCE
-- szBackupPath : WORD*
-- grbit : DWORD
-- pfnStatus : 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 JetBackupInstanceW = lib.func('__stdcall', 'JetBackupInstanceW', 'int32_t', ['uintptr_t', 'uint16_t *', 'uint32_t', 'void *']);
// JetBackupInstanceW(instance, szBackupPath, grbit, pfnStatus)
// instance : JET_INSTANCE -> 'uintptr_t'
// szBackupPath : WORD* -> 'uint16_t *'
// grbit : DWORD -> 'uint32_t'
// pfnStatus : JET_PFNSTATUS optional -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
// コールバック(関数ポインタ)は koffi.proto/koffi.register で型を定義して渡す(素の void* では JS 関数を渡せない)。const lib = Deno.dlopen("ESENT.dll", {
JetBackupInstanceW: { parameters: ["usize", "pointer", "u32", "pointer"], result: "i32" },
});
// lib.symbols.JetBackupInstanceW(instance, szBackupPath, grbit, pfnStatus)
// instance : JET_INSTANCE -> "usize"
// szBackupPath : WORD* -> "pointer"
// grbit : DWORD -> "u32"
// pfnStatus : JET_PFNSTATUS optional -> "pointer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
int32_t JetBackupInstanceW(
size_t instance,
uint16_t* szBackupPath,
uint32_t grbit,
void* pfnStatus);
C, "ESENT.dll");
// $ffi->JetBackupInstanceW(instance, szBackupPath, grbit, pfnStatus);
// instance : JET_INSTANCE
// szBackupPath : WORD*
// grbit : DWORD
// pfnStatus : 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 JetBackupInstanceW(
long instance, // JET_INSTANCE
ShortByReference szBackupPath, // WORD*
int grbit, // DWORD
Callback pfnStatus // JET_PFNSTATUS optional
);
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。@[Link("esent")]
lib LibESENT
fun JetBackupInstanceW = JetBackupInstanceW(
instance : LibC::SizeT, # JET_INSTANCE
szBackupPath : UInt16*, # WORD*
grbit : UInt32, # DWORD
pfnStatus : 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 JetBackupInstanceWNative = Int32 Function(UintPtr, Pointer<Uint16>, Uint32, Pointer<Void>);
typedef JetBackupInstanceWDart = int Function(int, Pointer<Uint16>, int, Pointer<Void>);
final JetBackupInstanceW = DynamicLibrary.open('ESENT.dll')
.lookupFunction<JetBackupInstanceWNative, JetBackupInstanceWDart>('JetBackupInstanceW');
// instance : JET_INSTANCE -> UintPtr
// szBackupPath : WORD* -> Pointer<Uint16>
// grbit : DWORD -> Uint32
// pfnStatus : JET_PFNSTATUS optional -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function JetBackupInstanceW(
instance: NativeUInt; // JET_INSTANCE
szBackupPath: Pointer; // WORD*
grbit: DWORD; // DWORD
pfnStatus: Pointer // JET_PFNSTATUS optional
): Integer; stdcall;
external 'ESENT.dll' name 'JetBackupInstanceW';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "JetBackupInstanceW"
c_JetBackupInstanceW :: CUIntPtr -> Ptr Word16 -> Word32 -> Ptr () -> IO Int32
-- instance : JET_INSTANCE -> CUIntPtr
-- szBackupPath : WORD* -> Ptr Word16
-- grbit : DWORD -> Word32
-- pfnStatus : JET_PFNSTATUS optional -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let jetbackupinstancew =
foreign "JetBackupInstanceW"
(size_t @-> (ptr uint16_t) @-> uint32_t @-> (ptr void) @-> returning int32_t)
(* instance : JET_INSTANCE -> size_t *)
(* szBackupPath : WORD* -> (ptr uint16_t) *)
(* grbit : DWORD -> uint32_t *)
(* pfnStatus : 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 ("JetBackupInstanceW" jet-backup-instance-w :convention :stdcall) :int32
(instance :uint64) ; JET_INSTANCE
(sz-backup-path :pointer) ; WORD*
(grbit :uint32) ; DWORD
(pfn-status :pointer)) ; JET_PFNSTATUS optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $JetBackupInstanceW = Win32::API::More->new('ESENT',
'int JetBackupInstanceW(WPARAM instance, LPVOID szBackupPath, DWORD grbit, LPVOID pfnStatus)');
# my $ret = $JetBackupInstanceW->Call($instance, $szBackupPath, $grbit, $pfnStatus);
# instance : JET_INSTANCE -> WPARAM
# szBackupPath : WORD* -> LPVOID
# grbit : DWORD -> DWORD
# pfnStatus : JET_PFNSTATUS optional -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# コールバック(関数ポインタ)は Perl sub を直接渡せません。Win32::API::Callback を使用してください。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。関連項目
文字セット違い
- f JetBackupInstanceA (ANSI版) — 指定したインスタンスをバックアップする(ANSI版)。
使用する型