JetOpenDatabaseW

関数

アタッチ済みのデータベースを開く(Unicode版)。

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

シグネチャ

// ESENT.dll  (Unicode / -W)
#include <windows.h>

INT JetOpenDatabaseW(
    JET_SESID sesid,
    WORD* szFilename,
    WORD* szConnect,   // optional
    DWORD* pdbid,
    DWORD grbit
);

パラメーター

名前	型	方向	説明
sesid	JET_SESID	in	データベースを開くセッションのJET_SESIDハンドル。
szFilename	WORD*	in	開くデータベースファイルのパスを指す終端付きUnicode文字列ポインタ。
szConnect	WORD*	inoptional	予約済みの接続文字列ポインタ。通常はNULLを指定する。
pdbid	DWORD*	out	開いたデータベースのIDを受け取る出力ポインタ(JET_DBID)。
grbit	DWORD	in	オープン動作を制御するビットフラグ。読み取り専用や排他などを指定する。

戻り値の型: INT

公式ドキュメント

JetOpenDatabase 関数は、JetAttachDatabase または JetAttachDatabase2 関数で事前にアタッチされたデータベースを、データベースセッションで使用するために開きます。この関数は、同じデータベースに対して複数回呼び出すことができます。

戻り値

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

リターンコード	説明
JET_errSuccess	操作は正常に完了しました。
JET_errDatabaseInUse	排他アクセスが要求されましたが、許可できませんでした。
JET_errDatabaseInvalidPath	szFilename に無効なパスが指定されました。szFilename は NULL 以外で、有効なファイルを参照している必要があります。
JET_errDatabaseLocked	別のセッションが既にデータベースを排他的に開いています (JET_bitDbExclusive を使用)。
JET_errDatabaseNotFound	データベースが事前にアタッチされていません (JetAttachDatabase を参照)。
JET_errInvalidDatabase	有効なデータベースファイルではないファイルを開こうとしました。
JET_errOneDatabasePerSession	複数のデータベースを開こうとしましたが、JET_paramOneDatabasePerSession が設定されていました。詳細については、System Parameters を参照してください。
JET_wrnFileOpenReadOnly	ファイルは読み取り専用としてアタッチされましたが、JetOpenDatabase は JET_bitDbReadOnly を渡しませんでした。データベースは読み取り専用アクセスで開かれます。

要件

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

各言語での呼び出し定義

// ESENT.dll  (Unicode / -W)
#include <windows.h>

INT JetOpenDatabaseW(
    JET_SESID sesid,
    WORD* szFilename,
    WORD* szConnect,   // optional
    DWORD* pdbid,
    DWORD grbit
);

[DllImport("ESENT.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern int JetOpenDatabaseW(
    UIntPtr sesid,   // JET_SESID
    ref ushort szFilename,   // WORD*
    IntPtr szConnect,   // WORD* optional
    out uint pdbid,   // DWORD* out
    uint grbit   // DWORD
);

<DllImport("ESENT.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function JetOpenDatabaseW(
    sesid As UIntPtr,   ' JET_SESID
    ByRef szFilename As UShort,   ' WORD*
    szConnect As IntPtr,   ' WORD* optional
    <Out> ByRef pdbid As UInteger,   ' DWORD* out
    grbit As UInteger   ' DWORD
) As Integer
End Function

' sesid : JET_SESID
' szFilename : WORD*
' szConnect : WORD* optional
' pdbid : DWORD* out
' grbit : DWORD
Declare PtrSafe Function JetOpenDatabaseW Lib "esent" ( _
    ByVal sesid As LongPtr, _
    ByRef szFilename As Integer, _
    ByVal szConnect As LongPtr, _
    ByRef pdbid As Long, _
    ByVal grbit As Long) As Long
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

JetOpenDatabaseW = ctypes.windll.esent.JetOpenDatabaseW
JetOpenDatabaseW.restype = ctypes.c_int
JetOpenDatabaseW.argtypes = [
    ctypes.c_size_t,  # sesid : JET_SESID
    ctypes.POINTER(ctypes.c_ushort),  # szFilename : WORD*
    ctypes.POINTER(ctypes.c_ushort),  # szConnect : WORD* optional
    ctypes.POINTER(wintypes.DWORD),  # pdbid : DWORD* out
    wintypes.DWORD,  # grbit : DWORD
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ESENT.dll')
JetOpenDatabaseW = Fiddle::Function.new(
  lib['JetOpenDatabaseW'],
  [
    Fiddle::TYPE_UINTPTR_T,  # sesid : JET_SESID
    Fiddle::TYPE_VOIDP,  # szFilename : WORD*
    Fiddle::TYPE_VOIDP,  # szConnect : WORD* optional
    Fiddle::TYPE_VOIDP,  # pdbid : DWORD* out
    -Fiddle::TYPE_INT,  # grbit : DWORD
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "esent")]
extern "system" {
    fn JetOpenDatabaseW(
        sesid: usize,  // JET_SESID
        szFilename: *mut u16,  // WORD*
        szConnect: *mut u16,  // WORD* optional
        pdbid: *mut u32,  // DWORD* out
        grbit: u32  // DWORD
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("ESENT.dll", CharSet = CharSet.Unicode)]
public static extern int JetOpenDatabaseW(UIntPtr sesid, ref ushort szFilename, IntPtr szConnect, out uint pdbid, uint grbit);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ESENT_JetOpenDatabaseW' -Namespace Win32 -PassThru
# $api::JetOpenDatabaseW(sesid, szFilename, szConnect, pdbid, grbit)

#uselib "ESENT.dll"
#func global JetOpenDatabaseW "JetOpenDatabaseW" wptr, wptr, wptr, wptr, wptr
; JetOpenDatabaseW sesid, varptr(szFilename), varptr(szConnect), varptr(pdbid), grbit   ; 戻り値は stat
; sesid : JET_SESID -> "wptr"
; szFilename : WORD* -> "wptr"
; szConnect : WORD* optional -> "wptr"
; pdbid : DWORD* out -> "wptr"
; grbit : DWORD -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

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