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

JetBackupA

関数
データベースをバックアップする(ANSI版)。
DLLESENT.dll文字セットANSI (-A)呼出規約winapi
📘 Microsoft Learn (日本語) · English

シグネチャ

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

INT JetBackupA(
    CHAR* szBackupPath,
    DWORD grbit,
    JET_PFNSTATUS pfnStatus   // optional
);

パラメーター

名前型方向説明
szBackupPathCHAR*inバックアップ出力先ディレクトリのパスを指す終端付きANSI文字列ポインタ。
grbitDWORDinバックアップ動作を制御するビットフラグ。JET_bitBackupIncremental等で増分などを指定する。
pfnStatusJET_PFNSTATUSinoptional進捗通知を受け取るステータスコールバック関数(JET_PFNSTATUS)。NULL可。

戻り値の型: INT

各言語での呼び出し定義

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

INT JetBackupA(
    CHAR* szBackupPath,
    DWORD grbit,
    JET_PFNSTATUS pfnStatus   // optional
);
[DllImport("ESENT.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern int JetBackupA(
    IntPtr szBackupPath,   // CHAR*
    uint grbit,   // DWORD
    IntPtr pfnStatus   // JET_PFNSTATUS optional
);
<DllImport("ESENT.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function JetBackupA(
    szBackupPath As IntPtr,   ' CHAR*
    grbit As UInteger,   ' DWORD
    pfnStatus As IntPtr   ' JET_PFNSTATUS optional
) As Integer
End Function
' szBackupPath : CHAR*
' grbit : DWORD
' pfnStatus : JET_PFNSTATUS optional
Declare PtrSafe Function JetBackupA Lib "esent" ( _
    ByVal szBackupPath As LongPtr, _
    ByVal grbit As Long, _
    ByVal pfnStatus As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

JetBackupA = ctypes.windll.esent.JetBackupA
JetBackupA.restype = ctypes.c_int
JetBackupA.argtypes = [
    ctypes.POINTER(ctypes.c_byte),  # szBackupPath : CHAR*
    wintypes.DWORD,  # grbit : DWORD
    ctypes.c_void_p,  # pfnStatus : JET_PFNSTATUS optional
]
require 'fiddle'
require 'fiddle/import'

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

var (
	esent = windows.NewLazySystemDLL("ESENT.dll")
	procJetBackupA = esent.NewProc("JetBackupA")
)

// szBackupPath (CHAR*), grbit (DWORD), pfnStatus (JET_PFNSTATUS optional)
r1, _, err := procJetBackupA.Call(
	uintptr(szBackupPath),
	uintptr(grbit),
	uintptr(pfnStatus),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // INT
function JetBackupA(
  szBackupPath: Pointer;   // CHAR*
  grbit: DWORD;   // DWORD
  pfnStatus: Pointer   // JET_PFNSTATUS optional
): Integer; stdcall;
  external 'ESENT.dll' name 'JetBackupA';
result := DllCall("ESENT\JetBackupA"
    , "Ptr", szBackupPath   ; CHAR*
    , "UInt", grbit   ; DWORD
    , "Ptr", pfnStatus   ; JET_PFNSTATUS optional
    , "Int")   ; return: INT
●JetBackupA(szBackupPath, grbit, pfnStatus) = DLL("ESENT.dll", "int JetBackupA(void*, dword, void*)")
# 呼び出し: JetBackupA(szBackupPath, grbit, pfnStatus)
# szBackupPath : CHAR* -> "void*"
# grbit : DWORD -> "dword"
# pfnStatus : JET_PFNSTATUS optional -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "esent" fn JetBackupA(
    szBackupPath: [*c]i8, // CHAR*
    grbit: u32, // DWORD
    pfnStatus: ?*anyopaque // JET_PFNSTATUS optional
) callconv(std.os.windows.WINAPI) i32;
proc JetBackupA(
    szBackupPath: ptr int8,  # CHAR*
    grbit: uint32,  # DWORD
    pfnStatus: pointer  # JET_PFNSTATUS optional
): int32 {.importc: "JetBackupA", stdcall, dynlib: "ESENT.dll".}
pragma(lib, "esent");
extern(Windows)
int JetBackupA(
    byte* szBackupPath,   // CHAR*
    uint grbit,   // DWORD
    void* pfnStatus   // JET_PFNSTATUS optional
);
ccall((:JetBackupA, "ESENT.dll"), stdcall, Int32,
      (Ptr{Int8}, UInt32, Ptr{Cvoid}),
      szBackupPath, grbit, pfnStatus)
# szBackupPath : CHAR* -> Ptr{Int8}
# grbit : DWORD -> UInt32
# pfnStatus : JET_PFNSTATUS optional -> Ptr{Cvoid}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t JetBackupA(
    int8_t* szBackupPath,
    uint32_t grbit,
    void* pfnStatus);
]]
local esent = ffi.load("esent")
-- esent.JetBackupA(szBackupPath, grbit, pfnStatus)
-- szBackupPath : CHAR*
-- grbit : DWORD
-- pfnStatus : JET_PFNSTATUS optional
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('ESENT.dll');
const JetBackupA = lib.func('__stdcall', 'JetBackupA', 'int32_t', ['int8_t *', 'uint32_t', 'void *']);
// JetBackupA(szBackupPath, grbit, pfnStatus)
// szBackupPath : CHAR* -> 'int8_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", {
  JetBackupA: { parameters: ["pointer", "u32", "pointer"], result: "i32" },
});
// lib.symbols.JetBackupA(szBackupPath, grbit, pfnStatus)
// szBackupPath : CHAR* -> "pointer"
// grbit : DWORD -> "u32"
// pfnStatus : JET_PFNSTATUS optional -> "pointer"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t JetBackupA(
    int8_t* szBackupPath,
    uint32_t grbit,
    void* pfnStatus);
C, "ESENT.dll");
// $ffi->JetBackupA(szBackupPath, grbit, pfnStatus);
// szBackupPath : CHAR*
// 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.ASCII_OPTIONS);
    int JetBackupA(
        byte[] szBackupPath,   // CHAR*
        int grbit,   // DWORD
        Callback pfnStatus   // JET_PFNSTATUS optional
    );
}
@[Link("esent")]
lib LibESENT
  fun JetBackupA = JetBackupA(
    szBackupPath : Int8*,   # CHAR*
    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 JetBackupANative = Int32 Function(Pointer<Int8>, Uint32, Pointer<Void>);
typedef JetBackupADart = int Function(Pointer<Int8>, int, Pointer<Void>);
final JetBackupA = DynamicLibrary.open('ESENT.dll')
    .lookupFunction<JetBackupANative, JetBackupADart>('JetBackupA');
// szBackupPath : CHAR* -> Pointer<Int8>
// grbit : DWORD -> Uint32
// pfnStatus : JET_PFNSTATUS optional -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function JetBackupA(
  szBackupPath: Pointer;   // CHAR*
  grbit: DWORD;   // DWORD
  pfnStatus: Pointer   // JET_PFNSTATUS optional
): Integer; stdcall;
  external 'ESENT.dll' name 'JetBackupA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "JetBackupA"
  c_JetBackupA :: Ptr Int8 -> Word32 -> Ptr () -> IO Int32
-- szBackupPath : CHAR* -> Ptr Int8
-- grbit : DWORD -> Word32
-- pfnStatus : JET_PFNSTATUS optional -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let jetbackupa =
  foreign "JetBackupA"
    ((ptr int8_t) @-> uint32_t @-> (ptr void) @-> returning int32_t)
(* szBackupPath : CHAR* -> (ptr int8_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 ("JetBackupA" jet-backup-a :convention :stdcall) :int32
  (sz-backup-path :pointer)   ; CHAR*
  (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 $JetBackupA = Win32::API::More->new('ESENT',
    'int JetBackupA(LPVOID szBackupPath, DWORD grbit, LPVOID pfnStatus)');
# my $ret = $JetBackupA->Call($szBackupPath, $grbit, $pfnStatus);
# szBackupPath : CHAR* -> LPVOID
# grbit : DWORD -> DWORD
# pfnStatus : JET_PFNSTATUS optional -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# コールバック(関数ポインタ)は Perl sub を直接渡せません。Win32::API::Callback を使用してください。

関連項目

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