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

JetDetachDatabase2W

関数
オプション指定でESEデータベースをデタッチする。
DLLESENT.dll文字セットUnicode (-W)呼出規約winapi

シグネチャ

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

INT JetDetachDatabase2W(
    JET_SESID sesid,
    WORD* szFilename,   // optional
    DWORD grbit
);

パラメーター

名前型方向説明
sesidJET_SESIDin操作に使用するセッションID。
szFilenameWORD*inoptionalデタッチするデータベースファイルのパスを指すワイド文字列(WORD*)。NULLで全DBが対象。
grbitDWORDinデタッチ動作を制御する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 が呼び出されたときに自動的に再アタッチされます。

要件

要件 値

Client

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

Server

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

Header

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

Library

ESENT.lib を使用します。

DLL

ESENT.dll が必要です。

Unicode

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

関連項目

JET_ERR
JET_GRBIT
JET_SESID
JET_TABLEID
JetAttachDatabase
JetAttachDatabase2
JetCloseDatabase
JetCreateDatabase
JetCreateDatabase2
JetInit
JetOpenDatabase
JetTerm

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

各言語での呼び出し定義

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

INT JetDetachDatabase2W(
    JET_SESID sesid,
    WORD* szFilename,   // optional
    DWORD grbit
);
[DllImport("ESENT.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern int JetDetachDatabase2W(
    UIntPtr sesid,   // JET_SESID
    IntPtr szFilename,   // WORD* optional
    uint grbit   // DWORD
);
<DllImport("ESENT.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function JetDetachDatabase2W(
    sesid As UIntPtr,   ' JET_SESID
    szFilename As IntPtr,   ' WORD* optional
    grbit As UInteger   ' DWORD
) As Integer
End Function
' sesid : JET_SESID
' szFilename : WORD* optional
' grbit : DWORD
Declare PtrSafe Function JetDetachDatabase2W Lib "esent" ( _
    ByVal sesid As LongPtr, _
    ByVal szFilename As LongPtr, _
    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

JetDetachDatabase2W = ctypes.windll.esent.JetDetachDatabase2W
JetDetachDatabase2W.restype = ctypes.c_int
JetDetachDatabase2W.argtypes = [
    ctypes.c_size_t,  # sesid : JET_SESID
    ctypes.POINTER(ctypes.c_ushort),  # szFilename : WORD* optional
    wintypes.DWORD,  # grbit : DWORD
]
require 'fiddle'
require 'fiddle/import'

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

var (
	esent = windows.NewLazySystemDLL("ESENT.dll")
	procJetDetachDatabase2W = esent.NewProc("JetDetachDatabase2W")
)

// sesid (JET_SESID), szFilename (WORD* optional), grbit (DWORD)
r1, _, err := procJetDetachDatabase2W.Call(
	uintptr(sesid),
	uintptr(szFilename),
	uintptr(grbit),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // INT
function JetDetachDatabase2W(
  sesid: NativeUInt;   // JET_SESID
  szFilename: Pointer;   // WORD* optional
  grbit: DWORD   // DWORD
): Integer; stdcall;
  external 'ESENT.dll' name 'JetDetachDatabase2W';
result := DllCall("ESENT\JetDetachDatabase2W"
    , "UPtr", sesid   ; JET_SESID
    , "Ptr", szFilename   ; WORD* optional
    , "UInt", grbit   ; DWORD
    , "Int")   ; return: INT
●JetDetachDatabase2W(sesid, szFilename, grbit) = DLL("ESENT.dll", "int JetDetachDatabase2W(int, void*, dword)")
# 呼び出し: JetDetachDatabase2W(sesid, szFilename, grbit)
# sesid : JET_SESID -> "int"
# szFilename : WORD* optional -> "void*"
# grbit : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。
const std = @import("std");

extern "esent" fn JetDetachDatabase2W(
    sesid: usize, // JET_SESID
    szFilename: [*c]u16, // WORD* optional
    grbit: u32 // DWORD
) callconv(std.os.windows.WINAPI) i32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc JetDetachDatabase2W(
    sesid: uint,  # JET_SESID
    szFilename: ptr uint16,  # WORD* optional
    grbit: uint32  # DWORD
): int32 {.importc: "JetDetachDatabase2W", stdcall, dynlib: "ESENT.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "esent");
extern(Windows)
int JetDetachDatabase2W(
    size_t sesid,   // JET_SESID
    ushort* szFilename,   // WORD* optional
    uint grbit   // DWORD
);
ccall((:JetDetachDatabase2W, "ESENT.dll"), stdcall, Int32,
      (Csize_t, Ptr{UInt16}, UInt32),
      sesid, szFilename, grbit)
# sesid : JET_SESID -> Csize_t
# szFilename : WORD* optional -> Ptr{UInt16}
# grbit : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
int32_t JetDetachDatabase2W(
    uintptr_t sesid,
    uint16_t* szFilename,
    uint32_t grbit);
]]
local esent = ffi.load("esent")
-- esent.JetDetachDatabase2W(sesid, szFilename, grbit)
-- sesid : JET_SESID
-- szFilename : WORD* optional
-- grbit : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。
const koffi = require('koffi');
const lib = koffi.load('ESENT.dll');
const JetDetachDatabase2W = lib.func('__stdcall', 'JetDetachDatabase2W', 'int32_t', ['uintptr_t', 'uint16_t *', 'uint32_t']);
// JetDetachDatabase2W(sesid, szFilename, grbit)
// sesid : JET_SESID -> 'uintptr_t'
// szFilename : WORD* optional -> 'uint16_t *'
// grbit : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("ESENT.dll", {
  JetDetachDatabase2W: { parameters: ["usize", "pointer", "u32"], result: "i32" },
});
// lib.symbols.JetDetachDatabase2W(sesid, szFilename, grbit)
// sesid : JET_SESID -> "usize"
// szFilename : WORD* optional -> "pointer"
// grbit : DWORD -> "u32"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t JetDetachDatabase2W(
    size_t sesid,
    uint16_t* szFilename,
    uint32_t grbit);
C, "ESENT.dll");
// $ffi->JetDetachDatabase2W(sesid, szFilename, grbit);
// sesid : JET_SESID
// szFilename : WORD* optional
// 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.UNICODE_OPTIONS);
    int JetDetachDatabase2W(
        long sesid,   // JET_SESID
        ShortByReference szFilename,   // WORD* optional
        int grbit   // DWORD
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("esent")]
lib LibESENT
  fun JetDetachDatabase2W = JetDetachDatabase2W(
    sesid : LibC::SizeT,   # JET_SESID
    szFilename : UInt16*,   # WORD* optional
    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 JetDetachDatabase2WNative = Int32 Function(UintPtr, Pointer<Uint16>, Uint32);
typedef JetDetachDatabase2WDart = int Function(int, Pointer<Uint16>, int);
final JetDetachDatabase2W = DynamicLibrary.open('ESENT.dll')
    .lookupFunction<JetDetachDatabase2WNative, JetDetachDatabase2WDart>('JetDetachDatabase2W');
// sesid : JET_SESID -> UintPtr
// szFilename : WORD* optional -> Pointer<Uint16>
// grbit : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function JetDetachDatabase2W(
  sesid: NativeUInt;   // JET_SESID
  szFilename: Pointer;   // WORD* optional
  grbit: DWORD   // DWORD
): Integer; stdcall;
  external 'ESENT.dll' name 'JetDetachDatabase2W';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

let jetdetachdatabase2w =
  foreign "JetDetachDatabase2W"
    (size_t @-> (ptr uint16_t) @-> uint32_t @-> returning int32_t)
(* sesid : JET_SESID -> size_t *)
(* szFilename : WORD* optional -> (ptr uint16_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 ("JetDetachDatabase2W" jet-detach-database2-w :convention :stdcall) :int32
  (sesid :uint64)   ; JET_SESID
  (sz-filename :pointer)   ; WORD* optional
  (grbit :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $JetDetachDatabase2W = Win32::API::More->new('ESENT',
    'int JetDetachDatabase2W(WPARAM sesid, LPVOID szFilename, DWORD grbit)');
# my $ret = $JetDetachDatabase2W->Call($sesid, $szFilename, $grbit);
# sesid : JET_SESID -> WPARAM
# szFilename : WORD* optional -> LPVOID
# grbit : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い
類似 API