JetCreateIndex2A
関数シグネチャ
// ESENT.dll (ANSI / -A)
#include <windows.h>
INT JetCreateIndex2A(
JET_SESID sesid,
JET_TABLEID tableid,
JET_INDEXCREATE_A* pindexcreate,
DWORD cIndexCreate
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| sesid | JET_SESID | in | 操作に使用するセッションID。 |
| tableid | JET_TABLEID | in | インデックスを作成する対象テーブルのカーソルID。 |
| pindexcreate | JET_INDEXCREATE_A* | in | 作成するインデックスの定義配列(JET_INDEXCREATE_A)へのポインタ。 |
| cIndexCreate | DWORD | in | pindexcreate配列の要素数(同時作成するインデックス数)。 |
戻り値の型: INT
公式ドキュメント
JetCreateIndex2 関数は、ESE データベース内のデータに対するインデックスを作成します。インデックスを使用すると、特定のデータを高速に検索できます。
戻り値
この関数は JET_ERR データ型を返し、その値は次のいずれかのリターンコードになります。発生し得る ESE のエラーの詳細については、Extensible Storage Engine Errors および Error Handling Parameters を参照してください。
リターンコード |
説明 |
|---|---|
JET_errSuccess |
操作は正常に完了しました。 |
JET_errCannotIndex |
エスクロー更新列または SLV 列に対してインデックスを作成しようとしました (SLV 列は非推奨です)。 |
JET_errColumnNotFound |
存在しない列に対してインデックスを作成しようとしました。存在しない列に対して条件付きインデックスを作成しようとした場合も、このエラーが発生することがあります。 |
JET_errDensityInvalid |
JET_INDEXCREATE 構造体の ulDensity メンバーに 20 未満または 100 を超える値が設定されている場合、このエラーが返されます。 |
JET_errIndexDuplicate |
同一のインデックスを 2 つ定義しようとしました。 |
JET_errIndexHasPrimary |
1 つのテーブルに対して複数の主インデックスを指定しようとしました。テーブルは主インデックスをちょうど 1 つ持つ必要があります。主インデックスが指定されない場合、データベースエンジンが自動的に作成します。 |
JET_errIndexInvalidDef |
無効なインデックス定義が指定されました。このエラーが返される理由には次のようなものがあります。
|
JET_errIndexTuplesInvalidLimits |
Windows XP 以降。JET_TUPLELIMITS 構造体が指定されましたが、その制限値はサポートされていません。JET_TUPLELIMITS 構造体の解説セクションを参照してください。 |
JET_errIndexTuplesNonUniqueOnly |
Windows XP 以降。タプルインデックスを一意にすることはできません (grbit に JET_bitIndexTuples と JET_bitIndexUnique の両方を設定することはできません)。 |
JET_errIndexTuplesOneColumnOnly |
Windows XP 以降。タプルインデックスは単一の列に対してのみ作成できます (つまり、JET_INDEXCREATE 構造体の grbit メンバーに JET_bitIndexTuples が設定されているのに、JET_INDEXCREATE 構造体の szKey メンバーが複数の列を指定している)。 |
JET_errIndexTuplesSecondaryIndexOnly |
Windows XP 以降。タプルインデックスを主インデックスにすることはできません (つまり、JET_INDEXCREATE 構造体の grbit メンバーに JET_bitIndexPrimary と JET_bitIndexTuples の両方を設定することはできません)。 |
JET_errIndexTuplesTextColumnsOnly |
Windows XP 以降。タプルインデックスはテキスト列または Unicode 列に対してのみ作成できます。それ以外の列 (バイナリ列など) にインデックスを作成しようとすると、JET_errIndexTuplesTextColumnsOnly が返されます。 |
JET_errIndexTuplesVarSegMacNotAllowed |
Windows XP 以降。タプルインデックスでは、JET_INDEXCREATE 構造体の cbVarSegMac メンバーを設定できません。 |
JET_errInTransaction |
トランザクション中に、バージョン情報を伴わないインデックスを作成しようとしました。 |
JET_errInvalidgrbit |
JET_INDEXCREATE 構造体の grbit メンバーに矛盾する値が含まれているため、インデックス定義が無効です。考えられる原因は次のとおりです。
複数のインデックスを一度に作成する場合 (つまり、cIndexCreate パラメーターが 1 より大きい場合)、いずれのインデックスにも次のビットを含めることはできません。
|
JET_errInvalidLanguageId |
無効なロケール ID (LCID) が渡されました (JET_INDEXCREATE 構造体の pidxunicode メンバーが指す JET_UNICODEINDEX 構造体の lcid メンバーを通じて、または JET_INDEXCREATE 構造体の lcid メンバーを通じて)。 |
JET_errInvalidName |
無効なインデックス名が指定されました。詳細については JET_INDEXCREATE を参照してください。 |
JET_errInvalidParameter |
無効なパラメーターが API に渡されました。このエラーが返される理由には次のようなものがあります。
|
JET_errUnicodeTranslationFail |
Unicode 列を正規化しようとしたときにエラーが発生しました。これはシステムリソースの不足が原因で発生することがあります。 |
解説
指定されたすべてのインデックスの作成が正常に完了した場合、戻り値は JET_errSuccess になります。
JetCreateIndex2 は pindexcreate に指定されたインデックスを順に処理しますが、最初の失敗で処理を中止することがあります。エラーが発生した最初のインデックス以降のインデックスは、JET_INDEXCREATE 構造体の err メンバーが JET_errSuccess であっても、作成が試行されていない可能性があります。
要件
| 要件 | 値 |
|---|---|
クライアント |
Windows Vista、Windows XP、または Windows 2000 Professional が必要です。 |
サーバー |
Windows Server 2008、Windows Server 2003、または Windows 2000 Server が必要です。 |
ヘッダー |
Esent.h で宣言されています。 |
ライブラリ |
ESENT.lib を使用します。 |
DLL |
ESENT.dll が必要です。 |
Unicode |
JetCreateIndex2W (Unicode) および JetCreateIndex2A (ANSI) として実装されています。 |
関連項目
JET_CONDITIONALCOLUMN
JET_ERR
JET_GRBIT
JET_SESID
JET_TABLEID
JET_INDEXCREATE
JetCreateIndex
JetCreateTableColumnIndex
JetCreateTableColumnIndex2
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp)
各言語での呼び出し定義
// ESENT.dll (ANSI / -A)
#include <windows.h>
INT JetCreateIndex2A(
JET_SESID sesid,
JET_TABLEID tableid,
JET_INDEXCREATE_A* pindexcreate,
DWORD cIndexCreate
);[DllImport("ESENT.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern int JetCreateIndex2A(
UIntPtr sesid, // JET_SESID
UIntPtr tableid, // JET_TABLEID
IntPtr pindexcreate, // JET_INDEXCREATE_A*
uint cIndexCreate // DWORD
);<DllImport("ESENT.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function JetCreateIndex2A(
sesid As UIntPtr, ' JET_SESID
tableid As UIntPtr, ' JET_TABLEID
pindexcreate As IntPtr, ' JET_INDEXCREATE_A*
cIndexCreate As UInteger ' DWORD
) As Integer
End Function' sesid : JET_SESID
' tableid : JET_TABLEID
' pindexcreate : JET_INDEXCREATE_A*
' cIndexCreate : DWORD
Declare PtrSafe Function JetCreateIndex2A Lib "esent" ( _
ByVal sesid As LongPtr, _
ByVal tableid As LongPtr, _
ByVal pindexcreate As LongPtr, _
ByVal cIndexCreate As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
JetCreateIndex2A = ctypes.windll.esent.JetCreateIndex2A
JetCreateIndex2A.restype = ctypes.c_int
JetCreateIndex2A.argtypes = [
ctypes.c_size_t, # sesid : JET_SESID
ctypes.c_size_t, # tableid : JET_TABLEID
ctypes.c_void_p, # pindexcreate : JET_INDEXCREATE_A*
wintypes.DWORD, # cIndexCreate : DWORD
]require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('ESENT.dll')
JetCreateIndex2A = Fiddle::Function.new(
lib['JetCreateIndex2A'],
[
Fiddle::TYPE_UINTPTR_T, # sesid : JET_SESID
Fiddle::TYPE_UINTPTR_T, # tableid : JET_TABLEID
Fiddle::TYPE_VOIDP, # pindexcreate : JET_INDEXCREATE_A*
-Fiddle::TYPE_INT, # cIndexCreate : DWORD
],
Fiddle::TYPE_INT)#[link(name = "esent")]
extern "system" {
fn JetCreateIndex2A(
sesid: usize, // JET_SESID
tableid: usize, // JET_TABLEID
pindexcreate: *mut JET_INDEXCREATE_A, // JET_INDEXCREATE_A*
cIndexCreate: u32 // DWORD
) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[DllImport("ESENT.dll", CharSet = CharSet.Ansi)]
public static extern int JetCreateIndex2A(UIntPtr sesid, UIntPtr tableid, IntPtr pindexcreate, uint cIndexCreate);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ESENT_JetCreateIndex2A' -Namespace Win32 -PassThru
# $api::JetCreateIndex2A(sesid, tableid, pindexcreate, cIndexCreate)#uselib "ESENT.dll"
#func global JetCreateIndex2A "JetCreateIndex2A" sptr, sptr, sptr, sptr
; JetCreateIndex2A sesid, tableid, varptr(pindexcreate), cIndexCreate ; 戻り値は stat
; sesid : JET_SESID -> "sptr"
; tableid : JET_TABLEID -> "sptr"
; pindexcreate : JET_INDEXCREATE_A* -> "sptr"
; cIndexCreate : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "ESENT.dll" #cfunc global JetCreateIndex2A "JetCreateIndex2A" sptr, sptr, var, int ; res = JetCreateIndex2A(sesid, tableid, pindexcreate, cIndexCreate) ; sesid : JET_SESID -> "sptr" ; tableid : JET_TABLEID -> "sptr" ; pindexcreate : JET_INDEXCREATE_A* -> "var" ; cIndexCreate : DWORD -> "int" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "ESENT.dll" #cfunc global JetCreateIndex2A "JetCreateIndex2A" sptr, sptr, sptr, int ; res = JetCreateIndex2A(sesid, tableid, varptr(pindexcreate), cIndexCreate) ; sesid : JET_SESID -> "sptr" ; tableid : JET_TABLEID -> "sptr" ; pindexcreate : JET_INDEXCREATE_A* -> "sptr" ; cIndexCreate : DWORD -> "int" ; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; INT JetCreateIndex2A(JET_SESID sesid, JET_TABLEID tableid, JET_INDEXCREATE_A* pindexcreate, DWORD cIndexCreate) #uselib "ESENT.dll" #cfunc global JetCreateIndex2A "JetCreateIndex2A" intptr, intptr, var, int ; res = JetCreateIndex2A(sesid, tableid, pindexcreate, cIndexCreate) ; sesid : JET_SESID -> "intptr" ; tableid : JET_TABLEID -> "intptr" ; pindexcreate : JET_INDEXCREATE_A* -> "var" ; cIndexCreate : DWORD -> "int" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。; INT JetCreateIndex2A(JET_SESID sesid, JET_TABLEID tableid, JET_INDEXCREATE_A* pindexcreate, DWORD cIndexCreate) #uselib "ESENT.dll" #cfunc global JetCreateIndex2A "JetCreateIndex2A" intptr, intptr, intptr, int ; res = JetCreateIndex2A(sesid, tableid, varptr(pindexcreate), cIndexCreate) ; sesid : JET_SESID -> "intptr" ; tableid : JET_TABLEID -> "intptr" ; pindexcreate : JET_INDEXCREATE_A* -> "intptr" ; cIndexCreate : DWORD -> "int" ; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは varptr(変数))。
import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
esent = windows.NewLazySystemDLL("ESENT.dll")
procJetCreateIndex2A = esent.NewProc("JetCreateIndex2A")
)
// sesid (JET_SESID), tableid (JET_TABLEID), pindexcreate (JET_INDEXCREATE_A*), cIndexCreate (DWORD)
r1, _, err := procJetCreateIndex2A.Call(
uintptr(sesid),
uintptr(tableid),
uintptr(pindexcreate),
uintptr(cIndexCreate),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // INTfunction JetCreateIndex2A(
sesid: NativeUInt; // JET_SESID
tableid: NativeUInt; // JET_TABLEID
pindexcreate: Pointer; // JET_INDEXCREATE_A*
cIndexCreate: DWORD // DWORD
): Integer; stdcall;
external 'ESENT.dll' name 'JetCreateIndex2A';result := DllCall("ESENT\JetCreateIndex2A"
, "UPtr", sesid ; JET_SESID
, "UPtr", tableid ; JET_TABLEID
, "Ptr", pindexcreate ; JET_INDEXCREATE_A*
, "UInt", cIndexCreate ; DWORD
, "Int") ; return: INT●JetCreateIndex2A(sesid, tableid, pindexcreate, cIndexCreate) = DLL("ESENT.dll", "int JetCreateIndex2A(int, int, void*, dword)")
# 呼び出し: JetCreateIndex2A(sesid, tableid, pindexcreate, cIndexCreate)
# sesid : JET_SESID -> "int"
# tableid : JET_TABLEID -> "int"
# pindexcreate : JET_INDEXCREATE_A* -> "void*"
# cIndexCreate : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "esent" fn JetCreateIndex2A(
sesid: usize, // JET_SESID
tableid: usize, // JET_TABLEID
pindexcreate: [*c]JET_INDEXCREATE_A, // JET_INDEXCREATE_A*
cIndexCreate: u32 // DWORD
) callconv(std.os.windows.WINAPI) i32;proc JetCreateIndex2A(
sesid: uint, # JET_SESID
tableid: uint, # JET_TABLEID
pindexcreate: ptr JET_INDEXCREATE_A, # JET_INDEXCREATE_A*
cIndexCreate: uint32 # DWORD
): int32 {.importc: "JetCreateIndex2A", stdcall, dynlib: "ESENT.dll".}pragma(lib, "esent");
extern(Windows)
int JetCreateIndex2A(
size_t sesid, // JET_SESID
size_t tableid, // JET_TABLEID
JET_INDEXCREATE_A* pindexcreate, // JET_INDEXCREATE_A*
uint cIndexCreate // DWORD
);ccall((:JetCreateIndex2A, "ESENT.dll"), stdcall, Int32,
(Csize_t, Csize_t, Ptr{JET_INDEXCREATE_A}, UInt32),
sesid, tableid, pindexcreate, cIndexCreate)
# sesid : JET_SESID -> Csize_t
# tableid : JET_TABLEID -> Csize_t
# pindexcreate : JET_INDEXCREATE_A* -> Ptr{JET_INDEXCREATE_A}
# cIndexCreate : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
int32_t JetCreateIndex2A(
uintptr_t sesid,
uintptr_t tableid,
void* pindexcreate,
uint32_t cIndexCreate);
]]
local esent = ffi.load("esent")
-- esent.JetCreateIndex2A(sesid, tableid, pindexcreate, cIndexCreate)
-- sesid : JET_SESID
-- tableid : JET_TABLEID
-- pindexcreate : JET_INDEXCREATE_A*
-- cIndexCreate : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('ESENT.dll');
const JetCreateIndex2A = lib.func('__stdcall', 'JetCreateIndex2A', 'int32_t', ['uintptr_t', 'uintptr_t', 'void *', 'uint32_t']);
// JetCreateIndex2A(sesid, tableid, pindexcreate, cIndexCreate)
// sesid : JET_SESID -> 'uintptr_t'
// tableid : JET_TABLEID -> 'uintptr_t'
// pindexcreate : JET_INDEXCREATE_A* -> 'void *'
// cIndexCreate : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("ESENT.dll", {
JetCreateIndex2A: { parameters: ["usize", "usize", "pointer", "u32"], result: "i32" },
});
// lib.symbols.JetCreateIndex2A(sesid, tableid, pindexcreate, cIndexCreate)
// sesid : JET_SESID -> "usize"
// tableid : JET_TABLEID -> "usize"
// pindexcreate : JET_INDEXCREATE_A* -> "pointer"
// cIndexCreate : DWORD -> "u32"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
int32_t JetCreateIndex2A(
size_t sesid,
size_t tableid,
void* pindexcreate,
uint32_t cIndexCreate);
C, "ESENT.dll");
// $ffi->JetCreateIndex2A(sesid, tableid, pindexcreate, cIndexCreate);
// sesid : JET_SESID
// tableid : JET_TABLEID
// pindexcreate : JET_INDEXCREATE_A*
// cIndexCreate : 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.ASCII_OPTIONS);
int JetCreateIndex2A(
long sesid, // JET_SESID
long tableid, // JET_TABLEID
Pointer pindexcreate, // JET_INDEXCREATE_A*
int cIndexCreate // DWORD
);
}@[Link("esent")]
lib LibESENT
fun JetCreateIndex2A = JetCreateIndex2A(
sesid : LibC::SizeT, # JET_SESID
tableid : LibC::SizeT, # JET_TABLEID
pindexcreate : JET_INDEXCREATE_A*, # JET_INDEXCREATE_A*
cIndexCreate : 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 JetCreateIndex2ANative = Int32 Function(UintPtr, UintPtr, Pointer<Void>, Uint32);
typedef JetCreateIndex2ADart = int Function(int, int, Pointer<Void>, int);
final JetCreateIndex2A = DynamicLibrary.open('ESENT.dll')
.lookupFunction<JetCreateIndex2ANative, JetCreateIndex2ADart>('JetCreateIndex2A');
// sesid : JET_SESID -> UintPtr
// tableid : JET_TABLEID -> UintPtr
// pindexcreate : JET_INDEXCREATE_A* -> Pointer<Void>
// cIndexCreate : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function JetCreateIndex2A(
sesid: NativeUInt; // JET_SESID
tableid: NativeUInt; // JET_TABLEID
pindexcreate: Pointer; // JET_INDEXCREATE_A*
cIndexCreate: DWORD // DWORD
): Integer; stdcall;
external 'ESENT.dll' name 'JetCreateIndex2A';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "JetCreateIndex2A"
c_JetCreateIndex2A :: CUIntPtr -> CUIntPtr -> Ptr () -> Word32 -> IO Int32
-- sesid : JET_SESID -> CUIntPtr
-- tableid : JET_TABLEID -> CUIntPtr
-- pindexcreate : JET_INDEXCREATE_A* -> Ptr ()
-- cIndexCreate : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let jetcreateindex2a =
foreign "JetCreateIndex2A"
(size_t @-> size_t @-> (ptr void) @-> uint32_t @-> returning int32_t)
(* sesid : JET_SESID -> size_t *)
(* tableid : JET_TABLEID -> size_t *)
(* pindexcreate : JET_INDEXCREATE_A* -> (ptr void) *)
(* cIndexCreate : 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 ("JetCreateIndex2A" jet-create-index2-a :convention :stdcall) :int32
(sesid :uint64) ; JET_SESID
(tableid :uint64) ; JET_TABLEID
(pindexcreate :pointer) ; JET_INDEXCREATE_A*
(c-index-create :uint32)) ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $JetCreateIndex2A = Win32::API::More->new('ESENT',
'int JetCreateIndex2A(WPARAM sesid, WPARAM tableid, LPVOID pindexcreate, DWORD cIndexCreate)');
# my $ret = $JetCreateIndex2A->Call($sesid, $tableid, $pindexcreate, $cIndexCreate);
# sesid : JET_SESID -> WPARAM
# tableid : JET_TABLEID -> WPARAM
# pindexcreate : JET_INDEXCREATE_A* -> LPVOID
# cIndexCreate : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。関連項目
- f JetCreateIndex2W (Unicode版) — 構造体配列で複数のインデックスを一括作成する(Unicode版)。
- f JetCreateIndex3A — 拡張構造体を用いて複数のインデックスを作成する(ANSI版)。
- f JetCreateIndex4A — さらに拡張した構造体で複数のインデックスを作成する(ANSI版)。
- f JetCreateIndexA — キー定義を指定してテーブルにインデックスを作成する(ANSI版)。