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

JetOpenDatabaseA

関数
アタッチ済みのデータベースを開く(ANSI版)。
DLLESENT.dll文字セットANSI (-A)呼出規約winapi

シグネチャ

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

INT JetOpenDatabaseA(
    JET_SESID sesid,
    CHAR* szFilename,
    CHAR* szConnect,   // optional
    DWORD* pdbid,
    DWORD grbit
);

パラメーター

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

戻り値の型: 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) として実装されています。

関連項目

JET_ERR
JET_GRBIT
JET_SESID
JET_TABLEID
JetAttachDatabase
JetAttachDatabase2
JetSetSystemParameter
System Parameters

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

各言語での呼び出し定義

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

INT JetOpenDatabaseA(
    JET_SESID sesid,
    CHAR* szFilename,
    CHAR* szConnect,   // optional
    DWORD* pdbid,
    DWORD grbit
);
[DllImport("ESENT.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern int JetOpenDatabaseA(
    UIntPtr sesid,   // JET_SESID
    IntPtr szFilename,   // CHAR*
    IntPtr szConnect,   // CHAR* optional
    out uint pdbid,   // DWORD* out
    uint grbit   // DWORD
);
<DllImport("ESENT.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function JetOpenDatabaseA(
    sesid As UIntPtr,   ' JET_SESID
    szFilename As IntPtr,   ' CHAR*
    szConnect As IntPtr,   ' CHAR* optional
    <Out> ByRef pdbid As UInteger,   ' DWORD* out
    grbit As UInteger   ' DWORD
) As Integer
End Function
' sesid : JET_SESID
' szFilename : CHAR*
' szConnect : CHAR* optional
' pdbid : DWORD* out
' grbit : DWORD
Declare PtrSafe Function JetOpenDatabaseA Lib "esent" ( _
    ByVal sesid As LongPtr, _
    ByVal szFilename As LongPtr, _
    ByVal szConnect As LongPtr, _
    ByRef pdbid As Long, _
    ByVal grbit As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

JetOpenDatabaseA = ctypes.windll.esent.JetOpenDatabaseA
JetOpenDatabaseA.restype = ctypes.c_int
JetOpenDatabaseA.argtypes = [
    ctypes.c_size_t,  # sesid : JET_SESID
    ctypes.POINTER(ctypes.c_byte),  # szFilename : CHAR*
    ctypes.POINTER(ctypes.c_byte),  # szConnect : CHAR* optional
    ctypes.POINTER(wintypes.DWORD),  # pdbid : DWORD* out
    wintypes.DWORD,  # grbit : DWORD
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ESENT.dll')
JetOpenDatabaseA = Fiddle::Function.new(
  lib['JetOpenDatabaseA'],
  [
    Fiddle::TYPE_UINTPTR_T,  # sesid : JET_SESID
    Fiddle::TYPE_VOIDP,  # szFilename : CHAR*
    Fiddle::TYPE_VOIDP,  # szConnect : CHAR* optional
    Fiddle::TYPE_VOIDP,  # pdbid : DWORD* out
    -Fiddle::TYPE_INT,  # grbit : DWORD
  ],
  Fiddle::TYPE_INT)
#[link(name = "esent")]
extern "system" {
    fn JetOpenDatabaseA(
        sesid: usize,  // JET_SESID
        szFilename: *mut i8,  // CHAR*
        szConnect: *mut i8,  // CHAR* 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.Ansi)]
public static extern int JetOpenDatabaseA(UIntPtr sesid, IntPtr szFilename, IntPtr szConnect, out uint pdbid, uint grbit);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ESENT_JetOpenDatabaseA' -Namespace Win32 -PassThru
# $api::JetOpenDatabaseA(sesid, szFilename, szConnect, pdbid, grbit)
#uselib "ESENT.dll"
#func global JetOpenDatabaseA "JetOpenDatabaseA" sptr, sptr, sptr, sptr, sptr
; JetOpenDatabaseA sesid, varptr(szFilename), varptr(szConnect), varptr(pdbid), grbit   ; 戻り値は stat
; sesid : JET_SESID -> "sptr"
; szFilename : CHAR* -> "sptr"
; szConnect : CHAR* optional -> "sptr"
; pdbid : DWORD* out -> "sptr"
; grbit : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "ESENT.dll"
#cfunc global JetOpenDatabaseA "JetOpenDatabaseA" sptr, var, var, var, int
; res = JetOpenDatabaseA(sesid, szFilename, szConnect, pdbid, grbit)
; sesid : JET_SESID -> "sptr"
; szFilename : CHAR* -> "var"
; szConnect : CHAR* optional -> "var"
; pdbid : DWORD* out -> "var"
; grbit : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; INT JetOpenDatabaseA(JET_SESID sesid, CHAR* szFilename, CHAR* szConnect, DWORD* pdbid, DWORD grbit)
#uselib "ESENT.dll"
#cfunc global JetOpenDatabaseA "JetOpenDatabaseA" intptr, var, var, var, int
; res = JetOpenDatabaseA(sesid, szFilename, szConnect, pdbid, grbit)
; sesid : JET_SESID -> "intptr"
; szFilename : CHAR* -> "var"
; szConnect : CHAR* optional -> "var"
; pdbid : DWORD* out -> "var"
; grbit : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	esent = windows.NewLazySystemDLL("ESENT.dll")
	procJetOpenDatabaseA = esent.NewProc("JetOpenDatabaseA")
)

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

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

foreign import stdcall safe "JetOpenDatabaseA"
  c_JetOpenDatabaseA :: CUIntPtr -> Ptr Int8 -> Ptr Int8 -> Ptr Word32 -> Word32 -> IO Int32
-- sesid : JET_SESID -> CUIntPtr
-- szFilename : CHAR* -> Ptr Int8
-- szConnect : CHAR* optional -> Ptr Int8
-- pdbid : DWORD* out -> Ptr Word32
-- grbit : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let jetopendatabasea =
  foreign "JetOpenDatabaseA"
    (size_t @-> (ptr int8_t) @-> (ptr int8_t) @-> (ptr uint32_t) @-> uint32_t @-> returning int32_t)
(* sesid : JET_SESID -> size_t *)
(* szFilename : CHAR* -> (ptr int8_t) *)
(* szConnect : CHAR* optional -> (ptr int8_t) *)
(* pdbid : DWORD* out -> (ptr uint32_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 ("JetOpenDatabaseA" jet-open-database-a :convention :stdcall) :int32
  (sesid :uint64)   ; JET_SESID
  (sz-filename :pointer)   ; CHAR*
  (sz-connect :pointer)   ; CHAR* optional
  (pdbid :pointer)   ; DWORD* out
  (grbit :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $JetOpenDatabaseA = Win32::API::More->new('ESENT',
    'int JetOpenDatabaseA(WPARAM sesid, LPVOID szFilename, LPVOID szConnect, LPVOID pdbid, DWORD grbit)');
# my $ret = $JetOpenDatabaseA->Call($sesid, $szFilename, $szConnect, $pdbid, $grbit);
# sesid : JET_SESID -> WPARAM
# szFilename : CHAR* -> LPVOID
# szConnect : CHAR* optional -> LPVOID
# pdbid : DWORD* out -> LPVOID
# grbit : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

文字セット違い