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

JetOpenFileW

関数
外部バックアップ用にファイルを開きハンドルを取得する(Unicode版)。
DLLESENT.dll文字セットUnicode (-W)呼出規約winapi

シグネチャ

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

INT JetOpenFileW(
    WORD* szFileName,
    JET_HANDLE* phfFile,
    DWORD* pulFileSizeLow,
    DWORD* pulFileSizeHigh
);

パラメーター

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

戻り値の型: INT

各言語での呼び出し定義

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

INT JetOpenFileW(
    WORD* szFileName,
    JET_HANDLE* phfFile,
    DWORD* pulFileSizeLow,
    DWORD* pulFileSizeHigh
);
[DllImport("ESENT.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern int JetOpenFileW(
    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 JetOpenFileW(
    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
' szFileName : WORD*
' phfFile : JET_HANDLE* out
' pulFileSizeLow : DWORD* out
' pulFileSizeHigh : DWORD* out
Declare PtrSafe Function JetOpenFileW Lib "esent" ( _
    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

JetOpenFileW = ctypes.windll.esent.JetOpenFileW
JetOpenFileW.restype = ctypes.c_int
JetOpenFileW.argtypes = [
    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')
JetOpenFileW = Fiddle::Function.new(
  lib['JetOpenFileW'],
  [
    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 JetOpenFileW(
        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 JetOpenFileW(ref ushort szFileName, out UIntPtr phfFile, out uint pulFileSizeLow, out uint pulFileSizeHigh);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ESENT_JetOpenFileW' -Namespace Win32 -PassThru
# $api::JetOpenFileW(szFileName, phfFile, pulFileSizeLow, pulFileSizeHigh)
#uselib "ESENT.dll"
#func global JetOpenFileW "JetOpenFileW" wptr, wptr, wptr, wptr
; JetOpenFileW varptr(szFileName), varptr(phfFile), varptr(pulFileSizeLow), varptr(pulFileSizeHigh)   ; 戻り値は stat
; 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 JetOpenFileW "JetOpenFileW" var, var, var, var
; res = JetOpenFileW(szFileName, phfFile, pulFileSizeLow, pulFileSizeHigh)
; szFileName : WORD* -> "var"
; phfFile : JET_HANDLE* out -> "var"
; pulFileSizeLow : DWORD* out -> "var"
; pulFileSizeHigh : DWORD* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; INT JetOpenFileW(WORD* szFileName, JET_HANDLE* phfFile, DWORD* pulFileSizeLow, DWORD* pulFileSizeHigh)
#uselib "ESENT.dll"
#cfunc global JetOpenFileW "JetOpenFileW" var, var, var, var
; res = JetOpenFileW(szFileName, phfFile, pulFileSizeLow, pulFileSizeHigh)
; 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")
	procJetOpenFileW = esent.NewProc("JetOpenFileW")
)

// szFileName (WORD*), phfFile (JET_HANDLE* out), pulFileSizeLow (DWORD* out), pulFileSizeHigh (DWORD* out)
r1, _, err := procJetOpenFileW.Call(
	uintptr(szFileName),
	uintptr(phfFile),
	uintptr(pulFileSizeLow),
	uintptr(pulFileSizeHigh),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // INT
function JetOpenFileW(
  szFileName: Pointer;   // WORD*
  phfFile: Pointer;   // JET_HANDLE* out
  pulFileSizeLow: Pointer;   // DWORD* out
  pulFileSizeHigh: Pointer   // DWORD* out
): Integer; stdcall;
  external 'ESENT.dll' name 'JetOpenFileW';
result := DllCall("ESENT\JetOpenFileW"
    , "Ptr", szFileName   ; WORD*
    , "Ptr", phfFile   ; JET_HANDLE* out
    , "Ptr", pulFileSizeLow   ; DWORD* out
    , "Ptr", pulFileSizeHigh   ; DWORD* out
    , "Int")   ; return: INT
●JetOpenFileW(szFileName, phfFile, pulFileSizeLow, pulFileSizeHigh) = DLL("ESENT.dll", "int JetOpenFileW(void*, void*, void*, void*)")
# 呼び出し: JetOpenFileW(szFileName, phfFile, pulFileSizeLow, pulFileSizeHigh)
# 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 JetOpenFileW(
    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 JetOpenFileW(
    szFileName: ptr uint16,  # WORD*
    phfFile: ptr uint,  # JET_HANDLE* out
    pulFileSizeLow: ptr uint32,  # DWORD* out
    pulFileSizeHigh: ptr uint32  # DWORD* out
): int32 {.importc: "JetOpenFileW", stdcall, dynlib: "ESENT.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "esent");
extern(Windows)
int JetOpenFileW(
    ushort* szFileName,   // WORD*
    size_t* phfFile,   // JET_HANDLE* out
    uint* pulFileSizeLow,   // DWORD* out
    uint* pulFileSizeHigh   // DWORD* out
);
ccall((:JetOpenFileW, "ESENT.dll"), stdcall, Int32,
      (Ptr{UInt16}, Ptr{Csize_t}, Ptr{UInt32}, Ptr{UInt32}),
      szFileName, phfFile, pulFileSizeLow, pulFileSizeHigh)
# 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 JetOpenFileW(
    uint16_t* szFileName,
    uintptr_t* phfFile,
    uint32_t* pulFileSizeLow,
    uint32_t* pulFileSizeHigh);
]]
local esent = ffi.load("esent")
-- esent.JetOpenFileW(szFileName, phfFile, pulFileSizeLow, pulFileSizeHigh)
-- 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 JetOpenFileW = lib.func('__stdcall', 'JetOpenFileW', 'int32_t', ['uint16_t *', 'uintptr_t *', 'uint32_t *', 'uint32_t *']);
// JetOpenFileW(szFileName, phfFile, pulFileSizeLow, pulFileSizeHigh)
// 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", {
  JetOpenFileW: { parameters: ["pointer", "pointer", "pointer", "pointer"], result: "i32" },
});
// lib.symbols.JetOpenFileW(szFileName, phfFile, pulFileSizeLow, pulFileSizeHigh)
// 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 JetOpenFileW(
    uint16_t* szFileName,
    size_t* phfFile,
    uint32_t* pulFileSizeLow,
    uint32_t* pulFileSizeHigh);
C, "ESENT.dll");
// $ffi->JetOpenFileW(szFileName, phfFile, pulFileSizeLow, pulFileSizeHigh);
// 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 JetOpenFileW(
        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 JetOpenFileW = JetOpenFileW(
    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 JetOpenFileWNative = Int32 Function(Pointer<Uint16>, Pointer<UintPtr>, Pointer<Uint32>, Pointer<Uint32>);
typedef JetOpenFileWDart = int Function(Pointer<Uint16>, Pointer<UintPtr>, Pointer<Uint32>, Pointer<Uint32>);
final JetOpenFileW = DynamicLibrary.open('ESENT.dll')
    .lookupFunction<JetOpenFileWNative, JetOpenFileWDart>('JetOpenFileW');
// 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 JetOpenFileW(
  szFileName: Pointer;   // WORD*
  phfFile: Pointer;   // JET_HANDLE* out
  pulFileSizeLow: Pointer;   // DWORD* out
  pulFileSizeHigh: Pointer   // DWORD* out
): Integer; stdcall;
  external 'ESENT.dll' name 'JetOpenFileW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "JetOpenFileW"
  c_JetOpenFileW :: Ptr Word16 -> Ptr CUIntPtr -> Ptr Word32 -> Ptr Word32 -> IO Int32
-- 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 jetopenfilew =
  foreign "JetOpenFileW"
    ((ptr uint16_t) @-> (ptr size_t) @-> (ptr uint32_t) @-> (ptr uint32_t) @-> returning int32_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 ("JetOpenFileW" jet-open-file-w :convention :stdcall) :int32
  (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 $JetOpenFileW = Win32::API::More->new('ESENT',
    'int JetOpenFileW(LPVOID szFileName, LPVOID phfFile, LPVOID pulFileSizeLow, LPVOID pulFileSizeHigh)');
# my $ret = $JetOpenFileW->Call($szFileName, $phfFile, $pulFileSizeLow, $pulFileSizeHigh);
# 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 変換を行う。

関連項目

文字セット違い