JetDefragmentW

関数

テーブルやデータベースをオンラインで最適化する(Unicode版)。

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

シグネチャ

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

INT JetDefragmentW(
    JET_SESID sesid,
    DWORD dbid,
    WORD* szTableName,   // optional
    DWORD* pcPasses,   // optional
    DWORD* pcSeconds,   // optional
    DWORD grbit
);

パラメーター

名前	型	方向	説明
sesid	JET_SESID	in	オンライン最適化を行うセッションのJET_SESIDハンドル。
dbid	DWORD	in	最適化対象のデータベースを識別するデータベースID(JET_DBID)。
szTableName	WORD*	inoptional	最適化対象テーブル名を指す終端付きUnicode文字列ポインタ。NULLで全テーブル対象となる。
pcPasses	DWORD*	inoutoptional	実行する最大パス数を入出力で受け渡すポインタ。完了時に実行済み回数が返る。NULL可。
pcSeconds	DWORD*	inoutoptional	実行する最大秒数を入出力で受け渡すポインタ。完了時に経過秒数が返る。NULL可。
grbit	DWORD	in	最適化動作を制御するビットフラグ。バッチ開始/停止などを指定する。

戻り値の型: INT

各言語での呼び出し定義

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

INT JetDefragmentW(
    JET_SESID sesid,
    DWORD dbid,
    WORD* szTableName,   // optional
    DWORD* pcPasses,   // optional
    DWORD* pcSeconds,   // optional
    DWORD grbit
);

[DllImport("ESENT.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern int JetDefragmentW(
    UIntPtr sesid,   // JET_SESID
    uint dbid,   // DWORD
    IntPtr szTableName,   // WORD* optional
    IntPtr pcPasses,   // DWORD* optional, in/out
    IntPtr pcSeconds,   // DWORD* optional, in/out
    uint grbit   // DWORD
);

<DllImport("ESENT.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function JetDefragmentW(
    sesid As UIntPtr,   ' JET_SESID
    dbid As UInteger,   ' DWORD
    szTableName As IntPtr,   ' WORD* optional
    pcPasses As IntPtr,   ' DWORD* optional, in/out
    pcSeconds As IntPtr,   ' DWORD* optional, in/out
    grbit As UInteger   ' DWORD
) As Integer
End Function

' sesid : JET_SESID
' dbid : DWORD
' szTableName : WORD* optional
' pcPasses : DWORD* optional, in/out
' pcSeconds : DWORD* optional, in/out
' grbit : DWORD
Declare PtrSafe Function JetDefragmentW Lib "esent" ( _
    ByVal sesid As LongPtr, _
    ByVal dbid As Long, _
    ByVal szTableName As LongPtr, _
    ByVal pcPasses As LongPtr, _
    ByVal pcSeconds 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

JetDefragmentW = ctypes.windll.esent.JetDefragmentW
JetDefragmentW.restype = ctypes.c_int
JetDefragmentW.argtypes = [
    ctypes.c_size_t,  # sesid : JET_SESID
    wintypes.DWORD,  # dbid : DWORD
    ctypes.POINTER(ctypes.c_ushort),  # szTableName : WORD* optional
    ctypes.POINTER(wintypes.DWORD),  # pcPasses : DWORD* optional, in/out
    ctypes.POINTER(wintypes.DWORD),  # pcSeconds : DWORD* optional, in/out
    wintypes.DWORD,  # grbit : DWORD
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ESENT.dll')
JetDefragmentW = Fiddle::Function.new(
  lib['JetDefragmentW'],
  [
    Fiddle::TYPE_UINTPTR_T,  # sesid : JET_SESID
    -Fiddle::TYPE_INT,  # dbid : DWORD
    Fiddle::TYPE_VOIDP,  # szTableName : WORD* optional
    Fiddle::TYPE_VOIDP,  # pcPasses : DWORD* optional, in/out
    Fiddle::TYPE_VOIDP,  # pcSeconds : DWORD* optional, in/out
    -Fiddle::TYPE_INT,  # grbit : DWORD
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "esent")]
extern "system" {
    fn JetDefragmentW(
        sesid: usize,  // JET_SESID
        dbid: u32,  // DWORD
        szTableName: *mut u16,  // WORD* optional
        pcPasses: *mut u32,  // DWORD* optional, in/out
        pcSeconds: *mut u32,  // DWORD* optional, in/out
        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 JetDefragmentW(UIntPtr sesid, uint dbid, IntPtr szTableName, IntPtr pcPasses, IntPtr pcSeconds, uint grbit);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ESENT_JetDefragmentW' -Namespace Win32 -PassThru
# $api::JetDefragmentW(sesid, dbid, szTableName, pcPasses, pcSeconds, grbit)

#uselib "ESENT.dll"
#func global JetDefragmentW "JetDefragmentW" wptr, wptr, wptr, wptr, wptr, wptr
; JetDefragmentW sesid, dbid, varptr(szTableName), varptr(pcPasses), varptr(pcSeconds), grbit   ; 戻り値は stat
; sesid : JET_SESID -> "wptr"
; dbid : DWORD -> "wptr"
; szTableName : WORD* optional -> "wptr"
; pcPasses : DWORD* optional, in/out -> "wptr"
; pcSeconds : DWORD* optional, in/out -> "wptr"
; grbit : DWORD -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

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

出力引数:

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

import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	esent = windows.NewLazySystemDLL("ESENT.dll")
	procJetDefragmentW = esent.NewProc("JetDefragmentW")
)

// sesid (JET_SESID), dbid (DWORD), szTableName (WORD* optional), pcPasses (DWORD* optional, in/out), pcSeconds (DWORD* optional, in/out), grbit (DWORD)
r1, _, err := procJetDefragmentW.Call(
	uintptr(sesid),
	uintptr(dbid),
	uintptr(szTableName),
	uintptr(pcPasses),
	uintptr(pcSeconds),
	uintptr(grbit),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // INT

function JetDefragmentW(
  sesid: NativeUInt;   // JET_SESID
  dbid: DWORD;   // DWORD
  szTableName: Pointer;   // WORD* optional
  pcPasses: Pointer;   // DWORD* optional, in/out
  pcSeconds: Pointer;   // DWORD* optional, in/out
  grbit: DWORD   // DWORD
): Integer; stdcall;
  external 'ESENT.dll' name 'JetDefragmentW';

result := DllCall("ESENT\JetDefragmentW"
    , "UPtr", sesid   ; JET_SESID
    , "UInt", dbid   ; DWORD
    , "Ptr", szTableName   ; WORD* optional
    , "Ptr", pcPasses   ; DWORD* optional, in/out
    , "Ptr", pcSeconds   ; DWORD* optional, in/out
    , "UInt", grbit   ; DWORD
    , "Int")   ; return: INT

●JetDefragmentW(sesid, dbid, szTableName, pcPasses, pcSeconds, grbit) = DLL("ESENT.dll", "int JetDefragmentW(int, dword, void*, void*, void*, dword)")
# 呼び出し: JetDefragmentW(sesid, dbid, szTableName, pcPasses, pcSeconds, grbit)
# sesid : JET_SESID -> "int"
# dbid : DWORD -> "dword"
# szTableName : WORD* optional -> "void*"
# pcPasses : DWORD* optional, in/out -> "void*"
# pcSeconds : DWORD* optional, in/out -> "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 JetDefragmentW(
    sesid: usize, // JET_SESID
    dbid: u32, // DWORD
    szTableName: [*c]u16, // WORD* optional
    pcPasses: [*c]u32, // DWORD* optional, in/out
    pcSeconds: [*c]u32, // DWORD* optional, in/out
    grbit: u32 // DWORD
) callconv(std.os.windows.WINAPI) i32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。

proc JetDefragmentW(
    sesid: uint,  # JET_SESID
    dbid: uint32,  # DWORD
    szTableName: ptr uint16,  # WORD* optional
    pcPasses: ptr uint32,  # DWORD* optional, in/out
    pcSeconds: ptr uint32,  # DWORD* optional, in/out
    grbit: uint32  # DWORD
): int32 {.importc: "JetDefragmentW", stdcall, dynlib: "ESENT.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。

pragma(lib, "esent");
extern(Windows)
int JetDefragmentW(
    size_t sesid,   // JET_SESID
    uint dbid,   // DWORD
    ushort* szTableName,   // WORD* optional
    uint* pcPasses,   // DWORD* optional, in/out
    uint* pcSeconds,   // DWORD* optional, in/out
    uint grbit   // DWORD
);

ccall((:JetDefragmentW, "ESENT.dll"), stdcall, Int32,
      (Csize_t, UInt32, Ptr{UInt16}, Ptr{UInt32}, Ptr{UInt32}, UInt32),
      sesid, dbid, szTableName, pcPasses, pcSeconds, grbit)
# sesid : JET_SESID -> Csize_t
# dbid : DWORD -> UInt32
# szTableName : WORD* optional -> Ptr{UInt16}
# pcPasses : DWORD* optional, in/out -> Ptr{UInt32}
# pcSeconds : DWORD* optional, in/out -> Ptr{UInt32}
# grbit : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。

local ffi = require("ffi")
ffi.cdef[[
int32_t JetDefragmentW(
    uintptr_t sesid,
    uint32_t dbid,
    uint16_t* szTableName,
    uint32_t* pcPasses,
    uint32_t* pcSeconds,
    uint32_t grbit);
]]
local esent = ffi.load("esent")
-- esent.JetDefragmentW(sesid, dbid, szTableName, pcPasses, pcSeconds, grbit)
-- sesid : JET_SESID
-- dbid : DWORD
-- szTableName : WORD* optional
-- pcPasses : DWORD* optional, in/out
-- pcSeconds : DWORD* optional, in/out
-- 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 JetDefragmentW = lib.func('__stdcall', 'JetDefragmentW', 'int32_t', ['uintptr_t', 'uint32_t', 'uint16_t *', 'uint32_t *', 'uint32_t *', 'uint32_t']);
// JetDefragmentW(sesid, dbid, szTableName, pcPasses, pcSeconds, grbit)
// sesid : JET_SESID -> 'uintptr_t'
// dbid : DWORD -> 'uint32_t'
// szTableName : WORD* optional -> 'uint16_t *'
// pcPasses : DWORD* optional, in/out -> 'uint32_t *'
// pcSeconds : DWORD* optional, in/out -> 'uint32_t *'
// grbit : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。

const lib = Deno.dlopen("ESENT.dll", {
  JetDefragmentW: { parameters: ["usize", "u32", "pointer", "pointer", "pointer", "u32"], result: "i32" },
});
// lib.symbols.JetDefragmentW(sesid, dbid, szTableName, pcPasses, pcSeconds, grbit)
// sesid : JET_SESID -> "usize"
// dbid : DWORD -> "u32"
// szTableName : WORD* optional -> "pointer"
// pcPasses : DWORD* optional, in/out -> "pointer"
// pcSeconds : DWORD* optional, in/out -> "pointer"
// grbit : DWORD -> "u32"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。

<?php
$ffi = FFI::cdef(<<<C
int32_t JetDefragmentW(
    size_t sesid,
    uint32_t dbid,
    uint16_t* szTableName,
    uint32_t* pcPasses,
    uint32_t* pcSeconds,
    uint32_t grbit);
C, "ESENT.dll");
// $ffi->JetDefragmentW(sesid, dbid, szTableName, pcPasses, pcSeconds, grbit);
// sesid : JET_SESID
// dbid : DWORD
// szTableName : WORD* optional
// pcPasses : DWORD* optional, in/out
// pcSeconds : DWORD* optional, in/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.UNICODE_OPTIONS);
    int JetDefragmentW(
        long sesid,   // JET_SESID
        int dbid,   // DWORD
        ShortByReference szTableName,   // WORD* optional
        IntByReference pcPasses,   // DWORD* optional, in/out
        IntByReference pcSeconds,   // DWORD* optional, in/out
        int grbit   // DWORD
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。

@[Link("esent")]
lib LibESENT
  fun JetDefragmentW = JetDefragmentW(
    sesid : LibC::SizeT,   # JET_SESID
    dbid : UInt32,   # DWORD
    szTableName : UInt16*,   # WORD* optional
    pcPasses : UInt32*,   # DWORD* optional, in/out
    pcSeconds : UInt32*,   # DWORD* optional, in/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 JetDefragmentWNative = Int32 Function(UintPtr, Uint32, Pointer<Uint16>, Pointer<Uint32>, Pointer<Uint32>, Uint32);
typedef JetDefragmentWDart = int Function(int, int, Pointer<Uint16>, Pointer<Uint32>, Pointer<Uint32>, int);
final JetDefragmentW = DynamicLibrary.open('ESENT.dll')
    .lookupFunction<JetDefragmentWNative, JetDefragmentWDart>('JetDefragmentW');
// sesid : JET_SESID -> UintPtr
// dbid : DWORD -> Uint32
// szTableName : WORD* optional -> Pointer<Uint16>
// pcPasses : DWORD* optional, in/out -> Pointer<Uint32>
// pcSeconds : DWORD* optional, in/out -> Pointer<Uint32>
// grbit : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。

{$mode objfpc}{$H+}
function JetDefragmentW(
  sesid: NativeUInt;   // JET_SESID
  dbid: DWORD;   // DWORD
  szTableName: Pointer;   // WORD* optional
  pcPasses: Pointer;   // DWORD* optional, in/out
  pcSeconds: Pointer;   // DWORD* optional, in/out
  grbit: DWORD   // DWORD
): Integer; stdcall;
  external 'ESENT.dll' name 'JetDefragmentW';

import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "JetDefragmentW"
  c_JetDefragmentW :: CUIntPtr -> Word32 -> Ptr Word16 -> Ptr Word32 -> Ptr Word32 -> Word32 -> IO Int32
-- sesid : JET_SESID -> CUIntPtr
-- dbid : DWORD -> Word32
-- szTableName : WORD* optional -> Ptr Word16
-- pcPasses : DWORD* optional, in/out -> Ptr Word32
-- pcSeconds : DWORD* optional, in/out -> Ptr Word32
-- grbit : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。

open Ctypes
open Foreign

let jetdefragmentw =
  foreign "JetDefragmentW"
    (size_t @-> uint32_t @-> (ptr uint16_t) @-> (ptr uint32_t) @-> (ptr uint32_t) @-> uint32_t @-> returning int32_t)
(* sesid : JET_SESID -> size_t *)
(* dbid : DWORD -> uint32_t *)
(* szTableName : WORD* optional -> (ptr uint16_t) *)
(* pcPasses : DWORD* optional, in/out -> (ptr uint32_t) *)
(* pcSeconds : DWORD* optional, in/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 ("JetDefragmentW" jet-defragment-w :convention :stdcall) :int32
  (sesid :uint64)   ; JET_SESID
  (dbid :uint32)   ; DWORD
  (sz-table-name :pointer)   ; WORD* optional
  (pc-passes :pointer)   ; DWORD* optional, in/out
  (pc-seconds :pointer)   ; DWORD* optional, in/out
  (grbit :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。

use Win32::API;
my $JetDefragmentW = Win32::API::More->new('ESENT',
    'int JetDefragmentW(WPARAM sesid, DWORD dbid, LPVOID szTableName, LPVOID pcPasses, LPVOID pcSeconds, DWORD grbit)');
# my $ret = $JetDefragmentW->Call($sesid, $dbid, $szTableName, $pcPasses, $pcSeconds, $grbit);
# sesid : JET_SESID -> WPARAM
# dbid : DWORD -> DWORD
# szTableName : WORD* optional -> LPVOID
# pcPasses : DWORD* optional, in/out -> LPVOID
# pcSeconds : DWORD* optional, in/out -> LPVOID
# grbit : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

JetDefragmentW

シグネチャ

パラメーター

各言語での呼び出し定義

関連項目