JetOpenTableA

関数

データベース内のテーブルを開きカーソルを取得する(ANSI版)。

DLLESENT.dll文字セットANSI (-A)呼出規約winapi

シグネチャ

// ESENT.dll  (ANSI / -A)
#include <windows.h>

INT JetOpenTableA(
    JET_SESID sesid,
    DWORD dbid,
    CHAR* szTableName,
    void* pvParameters,   // optional
    DWORD cbParameters,
    DWORD grbit,
    JET_TABLEID* ptableid
);

パラメーター

名前	型	方向	説明
sesid	JET_SESID	in	テーブルを開くセッションのJET_SESIDハンドル。
dbid	DWORD	in	テーブルが属するデータベースを識別するデータベースID(JET_DBID)。
szTableName	CHAR*	in	開くテーブルの名前を指す終端付きANSI文字列ポインタ。
pvParameters	void*	inoptional	予約済みのパラメータバッファポインタ。通常はNULLを指定する。
cbParameters	DWORD	in	pvParametersバッファのサイズをバイト単位で指定する値。通常0。
grbit	DWORD	in	オープン動作を制御するビットフラグ。JET_bitTableUpdatable等でアクセス権を指定する。
ptableid	JET_TABLEID*	out	開いたテーブルのカーソルを受け取る出力ポインタ(JET_TABLEID)。

戻り値の型: INT

公式ドキュメント

JetOpenTable 関数は、既に作成されているテーブルに対してカーソルを開きます。

戻り値

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

戻りコード	説明
JET_errSuccess	操作は正常に完了しました。
JET_errInvalidDatabaseId	dbid が有効なデータベース識別子ではありません。
JET_errInvalidgrbit	grbit に不正な組み合わせが渡されました。
JET_errInvalidName	szTableName に指定された名前が無効です。有効なテーブル名の詳細については、JetCreateTable の szTableName パラメーターを参照してください。
JET_errObjectNotFound	データベースに存在しないテーブルを開こうとしました。
JET_errOutOfCursors	新しいカーソルを開くために必要なリソースをエンジンが割り当てられなかったため、操作が失敗しました。「解説」セクションを参照してください。
JET_errTableInUse	そのテーブルは別のデータベース操作によって使用されています。
JET_wrnTableInUseBySystem	そのテーブルがシステムによって使用されていることを示す、致命的でない警告です。
JET_errTableLocked	そのテーブルは別のデータベース操作によってロックされています。
JET_errTooManyOpenTables	一度に開くことのできる一意のテーブルの数を超えて開こうとしました。「解説」セクションを参照してください。

解説

JetOpenTable で開いたテーブルは、通常 JetCloseTable で閉じる必要があります。この規則の例外は、JetOpenTable をトランザクション内で呼び出し、そのトランザクションが (JetRollback によって) ロールバックされた場合です。トランザクションをロールバックすると、テーブルは自動的に閉じられます。この場合、JetCloseTable でテーブルを閉じるとエラーになります。

JetOpenTable でシステムテーブル (MSysObjects、MSysUnicodeFixup など) を開くことは可能です。ただし、システムテーブルのスキーマは変更される可能性があるため、システムテーブルへのアクセスは推奨されません。同時に開くことのできる一意のテーブルの数は、JET_paramMaxOpenTables の影響を直接受けます。テーブルが既に開かれている場合は、そのテーブルに対して新しいカーソルが作成されます。カーソルのリソースは、JetSetSystemParameter と JET_paramMaxCursors を使用して構成します。JetDupCursor も参照してください。

要件

要件	値
Client	Windows Vista、Windows XP、または Windows 2000 Professional が必要です。
Server	Windows Server 2008、Windows Server 2003、または Windows 2000 Server が必要です。
Header	Esent.h で宣言されています。
Library	ESENT.lib を使用します。
DLL	ESENT.dll が必要です。
Unicode	JetOpenTableW (Unicode) および JetOpenTableA (ANSI) として実装されています。

各言語での呼び出し定義

// ESENT.dll  (ANSI / -A)
#include <windows.h>

INT JetOpenTableA(
    JET_SESID sesid,
    DWORD dbid,
    CHAR* szTableName,
    void* pvParameters,   // optional
    DWORD cbParameters,
    DWORD grbit,
    JET_TABLEID* ptableid
);

[DllImport("ESENT.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern int JetOpenTableA(
    UIntPtr sesid,   // JET_SESID
    uint dbid,   // DWORD
    IntPtr szTableName,   // CHAR*
    IntPtr pvParameters,   // void* optional
    uint cbParameters,   // DWORD
    uint grbit,   // DWORD
    out UIntPtr ptableid   // JET_TABLEID* out
);

<DllImport("ESENT.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function JetOpenTableA(
    sesid As UIntPtr,   ' JET_SESID
    dbid As UInteger,   ' DWORD
    szTableName As IntPtr,   ' CHAR*
    pvParameters As IntPtr,   ' void* optional
    cbParameters As UInteger,   ' DWORD
    grbit As UInteger,   ' DWORD
    <Out> ByRef ptableid As UIntPtr   ' JET_TABLEID* out
) As Integer
End Function

' sesid : JET_SESID
' dbid : DWORD
' szTableName : CHAR*
' pvParameters : void* optional
' cbParameters : DWORD
' grbit : DWORD
' ptableid : JET_TABLEID* out
Declare PtrSafe Function JetOpenTableA Lib "esent" ( _
    ByVal sesid As LongPtr, _
    ByVal dbid As Long, _
    ByVal szTableName As LongPtr, _
    ByVal pvParameters As LongPtr, _
    ByVal cbParameters As Long, _
    ByVal grbit As Long, _
    ByRef ptableid As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

JetOpenTableA = ctypes.windll.esent.JetOpenTableA
JetOpenTableA.restype = ctypes.c_int
JetOpenTableA.argtypes = [
    ctypes.c_size_t,  # sesid : JET_SESID
    wintypes.DWORD,  # dbid : DWORD
    ctypes.POINTER(ctypes.c_byte),  # szTableName : CHAR*
    ctypes.POINTER(None),  # pvParameters : void* optional
    wintypes.DWORD,  # cbParameters : DWORD
    wintypes.DWORD,  # grbit : DWORD
    ctypes.c_void_p,  # ptableid : JET_TABLEID* out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ESENT.dll')
JetOpenTableA = Fiddle::Function.new(
  lib['JetOpenTableA'],
  [
    Fiddle::TYPE_UINTPTR_T,  # sesid : JET_SESID
    -Fiddle::TYPE_INT,  # dbid : DWORD
    Fiddle::TYPE_VOIDP,  # szTableName : CHAR*
    Fiddle::TYPE_VOIDP,  # pvParameters : void* optional
    -Fiddle::TYPE_INT,  # cbParameters : DWORD
    -Fiddle::TYPE_INT,  # grbit : DWORD
    Fiddle::TYPE_VOIDP,  # ptableid : JET_TABLEID* out
  ],
  Fiddle::TYPE_INT)

#[link(name = "esent")]
extern "system" {
    fn JetOpenTableA(
        sesid: usize,  // JET_SESID
        dbid: u32,  // DWORD
        szTableName: *mut i8,  // CHAR*
        pvParameters: *mut (),  // void* optional
        cbParameters: u32,  // DWORD
        grbit: u32,  // DWORD
        ptableid: *mut usize  // JET_TABLEID* out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("ESENT.dll", CharSet = CharSet.Ansi)]
public static extern int JetOpenTableA(UIntPtr sesid, uint dbid, IntPtr szTableName, IntPtr pvParameters, uint cbParameters, uint grbit, out UIntPtr ptableid);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ESENT_JetOpenTableA' -Namespace Win32 -PassThru
# $api::JetOpenTableA(sesid, dbid, szTableName, pvParameters, cbParameters, grbit, ptableid)

#uselib "ESENT.dll"
#func global JetOpenTableA "JetOpenTableA" sptr, sptr, sptr, sptr, sptr, sptr, sptr
; JetOpenTableA sesid, dbid, varptr(szTableName), pvParameters, cbParameters, grbit, varptr(ptableid)   ; 戻り値は stat
; sesid : JET_SESID -> "sptr"
; dbid : DWORD -> "sptr"
; szTableName : CHAR* -> "sptr"
; pvParameters : void* optional -> "sptr"
; cbParameters : DWORD -> "sptr"
; grbit : DWORD -> "sptr"
; ptableid : JET_TABLEID* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

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