JetCloseFile
関数シグネチャ
// ESENT.dll
#include <windows.h>
INT JetCloseFile(
JET_HANDLE hfFile
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| hfFile | JET_HANDLE | in | 閉じる対象のファイルを識別するJET_HANDLE。JetOpenFileで取得したハンドルを指定する。 |
戻り値の型: INT
公式ドキュメント
JetCloseFile 関数は、JetReadFile を使用してファイルからデータを抽出した後に、JetOpenFile で開いたファイルを閉じます。
戻り値
この関数は JET_ERR データ型を返し、その値は次のリターンコードのいずれかです。発生し得る ESE のエラーの詳細については、Extensible Storage Engine Errors および Error Handling Parameters を参照してください。
リターンコード |
説明 |
|---|---|
JET_errSuccess |
操作が正常に完了しました。 |
JET_errClientRequestToStopJetService |
JetStopService の呼び出しにより、セッションに関連付けられたインスタンス上のすべての処理が停止しているため、操作を完了できません。 |
JET_errInstanceUnavailable |
セッションに関連付けられたインスタンスで、データの整合性を保護するためにすべてのデータへのアクセスを取り消す必要がある致命的なエラーが発生したため、操作を完了できません。 このエラーは Windows XP 以降のリリースでのみ返されます。 |
JET_errInvalidParameter |
指定されたパラメーターのいずれかに予期しない値が含まれているか、他のパラメーターの値と組み合わせたときに意味をなさない値が含まれていました。JetCloseFile では、次の場合にこのエラーが発生します。
|
JET_errNoBackup |
外部バックアップが進行中ではないため、操作が失敗しました。 |
JET_errNotInitialized |
セッションに関連付けられたインスタンスがまだ初期化されていないため、操作を完了できません。 |
JET_errRestoreInProgress |
セッションに関連付けられたインスタンスで復元操作が進行中であるため、操作を完了できません。 |
JET_errRunningInMultiInstanceMode |
実際には複数のインスタンスが既に存在しているにもかかわらず、インスタンスを 1 つだけサポートするレガシーモード (Windows 2000 互換モード) でエンジンを使用しようとしたため、操作が失敗しました。 |
JET_errTermInProgress |
セッションに関連付けられたインスタンスがシャットダウン中であるため、操作を完了できません。 |
成功した場合、ファイルハンドルは閉じられます。データベースファイルが閉じられた場合は、関連するデータベースパッチファイル (存在する場合) が破棄されます。
失敗した場合、変更は行われません。
解説
データベースエンジンは現在のところ、JetOpenFile によって同時に開けるファイルを 1 つだけサポートしています。JetOpenFile を使用してファイルハンドルを開いた場合は、別のファイルを開く前に JetCloseFile を使用してそれを閉じる必要があります。
要件
| 要件 | 値 |
|---|---|
クライアント |
Windows Vista、Windows XP、または Windows 2000 Professional が必要です。 |
サーバー |
Windows Server 2008、Windows Server 2003、または Windows 2000 Server が必要です。 |
ヘッダー |
Esent.h で宣言されています。 |
ライブラリ |
ESENT.lib を使用します。 |
DLL |
ESENT.dll が必要です。 |
関連項目
JET_ERR
JET_INSTANCE
JET_HANDLE
JetOpenFile
JetReadFile
JetStopService
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp)
各言語での呼び出し定義
// ESENT.dll
#include <windows.h>
INT JetCloseFile(
JET_HANDLE hfFile
);[DllImport("ESENT.dll", ExactSpelling = true)]
static extern int JetCloseFile(
UIntPtr hfFile // JET_HANDLE
);<DllImport("ESENT.dll", ExactSpelling:=True)>
Public Shared Function JetCloseFile(
hfFile As UIntPtr ' JET_HANDLE
) As Integer
End Function' hfFile : JET_HANDLE
Declare PtrSafe Function JetCloseFile Lib "esent" ( _
ByVal hfFile As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
JetCloseFile = ctypes.windll.esent.JetCloseFile
JetCloseFile.restype = ctypes.c_int
JetCloseFile.argtypes = [
ctypes.c_size_t, # hfFile : JET_HANDLE
]require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('ESENT.dll')
JetCloseFile = Fiddle::Function.new(
lib['JetCloseFile'],
[
Fiddle::TYPE_UINTPTR_T, # hfFile : JET_HANDLE
],
Fiddle::TYPE_INT)#[link(name = "esent")]
extern "system" {
fn JetCloseFile(
hfFile: usize // JET_HANDLE
) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[DllImport("ESENT.dll")]
public static extern int JetCloseFile(UIntPtr hfFile);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ESENT_JetCloseFile' -Namespace Win32 -PassThru
# $api::JetCloseFile(hfFile)#uselib "ESENT.dll"
#func global JetCloseFile "JetCloseFile" sptr
; JetCloseFile hfFile ; 戻り値は stat
; hfFile : JET_HANDLE -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "ESENT.dll"
#cfunc global JetCloseFile "JetCloseFile" sptr
; res = JetCloseFile(hfFile)
; hfFile : JET_HANDLE -> "sptr"; INT JetCloseFile(JET_HANDLE hfFile)
#uselib "ESENT.dll"
#cfunc global JetCloseFile "JetCloseFile" intptr
; res = JetCloseFile(hfFile)
; hfFile : JET_HANDLE -> "intptr"import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
esent = windows.NewLazySystemDLL("ESENT.dll")
procJetCloseFile = esent.NewProc("JetCloseFile")
)
// hfFile (JET_HANDLE)
r1, _, err := procJetCloseFile.Call(
uintptr(hfFile),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // INTfunction JetCloseFile(
hfFile: NativeUInt // JET_HANDLE
): Integer; stdcall;
external 'ESENT.dll' name 'JetCloseFile';result := DllCall("ESENT\JetCloseFile"
, "UPtr", hfFile ; JET_HANDLE
, "Int") ; return: INT●JetCloseFile(hfFile) = DLL("ESENT.dll", "int JetCloseFile(int)")
# 呼び出し: JetCloseFile(hfFile)
# hfFile : JET_HANDLE -> "int"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "esent" fn JetCloseFile(
hfFile: usize // JET_HANDLE
) callconv(std.os.windows.WINAPI) i32;proc JetCloseFile(
hfFile: uint # JET_HANDLE
): int32 {.importc: "JetCloseFile", stdcall, dynlib: "ESENT.dll".}pragma(lib, "esent");
extern(Windows)
int JetCloseFile(
size_t hfFile // JET_HANDLE
);ccall((:JetCloseFile, "ESENT.dll"), stdcall, Int32,
(Csize_t,),
hfFile)
# hfFile : JET_HANDLE -> Csize_t
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
int32_t JetCloseFile(
uintptr_t hfFile);
]]
local esent = ffi.load("esent")
-- esent.JetCloseFile(hfFile)
-- hfFile : JET_HANDLE
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('ESENT.dll');
const JetCloseFile = lib.func('__stdcall', 'JetCloseFile', 'int32_t', ['uintptr_t']);
// JetCloseFile(hfFile)
// hfFile : JET_HANDLE -> 'uintptr_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("ESENT.dll", {
JetCloseFile: { parameters: ["usize"], result: "i32" },
});
// lib.symbols.JetCloseFile(hfFile)
// hfFile : JET_HANDLE -> "usize"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
int32_t JetCloseFile(
size_t hfFile);
C, "ESENT.dll");
// $ffi->JetCloseFile(hfFile);
// hfFile : JET_HANDLE
// 構造体/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);
int JetCloseFile(
long hfFile // JET_HANDLE
);
}@[Link("esent")]
lib LibESENT
fun JetCloseFile = JetCloseFile(
hfFile : LibC::SizeT # JET_HANDLE
) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef JetCloseFileNative = Int32 Function(UintPtr);
typedef JetCloseFileDart = int Function(int);
final JetCloseFile = DynamicLibrary.open('ESENT.dll')
.lookupFunction<JetCloseFileNative, JetCloseFileDart>('JetCloseFile');
// hfFile : JET_HANDLE -> UintPtr
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function JetCloseFile(
hfFile: NativeUInt // JET_HANDLE
): Integer; stdcall;
external 'ESENT.dll' name 'JetCloseFile';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "JetCloseFile"
c_JetCloseFile :: CUIntPtr -> IO Int32
-- hfFile : JET_HANDLE -> CUIntPtr
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let jetclosefile =
foreign "JetCloseFile"
(size_t @-> returning int32_t)
(* hfFile : JET_HANDLE -> size_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)(cffi:define-foreign-library esent (t "ESENT.dll"))
(cffi:use-foreign-library esent)
(cffi:defcfun ("JetCloseFile" jet-close-file :convention :stdcall) :int32
(hf-file :uint64)) ; JET_HANDLE
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $JetCloseFile = Win32::API::More->new('ESENT',
'int JetCloseFile(WPARAM hfFile)');
# my $ret = $JetCloseFile->Call($hfFile);
# hfFile : JET_HANDLE -> WPARAM
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。