ホーム › Storage.Jet › JetEnableMultiInstanceW

JetEnableMultiInstanceW

関数

ESEのマルチインスタンス動作を有効化しパラメーターを設定する。

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

シグネチャ

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

INT JetEnableMultiInstanceW(
    JET_SETSYSPARAM_W* psetsysparam,   // optional
    DWORD csetsysparam,
    DWORD* pcsetsucceed   // optional
);

パラメーター

名前	型	方向	説明
psetsysparam	JET_SETSYSPARAM_W*	inoptional	マルチインスタンス有効化時に設定するシステムパラメータ配列(JET_SETSYSPARAM_W)へのポインタ。
csetsysparam	DWORD	in	psetsysparam配列の要素数。
pcsetsucceed	DWORD*	outoptional	正常に設定できたパラメータ数を受け取るDWORDポインタ。

戻り値の型: INT

公式ドキュメント

JetEnableMultiInstance 関数は、同一プロセス内で複数のインスタンスを使用できるようにデータベースエンジンを構成します。最初の呼び出し元は、マルチインスタンスモードへの変更に合わせて、オプションでグローバルシステムパラメーターの配列を指定できます。

戻り値

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

戻り値コード	説明
JET_errSuccess	操作は正常に完了しました。
JET_errIndexTuplesInvalidLimits	指定されたタプルインデックスのパラメーターは許可されていません。このエラーは、JET_paramIndexTuplesLengthMin、JET_paramIndexTuplesLengthMax、または JET_paramIndexTuplesToIndexMax に不正な値を設定した場合にのみ、JetEnableMultiInstance から返されます。 Windows XP: この戻り値は Windows XP で導入されました。
JET_errInvalidPath	指定されたファイルシステムのパスが無効です。このエラーは、ファイルシステムのパスを表すシステムパラメーターを設定した場合にのみ、JetEnableMultiInstance から返されます。たとえば、JET_paramSystemPath はこのエラーを返すことがあります。
JET_errRunningInOneInstanceMode	データベースエンジンがシングルインスタンスモード (Windows 2000 互換モード) で動作している場合、この操作は許可されていないため失敗しました。
JET_errSystemParamsAlreadySet	エンジンが既にマルチインスタンスモードであるため、JetEnableMultiInstance は失敗しました。注意これは、システムパラメーターが 1 つも指定されていない場合でも発生します。

この関数が成功すると、データベースエンジンはマルチインスタンスモードで動作するように構成されます。また、オプションで指定したグローバルシステムパラメーターの一覧による構成も正常に行われています。

この関数が失敗した場合、データベースエンジンは現在のモードのままになります。pcsetsucceed が 0 以外の場合、その数のシステムパラメーターは設定されたままになります。

解説

この関数は、同一プロセス内のマルチユーザーシナリオで使用するためにデータベースエンジンをセットアップする際に、指定した一連のシステムパラメーターをアトミックに構成する必要がある場合にのみ使用してください。他の同期手段が利用できる場合は、JetCreateInstance と JetSetSystemParameter を個別に呼び出すことをお勧めします。

要件

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

各言語での呼び出し定義

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

INT JetEnableMultiInstanceW(
    JET_SETSYSPARAM_W* psetsysparam,   // optional
    DWORD csetsysparam,
    DWORD* pcsetsucceed   // optional
);

[DllImport("ESENT.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern int JetEnableMultiInstanceW(
    IntPtr psetsysparam,   // JET_SETSYSPARAM_W* optional
    uint csetsysparam,   // DWORD
    IntPtr pcsetsucceed   // DWORD* optional, out
);

<DllImport("ESENT.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function JetEnableMultiInstanceW(
    psetsysparam As IntPtr,   ' JET_SETSYSPARAM_W* optional
    csetsysparam As UInteger,   ' DWORD
    pcsetsucceed As IntPtr   ' DWORD* optional, out
) As Integer
End Function

' psetsysparam : JET_SETSYSPARAM_W* optional
' csetsysparam : DWORD
' pcsetsucceed : DWORD* optional, out
Declare PtrSafe Function JetEnableMultiInstanceW Lib "esent" ( _
    ByVal psetsysparam As LongPtr, _
    ByVal csetsysparam As Long, _
    ByVal pcsetsucceed As LongPtr) 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

JetEnableMultiInstanceW = ctypes.windll.esent.JetEnableMultiInstanceW
JetEnableMultiInstanceW.restype = ctypes.c_int
JetEnableMultiInstanceW.argtypes = [
    ctypes.c_void_p,  # psetsysparam : JET_SETSYSPARAM_W* optional
    wintypes.DWORD,  # csetsysparam : DWORD
    ctypes.POINTER(wintypes.DWORD),  # pcsetsucceed : DWORD* optional, out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ESENT.dll')
JetEnableMultiInstanceW = Fiddle::Function.new(
  lib['JetEnableMultiInstanceW'],
  [
    Fiddle::TYPE_VOIDP,  # psetsysparam : JET_SETSYSPARAM_W* optional
    -Fiddle::TYPE_INT,  # csetsysparam : DWORD
    Fiddle::TYPE_VOIDP,  # pcsetsucceed : DWORD* optional, out
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "esent")]
extern "system" {
    fn JetEnableMultiInstanceW(
        psetsysparam: *mut JET_SETSYSPARAM_W,  // JET_SETSYSPARAM_W* optional
        csetsysparam: u32,  // DWORD
        pcsetsucceed: *mut u32  // DWORD* optional, out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("ESENT.dll", CharSet = CharSet.Unicode)]
public static extern int JetEnableMultiInstanceW(IntPtr psetsysparam, uint csetsysparam, IntPtr pcsetsucceed);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ESENT_JetEnableMultiInstanceW' -Namespace Win32 -PassThru
# $api::JetEnableMultiInstanceW(psetsysparam, csetsysparam, pcsetsucceed)

#uselib "ESENT.dll"
#func global JetEnableMultiInstanceW "JetEnableMultiInstanceW" wptr, wptr, wptr
; JetEnableMultiInstanceW varptr(psetsysparam), csetsysparam, varptr(pcsetsucceed)   ; 戻り値は stat
; psetsysparam : JET_SETSYSPARAM_W* optional -> "wptr"
; csetsysparam : DWORD -> "wptr"
; pcsetsucceed : DWORD* optional, out -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

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