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

JetOpenFileInstanceW

関数
指定インスタンスの外部バックアップ用ファイルを開く(Unicode版)。
DLLESENT.dll文字セットUnicode (-W)呼出規約winapi

シグネチャ

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

INT JetOpenFileInstanceW(
    JET_INSTANCE instance,
    WORD* szFileName,
    JET_HANDLE* phfFile,
    DWORD* pulFileSizeLow,
    DWORD* pulFileSizeHigh
);

パラメーター

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

戻り値の型: INT

公式ドキュメント

JetOpenFileInstance 関数は、ストリーミング方式のファジー バックアップを実行する目的で、アクティブなインスタンスのアタッチ済みデータベース、データベース パッチ ファイル、またはトランザクション ログ ファイルを開きます。これらのファイルのデータは、その後、返されたハンドルを介して JetReadFileInstance で読み取ることができます。返されたハンドルは JetCloseFileInstance で閉じる必要があります。事前に JetBeginExternalBackupInstance を使用して、そのインスタンスの外部バックアップを開始しておく必要があります。

戻り値

この関数は JET_ERR データ型を返し、その値は次の戻り値コードのいずれかです。発生し得る ESE のエラーの詳細については、Extensible Storage Engine Errors および Error Handling Parameters を参照してください。

戻り値コード

説明

JET_errSuccess

操作は正常に完了しました。

JET_errBackupAbortByServer

JetStopBackupInstance の呼び出しによって現在の外部バックアップが中止されたため、操作は失敗しました。このエラーは Windows XP 以降のリリースでのみ返されます。

JET_errClientRequestToStopJetService

JetStopServiceInstance の呼び出しの結果、セッションに関連付けられたインスタンス上のすべての処理が停止したため、操作を完了できません。

JET_errFileAccessDenied

共有違反または特権の不足により、要求されたファイルを開くことができなかったため、操作は失敗しました。

JET_errFileNotFound

要求されたファイルが指定されたパスに見つからず、開くことができなかったため、操作は失敗しました。このエラーは Windows 2000 でのみ返されます。

JET_errInvalidBackupSequence

バックアップ操作が正しい順序で呼び出されなかったため、失敗しました。

JET_errInvalidPath

指定されたパスが見つからなかったため、操作は失敗しました。

JET_errInstanceUnavailable

セッションに関連付けられたインスタンスで致命的なエラーが発生し、データの整合性を保護するためにすべてのデータへのアクセスを取り消す必要があるため、操作を完了できません。このエラーは Windows XP 以降のリリースでのみ返されます。

JET_errInvalidParameter

指定されたパラメーターのいずれかに予期しない値が含まれているか、他のパラメーターの値と組み合わせたときに意味をなさない値が含まれていました。JetOpenFileInstance では、次の場合にこれが発生することがあります。

  • 指定されたインスタンス ハンドルが無効である (Windows XP 以降のリリース)。

  • 指定された filename パラメーターが NULL または長さ 0 の文字列である (Windows XP 以降のリリース)。

JET_errMissingFileToBackup

要求されたファイルが見つからなかったため、バックアップのために開くことができませんでした。このエラーは Windows XP 以降のリリースでのみ返されます。

JET_errNoBackup

外部バックアップが実行中でないため、操作は失敗しました。

JET_errNotInitialized

セッションに関連付けられたインスタンスがまだ初期化されていないため、操作を完了できません。

JET_errOutOfMemory

操作を完了するのに十分なメモリを割り当てられなかったため、操作は失敗しました。JetOpenFileInstance で開いた直前のファイルが JetCloseFileInstance によって閉じられる前に別のファイルを開こうとした場合、JetOpenFileInstance は JET_errOutOfMemory を返します。現在サポートされているのは、同時に 1 つのファイル ハンドルのみです。

JET_errRestoreInProgress

セッションに関連付けられたインスタンスで復元操作が実行中であるため、操作を完了できません。

JET_errRunningInMultiInstanceMode

実際には複数のインスタンスが既に存在しているにもかかわらず、1 つのインスタンスのみがサポートされるレガシー モード (Windows 2000 互換モード) でエンジンを使用しようとしたため、操作は失敗しました。

JET_errTermInProgress

セッションに関連付けられたインスタンスがシャットダウン中であるため、操作を完了できません。

成功した場合は、要求されたファイルのハンドルが返されます。そのハンドルがデータベース ファイルに対するものである場合、そのデータベース ファイルはストリーミング バックアップ用に準備され、その結果、データベース ファイルと同じ場所にデータベース パッチ ファイルが作成されることがあります。データベース パッチ ファイルは、データベース ファイルとまったく同じパスおよびファイル名を持ちますが、拡張子は .PAT になります。ファイルのサイズも返されます。

失敗した場合、出力バッファーの状態は未定義になります。データベース パッチ ファイルがディスク上に一時的に作成されることがあり、パッチ ファイルの場所にある既存のファイルが削除される可能性もあります。この失敗により、そのインスタンスのバックアップ処理全体が取り消されます。Windows XP 以降のリリースでは、呼び出し時点でインスタンスにアタッチされていなかったデータベースをバックアップしようとした場合、バックアップは取り消されません。

警告 セキュリティ上の理由から、JetOpenFileInstance が、要求されたファイル パスがそのインスタンスのバックアップ対象ファイルのセットに関連付けられているかどうかを検証しない点に注意することが重要です。そのため、この関数を使用して、スレッドの現在のセキュリティ コンテキストで開くことができる任意のファイルにアクセスできてしまいます。アプリケーションは、この関数に渡すパスを既知の安全なファイル パスのセットに制限することが不可欠です。そうしないと、情報漏えい攻撃が可能になるおそれがあります。

解説

ハンドルおよびファイル サイズの出力バッファーは必ず指定する必要があります。指定されていない場合、出力バッファーのパラメーターは検証されないため、エンジンがクラッシュします。

現時点では、バックアップのために同時に開くことができるファイルは 1 つだけです。

JetOpenFileInstance は、要求されたファイルを開く前にバックアップ特権を要求しません。

この関数が報告する読み取り対象ファイルのサイズは、ディスク上のファイルのサイズと一致しない場合があります。Windows XP 以降のリリースでは、復元操作中にデータベース エンジンが使用する追加情報がデータベース ファイルに付加されることがあります。そのためアプリケーションは、JetOpenFileInstance が返すファイル サイズ、または JetReadFileInstance が実際に返したデータのバイト数のみに依存するようにしてください。

要件

要件 値

クライアント

Windows Vista または Windows XP が必要です。

サーバー

Windows Server 2008 または Windows Server 2003 が必要です。

ヘッダー

Esent.h で宣言されています。

ライブラリ

ESENT.lib を使用します。

DLL

ESENT.dll が必要です。

Unicode

JetOpenFileInstanceW (Unicode) および JetOpenFileInstanceA (ANSI) として実装されています。

関連項目

JET_ERR
JET_HANDLE
JET_INSTANCE
JetAttachDatabase
JetBeginExternalBackupInstance
JetCloseFileInstance
JetGetAttachInfoInstance
JetGetLogInfoInstance
JetReadFileInstance
JetStopBackupInstance
JetTruncateLogInstance

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp)

各言語での呼び出し定義

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

INT JetOpenFileInstanceW(
    JET_INSTANCE instance,
    WORD* szFileName,
    JET_HANDLE* phfFile,
    DWORD* pulFileSizeLow,
    DWORD* pulFileSizeHigh
);
[DllImport("ESENT.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern int JetOpenFileInstanceW(
    UIntPtr instance,   // JET_INSTANCE
    ref ushort szFileName,   // WORD*
    out UIntPtr phfFile,   // JET_HANDLE* out
    out uint pulFileSizeLow,   // DWORD* out
    out uint pulFileSizeHigh   // DWORD* out
);
<DllImport("ESENT.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function JetOpenFileInstanceW(
    instance As UIntPtr,   ' JET_INSTANCE
    ByRef szFileName As UShort,   ' WORD*
    <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 : WORD*
' phfFile : JET_HANDLE* out
' pulFileSizeLow : DWORD* out
' pulFileSizeHigh : DWORD* out
Declare PtrSafe Function JetOpenFileInstanceW Lib "esent" ( _
    ByVal instance As LongPtr, _
    ByRef szFileName As Integer, _
    ByRef phfFile As LongPtr, _
    ByRef pulFileSizeLow As Long, _
    ByRef pulFileSizeHigh As Long) 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

JetOpenFileInstanceW = ctypes.windll.esent.JetOpenFileInstanceW
JetOpenFileInstanceW.restype = ctypes.c_int
JetOpenFileInstanceW.argtypes = [
    ctypes.c_size_t,  # instance : JET_INSTANCE
    ctypes.POINTER(ctypes.c_ushort),  # szFileName : WORD*
    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')
JetOpenFileInstanceW = Fiddle::Function.new(
  lib['JetOpenFileInstanceW'],
  [
    Fiddle::TYPE_UINTPTR_T,  # instance : JET_INSTANCE
    Fiddle::TYPE_VOIDP,  # szFileName : WORD*
    Fiddle::TYPE_VOIDP,  # phfFile : JET_HANDLE* out
    Fiddle::TYPE_VOIDP,  # pulFileSizeLow : DWORD* out
    Fiddle::TYPE_VOIDP,  # pulFileSizeHigh : DWORD* out
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "esent")]
extern "system" {
    fn JetOpenFileInstanceW(
        instance: usize,  // JET_INSTANCE
        szFileName: *mut u16,  // WORD*
        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.Unicode)]
public static extern int JetOpenFileInstanceW(UIntPtr instance, ref ushort szFileName, out UIntPtr phfFile, out uint pulFileSizeLow, out uint pulFileSizeHigh);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ESENT_JetOpenFileInstanceW' -Namespace Win32 -PassThru
# $api::JetOpenFileInstanceW(instance, szFileName, phfFile, pulFileSizeLow, pulFileSizeHigh)
#uselib "ESENT.dll"
#func global JetOpenFileInstanceW "JetOpenFileInstanceW" wptr, wptr, wptr, wptr, wptr
; JetOpenFileInstanceW instance, varptr(szFileName), varptr(phfFile), varptr(pulFileSizeLow), varptr(pulFileSizeHigh)   ; 戻り値は stat
; instance : JET_INSTANCE -> "wptr"
; szFileName : WORD* -> "wptr"
; phfFile : JET_HANDLE* out -> "wptr"
; pulFileSizeLow : DWORD* out -> "wptr"
; pulFileSizeHigh : DWORD* out -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "ESENT.dll"
#cfunc global JetOpenFileInstanceW "JetOpenFileInstanceW" sptr, var, var, var, var
; res = JetOpenFileInstanceW(instance, szFileName, phfFile, pulFileSizeLow, pulFileSizeHigh)
; instance : JET_INSTANCE -> "sptr"
; szFileName : WORD* -> "var"
; phfFile : JET_HANDLE* out -> "var"
; pulFileSizeLow : DWORD* out -> "var"
; pulFileSizeHigh : DWORD* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; INT JetOpenFileInstanceW(JET_INSTANCE instance, WORD* szFileName, JET_HANDLE* phfFile, DWORD* pulFileSizeLow, DWORD* pulFileSizeHigh)
#uselib "ESENT.dll"
#cfunc global JetOpenFileInstanceW "JetOpenFileInstanceW" intptr, var, var, var, var
; res = JetOpenFileInstanceW(instance, szFileName, phfFile, pulFileSizeLow, pulFileSizeHigh)
; instance : JET_INSTANCE -> "intptr"
; szFileName : WORD* -> "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")
	procJetOpenFileInstanceW = esent.NewProc("JetOpenFileInstanceW")
)

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

extern "esent" fn JetOpenFileInstanceW(
    instance: usize, // JET_INSTANCE
    szFileName: [*c]u16, // WORD*
    phfFile: [*c]usize, // JET_HANDLE* out
    pulFileSizeLow: [*c]u32, // DWORD* out
    pulFileSizeHigh: [*c]u32 // DWORD* out
) callconv(std.os.windows.WINAPI) i32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc JetOpenFileInstanceW(
    instance: uint,  # JET_INSTANCE
    szFileName: ptr uint16,  # WORD*
    phfFile: ptr uint,  # JET_HANDLE* out
    pulFileSizeLow: ptr uint32,  # DWORD* out
    pulFileSizeHigh: ptr uint32  # DWORD* out
): int32 {.importc: "JetOpenFileInstanceW", stdcall, dynlib: "ESENT.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "esent");
extern(Windows)
int JetOpenFileInstanceW(
    size_t instance,   // JET_INSTANCE
    ushort* szFileName,   // WORD*
    size_t* phfFile,   // JET_HANDLE* out
    uint* pulFileSizeLow,   // DWORD* out
    uint* pulFileSizeHigh   // DWORD* out
);
ccall((:JetOpenFileInstanceW, "ESENT.dll"), stdcall, Int32,
      (Csize_t, Ptr{UInt16}, Ptr{Csize_t}, Ptr{UInt32}, Ptr{UInt32}),
      instance, szFileName, phfFile, pulFileSizeLow, pulFileSizeHigh)
# instance : JET_INSTANCE -> Csize_t
# szFileName : WORD* -> Ptr{UInt16}
# phfFile : JET_HANDLE* out -> Ptr{Csize_t}
# pulFileSizeLow : DWORD* out -> Ptr{UInt32}
# pulFileSizeHigh : DWORD* out -> Ptr{UInt32}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
int32_t JetOpenFileInstanceW(
    uintptr_t instance,
    uint16_t* szFileName,
    uintptr_t* phfFile,
    uint32_t* pulFileSizeLow,
    uint32_t* pulFileSizeHigh);
]]
local esent = ffi.load("esent")
-- esent.JetOpenFileInstanceW(instance, szFileName, phfFile, pulFileSizeLow, pulFileSizeHigh)
-- instance : JET_INSTANCE
-- szFileName : WORD*
-- phfFile : JET_HANDLE* out
-- pulFileSizeLow : DWORD* out
-- pulFileSizeHigh : DWORD* out
-- 構造体/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 JetOpenFileInstanceW = lib.func('__stdcall', 'JetOpenFileInstanceW', 'int32_t', ['uintptr_t', 'uint16_t *', 'uintptr_t *', 'uint32_t *', 'uint32_t *']);
// JetOpenFileInstanceW(instance, szFileName, phfFile, pulFileSizeLow, pulFileSizeHigh)
// instance : JET_INSTANCE -> 'uintptr_t'
// szFileName : WORD* -> 'uint16_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", {
  JetOpenFileInstanceW: { parameters: ["usize", "pointer", "pointer", "pointer", "pointer"], result: "i32" },
});
// lib.symbols.JetOpenFileInstanceW(instance, szFileName, phfFile, pulFileSizeLow, pulFileSizeHigh)
// instance : JET_INSTANCE -> "usize"
// szFileName : WORD* -> "pointer"
// phfFile : JET_HANDLE* out -> "pointer"
// pulFileSizeLow : DWORD* out -> "pointer"
// pulFileSizeHigh : DWORD* out -> "pointer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t JetOpenFileInstanceW(
    size_t instance,
    uint16_t* szFileName,
    size_t* phfFile,
    uint32_t* pulFileSizeLow,
    uint32_t* pulFileSizeHigh);
C, "ESENT.dll");
// $ffi->JetOpenFileInstanceW(instance, szFileName, phfFile, pulFileSizeLow, pulFileSizeHigh);
// instance : JET_INSTANCE
// szFileName : WORD*
// 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.UNICODE_OPTIONS);
    int JetOpenFileInstanceW(
        long instance,   // JET_INSTANCE
        ShortByReference szFileName,   // WORD*
        LongByReference phfFile,   // JET_HANDLE* out
        IntByReference pulFileSizeLow,   // DWORD* out
        IntByReference pulFileSizeHigh   // DWORD* out
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("esent")]
lib LibESENT
  fun JetOpenFileInstanceW = JetOpenFileInstanceW(
    instance : LibC::SizeT,   # JET_INSTANCE
    szFileName : UInt16*,   # WORD*
    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 JetOpenFileInstanceWNative = Int32 Function(UintPtr, Pointer<Uint16>, Pointer<UintPtr>, Pointer<Uint32>, Pointer<Uint32>);
typedef JetOpenFileInstanceWDart = int Function(int, Pointer<Uint16>, Pointer<UintPtr>, Pointer<Uint32>, Pointer<Uint32>);
final JetOpenFileInstanceW = DynamicLibrary.open('ESENT.dll')
    .lookupFunction<JetOpenFileInstanceWNative, JetOpenFileInstanceWDart>('JetOpenFileInstanceW');
// instance : JET_INSTANCE -> UintPtr
// szFileName : WORD* -> Pointer<Uint16>
// phfFile : JET_HANDLE* out -> Pointer<UintPtr>
// pulFileSizeLow : DWORD* out -> Pointer<Uint32>
// pulFileSizeHigh : DWORD* out -> Pointer<Uint32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function JetOpenFileInstanceW(
  instance: NativeUInt;   // JET_INSTANCE
  szFileName: Pointer;   // WORD*
  phfFile: Pointer;   // JET_HANDLE* out
  pulFileSizeLow: Pointer;   // DWORD* out
  pulFileSizeHigh: Pointer   // DWORD* out
): Integer; stdcall;
  external 'ESENT.dll' name 'JetOpenFileInstanceW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "JetOpenFileInstanceW"
  c_JetOpenFileInstanceW :: CUIntPtr -> Ptr Word16 -> Ptr CUIntPtr -> Ptr Word32 -> Ptr Word32 -> IO Int32
-- instance : JET_INSTANCE -> CUIntPtr
-- szFileName : WORD* -> Ptr Word16
-- 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 jetopenfileinstancew =
  foreign "JetOpenFileInstanceW"
    (size_t @-> (ptr uint16_t) @-> (ptr size_t) @-> (ptr uint32_t) @-> (ptr uint32_t) @-> returning int32_t)
(* instance : JET_INSTANCE -> size_t *)
(* szFileName : WORD* -> (ptr uint16_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 ("JetOpenFileInstanceW" jet-open-file-instance-w :convention :stdcall) :int32
  (instance :uint64)   ; JET_INSTANCE
  (sz-file-name :pointer)   ; WORD*
  (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 $JetOpenFileInstanceW = Win32::API::More->new('ESENT',
    'int JetOpenFileInstanceW(WPARAM instance, LPVOID szFileName, LPVOID phfFile, LPVOID pulFileSizeLow, LPVOID pulFileSizeHigh)');
# my $ret = $JetOpenFileInstanceW->Call($instance, $szFileName, $phfFile, $pulFileSizeLow, $pulFileSizeHigh);
# instance : JET_INSTANCE -> WPARAM
# szFileName : WORD* -> LPVOID
# phfFile : JET_HANDLE* out -> LPVOID
# pulFileSizeLow : DWORD* out -> LPVOID
# pulFileSizeHigh : DWORD* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い