JetGetLock
関数シグネチャ
// ESENT.dll
#include <windows.h>
INT JetGetLock(
JET_SESID sesid,
JET_TABLEID tableid,
DWORD grbit
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| sesid | JET_SESID | in | ロック取得を行うセッションのJET_SESIDハンドル。 |
| tableid | JET_TABLEID | in | ロック対象のカレントレコードを持つテーブルのカーソルハンドル。 |
| grbit | DWORD | in | 取得するロック種別を指定するビットフラグ。JET_bitReadLockまたはJET_bitWriteLockを指定する。 |
戻り値の型: INT
公式ドキュメント
JetGetLock 関数は、行を更新する権利を明示的に予約する (書き込みロック)、または他のセッションによって行が更新されるのを明示的に防ぐ (読み取りロック) ための手段を提供します。通常、行の書き込みロックは行を更新した結果として暗黙的に取得されます。読み取りロックは、レコードのバージョン管理があるため通常は必要ありません。ただし場合によっては、直列化を強制するため、あるいは必要なロックが既に取得されていることによって後続の操作が成功することを保証するために、トランザクションが行を明示的にロックしたいことがあります。
戻り値
この関数は JET_ERR データ型を返し、その値は以下の戻り値コードのいずれかです。発生し得る ESE のエラーの詳細については、Extensible Storage Engine Errors および Error Handling Parameters を参照してください。
戻り値コード |
説明 |
|---|---|
JET_errSuccess |
操作は正常に完了しました。 |
JET_errClientRequestToStopJetService |
JetStopService の呼び出しの結果として、セッションに関連付けられたインスタンス上のすべての処理が停止しているため、操作を完了できません。 |
JET_errInstanceUnavailable |
セッションに関連付けられたインスタンスが、データの整合性を保護するためにすべてのデータへのアクセスを取り消す必要がある致命的なエラーに遭遇したため、操作を完了できません。このエラーは Windows XP 以降のリリースでのみ返されます。 |
JET_errInvalidgrbit |
指定された grbit が JET_bitReadLock でも JET_bitWriteLock でもありません。これら 2 つのフラグのいずれかである必要があります。 |
JET_errNoCurrentRecord |
ロックを取得するには、カーソルがレコード上にある必要があります。ロックは常にレコードに対して行われます。 |
JET_errNotInitialized |
セッションに関連付けられたインスタンスがまだ初期化されていないため、操作を完了できません。 |
JET_errNotInTransaction |
ロックは、トランザクション内のセッションからのみ取得できます。 |
JET_errPermissionDenied |
読み取り専用のカーソルで書き込みロックを取得することはできません。 |
JET_errRestoreInProgress |
セッションに関連付けられたインスタンスで復元操作が進行中であるため、操作を完了できません。 |
JET_errSessionSharingViolation |
同じセッションを同時に複数のスレッドで使用することはできません。このエラーは Windows XP 以降のリリースでのみ返されます。 |
JET_errTermInProgress |
セッションに関連付けられたインスタンスがシャットダウン中であるため、操作を完了できません。 |
JET_errTransReadOnly |
書き込みロックを取得するには、セッションが書き込み権限を持っている必要があります。 |
JET_errWriteConflict |
競合するロックが要求された場合に返されるエラーです。 |
成功した場合、セッションは要求したロックを取得しています。
失敗した場合、セッションは要求したロックを取得していません。
解説
読み取り専用の権限しか持たないセッションやカーソルでは、最終的に更新操作を行わない場合であっても、書き込みロックを取得することはできません。書き込みロックを取得するには、セッションとカーソルの両方が書き込み特権を持っている必要があります。
読み取りロックと書き込みロックは、悲観的ロックの手段です。悲観的ロックは、複数の同時実行セッションが競合することを想定し、操作が確実に成功するように事前にロックを取得します。
ほとんどの操作は、暗黙的に取得されるロックによって直列化可能になります。しかし、そうならない操作もあります。これを説明するために、次の 2 つのトランザクションを考えます。
T1 : R(A), U(B)
T2 : R(B), U(A)
レコードレベルのバージョン管理により、これらのトランザクションを同時に実行した場合、それぞれが A と B の元の値を参照することが保証されます。結果が読み取ったデータに依存する場合、A と B について同じ結果を生成するような逐次的な実行順序は存在しません。アプリケーションがこのトランザクションを直列化可能にするには、各トランザクションで値を読み取るときに A と B に対して明示的な読み取りロックを取得する必要があります。
要件
| 要件 | 値 |
|---|---|
クライアント |
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_SESID
JET_TABLEID
JetPrepareUpdate
JetStopService
JetUpdate
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp)
各言語での呼び出し定義
// ESENT.dll
#include <windows.h>
INT JetGetLock(
JET_SESID sesid,
JET_TABLEID tableid,
DWORD grbit
);[DllImport("ESENT.dll", ExactSpelling = true)]
static extern int JetGetLock(
UIntPtr sesid, // JET_SESID
UIntPtr tableid, // JET_TABLEID
uint grbit // DWORD
);<DllImport("ESENT.dll", ExactSpelling:=True)>
Public Shared Function JetGetLock(
sesid As UIntPtr, ' JET_SESID
tableid As UIntPtr, ' JET_TABLEID
grbit As UInteger ' DWORD
) As Integer
End Function' sesid : JET_SESID
' tableid : JET_TABLEID
' grbit : DWORD
Declare PtrSafe Function JetGetLock Lib "esent" ( _
ByVal sesid As LongPtr, _
ByVal tableid 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
JetGetLock = ctypes.windll.esent.JetGetLock
JetGetLock.restype = ctypes.c_int
JetGetLock.argtypes = [
ctypes.c_size_t, # sesid : JET_SESID
ctypes.c_size_t, # tableid : JET_TABLEID
wintypes.DWORD, # grbit : DWORD
]require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('ESENT.dll')
JetGetLock = Fiddle::Function.new(
lib['JetGetLock'],
[
Fiddle::TYPE_UINTPTR_T, # sesid : JET_SESID
Fiddle::TYPE_UINTPTR_T, # tableid : JET_TABLEID
-Fiddle::TYPE_INT, # grbit : DWORD
],
Fiddle::TYPE_INT)#[link(name = "esent")]
extern "system" {
fn JetGetLock(
sesid: usize, // JET_SESID
tableid: usize, // JET_TABLEID
grbit: u32 // DWORD
) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[DllImport("ESENT.dll")]
public static extern int JetGetLock(UIntPtr sesid, UIntPtr tableid, uint grbit);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ESENT_JetGetLock' -Namespace Win32 -PassThru
# $api::JetGetLock(sesid, tableid, grbit)#uselib "ESENT.dll"
#func global JetGetLock "JetGetLock" sptr, sptr, sptr
; JetGetLock sesid, tableid, grbit ; 戻り値は stat
; sesid : JET_SESID -> "sptr"
; tableid : JET_TABLEID -> "sptr"
; grbit : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "ESENT.dll"
#cfunc global JetGetLock "JetGetLock" sptr, sptr, int
; res = JetGetLock(sesid, tableid, grbit)
; sesid : JET_SESID -> "sptr"
; tableid : JET_TABLEID -> "sptr"
; grbit : DWORD -> "int"; INT JetGetLock(JET_SESID sesid, JET_TABLEID tableid, DWORD grbit)
#uselib "ESENT.dll"
#cfunc global JetGetLock "JetGetLock" intptr, intptr, int
; res = JetGetLock(sesid, tableid, grbit)
; sesid : JET_SESID -> "intptr"
; tableid : JET_TABLEID -> "intptr"
; grbit : DWORD -> "int"import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
esent = windows.NewLazySystemDLL("ESENT.dll")
procJetGetLock = esent.NewProc("JetGetLock")
)
// sesid (JET_SESID), tableid (JET_TABLEID), grbit (DWORD)
r1, _, err := procJetGetLock.Call(
uintptr(sesid),
uintptr(tableid),
uintptr(grbit),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // INTfunction JetGetLock(
sesid: NativeUInt; // JET_SESID
tableid: NativeUInt; // JET_TABLEID
grbit: DWORD // DWORD
): Integer; stdcall;
external 'ESENT.dll' name 'JetGetLock';result := DllCall("ESENT\JetGetLock"
, "UPtr", sesid ; JET_SESID
, "UPtr", tableid ; JET_TABLEID
, "UInt", grbit ; DWORD
, "Int") ; return: INT●JetGetLock(sesid, tableid, grbit) = DLL("ESENT.dll", "int JetGetLock(int, int, dword)")
# 呼び出し: JetGetLock(sesid, tableid, grbit)
# sesid : JET_SESID -> "int"
# tableid : JET_TABLEID -> "int"
# grbit : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "esent" fn JetGetLock(
sesid: usize, // JET_SESID
tableid: usize, // JET_TABLEID
grbit: u32 // DWORD
) callconv(std.os.windows.WINAPI) i32;proc JetGetLock(
sesid: uint, # JET_SESID
tableid: uint, # JET_TABLEID
grbit: uint32 # DWORD
): int32 {.importc: "JetGetLock", stdcall, dynlib: "ESENT.dll".}pragma(lib, "esent");
extern(Windows)
int JetGetLock(
size_t sesid, // JET_SESID
size_t tableid, // JET_TABLEID
uint grbit // DWORD
);ccall((:JetGetLock, "ESENT.dll"), stdcall, Int32,
(Csize_t, Csize_t, UInt32),
sesid, tableid, grbit)
# sesid : JET_SESID -> Csize_t
# tableid : JET_TABLEID -> Csize_t
# grbit : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
int32_t JetGetLock(
uintptr_t sesid,
uintptr_t tableid,
uint32_t grbit);
]]
local esent = ffi.load("esent")
-- esent.JetGetLock(sesid, tableid, grbit)
-- sesid : JET_SESID
-- tableid : JET_TABLEID
-- grbit : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('ESENT.dll');
const JetGetLock = lib.func('__stdcall', 'JetGetLock', 'int32_t', ['uintptr_t', 'uintptr_t', 'uint32_t']);
// JetGetLock(sesid, tableid, grbit)
// sesid : JET_SESID -> 'uintptr_t'
// tableid : JET_TABLEID -> 'uintptr_t'
// grbit : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("ESENT.dll", {
JetGetLock: { parameters: ["usize", "usize", "u32"], result: "i32" },
});
// lib.symbols.JetGetLock(sesid, tableid, grbit)
// sesid : JET_SESID -> "usize"
// tableid : JET_TABLEID -> "usize"
// grbit : DWORD -> "u32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
int32_t JetGetLock(
size_t sesid,
size_t tableid,
uint32_t grbit);
C, "ESENT.dll");
// $ffi->JetGetLock(sesid, tableid, grbit);
// sesid : JET_SESID
// tableid : JET_TABLEID
// 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 JetGetLock(
long sesid, // JET_SESID
long tableid, // JET_TABLEID
int grbit // DWORD
);
}@[Link("esent")]
lib LibESENT
fun JetGetLock = JetGetLock(
sesid : LibC::SizeT, # JET_SESID
tableid : LibC::SizeT, # JET_TABLEID
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 JetGetLockNative = Int32 Function(UintPtr, UintPtr, Uint32);
typedef JetGetLockDart = int Function(int, int, int);
final JetGetLock = DynamicLibrary.open('ESENT.dll')
.lookupFunction<JetGetLockNative, JetGetLockDart>('JetGetLock');
// sesid : JET_SESID -> UintPtr
// tableid : JET_TABLEID -> UintPtr
// grbit : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function JetGetLock(
sesid: NativeUInt; // JET_SESID
tableid: NativeUInt; // JET_TABLEID
grbit: DWORD // DWORD
): Integer; stdcall;
external 'ESENT.dll' name 'JetGetLock';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "JetGetLock"
c_JetGetLock :: CUIntPtr -> CUIntPtr -> Word32 -> IO Int32
-- sesid : JET_SESID -> CUIntPtr
-- tableid : JET_TABLEID -> CUIntPtr
-- grbit : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let jetgetlock =
foreign "JetGetLock"
(size_t @-> size_t @-> uint32_t @-> returning int32_t)
(* sesid : JET_SESID -> size_t *)
(* tableid : JET_TABLEID -> 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 ("JetGetLock" jet-get-lock :convention :stdcall) :int32
(sesid :uint64) ; JET_SESID
(tableid :uint64) ; JET_TABLEID
(grbit :uint32)) ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $JetGetLock = Win32::API::More->new('ESENT',
'int JetGetLock(WPARAM sesid, WPARAM tableid, DWORD grbit)');
# my $ret = $JetGetLock->Call($sesid, $tableid, $grbit);
# sesid : JET_SESID -> WPARAM
# tableid : JET_TABLEID -> WPARAM
# grbit : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。