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

JetEndSession

関数
指定したESEセッションを終了する。
DLLESENT.dll呼出規約winapi

シグネチャ

// ESENT.dll
#include <windows.h>

INT JetEndSession(
    JET_SESID sesid,
    DWORD grbit
);

パラメーター

名前型方向説明
sesidJET_SESIDin終了する対象のセッションID。
grbitDWORDin終了動作を制御するフラグ。通常は0を指定する。

戻り値の型: INT

公式ドキュメント

JetEndSession 関数は、セッションを終了し、指定されたセッションに関連付けられているリソースをクリーンアップして解放します。

戻り値

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

戻り値コード

説明

JET_errSuccess

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

JET_errClientRequestToStopJetService

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

JET_errInvalidParameter

指定されたパラメーターのいずれかに予期しない値が含まれていたか、複数のパラメーター値の組み合わせによって予期しない結果が生じました。

JET_errInvalidSesid

セッションが有効な JET セッションではありませんでした。

JET_errNotInitialized

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

JET_errOutOfMemory

メモリを割り当てられなかったため、操作は失敗しました。

JET_errSessionInUse

セッションが別のスレッドで使用中であったか、セッションが適切に設定またはリセットされていなかったことを示します。

JET_errInstanceUnavailable

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

このエラーは Windows XP 以降のリリースでのみ返されます。

JET_errOutOfBuffers

使用可能なバッファーがこれ以上ないことを示すシステムエラーです。

JET_errRestoreInProgress

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

JET_errTermInProgress

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

成功した場合、セッションのハンドルは閉じられて使用できなくなり、このセッションに関連するすべてのリソースがクリーンアップされます。

失敗した場合、ソートテーブルのクローズ、カーソルのクローズ、トランザクションのロールバックの一部として、さらにいくつかのエラーが発生する可能性があります。これらのエラーが発生することはかなりまれであり、JetEndSession を呼び出す時点でセッションがまったく使用されていない場合は極めてまれです。これらのエラーは、セッションの一部を適切にクリーンアップできなかった場合に返されます。

解説

この API は、開いているトランザクション (レベル 0 にコミットされていないもの) をすべてロールバックします。また、このセッションに関連付けられているすべてのカーソル、および作成または開かれたソートテーブルもクリーンアップされます。

要件

要件 値

クライアント

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

サーバー

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

ヘッダー

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

ライブラリ

ESENT.lib を使用します。

DLL

ESENT.dll が必要です。

関連項目

JET_GRBIT
JET_SESID
JetBeginSession
JetRollback
JetSetSystemParameter
JetStopService

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

各言語での呼び出し定義

// ESENT.dll
#include <windows.h>

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

JetEndSession = ctypes.windll.esent.JetEndSession
JetEndSession.restype = ctypes.c_int
JetEndSession.argtypes = [
    ctypes.c_size_t,  # sesid : JET_SESID
    wintypes.DWORD,  # grbit : DWORD
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ESENT.dll')
JetEndSession = Fiddle::Function.new(
  lib['JetEndSession'],
  [
    Fiddle::TYPE_UINTPTR_T,  # sesid : JET_SESID
    -Fiddle::TYPE_INT,  # grbit : DWORD
  ],
  Fiddle::TYPE_INT)
#[link(name = "esent")]
extern "system" {
    fn JetEndSession(
        sesid: usize,  // JET_SESID
        grbit: u32  // DWORD
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("ESENT.dll")]
public static extern int JetEndSession(UIntPtr sesid, uint grbit);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ESENT_JetEndSession' -Namespace Win32 -PassThru
# $api::JetEndSession(sesid, grbit)
#uselib "ESENT.dll"
#func global JetEndSession "JetEndSession" sptr, sptr
; JetEndSession sesid, grbit   ; 戻り値は stat
; sesid : JET_SESID -> "sptr"
; grbit : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "ESENT.dll"
#cfunc global JetEndSession "JetEndSession" sptr, int
; res = JetEndSession(sesid, grbit)
; sesid : JET_SESID -> "sptr"
; grbit : DWORD -> "int"
; INT JetEndSession(JET_SESID sesid, DWORD grbit)
#uselib "ESENT.dll"
#cfunc global JetEndSession "JetEndSession" intptr, int
; res = JetEndSession(sesid, grbit)
; sesid : JET_SESID -> "intptr"
; grbit : DWORD -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	esent = windows.NewLazySystemDLL("ESENT.dll")
	procJetEndSession = esent.NewProc("JetEndSession")
)

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

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

typedef JetEndSessionNative = Int32 Function(UintPtr, Uint32);
typedef JetEndSessionDart = int Function(int, int);
final JetEndSession = DynamicLibrary.open('ESENT.dll')
    .lookupFunction<JetEndSessionNative, JetEndSessionDart>('JetEndSession');
// sesid : JET_SESID -> UintPtr
// grbit : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function JetEndSession(
  sesid: NativeUInt;   // JET_SESID
  grbit: DWORD   // DWORD
): Integer; stdcall;
  external 'ESENT.dll' name 'JetEndSession';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "JetEndSession"
  c_JetEndSession :: CUIntPtr -> Word32 -> IO Int32
-- sesid : JET_SESID -> CUIntPtr
-- grbit : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let jetendsession =
  foreign "JetEndSession"
    (size_t @-> uint32_t @-> returning int32_t)
(* sesid : JET_SESID -> size_t *)
(* grbit : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library esent (t "ESENT.dll"))
(cffi:use-foreign-library esent)

(cffi:defcfun ("JetEndSession" jet-end-session :convention :stdcall) :int32
  (sesid :uint64)   ; JET_SESID
  (grbit :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $JetEndSession = Win32::API::More->new('ESENT',
    'int JetEndSession(WPARAM sesid, DWORD grbit)');
# my $ret = $JetEndSession->Call($sesid, $grbit);
# sesid : JET_SESID -> WPARAM
# grbit : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。