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

JetOpenFileInstanceA

関数
指定インスタンスの外部バックアップ用ファイルを開く(ANSI版)。
DLLESENT.dll文字セットANSI (-A)呼出規約winapi
📘 Microsoft Learn (日本語) · English

シグネチャ

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

INT JetOpenFileInstanceA(
    JET_INSTANCE instance,
    CHAR* szFileName,
    JET_HANDLE* phfFile,
    DWORD* pulFileSizeLow,
    DWORD* pulFileSizeHigh
);

パラメーター

名前型方向説明
instanceJET_INSTANCEin対象のインスタンスを識別するJET_INSTANCEハンドル。
szFileNameCHAR*inバックアップ用に開くファイルのパスを指す終端付きANSI文字列ポインタ。
phfFileJET_HANDLE*out開いたファイルのハンドルを受け取る出力ポインタ(JET_HANDLE)。
pulFileSizeLowDWORD*outファイルサイズの下位32ビットを受け取る出力ポインタ。
pulFileSizeHighDWORD*outファイルサイズの上位32ビットを受け取る出力ポインタ。

戻り値の型: INT

各言語での呼び出し定義

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

INT JetOpenFileInstanceA(
    JET_INSTANCE instance,
    CHAR* szFileName,
    JET_HANDLE* phfFile,
    DWORD* pulFileSizeLow,
    DWORD* pulFileSizeHigh
);
[DllImport("ESENT.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern int JetOpenFileInstanceA(
    UIntPtr instance,   // JET_INSTANCE
    IntPtr szFileName,   // CHAR*
    out UIntPtr phfFile,   // JET_HANDLE* out
    out uint pulFileSizeLow,   // DWORD* out
    out uint pulFileSizeHigh   // DWORD* out
);
<DllImport("ESENT.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function JetOpenFileInstanceA(
    instance As UIntPtr,   ' JET_INSTANCE
    szFileName As IntPtr,   ' CHAR*
    <Out> ByRef phfFile As UIntPtr,   ' JET_HANDLE* out
    <Out> ByRef pulFileSizeLow As UInteger,   ' DWORD* out
    <Out> ByRef pulFileSizeHigh As UInteger   ' DWORD* out
) As Integer
End Function
' instance : JET_INSTANCE
' szFileName : CHAR*
' phfFile : JET_HANDLE* out
' pulFileSizeLow : DWORD* out
' pulFileSizeHigh : DWORD* out
Declare PtrSafe Function JetOpenFileInstanceA Lib "esent" ( _
    ByVal instance As LongPtr, _
    ByVal szFileName As LongPtr, _
    ByRef phfFile As LongPtr, _
    ByRef pulFileSizeLow As Long, _
    ByRef pulFileSizeHigh As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

JetOpenFileInstanceA = ctypes.windll.esent.JetOpenFileInstanceA
JetOpenFileInstanceA.restype = ctypes.c_int
JetOpenFileInstanceA.argtypes = [
    ctypes.c_size_t,  # instance : JET_INSTANCE
    ctypes.POINTER(ctypes.c_byte),  # szFileName : CHAR*
    ctypes.c_void_p,  # phfFile : JET_HANDLE* out
    ctypes.POINTER(wintypes.DWORD),  # pulFileSizeLow : DWORD* out
    ctypes.POINTER(wintypes.DWORD),  # pulFileSizeHigh : DWORD* out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ESENT.dll')
JetOpenFileInstanceA = Fiddle::Function.new(
  lib['JetOpenFileInstanceA'],
  [
    Fiddle::TYPE_UINTPTR_T,  # instance : JET_INSTANCE
    Fiddle::TYPE_VOIDP,  # szFileName : CHAR*
    Fiddle::TYPE_VOIDP,  # phfFile : JET_HANDLE* out
    Fiddle::TYPE_VOIDP,  # pulFileSizeLow : DWORD* out
    Fiddle::TYPE_VOIDP,  # pulFileSizeHigh : DWORD* out
  ],
  Fiddle::TYPE_INT)
#[link(name = "esent")]
extern "system" {
    fn JetOpenFileInstanceA(
        instance: usize,  // JET_INSTANCE
        szFileName: *mut i8,  // CHAR*
        phfFile: *mut usize,  // JET_HANDLE* out
        pulFileSizeLow: *mut u32,  // DWORD* out
        pulFileSizeHigh: *mut u32  // DWORD* out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("ESENT.dll", CharSet = CharSet.Ansi)]
public static extern int JetOpenFileInstanceA(UIntPtr instance, IntPtr szFileName, out UIntPtr phfFile, out uint pulFileSizeLow, out uint pulFileSizeHigh);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ESENT_JetOpenFileInstanceA' -Namespace Win32 -PassThru
# $api::JetOpenFileInstanceA(instance, szFileName, phfFile, pulFileSizeLow, pulFileSizeHigh)
#uselib "ESENT.dll"
#func global JetOpenFileInstanceA "JetOpenFileInstanceA" sptr, sptr, sptr, sptr, sptr
; JetOpenFileInstanceA instance, varptr(szFileName), varptr(phfFile), varptr(pulFileSizeLow), varptr(pulFileSizeHigh)   ; 戻り値は stat
; instance : JET_INSTANCE -> "sptr"
; szFileName : CHAR* -> "sptr"
; phfFile : JET_HANDLE* out -> "sptr"
; pulFileSizeLow : DWORD* out -> "sptr"
; pulFileSizeHigh : DWORD* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数: 
#uselib "ESENT.dll"
#cfunc global JetOpenFileInstanceA "JetOpenFileInstanceA" sptr, var, var, var, var
; res = JetOpenFileInstanceA(instance, szFileName, phfFile, pulFileSizeLow, pulFileSizeHigh)
; instance : JET_INSTANCE -> "sptr"
; szFileName : CHAR* -> "var"
; phfFile : JET_HANDLE* out -> "var"
; pulFileSizeLow : DWORD* out -> "var"
; pulFileSizeHigh : DWORD* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数: 
; INT JetOpenFileInstanceA(JET_INSTANCE instance, CHAR* szFileName, JET_HANDLE* phfFile, DWORD* pulFileSizeLow, DWORD* pulFileSizeHigh)
#uselib "ESENT.dll"
#cfunc global JetOpenFileInstanceA "JetOpenFileInstanceA" intptr, var, var, var, var
; res = JetOpenFileInstanceA(instance, szFileName, phfFile, pulFileSizeLow, pulFileSizeHigh)
; instance : JET_INSTANCE -> "intptr"
; szFileName : CHAR* -> "var"
; phfFile : JET_HANDLE* out -> "var"
; pulFileSizeLow : DWORD* out -> "var"
; pulFileSizeHigh : DWORD* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	esent = windows.NewLazySystemDLL("ESENT.dll")
	procJetOpenFileInstanceA = esent.NewProc("JetOpenFileInstanceA")
)

// instance (JET_INSTANCE), szFileName (CHAR*), phfFile (JET_HANDLE* out), pulFileSizeLow (DWORD* out), pulFileSizeHigh (DWORD* out)
r1, _, err := procJetOpenFileInstanceA.Call(
	uintptr(instance),
	uintptr(szFileName),
	uintptr(phfFile),
	uintptr(pulFileSizeLow),
	uintptr(pulFileSizeHigh),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // INT
function JetOpenFileInstanceA(
  instance: NativeUInt;   // JET_INSTANCE
  szFileName: Pointer;   // CHAR*
  phfFile: Pointer;   // JET_HANDLE* out
  pulFileSizeLow: Pointer;   // DWORD* out
  pulFileSizeHigh: Pointer   // DWORD* out
): Integer; stdcall;
  external 'ESENT.dll' name 'JetOpenFileInstanceA';
result := DllCall("ESENT\JetOpenFileInstanceA"
    , "UPtr", instance   ; JET_INSTANCE
    , "Ptr", szFileName   ; CHAR*
    , "Ptr", phfFile   ; JET_HANDLE* out
    , "Ptr", pulFileSizeLow   ; DWORD* out
    , "Ptr", pulFileSizeHigh   ; DWORD* out
    , "Int")   ; return: INT
●JetOpenFileInstanceA(instance, szFileName, phfFile, pulFileSizeLow, pulFileSizeHigh) = DLL("ESENT.dll", "int JetOpenFileInstanceA(int, void*, void*, void*, void*)")
# 呼び出し: JetOpenFileInstanceA(instance, szFileName, phfFile, pulFileSizeLow, pulFileSizeHigh)
# instance : JET_INSTANCE -> "int"
# szFileName : CHAR* -> "void*"
# phfFile : JET_HANDLE* out -> "void*"
# pulFileSizeLow : DWORD* out -> "void*"
# pulFileSizeHigh : DWORD* out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "esent" fn JetOpenFileInstanceA(
    instance: usize, // JET_INSTANCE
    szFileName: [*c]i8, // CHAR*
    phfFile: [*c]usize, // JET_HANDLE* out
    pulFileSizeLow: [*c]u32, // DWORD* out
    pulFileSizeHigh: [*c]u32 // DWORD* out
) callconv(std.os.windows.WINAPI) i32;
proc JetOpenFileInstanceA(
    instance: uint,  # JET_INSTANCE
    szFileName: ptr int8,  # CHAR*
    phfFile: ptr uint,  # JET_HANDLE* out
    pulFileSizeLow: ptr uint32,  # DWORD* out
    pulFileSizeHigh: ptr uint32  # DWORD* out
): int32 {.importc: "JetOpenFileInstanceA", stdcall, dynlib: "ESENT.dll".}
pragma(lib, "esent");
extern(Windows)
int JetOpenFileInstanceA(
    size_t instance,   // JET_INSTANCE
    byte* szFileName,   // CHAR*
    size_t* phfFile,   // JET_HANDLE* out
    uint* pulFileSizeLow,   // DWORD* out
    uint* pulFileSizeHigh   // DWORD* out
);
ccall((:JetOpenFileInstanceA, "ESENT.dll"), stdcall, Int32,
      (Csize_t, Ptr{Int8}, Ptr{Csize_t}, Ptr{UInt32}, Ptr{UInt32}),
      instance, szFileName, phfFile, pulFileSizeLow, pulFileSizeHigh)
# instance : JET_INSTANCE -> Csize_t
# szFileName : CHAR* -> Ptr{Int8}
# phfFile : JET_HANDLE* out -> Ptr{Csize_t}
# pulFileSizeLow : DWORD* out -> Ptr{UInt32}
# pulFileSizeHigh : DWORD* out -> Ptr{UInt32}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t JetOpenFileInstanceA(
    uintptr_t instance,
    int8_t* szFileName,
    uintptr_t* phfFile,
    uint32_t* pulFileSizeLow,
    uint32_t* pulFileSizeHigh);
]]
local esent = ffi.load("esent")
-- esent.JetOpenFileInstanceA(instance, szFileName, phfFile, pulFileSizeLow, pulFileSizeHigh)
-- instance : JET_INSTANCE
-- szFileName : CHAR*
-- phfFile : JET_HANDLE* out
-- pulFileSizeLow : DWORD* out
-- pulFileSizeHigh : DWORD* out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('ESENT.dll');
const JetOpenFileInstanceA = lib.func('__stdcall', 'JetOpenFileInstanceA', 'int32_t', ['uintptr_t', 'int8_t *', 'uintptr_t *', 'uint32_t *', 'uint32_t *']);
// JetOpenFileInstanceA(instance, szFileName, phfFile, pulFileSizeLow, pulFileSizeHigh)
// instance : JET_INSTANCE -> 'uintptr_t'
// szFileName : CHAR* -> 'int8_t *'
// phfFile : JET_HANDLE* out -> 'uintptr_t *'
// pulFileSizeLow : DWORD* out -> 'uint32_t *'
// pulFileSizeHigh : DWORD* out -> 'uint32_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("ESENT.dll", {
  JetOpenFileInstanceA: { parameters: ["usize", "pointer", "pointer", "pointer", "pointer"], result: "i32" },
});
// lib.symbols.JetOpenFileInstanceA(instance, szFileName, phfFile, pulFileSizeLow, pulFileSizeHigh)
// instance : JET_INSTANCE -> "usize"
// szFileName : CHAR* -> "pointer"
// phfFile : JET_HANDLE* out -> "pointer"
// pulFileSizeLow : DWORD* out -> "pointer"
// pulFileSizeHigh : DWORD* out -> "pointer"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t JetOpenFileInstanceA(
    size_t instance,
    int8_t* szFileName,
    size_t* phfFile,
    uint32_t* pulFileSizeLow,
    uint32_t* pulFileSizeHigh);
C, "ESENT.dll");
// $ffi->JetOpenFileInstanceA(instance, szFileName, phfFile, pulFileSizeLow, pulFileSizeHigh);
// instance : JET_INSTANCE
// szFileName : CHAR*
// phfFile : JET_HANDLE* out
// pulFileSizeLow : DWORD* out
// pulFileSizeHigh : DWORD* out
// 構造体/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 JetOpenFileInstanceA(
        long instance,   // JET_INSTANCE
        byte[] szFileName,   // CHAR*
        LongByReference phfFile,   // JET_HANDLE* out
        IntByReference pulFileSizeLow,   // DWORD* out
        IntByReference pulFileSizeHigh   // DWORD* out
    );
}
@[Link("esent")]
lib LibESENT
  fun JetOpenFileInstanceA = JetOpenFileInstanceA(
    instance : LibC::SizeT,   # JET_INSTANCE
    szFileName : Int8*,   # CHAR*
    phfFile : LibC::SizeT*,   # JET_HANDLE* out
    pulFileSizeLow : UInt32*,   # DWORD* out
    pulFileSizeHigh : UInt32*   # DWORD* out
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef JetOpenFileInstanceANative = Int32 Function(UintPtr, Pointer<Int8>, Pointer<UintPtr>, Pointer<Uint32>, Pointer<Uint32>);
typedef JetOpenFileInstanceADart = int Function(int, Pointer<Int8>, Pointer<UintPtr>, Pointer<Uint32>, Pointer<Uint32>);
final JetOpenFileInstanceA = DynamicLibrary.open('ESENT.dll')
    .lookupFunction<JetOpenFileInstanceANative, JetOpenFileInstanceADart>('JetOpenFileInstanceA');
// instance : JET_INSTANCE -> UintPtr
// szFileName : CHAR* -> Pointer<Int8>
// phfFile : JET_HANDLE* out -> Pointer<UintPtr>
// pulFileSizeLow : DWORD* out -> Pointer<Uint32>
// pulFileSizeHigh : DWORD* out -> Pointer<Uint32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function JetOpenFileInstanceA(
  instance: NativeUInt;   // JET_INSTANCE
  szFileName: Pointer;   // CHAR*
  phfFile: Pointer;   // JET_HANDLE* out
  pulFileSizeLow: Pointer;   // DWORD* out
  pulFileSizeHigh: Pointer   // DWORD* out
): Integer; stdcall;
  external 'ESENT.dll' name 'JetOpenFileInstanceA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "JetOpenFileInstanceA"
  c_JetOpenFileInstanceA :: CUIntPtr -> Ptr Int8 -> Ptr CUIntPtr -> Ptr Word32 -> Ptr Word32 -> IO Int32
-- instance : JET_INSTANCE -> CUIntPtr
-- szFileName : CHAR* -> Ptr Int8
-- phfFile : JET_HANDLE* out -> Ptr CUIntPtr
-- pulFileSizeLow : DWORD* out -> Ptr Word32
-- pulFileSizeHigh : DWORD* out -> Ptr Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let jetopenfileinstancea =
  foreign "JetOpenFileInstanceA"
    (size_t @-> (ptr int8_t) @-> (ptr size_t) @-> (ptr uint32_t) @-> (ptr uint32_t) @-> returning int32_t)
(* instance : JET_INSTANCE -> size_t *)
(* szFileName : CHAR* -> (ptr int8_t) *)
(* phfFile : JET_HANDLE* out -> (ptr size_t) *)
(* pulFileSizeLow : DWORD* out -> (ptr uint32_t) *)
(* pulFileSizeHigh : DWORD* out -> (ptr uint32_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library esent (t "ESENT.dll"))
(cffi:use-foreign-library esent)

(cffi:defcfun ("JetOpenFileInstanceA" jet-open-file-instance-a :convention :stdcall) :int32
  (instance :uint64)   ; JET_INSTANCE
  (sz-file-name :pointer)   ; CHAR*
  (phf-file :pointer)   ; JET_HANDLE* out
  (pul-file-size-low :pointer)   ; DWORD* out
  (pul-file-size-high :pointer))   ; DWORD* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $JetOpenFileInstanceA = Win32::API::More->new('ESENT',
    'int JetOpenFileInstanceA(WPARAM instance, LPVOID szFileName, LPVOID phfFile, LPVOID pulFileSizeLow, LPVOID pulFileSizeHigh)');
# my $ret = $JetOpenFileInstanceA->Call($instance, $szFileName, $phfFile, $pulFileSizeLow, $pulFileSizeHigh);
# instance : JET_INSTANCE -> WPARAM
# szFileName : CHAR* -> LPVOID
# phfFile : JET_HANDLE* out -> LPVOID
# pulFileSizeLow : DWORD* out -> LPVOID
# pulFileSizeHigh : DWORD* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

文字セット違い