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

JetPrepareUpdate

関数
レコードの挿入や更新のための準備を開始する。
DLLESENT.dll呼出規約winapi

シグネチャ

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

INT JetPrepareUpdate(
    JET_SESID sesid,
    JET_TABLEID tableid,
    DWORD prep
);

パラメーター

名前型方向説明
sesidJET_SESIDin更新準備を行うセッションのJET_SESIDハンドル。
tableidJET_TABLEIDin更新を準備する対象テーブルのカーソルハンドル。
prepDWORDin準備する更新の種類を指定する値。JET_prepInsertやJET_prepReplace等で挿入や置換を選ぶ。

戻り値の型: INT

公式ドキュメント

JetPrepareUpdate 関数は、新しいレコードを挿入する、または既存のレコードを新しい値で置き換える目的で更新を実行する際の、最初の操作です。更新は、JetPrepareUpdate を呼び出し、続いて JetSetColumn または JetSetColumns を 0 回以上呼び出し、最後に JetUpdate を呼び出して操作を完了することで行います。JetPrepareUpdate と JetUpdate は更新操作の境界を定めるものであり、レコードの最終的な更新状態だけをインデックスに登録するうえで重要です。これはより効率的であるだけでなく、複数回の列設定操作を通じてデータが有効な状態に一致していなければならない場合には必須でもあります。

戻り値

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

戻り値コード

説明

JET_errSuccess

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

JET_errAlreadyPrepared

JetPrepareUpdate が、JET_prepCancel 以外の有効な準備フラグで呼び出されましたが、カーソルは既に準備済みの状態でした。

JET_errClientRequestToStopJetService

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

JET_errInstanceUnavailable

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

JET_errInvalidParameter

指定された準備フラグが有効なフラグではありません。

JET_errNotInitialized

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

JET_errNotInTransaction

JetPrepareUpdate が、SLV 列を持つレコードを置き換えるために呼び出されました。SLV 列。なお、SLV 列は一般的な用途を想定した機能ではありません。この機能は Microsoft Exchange のインフラストラクチャをサポートするためのものであり、アプリケーションで使用することを意図していません。

JET_errRestoreInProgress

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

JET_errRollbackError

JetPrepareUpdate が JET_prepCancel を指定して呼び出されましたが、JET_coltypLongText 型の列および JET_coltypLongBinary 型の列に対して行われたすべての変更をロールバックできませんでした。

JET_errSessionSharingViolation

このフラグは、同一のセッションに対して複数のスレッドから同時に使用することはできません。このエラーは Windows XP 以降のリリースでのみ返されます。

JET_errTermInProgress

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

JET_errUpdateNotPrepared

JetPrepareUpdate が JET_prepCancel を指定して呼び出されましたが、カーソルは準備済みの状態ではありませんでした。

成功した場合、カーソルは目的の更新のために準備済みの状態に変更されます。JET_prepCancel の場合は、カーソルは準備されていない状態に戻され、変更はすべて破棄されます。

失敗した場合、カーソルの状態は変更されません。失敗が JET_errRollbackError であった場合は、カーソルの状態は準備されていない状態に変更されますが、すべての変更が元に戻されたわけではありません。

解説

レコードのコピーを挿入することは、レコードが JET_coltypLongText 型および JET_coltypLongBinary 型のデータを共有している場合に重要な最適化となります。この種のデータはサイズが大きい場合にレコード外に格納され、複数のレコードが同じ物理的なデータ表現を共有することがあります。この場合、どちらのレコードからでもデータを更新できますが、更新するとデータが分離され、各レコードがそれぞれ独自のコピーを持つようになります。あるレコードでの変更によって別のレコードのデータを変更することはできません。また、あるレコードの更新によって別のレコードの更新をブロックすることもできません。これは ESE の中心的な機能であり、レコード レベル ロック (Record Level Locking) と呼ばれます。

JetUpdate 操作が失敗した場合、カーソルは更新の準備済み状態のまま残ります。これは、誤った列の値などの一部のエラーを、更新状態を再構築せずに訂正できるようにするためです。つまり、カーソルが更新を中止するすべての場合において、JET_prepCancel を指定して JetPrepareUpdate を明示的に呼び出す必要があります。

要件

要件 値

クライアント

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
JetRetrieveColumn
JetSetColumn
JetUpdate

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

各言語での呼び出し定義

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

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

JetPrepareUpdate = ctypes.windll.esent.JetPrepareUpdate
JetPrepareUpdate.restype = ctypes.c_int
JetPrepareUpdate.argtypes = [
    ctypes.c_size_t,  # sesid : JET_SESID
    ctypes.c_size_t,  # tableid : JET_TABLEID
    wintypes.DWORD,  # prep : DWORD
]
require 'fiddle'
require 'fiddle/import'

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

var (
	esent = windows.NewLazySystemDLL("ESENT.dll")
	procJetPrepareUpdate = esent.NewProc("JetPrepareUpdate")
)

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

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

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

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