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

JetTerm2

関数
オプション指定でESEデータベースインスタンスを終了する。
DLLESENT.dll呼出規約winapi

シグネチャ

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

INT JetTerm2(
    JET_INSTANCE instance,
    DWORD grbit
);

パラメーター

名前型方向説明
instanceJET_INSTANCEin終了させる対象のインスタンスハンドル。
grbitDWORDin終了動作を制御するJET_bitTerm系フラグ。完全終了か中断かなどを指定する。

戻り値の型: INT

公式ドキュメント

JetTerm2 関数は、JetInit によって初期化されたインスタンスのシャットダウンを開始します。

戻り値

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

戻りコード

説明

JET_errSuccess

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

JET_errBackupInProgress

インスタンスでバックアップ操作が進行中であるため、操作を完了できません。

JET_errInvalidParameter

指定されたパラメーターのいずれかに予期しない値が含まれていたか、複数のパラメーターの組み合わせが予期しない結果になりました。このエラーは、エンジンがマルチインスタンス モードで動作しており、かつ pinstance が無効なインスタンスを参照している場合に JetTerm から返されます。

Windows XP: この戻り値は Windows XP で導入されました。

JET_errNotInitialized

インスタンスがまだ初期化されていないため、操作を完了できません。

JET_errTermInProgress

インスタンスがシャットダウン処理中であるため、操作を完了できません。

JET_errRestoreInProgress

インスタンスで復元操作が進行中であるため、操作を完了できません。

JET_errTooManyActiveUsers

指定されたインスタンスに対してアクティブなトランザクションを持つセッションが現在存在するため、インスタンスをシャットダウンできません。このエラーは、JET_bitTermComplete が使用された場合にのみ発生します。

この関数が成功すると、指定されたインスタンスはシャットダウンされます。インスタンス ハンドルも閉じられ、インスタンス ハンドルを受け取るどの API でも使用できなくなります。セッションなど、そのインスタンスに関連付けられている他のすべてのオブジェクトも閉じられます。チェックポイント ファイル、トランザクション ログ ファイル、およびインスタンスにアタッチされているデータベース ファイルの状態は、シャットダウン処理中に変更されます。

使用方法の誤りが原因でこの関数が失敗した場合、インスタンスは初期化された状態のまま維持され、何も変更されません。それ以外の場合は、成功時と同様にインスタンスはシャットダウンされます。異なる点は、次回の初期化時にインスタンスがクラッシュ回復を実行する必要があることです。エンジンは、必要となる回復処理を最小限に抑えるため、可能な限り多くのデータをフラッシュしようとします。概念的には、このような JetTerm の失敗はプロセスのクラッシュと変わりません。

解説

「JetTerm」を参照してください。

要件

要件 値

クライアント

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

サーバー

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

ヘッダー

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

ライブラリ

ESENT.lib を使用します。

DLL

ESENT.dll が必要です。

関連項目

Extensible Storage Engine Files
JetCreateInstance
JET_ERR
JET_GRBIT
JetInit
JET_INSTANCE
JetTerm

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

各言語での呼び出し定義

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

INT JetTerm2(
    JET_INSTANCE instance,
    DWORD grbit
);
[DllImport("ESENT.dll", ExactSpelling = true)]
static extern int JetTerm2(
    UIntPtr instance,   // JET_INSTANCE
    uint grbit   // DWORD
);
<DllImport("ESENT.dll", ExactSpelling:=True)>
Public Shared Function JetTerm2(
    instance As UIntPtr,   ' JET_INSTANCE
    grbit As UInteger   ' DWORD
) As Integer
End Function
' instance : JET_INSTANCE
' grbit : DWORD
Declare PtrSafe Function JetTerm2 Lib "esent" ( _
    ByVal instance 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

JetTerm2 = ctypes.windll.esent.JetTerm2
JetTerm2.restype = ctypes.c_int
JetTerm2.argtypes = [
    ctypes.c_size_t,  # instance : JET_INSTANCE
    wintypes.DWORD,  # grbit : DWORD
]
require 'fiddle'
require 'fiddle/import'

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

var (
	esent = windows.NewLazySystemDLL("ESENT.dll")
	procJetTerm2 = esent.NewProc("JetTerm2")
)

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

extern "esent" fn JetTerm2(
    instance: usize, // JET_INSTANCE
    grbit: u32 // DWORD
) callconv(std.os.windows.WINAPI) i32;
proc JetTerm2(
    instance: uint,  # JET_INSTANCE
    grbit: uint32  # DWORD
): int32 {.importc: "JetTerm2", stdcall, dynlib: "ESENT.dll".}
pragma(lib, "esent");
extern(Windows)
int JetTerm2(
    size_t instance,   // JET_INSTANCE
    uint grbit   // DWORD
);
ccall((:JetTerm2, "ESENT.dll"), stdcall, Int32,
      (Csize_t, UInt32),
      instance, grbit)
# instance : JET_INSTANCE -> Csize_t
# grbit : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t JetTerm2(
    uintptr_t instance,
    uint32_t grbit);
]]
local esent = ffi.load("esent")
-- esent.JetTerm2(instance, grbit)
-- instance : JET_INSTANCE
-- grbit : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('ESENT.dll');
const JetTerm2 = lib.func('__stdcall', 'JetTerm2', 'int32_t', ['uintptr_t', 'uint32_t']);
// JetTerm2(instance, grbit)
// instance : JET_INSTANCE -> 'uintptr_t'
// grbit : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("ESENT.dll", {
  JetTerm2: { parameters: ["usize", "u32"], result: "i32" },
});
// lib.symbols.JetTerm2(instance, grbit)
// instance : JET_INSTANCE -> "usize"
// grbit : DWORD -> "u32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t JetTerm2(
    size_t instance,
    uint32_t grbit);
C, "ESENT.dll");
// $ffi->JetTerm2(instance, grbit);
// instance : JET_INSTANCE
// 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 JetTerm2(
        long instance,   // JET_INSTANCE
        int grbit   // DWORD
    );
}
@[Link("esent")]
lib LibESENT
  fun JetTerm2 = JetTerm2(
    instance : LibC::SizeT,   # JET_INSTANCE
    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 JetTerm2Native = Int32 Function(UintPtr, Uint32);
typedef JetTerm2Dart = int Function(int, int);
final JetTerm2 = DynamicLibrary.open('ESENT.dll')
    .lookupFunction<JetTerm2Native, JetTerm2Dart>('JetTerm2');
// instance : JET_INSTANCE -> UintPtr
// grbit : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function JetTerm2(
  instance: NativeUInt;   // JET_INSTANCE
  grbit: DWORD   // DWORD
): Integer; stdcall;
  external 'ESENT.dll' name 'JetTerm2';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

let jetterm2 =
  foreign "JetTerm2"
    (size_t @-> uint32_t @-> returning int32_t)
(* instance : JET_INSTANCE -> 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 ("JetTerm2" jet-term2 :convention :stdcall) :int32
  (instance :uint64)   ; JET_INSTANCE
  (grbit :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $JetTerm2 = Win32::API::More->new('ESENT',
    'int JetTerm2(WPARAM instance, DWORD grbit)');
# my $ret = $JetTerm2->Call($instance, $grbit);
# instance : JET_INSTANCE -> WPARAM
# grbit : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

類似 API