JetDetachDatabase2A

関数

オプション指定でESEデータベースをデタッチする（ANSI版）。

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

シグネチャ

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

INT JetDetachDatabase2A(
    JET_SESID sesid,
    CHAR* szFilename,   // optional
    DWORD grbit
);

パラメーター

名前	型	方向	説明
sesid	JET_SESID	in	操作に使用するセッションID。
szFilename	CHAR*	inoptional	デタッチするデータベースファイルのパスを指すANSI文字列。NULLで全DBが対象。
grbit	DWORD	in	デタッチ動作を制御するJET_bitForceDetach等のフラグ。

戻り値の型: INT

公式ドキュメント

JetDetachDatabase2 関数は、以前にデータベースセッションへアタッチされたデータベースファイルを解放します。

戻り値

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

戻りコード	説明
JET_errSuccess	操作は正常に完了しました。
JET_errBackupInProgress	データベースはバックアップ中であり、デタッチできません。
JET_errDatabaseInUse	データベースは JetOpenDatabase によって開かれています。デタッチする前にデータベースを閉じる必要があります。
JET_errDatabaseNotFound	データベースは事前にアタッチされていません (JetAttachDatabase または JetAttachDatabase2 を参照してください)。
JET_errForceDetachNotAllowed	JET_bitForceDetach はサポートされていません。
JET_errInTransaction	トランザクション中にデータベースをデタッチしようとしました。

解説

アタッチされたデータベースが (JetAttachDatabase によって) 開かれている場合は、デタッチする前に JetCloseDatabase で閉じる必要があります。

Windows 2000 のみ: JetTerm を呼び出す前にデタッチされなかったデータベースは、次に JetInit が呼び出されたときに自動的に再アタッチされます。

要件

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

各言語での呼び出し定義

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

INT JetDetachDatabase2A(
    JET_SESID sesid,
    CHAR* szFilename,   // optional
    DWORD grbit
);

[DllImport("ESENT.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern int JetDetachDatabase2A(
    UIntPtr sesid,   // JET_SESID
    IntPtr szFilename,   // CHAR* optional
    uint grbit   // DWORD
);

<DllImport("ESENT.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function JetDetachDatabase2A(
    sesid As UIntPtr,   ' JET_SESID
    szFilename As IntPtr,   ' CHAR* optional
    grbit As UInteger   ' DWORD
) As Integer
End Function

' sesid : JET_SESID
' szFilename : CHAR* optional
' grbit : DWORD
Declare PtrSafe Function JetDetachDatabase2A Lib "esent" ( _
    ByVal sesid As LongPtr, _
    ByVal szFilename As LongPtr, _
    ByVal grbit As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

JetDetachDatabase2A = ctypes.windll.esent.JetDetachDatabase2A
JetDetachDatabase2A.restype = ctypes.c_int
JetDetachDatabase2A.argtypes = [
    ctypes.c_size_t,  # sesid : JET_SESID
    ctypes.POINTER(ctypes.c_byte),  # szFilename : CHAR* optional
    wintypes.DWORD,  # grbit : DWORD
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ESENT.dll')
JetDetachDatabase2A = Fiddle::Function.new(
  lib['JetDetachDatabase2A'],
  [
    Fiddle::TYPE_UINTPTR_T,  # sesid : JET_SESID
    Fiddle::TYPE_VOIDP,  # szFilename : CHAR* optional
    -Fiddle::TYPE_INT,  # grbit : DWORD
  ],
  Fiddle::TYPE_INT)

#[link(name = "esent")]
extern "system" {
    fn JetDetachDatabase2A(
        sesid: usize,  // JET_SESID
        szFilename: *mut i8,  // CHAR* optional
        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 JetDetachDatabase2A(UIntPtr sesid, IntPtr szFilename, uint grbit);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ESENT_JetDetachDatabase2A' -Namespace Win32 -PassThru
# $api::JetDetachDatabase2A(sesid, szFilename, grbit)

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

出力引数:

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