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

JetCreateInstanceA

関数
名前付きのESEデータベースインスタンスを作成する(ANSI版)。
DLLESENT.dll文字セットANSI (-A)呼出規約winapi

シグネチャ

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

INT JetCreateInstanceA(
    JET_INSTANCE* pinstance,
    CHAR* szInstanceName   // optional
);

パラメーター

名前型方向説明
pinstanceJET_INSTANCE*out生成されたインスタンスハンドルを受け取るJET_INSTANCEポインタ。
szInstanceNameCHAR*inoptionalインスタンスを識別する一意の名前を指すANSI文字列。NULL可。

戻り値の型: INT

公式ドキュメント

JetCreateInstance 関数は、単一のプロセス内で使用するためのデータベースエンジンの新しいインスタンスを割り当てます。

戻り値

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

戻り値コード

説明

JET_errSuccess

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

JET_errInstanceNameInUse

指定されたインスタンス名は、このプロセスで既に使用されています。

JET_errInvalidParameter

指定されたパラメーターのいずれかに予期しない値が含まれていたか、別のパラメーターの値と組み合わせたときに意味をなさない値が含まれていました。JetCreateInstance の場合、pinstance が NULL であるときにこのエラーが発生することがあります。

JET_errRunningInOneInstanceMode

データベースエンジンが単一インスタンスモード (Windows 2000 互換モード) で動作している場合はこの操作を使用できないため、操作は失敗しました。

JET_errTooManyInstances

インスタンス数が最大値に達しているため、新しいインスタンスを作成できませんでした。サポートされるインスタンスの最大数は、JetSetSystemParameter で JET_paramMaxInstances を使用して構成します。

成功した場合は、新しいインスタンスが割り当てられ、その識別子が返されます。この時点では、そのインスタンスのすべてのシステムパラメーターは、グローバルな既定のシステムパラメーターの値を持ちます。インスタンスを割り当てた後は、後でそれを終了または解放する必要があります。

失敗した場合は、失敗の原因を示すエラーが返され、インスタンスは割り当てられません。

解説

インスタンスは、JetSetSystemParameter 以外の用途で使用する前に、JetInit の呼び出しによって初期化する必要があります。

インスタンスは、JetInit で初期化されていない場合でも、JetTerm 関数の呼び出しによって破棄されます。同時に作成できるインスタンスの最大数は JET_paramMaxInstances によって制御され、これは JetSetSystemParameter の呼び出しで構成できます。インスタンスは、データベースエンジンにおける回復可能性の単位です。インスタンスは、一連のデータベースファイル内のデータの整合性を保護するために使用されるすべてのファイルのライフサイクルを制御します。これらのファイルには、チェックポイントファイルとトランザクションログファイルが含まれます。

この関数が成功すると、この呼び出しの副作用として、データベースエンジンは自動的にマルチインスタンスモードに変更されます。アプリケーションがプロセス内で 1 つのインスタンスのみを許可したい場合は、JetInit を使用して Windows 2000 互換モードでデータベースエンジンを開始してください。

szDisplayName が指定されている場合、イベントログなどの場所や、バックアップアプリケーションなどの他の呼び出し元に対して (JetGetInstanceInfo や JetOSSnapshotFreeze などの関数を通じて) インスタンスを識別するために使用されます。表示名が指定されていない場合は、代わりに一意の szInstanceName が (指定されていれば) 使用され、それも無い場合は空の文字列が返されます。エンジンに実行モードが設定されていなかった場合、この呼び出しの後にマルチインスタンスモードが設定されます。

複数の Jet インスタンスを実行する可能性のあるプロセスにおける典型的な起動シーケンスは、次のとおりです。

開始される最初のインスタンスである場合は、基本的なシステムの初期化と構成を行うために、この呼び出しの中でいくつかの追加手順が実行されます。それらの手順の一部は、JET_errOutOfMemory をはじめとする固有のエラー (上記のエラーも含む) を引き起こす可能性があります。

要件

要件 値

クライアント

Windows Vista または Windows XP が必要です。

サーバー

Windows Server 2008 または Windows Server 2003 が必要です。

ヘッダー

Esent.h で宣言されています。

ライブラリ

ESENT.lib を使用します。

DLL

ESENT.dll が必要です。

Unicode

JetCreateInstanceW (Unicode) および JetCreateInstanceA (ANSI) として実装されています。

関連項目

Extensible Storage Engine Files
JET_ERR
JET_INSTANCE
JetCreateInstance2
JetEnableMultiInstance
JetGetInstanceInfo
JetInit
JetInit2
JetOSSnapshotFreeze
JetSetSystemParameter
JetTerm
JetTerm2

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 JetCreateInstanceA(
    JET_INSTANCE* pinstance,
    CHAR* szInstanceName   // optional
);
[DllImport("ESENT.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern int JetCreateInstanceA(
    out UIntPtr pinstance,   // JET_INSTANCE* out
    IntPtr szInstanceName   // CHAR* optional
);
<DllImport("ESENT.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function JetCreateInstanceA(
    <Out> ByRef pinstance As UIntPtr,   ' JET_INSTANCE* out
    szInstanceName As IntPtr   ' CHAR* optional
) As Integer
End Function
' pinstance : JET_INSTANCE* out
' szInstanceName : CHAR* optional
Declare PtrSafe Function JetCreateInstanceA Lib "esent" ( _
    ByRef pinstance As LongPtr, _
    ByVal szInstanceName As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

JetCreateInstanceA = ctypes.windll.esent.JetCreateInstanceA
JetCreateInstanceA.restype = ctypes.c_int
JetCreateInstanceA.argtypes = [
    ctypes.c_void_p,  # pinstance : JET_INSTANCE* out
    ctypes.POINTER(ctypes.c_byte),  # szInstanceName : CHAR* optional
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ESENT.dll')
JetCreateInstanceA = Fiddle::Function.new(
  lib['JetCreateInstanceA'],
  [
    Fiddle::TYPE_VOIDP,  # pinstance : JET_INSTANCE* out
    Fiddle::TYPE_VOIDP,  # szInstanceName : CHAR* optional
  ],
  Fiddle::TYPE_INT)
#[link(name = "esent")]
extern "system" {
    fn JetCreateInstanceA(
        pinstance: *mut usize,  // JET_INSTANCE* out
        szInstanceName: *mut i8  // CHAR* optional
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("ESENT.dll", CharSet = CharSet.Ansi)]
public static extern int JetCreateInstanceA(out UIntPtr pinstance, IntPtr szInstanceName);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ESENT_JetCreateInstanceA' -Namespace Win32 -PassThru
# $api::JetCreateInstanceA(pinstance, szInstanceName)
#uselib "ESENT.dll"
#func global JetCreateInstanceA "JetCreateInstanceA" sptr, sptr
; JetCreateInstanceA varptr(pinstance), varptr(szInstanceName)   ; 戻り値は stat
; pinstance : JET_INSTANCE* out -> "sptr"
; szInstanceName : CHAR* optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "ESENT.dll"
#cfunc global JetCreateInstanceA "JetCreateInstanceA" var, var
; res = JetCreateInstanceA(pinstance, szInstanceName)
; pinstance : JET_INSTANCE* out -> "var"
; szInstanceName : CHAR* optional -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; INT JetCreateInstanceA(JET_INSTANCE* pinstance, CHAR* szInstanceName)
#uselib "ESENT.dll"
#cfunc global JetCreateInstanceA "JetCreateInstanceA" var, var
; res = JetCreateInstanceA(pinstance, szInstanceName)
; pinstance : JET_INSTANCE* out -> "var"
; szInstanceName : CHAR* optional -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	esent = windows.NewLazySystemDLL("ESENT.dll")
	procJetCreateInstanceA = esent.NewProc("JetCreateInstanceA")
)

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

extern "esent" fn JetCreateInstanceA(
    pinstance: [*c]usize, // JET_INSTANCE* out
    szInstanceName: [*c]i8 // CHAR* optional
) callconv(std.os.windows.WINAPI) i32;
proc JetCreateInstanceA(
    pinstance: ptr uint,  # JET_INSTANCE* out
    szInstanceName: ptr int8  # CHAR* optional
): int32 {.importc: "JetCreateInstanceA", stdcall, dynlib: "ESENT.dll".}
pragma(lib, "esent");
extern(Windows)
int JetCreateInstanceA(
    size_t* pinstance,   // JET_INSTANCE* out
    byte* szInstanceName   // CHAR* optional
);
ccall((:JetCreateInstanceA, "ESENT.dll"), stdcall, Int32,
      (Ptr{Csize_t}, Ptr{Int8}),
      pinstance, szInstanceName)
# pinstance : JET_INSTANCE* out -> Ptr{Csize_t}
# szInstanceName : CHAR* optional -> Ptr{Int8}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t JetCreateInstanceA(
    uintptr_t* pinstance,
    int8_t* szInstanceName);
]]
local esent = ffi.load("esent")
-- esent.JetCreateInstanceA(pinstance, szInstanceName)
-- pinstance : JET_INSTANCE* out
-- szInstanceName : CHAR* optional
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('ESENT.dll');
const JetCreateInstanceA = lib.func('__stdcall', 'JetCreateInstanceA', 'int32_t', ['uintptr_t *', 'int8_t *']);
// JetCreateInstanceA(pinstance, szInstanceName)
// pinstance : JET_INSTANCE* out -> 'uintptr_t *'
// szInstanceName : CHAR* optional -> 'int8_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("ESENT.dll", {
  JetCreateInstanceA: { parameters: ["pointer", "pointer"], result: "i32" },
});
// lib.symbols.JetCreateInstanceA(pinstance, szInstanceName)
// pinstance : JET_INSTANCE* out -> "pointer"
// szInstanceName : CHAR* optional -> "pointer"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t JetCreateInstanceA(
    size_t* pinstance,
    int8_t* szInstanceName);
C, "ESENT.dll");
// $ffi->JetCreateInstanceA(pinstance, szInstanceName);
// pinstance : JET_INSTANCE* out
// szInstanceName : CHAR* optional
// 構造体/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 JetCreateInstanceA(
        LongByReference pinstance,   // JET_INSTANCE* out
        byte[] szInstanceName   // CHAR* optional
    );
}
@[Link("esent")]
lib LibESENT
  fun JetCreateInstanceA = JetCreateInstanceA(
    pinstance : LibC::SizeT*,   # JET_INSTANCE* out
    szInstanceName : Int8*   # CHAR* optional
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef JetCreateInstanceANative = Int32 Function(Pointer<UintPtr>, Pointer<Int8>);
typedef JetCreateInstanceADart = int Function(Pointer<UintPtr>, Pointer<Int8>);
final JetCreateInstanceA = DynamicLibrary.open('ESENT.dll')
    .lookupFunction<JetCreateInstanceANative, JetCreateInstanceADart>('JetCreateInstanceA');
// pinstance : JET_INSTANCE* out -> Pointer<UintPtr>
// szInstanceName : CHAR* optional -> Pointer<Int8>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function JetCreateInstanceA(
  pinstance: Pointer;   // JET_INSTANCE* out
  szInstanceName: Pointer   // CHAR* optional
): Integer; stdcall;
  external 'ESENT.dll' name 'JetCreateInstanceA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "JetCreateInstanceA"
  c_JetCreateInstanceA :: Ptr CUIntPtr -> Ptr Int8 -> IO Int32
-- pinstance : JET_INSTANCE* out -> Ptr CUIntPtr
-- szInstanceName : CHAR* optional -> Ptr Int8
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let jetcreateinstancea =
  foreign "JetCreateInstanceA"
    ((ptr size_t) @-> (ptr int8_t) @-> returning int32_t)
(* pinstance : JET_INSTANCE* out -> (ptr size_t) *)
(* szInstanceName : CHAR* optional -> (ptr int8_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library esent (t "ESENT.dll"))
(cffi:use-foreign-library esent)

(cffi:defcfun ("JetCreateInstanceA" jet-create-instance-a :convention :stdcall) :int32
  (pinstance :pointer)   ; JET_INSTANCE* out
  (sz-instance-name :pointer))   ; CHAR* optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $JetCreateInstanceA = Win32::API::More->new('ESENT',
    'int JetCreateInstanceA(LPVOID pinstance, LPVOID szInstanceName)');
# my $ret = $JetCreateInstanceA->Call($pinstance, $szInstanceName);
# pinstance : JET_INSTANCE* out -> LPVOID
# szInstanceName : CHAR* optional -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

文字セット違い
類似 API