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

JetDeleteIndexW

関数
テーブルから指定したインデックスを削除する(Unicode版)。
DLLESENT.dll文字セットUnicode (-W)呼出規約winapi

シグネチャ

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

INT JetDeleteIndexW(
    JET_SESID sesid,
    JET_TABLEID tableid,
    WORD* szIndexName
);

パラメーター

名前型方向説明
sesidJET_SESIDin操作を実行するセッションを識別するJET_SESIDハンドル。JetBeginSessionで取得した有効なセッションを指定する。
tableidJET_TABLEIDin削除対象のインデックスを持つテーブルを識別するJET_TABLEIDカーソルハンドル。
szIndexNameWORD*in削除する二次インデックスの名前を指す終端付きUnicode文字列ポインタ。主インデックスは削除できない。

戻り値の型: INT

公式ドキュメント

JetDeleteIndex 関数は、テーブルからインデックスを削除します。

戻り値

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

リターンコード

説明

JET_errSuccess

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

JET_errFixedDDL

固定テーブル (たとえば JET_bitTableCreateFixedDDL を指定して作成されたテーブル) からインデックスを削除しようとしました。

JET_errFixedInheritedDDL

テンプレートテーブルからインデックスを削除しようとしました。テンプレートテーブルは DDL が固定されています。

JET_errIndexNotFound

szIndexName で指定された名前のインデックスが見つかりませんでした。

JET_errPermissionDenied

テーブルは読み取り専用で開かれているため、更新できません。

JET_errSessionSharingViolation

複数のスレッドが同じデータベースセッションを使用しようとしました。

JET_errTransReadOnly

トランザクションが読み取り専用トランザクションとして開かれています。

解説

成功すると、インデックスは削除されるため、以降は使用できません。そのインデックスを使用しているアクティブなトランザクションが存在してはなりません。

成功した場合、カレンシー (カーソル位置) は最初のレコードの前に設定されます。

要件

要件 値

クライアント

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

サーバー

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

ヘッダー

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

ライブラリ

ESENT.lib を使用します。

DLL

ESENT.dll が必要です。

Unicode

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

関連項目

JET_ERR
JET_GRBIT
JET_SESID
JET_TABLEID
JetCreateIndex
JetCreateIndex2

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 JetDeleteIndexW(
    JET_SESID sesid,
    JET_TABLEID tableid,
    WORD* szIndexName
);
[DllImport("ESENT.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern int JetDeleteIndexW(
    UIntPtr sesid,   // JET_SESID
    UIntPtr tableid,   // JET_TABLEID
    ref ushort szIndexName   // WORD*
);
<DllImport("ESENT.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function JetDeleteIndexW(
    sesid As UIntPtr,   ' JET_SESID
    tableid As UIntPtr,   ' JET_TABLEID
    ByRef szIndexName As UShort   ' WORD*
) As Integer
End Function
' sesid : JET_SESID
' tableid : JET_TABLEID
' szIndexName : WORD*
Declare PtrSafe Function JetDeleteIndexW Lib "esent" ( _
    ByVal sesid As LongPtr, _
    ByVal tableid As LongPtr, _
    ByRef szIndexName As Integer) 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

JetDeleteIndexW = ctypes.windll.esent.JetDeleteIndexW
JetDeleteIndexW.restype = ctypes.c_int
JetDeleteIndexW.argtypes = [
    ctypes.c_size_t,  # sesid : JET_SESID
    ctypes.c_size_t,  # tableid : JET_TABLEID
    ctypes.POINTER(ctypes.c_ushort),  # szIndexName : WORD*
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ESENT.dll')
JetDeleteIndexW = Fiddle::Function.new(
  lib['JetDeleteIndexW'],
  [
    Fiddle::TYPE_UINTPTR_T,  # sesid : JET_SESID
    Fiddle::TYPE_UINTPTR_T,  # tableid : JET_TABLEID
    Fiddle::TYPE_VOIDP,  # szIndexName : WORD*
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "esent")]
extern "system" {
    fn JetDeleteIndexW(
        sesid: usize,  // JET_SESID
        tableid: usize,  // JET_TABLEID
        szIndexName: *mut u16  // WORD*
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("ESENT.dll", CharSet = CharSet.Unicode)]
public static extern int JetDeleteIndexW(UIntPtr sesid, UIntPtr tableid, ref ushort szIndexName);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ESENT_JetDeleteIndexW' -Namespace Win32 -PassThru
# $api::JetDeleteIndexW(sesid, tableid, szIndexName)
#uselib "ESENT.dll"
#func global JetDeleteIndexW "JetDeleteIndexW" wptr, wptr, wptr
; JetDeleteIndexW sesid, tableid, varptr(szIndexName)   ; 戻り値は stat
; sesid : JET_SESID -> "wptr"
; tableid : JET_TABLEID -> "wptr"
; szIndexName : WORD* -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "ESENT.dll"
#cfunc global JetDeleteIndexW "JetDeleteIndexW" sptr, sptr, var
; res = JetDeleteIndexW(sesid, tableid, szIndexName)
; sesid : JET_SESID -> "sptr"
; tableid : JET_TABLEID -> "sptr"
; szIndexName : WORD* -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; INT JetDeleteIndexW(JET_SESID sesid, JET_TABLEID tableid, WORD* szIndexName)
#uselib "ESENT.dll"
#cfunc global JetDeleteIndexW "JetDeleteIndexW" intptr, intptr, var
; res = JetDeleteIndexW(sesid, tableid, szIndexName)
; sesid : JET_SESID -> "intptr"
; tableid : JET_TABLEID -> "intptr"
; szIndexName : WORD* -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	esent = windows.NewLazySystemDLL("ESENT.dll")
	procJetDeleteIndexW = esent.NewProc("JetDeleteIndexW")
)

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

extern "esent" fn JetDeleteIndexW(
    sesid: usize, // JET_SESID
    tableid: usize, // JET_TABLEID
    szIndexName: [*c]u16 // WORD*
) callconv(std.os.windows.WINAPI) i32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc JetDeleteIndexW(
    sesid: uint,  # JET_SESID
    tableid: uint,  # JET_TABLEID
    szIndexName: ptr uint16  # WORD*
): int32 {.importc: "JetDeleteIndexW", stdcall, dynlib: "ESENT.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "esent");
extern(Windows)
int JetDeleteIndexW(
    size_t sesid,   // JET_SESID
    size_t tableid,   // JET_TABLEID
    ushort* szIndexName   // WORD*
);
ccall((:JetDeleteIndexW, "ESENT.dll"), stdcall, Int32,
      (Csize_t, Csize_t, Ptr{UInt16}),
      sesid, tableid, szIndexName)
# sesid : JET_SESID -> Csize_t
# tableid : JET_TABLEID -> Csize_t
# szIndexName : WORD* -> Ptr{UInt16}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
int32_t JetDeleteIndexW(
    uintptr_t sesid,
    uintptr_t tableid,
    uint16_t* szIndexName);
]]
local esent = ffi.load("esent")
-- esent.JetDeleteIndexW(sesid, tableid, szIndexName)
-- sesid : JET_SESID
-- tableid : JET_TABLEID
-- szIndexName : WORD*
-- 構造体/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 JetDeleteIndexW = lib.func('__stdcall', 'JetDeleteIndexW', 'int32_t', ['uintptr_t', 'uintptr_t', 'uint16_t *']);
// JetDeleteIndexW(sesid, tableid, szIndexName)
// sesid : JET_SESID -> 'uintptr_t'
// tableid : JET_TABLEID -> 'uintptr_t'
// szIndexName : WORD* -> 'uint16_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("ESENT.dll", {
  JetDeleteIndexW: { parameters: ["usize", "usize", "pointer"], result: "i32" },
});
// lib.symbols.JetDeleteIndexW(sesid, tableid, szIndexName)
// sesid : JET_SESID -> "usize"
// tableid : JET_TABLEID -> "usize"
// szIndexName : WORD* -> "pointer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t JetDeleteIndexW(
    size_t sesid,
    size_t tableid,
    uint16_t* szIndexName);
C, "ESENT.dll");
// $ffi->JetDeleteIndexW(sesid, tableid, szIndexName);
// sesid : JET_SESID
// tableid : JET_TABLEID
// szIndexName : WORD*
// 構造体/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 JetDeleteIndexW(
        long sesid,   // JET_SESID
        long tableid,   // JET_TABLEID
        ShortByReference szIndexName   // WORD*
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("esent")]
lib LibESENT
  fun JetDeleteIndexW = JetDeleteIndexW(
    sesid : LibC::SizeT,   # JET_SESID
    tableid : LibC::SizeT,   # JET_TABLEID
    szIndexName : UInt16*   # WORD*
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef JetDeleteIndexWNative = Int32 Function(UintPtr, UintPtr, Pointer<Uint16>);
typedef JetDeleteIndexWDart = int Function(int, int, Pointer<Uint16>);
final JetDeleteIndexW = DynamicLibrary.open('ESENT.dll')
    .lookupFunction<JetDeleteIndexWNative, JetDeleteIndexWDart>('JetDeleteIndexW');
// sesid : JET_SESID -> UintPtr
// tableid : JET_TABLEID -> UintPtr
// szIndexName : WORD* -> Pointer<Uint16>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function JetDeleteIndexW(
  sesid: NativeUInt;   // JET_SESID
  tableid: NativeUInt;   // JET_TABLEID
  szIndexName: Pointer   // WORD*
): Integer; stdcall;
  external 'ESENT.dll' name 'JetDeleteIndexW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

let jetdeleteindexw =
  foreign "JetDeleteIndexW"
    (size_t @-> size_t @-> (ptr uint16_t) @-> returning int32_t)
(* sesid : JET_SESID -> size_t *)
(* tableid : JET_TABLEID -> size_t *)
(* szIndexName : WORD* -> (ptr uint16_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library esent (t "ESENT.dll"))
(cffi:use-foreign-library esent)

(cffi:defcfun ("JetDeleteIndexW" jet-delete-index-w :convention :stdcall) :int32
  (sesid :uint64)   ; JET_SESID
  (tableid :uint64)   ; JET_TABLEID
  (sz-index-name :pointer))   ; WORD*
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $JetDeleteIndexW = Win32::API::More->new('ESENT',
    'int JetDeleteIndexW(WPARAM sesid, WPARAM tableid, LPVOID szIndexName)');
# my $ret = $JetDeleteIndexW->Call($sesid, $tableid, $szIndexName);
# sesid : JET_SESID -> WPARAM
# tableid : JET_TABLEID -> WPARAM
# szIndexName : WORD* -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い