JetOpenTempTable3

関数

Unicodeインデックス指定付きで一時テーブルを開く。

DLLESENT.dll呼出規約winapi

シグネチャ

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

INT JetOpenTempTable3(
    JET_SESID sesid,
    const JET_COLUMNDEF* prgcolumndef,
    DWORD ccolumn,
    JET_UNICODEINDEX* pidxunicode,   // optional
    DWORD grbit,
    JET_TABLEID* ptableid,
    DWORD* prgcolumnid
);

パラメーター

名前	型	方向	説明
sesid	JET_SESID	in	一時テーブル作成を行うセッションのJET_SESIDハンドル。
prgcolumndef	JET_COLUMNDEF*	in	一時テーブルの列定義を保持するJET_COLUMNDEF配列のポインタ。
ccolumn	DWORD	in	prgcolumndef配列の列数を指定する値。
pidxunicode	JET_UNICODEINDEX*	inoptional	Unicode並べ替えのロケールと正規化オプションを指定するJET_UNICODEINDEX構造体ポインタ。NULL可。
grbit	DWORD	in	一時テーブル動作を制御するビットフラグ。並べ替えや一意性などを指定する。
ptableid	JET_TABLEID*	out	作成された一時テーブルのカーソルを受け取る出力ポインタ(JET_TABLEID)。
prgcolumnid	DWORD*	out	各列に割り当てられた列IDを受け取るDWORD配列の出力ポインタ。

戻り値の型: INT

公式ドキュメント

JetOpenTempTable3 関数は、単一のインデックスを持つ一時テーブルを作成します。この一時テーブルは、JetCreateTableColumnIndex で作成された通常のテーブルと同じようにレコードの格納と取得に使用できます。ただし、一時テーブルは揮発性であるため、通常のテーブルよりもはるかに高速です。また、完全にシーケンシャルな方法でアクセスする場合には、レコードセットの並べ替えや重複除去を非常に高速に行うためにも使用できます。

戻り値

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

戻りコード	説明
JET_errSuccess	操作は正常に完了しました。
JET_errCannotMaterializeForwardOnlySort	JET_bitTTForwardOnly が指定されていましたが、指定された内容の一時テーブルを前方専用の最適化を使用して作成できなかったため、JetOpenTempTable3 は失敗しました。このエラーは Windows Server 2003 以降のリリースでのみ返されます。
JET_errClientRequestToStopJetService	JetStopService の呼び出しの結果、セッションに関連付けられたインスタンス上のすべての動作が停止しているため、操作を完了できません。
JET_errIndexInvalidDef	無効なインデックス定義が指定されたため、インデックスを作成できませんでした。JetOpenTempTable3 は次の場合にこのエラーを返します。 Language Neutral ロケールが指定された場合。無効な正規化フラグの組み合わせが指定された場合。このエラーは Windows 2000 でのみ返されます。
JET_errInstanceUnavailable	セッションに関連付けられたインスタンスで、データの整合性を保護するためにすべてのデータへのアクセスを取り消す必要がある致命的なエラーが発生したため、操作を完了できません。このエラーは Windows XP 以降のリリースでのみ返されます。
JET_errInvalidCodePage	JET_COLUMNDEF 構造体の cp メンバーに有効なコードページが設定されていませんでした。テキスト列で有効な値は英語 (1252) と Unicode (1200) のみです。値 0 は既定値 (英語、1252) が使用されることを意味します。
JET_errInvalidColumnType	JET_COLUMNDEF 構造体の coltyp メンバーに有効な列の型が設定されていませんでした。
JET_errInvalidLanguageId	無効なロケール ID を使用しようとしたため、インデックスを作成できませんでした。ロケール ID が完全に無効であるか、関連する言語パックがインストールされていない可能性があります。
JET_errInvalidLCMapStringFlags	無効な正規化フラグの組み合わせを使用しようとしたため、インデックスを作成できませんでした。このエラーは Windows XP 以降のリリースでのみ返されます。Windows 2000 では、無効な正規化フラグの場合は代わりに JET_errIndexInvalidDef が返されます。
JET_errInvalidSesid	セッションハンドルが無効であるか、閉じられたセッションを参照しています。このエラーはすべての状況で返されるわけではありません。ハンドルの検証はベストエフォートでのみ行われます。
JET_errNotInitialized	セッションに関連付けられたインスタンスがまだ初期化されていないため、操作を完了できません。
JET_errOutOfCursors	新しいカーソルを開くために必要なリソースをエンジンが割り当てられないため、操作は失敗しました。カーソルのリソースは、JetSetSystemParameter に JET_paramMaxCursors を指定して構成します。
JET_errOutOfMemory	操作を完了するのに十分なメモリを割り当てられなかったため、操作は失敗しました。ホストプロセスのアドレス空間の断片化が進みすぎた場合、JetOpenTempTable3 は JET_errOutOfMemory を返すことがあります。一時テーブルマネージャーは、格納するデータ量にかかわらず、作成される一時テーブルごとに常に 1MB のアドレス空間を割り当てます。
JET_errRestoreInProgress	セッションに関連付けられたインスタンスで復元操作が進行中であるため、操作を完了できません。
JET_errSessionSharingViolation	同じセッションを同時に複数のスレッドで使用することはできません。このエラーは Windows XP 以降のリリースでのみ返されます。
JET_errTermInProgress	セッションに関連付けられたインスタンスがシャットダウン中であるため、操作を完了できません。
JET_errTooManyColumns	テーブルに多すぎる列を追加しようとしました。1 つのテーブルに持てるのは、固定長列が JET_ccolFixedMost 個まで、可変長列が JET_ccolVarMost 個まで、タグ付き列が JET_ccolTaggedMost 個までです。
JET_errTooManyOpenIndexes	テーブルのインデックスをキャッシュするために必要なリソースをエンジンが割り当てられないため、操作は失敗しました。スキーマをキャッシュできるインデックスの数は、JetSetSystemParameter に JET_paramMaxOpenTables を指定して構成します。
JET_errTooManyOpenTables	テーブルのスキーマをキャッシュするために必要なリソースをエンジンが割り当てられないため、操作は失敗しました。スキーマをキャッシュできるテーブルの数は、JetSetSystemParameter に JET_paramMaxOpenTables を指定して構成します。
JET_errTooManySorts	一時テーブルを作成するために必要なリソースをエンジンが割り当てられないため、操作は失敗しました。一時テーブルのリソースは、JetSetSystemParameter に JET_paramMaxTemporaryTables を指定して構成します。

成功した場合、新しく作成された一時テーブル上に開かれたカーソルが返されます。一時データベースの状態は、新しい一時テーブルを格納できるように準備されます。データベースエンジンが使用している通常のデータベースの状態は変更されません。

失敗した場合、一時テーブルは作成されず、カーソルも返されません。一時データベースの状態は変更される場合があります。データベースエンジンが使用している通常のデータベースの状態は変更されません。

要件

要件	値
クライアント	Windows Vista、Windows XP、または Windows 2000 Professional が必要です。
サーバー	Windows Server 2008、Windows Server 2003、または Windows 2000 Server が必要です。
ヘッダー	Esent.h で宣言されています。
ライブラリ	ESENT.lib を使用します。
DLL	ESENT.dll が必要です。

各言語での呼び出し定義

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

INT JetOpenTempTable3(
    JET_SESID sesid,
    const JET_COLUMNDEF* prgcolumndef,
    DWORD ccolumn,
    JET_UNICODEINDEX* pidxunicode,   // optional
    DWORD grbit,
    JET_TABLEID* ptableid,
    DWORD* prgcolumnid
);

[DllImport("ESENT.dll", ExactSpelling = true)]
static extern int JetOpenTempTable3(
    UIntPtr sesid,   // JET_SESID
    IntPtr prgcolumndef,   // JET_COLUMNDEF*
    uint ccolumn,   // DWORD
    IntPtr pidxunicode,   // JET_UNICODEINDEX* optional
    uint grbit,   // DWORD
    out UIntPtr ptableid,   // JET_TABLEID* out
    out uint prgcolumnid   // DWORD* out
);

<DllImport("ESENT.dll", ExactSpelling:=True)>
Public Shared Function JetOpenTempTable3(
    sesid As UIntPtr,   ' JET_SESID
    prgcolumndef As IntPtr,   ' JET_COLUMNDEF*
    ccolumn As UInteger,   ' DWORD
    pidxunicode As IntPtr,   ' JET_UNICODEINDEX* optional
    grbit As UInteger,   ' DWORD
    <Out> ByRef ptableid As UIntPtr,   ' JET_TABLEID* out
    <Out> ByRef prgcolumnid As UInteger   ' DWORD* out
) As Integer
End Function

' sesid : JET_SESID
' prgcolumndef : JET_COLUMNDEF*
' ccolumn : DWORD
' pidxunicode : JET_UNICODEINDEX* optional
' grbit : DWORD
' ptableid : JET_TABLEID* out
' prgcolumnid : DWORD* out
Declare PtrSafe Function JetOpenTempTable3 Lib "esent" ( _
    ByVal sesid As LongPtr, _
    ByVal prgcolumndef As LongPtr, _
    ByVal ccolumn As Long, _
    ByVal pidxunicode As LongPtr, _
    ByVal grbit As Long, _
    ByRef ptableid As LongPtr, _
    ByRef prgcolumnid As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

JetOpenTempTable3 = ctypes.windll.esent.JetOpenTempTable3
JetOpenTempTable3.restype = ctypes.c_int
JetOpenTempTable3.argtypes = [
    ctypes.c_size_t,  # sesid : JET_SESID
    ctypes.c_void_p,  # prgcolumndef : JET_COLUMNDEF*
    wintypes.DWORD,  # ccolumn : DWORD
    ctypes.c_void_p,  # pidxunicode : JET_UNICODEINDEX* optional
    wintypes.DWORD,  # grbit : DWORD
    ctypes.c_void_p,  # ptableid : JET_TABLEID* out
    ctypes.POINTER(wintypes.DWORD),  # prgcolumnid : DWORD* out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ESENT.dll')
JetOpenTempTable3 = Fiddle::Function.new(
  lib['JetOpenTempTable3'],
  [
    Fiddle::TYPE_UINTPTR_T,  # sesid : JET_SESID
    Fiddle::TYPE_VOIDP,  # prgcolumndef : JET_COLUMNDEF*
    -Fiddle::TYPE_INT,  # ccolumn : DWORD
    Fiddle::TYPE_VOIDP,  # pidxunicode : JET_UNICODEINDEX* optional
    -Fiddle::TYPE_INT,  # grbit : DWORD
    Fiddle::TYPE_VOIDP,  # ptableid : JET_TABLEID* out
    Fiddle::TYPE_VOIDP,  # prgcolumnid : DWORD* out
  ],
  Fiddle::TYPE_INT)

#[link(name = "esent")]
extern "system" {
    fn JetOpenTempTable3(
        sesid: usize,  // JET_SESID
        prgcolumndef: *const JET_COLUMNDEF,  // JET_COLUMNDEF*
        ccolumn: u32,  // DWORD
        pidxunicode: *mut JET_UNICODEINDEX,  // JET_UNICODEINDEX* optional
        grbit: u32,  // DWORD
        ptableid: *mut usize,  // JET_TABLEID* out
        prgcolumnid: *mut u32  // DWORD* out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("ESENT.dll")]
public static extern int JetOpenTempTable3(UIntPtr sesid, IntPtr prgcolumndef, uint ccolumn, IntPtr pidxunicode, uint grbit, out UIntPtr ptableid, out uint prgcolumnid);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ESENT_JetOpenTempTable3' -Namespace Win32 -PassThru
# $api::JetOpenTempTable3(sesid, prgcolumndef, ccolumn, pidxunicode, grbit, ptableid, prgcolumnid)

#uselib "ESENT.dll"
#func global JetOpenTempTable3 "JetOpenTempTable3" sptr, sptr, sptr, sptr, sptr, sptr, sptr
; JetOpenTempTable3 sesid, varptr(prgcolumndef), ccolumn, varptr(pidxunicode), grbit, varptr(ptableid), varptr(prgcolumnid)   ; 戻り値は stat
; sesid : JET_SESID -> "sptr"
; prgcolumndef : JET_COLUMNDEF* -> "sptr"
; ccolumn : DWORD -> "sptr"
; pidxunicode : JET_UNICODEINDEX* optional -> "sptr"
; grbit : DWORD -> "sptr"
; ptableid : JET_TABLEID* out -> "sptr"
; prgcolumnid : DWORD* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "ESENT.dll"
#cfunc global JetOpenTempTable3 "JetOpenTempTable3" sptr, var, int, var, int, var, var
; res = JetOpenTempTable3(sesid, prgcolumndef, ccolumn, pidxunicode, grbit, ptableid, prgcolumnid)
; sesid : JET_SESID -> "sptr"
; prgcolumndef : JET_COLUMNDEF* -> "var"
; ccolumn : DWORD -> "int"
; pidxunicode : JET_UNICODEINDEX* optional -> "var"
; grbit : DWORD -> "int"
; ptableid : JET_TABLEID* out -> "var"
; prgcolumnid : DWORD* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "ESENT.dll"
#cfunc global JetOpenTempTable3 "JetOpenTempTable3" sptr, sptr, int, sptr, int, sptr, sptr
; res = JetOpenTempTable3(sesid, varptr(prgcolumndef), ccolumn, varptr(pidxunicode), grbit, varptr(ptableid), varptr(prgcolumnid))
; sesid : JET_SESID -> "sptr"
; prgcolumndef : JET_COLUMNDEF* -> "sptr"
; ccolumn : DWORD -> "int"
; pidxunicode : JET_UNICODEINDEX* optional -> "sptr"
; grbit : DWORD -> "int"
; ptableid : JET_TABLEID* out -> "sptr"
; prgcolumnid : DWORD* out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。