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

JetDeleteIndexA

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

シグネチャ

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

INT JetDeleteIndexA(
    JET_SESID sesid,
    JET_TABLEID tableid,
    CHAR* szIndexName
);

パラメーター

名前型方向説明
sesidJET_SESIDin操作に使用するセッションID。
tableidJET_TABLEIDinインデックスを削除する対象テーブルのカーソルID。
szIndexNameCHAR*in削除するインデックス名を指すANSI文字列。

戻り値の型: 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  (ANSI / -A)
#include <windows.h>

INT JetDeleteIndexA(
    JET_SESID sesid,
    JET_TABLEID tableid,
    CHAR* szIndexName
);
[DllImport("ESENT.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern int JetDeleteIndexA(
    UIntPtr sesid,   // JET_SESID
    UIntPtr tableid,   // JET_TABLEID
    IntPtr szIndexName   // CHAR*
);
<DllImport("ESENT.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function JetDeleteIndexA(
    sesid As UIntPtr,   ' JET_SESID
    tableid As UIntPtr,   ' JET_TABLEID
    szIndexName As IntPtr   ' CHAR*
) As Integer
End Function
' sesid : JET_SESID
' tableid : JET_TABLEID
' szIndexName : CHAR*
Declare PtrSafe Function JetDeleteIndexA Lib "esent" ( _
    ByVal sesid As LongPtr, _
    ByVal tableid As LongPtr, _
    ByVal szIndexName As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

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

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

var (
	esent = windows.NewLazySystemDLL("ESENT.dll")
	procJetDeleteIndexA = esent.NewProc("JetDeleteIndexA")
)

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

extern "esent" fn JetDeleteIndexA(
    sesid: usize, // JET_SESID
    tableid: usize, // JET_TABLEID
    szIndexName: [*c]i8 // CHAR*
) callconv(std.os.windows.WINAPI) i32;
proc JetDeleteIndexA(
    sesid: uint,  # JET_SESID
    tableid: uint,  # JET_TABLEID
    szIndexName: ptr int8  # CHAR*
): int32 {.importc: "JetDeleteIndexA", stdcall, dynlib: "ESENT.dll".}
pragma(lib, "esent");
extern(Windows)
int JetDeleteIndexA(
    size_t sesid,   // JET_SESID
    size_t tableid,   // JET_TABLEID
    byte* szIndexName   // CHAR*
);
ccall((:JetDeleteIndexA, "ESENT.dll"), stdcall, Int32,
      (Csize_t, Csize_t, Ptr{Int8}),
      sesid, tableid, szIndexName)
# sesid : JET_SESID -> Csize_t
# tableid : JET_TABLEID -> Csize_t
# szIndexName : CHAR* -> Ptr{Int8}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t JetDeleteIndexA(
    uintptr_t sesid,
    uintptr_t tableid,
    int8_t* szIndexName);
]]
local esent = ffi.load("esent")
-- esent.JetDeleteIndexA(sesid, tableid, szIndexName)
-- sesid : JET_SESID
-- tableid : JET_TABLEID
-- szIndexName : CHAR*
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('ESENT.dll');
const JetDeleteIndexA = lib.func('__stdcall', 'JetDeleteIndexA', 'int32_t', ['uintptr_t', 'uintptr_t', 'int8_t *']);
// JetDeleteIndexA(sesid, tableid, szIndexName)
// sesid : JET_SESID -> 'uintptr_t'
// tableid : JET_TABLEID -> 'uintptr_t'
// szIndexName : CHAR* -> 'int8_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("ESENT.dll", {
  JetDeleteIndexA: { parameters: ["usize", "usize", "pointer"], result: "i32" },
});
// lib.symbols.JetDeleteIndexA(sesid, tableid, szIndexName)
// sesid : JET_SESID -> "usize"
// tableid : JET_TABLEID -> "usize"
// szIndexName : CHAR* -> "pointer"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t JetDeleteIndexA(
    size_t sesid,
    size_t tableid,
    int8_t* szIndexName);
C, "ESENT.dll");
// $ffi->JetDeleteIndexA(sesid, tableid, szIndexName);
// sesid : JET_SESID
// tableid : JET_TABLEID
// szIndexName : CHAR*
// 構造体/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.ASCII_OPTIONS);
    int JetDeleteIndexA(
        long sesid,   // JET_SESID
        long tableid,   // JET_TABLEID
        byte[] szIndexName   // CHAR*
    );
}
@[Link("esent")]
lib LibESENT
  fun JetDeleteIndexA = JetDeleteIndexA(
    sesid : LibC::SizeT,   # JET_SESID
    tableid : LibC::SizeT,   # JET_TABLEID
    szIndexName : Int8*   # CHAR*
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

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

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

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

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

関連項目

文字セット違い