JetCreateIndexW

関数

キー定義を指定してテーブルにインデックスを作成する(Unicode版)。

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

シグネチャ

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

INT JetCreateIndexW(
    JET_SESID sesid,
    JET_TABLEID tableid,
    WORD* szIndexName,
    DWORD grbit,
    WORD* szKey,
    DWORD cbKey,
    DWORD lDensity
);

パラメーター

名前	型	方向	説明
sesid	JET_SESID	in	操作に使用するセッションID。
tableid	JET_TABLEID	in	インデックスを作成する対象テーブルのカーソルID。
szIndexName	WORD*	in	作成するインデックス名を指すワイド文字列(WORD*)。
grbit	DWORD	in	インデックス属性を制御するJET_bitIndexUnique等のフラグ。
szKey	WORD*	in	キー列の指定を二重NUL終端で並べたワイド文字列(各列は方向記号+列名)。
cbKey	DWORD	in	szKeyの全体バイト長(終端NULを含む)。
lDensity	DWORD	in	インデックスの初期ページ充填率(20〜100のパーセント)。

戻り値の型: INT

公式ドキュメント

JetCreateIndex 関数を使用すると、Extensible Storage Engine (ESE) データベース内のデータのインデックスを作成できます。これにより、特定のデータをすばやく見つけることができます。

戻り値

この関数は JET_ERR データ型を返し、その値は次の表に示す戻り値コードのいずれかです。発生する可能性のある ESE のエラーの詳細については、Extensible Storage Engine Errors および Error Handling Parameters を参照してください。

戻り値コード	意味
JET_errSuccess	操作は正常に完了しました。

JetCreateIndex 関数が返す可能性のあるその他のエラーの一覧については、JetCreateIndex2 を参照してください。

解説

JetCreateIndex 関数の呼び出しは、JetCreateIndex のパラメーターと同じ設定を格納した JET_INDEXCREATE 構造体と、1 に等しい cIndexCreate パラメーターを指定して JetCreateIndex2 関数を呼び出す場合と同じです。JET_INDEXCREATE 構造体のフィールドのうち、JetCreateIndex に対応するパラメーターがないものについては、値 0 が想定されます。

JetCreateIndex は JetCreateIndex2 に置き換えられている点に注意してください。

要件

要件	値
クライアント	Windows Vista、Windows XP、または Windows 2000 Professional が必要です。
サーバー	Windows Server 2008、Windows Server 2003、または Windows 2000 Server が必要です。
ヘッダー	Esent.h で宣言されています。
ライブラリ	ESENT.lib を使用します。
DLL	ESENT.dll が必要です。
Unicode	JetCreateIndexW (Unicode) および JetCreateIndexA (ANSI) として実装されています。

各言語での呼び出し定義

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

INT JetCreateIndexW(
    JET_SESID sesid,
    JET_TABLEID tableid,
    WORD* szIndexName,
    DWORD grbit,
    WORD* szKey,
    DWORD cbKey,
    DWORD lDensity
);

[DllImport("ESENT.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern int JetCreateIndexW(
    UIntPtr sesid,   // JET_SESID
    UIntPtr tableid,   // JET_TABLEID
    ref ushort szIndexName,   // WORD*
    uint grbit,   // DWORD
    ref ushort szKey,   // WORD*
    uint cbKey,   // DWORD
    uint lDensity   // DWORD
);

<DllImport("ESENT.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function JetCreateIndexW(
    sesid As UIntPtr,   ' JET_SESID
    tableid As UIntPtr,   ' JET_TABLEID
    ByRef szIndexName As UShort,   ' WORD*
    grbit As UInteger,   ' DWORD
    ByRef szKey As UShort,   ' WORD*
    cbKey As UInteger,   ' DWORD
    lDensity As UInteger   ' DWORD
) As Integer
End Function

' sesid : JET_SESID
' tableid : JET_TABLEID
' szIndexName : WORD*
' grbit : DWORD
' szKey : WORD*
' cbKey : DWORD
' lDensity : DWORD
Declare PtrSafe Function JetCreateIndexW Lib "esent" ( _
    ByVal sesid As LongPtr, _
    ByVal tableid As LongPtr, _
    ByRef szIndexName As Integer, _
    ByVal grbit As Long, _
    ByRef szKey As Integer, _
    ByVal cbKey As Long, _
    ByVal lDensity 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

JetCreateIndexW = ctypes.windll.esent.JetCreateIndexW
JetCreateIndexW.restype = ctypes.c_int
JetCreateIndexW.argtypes = [
    ctypes.c_size_t,  # sesid : JET_SESID
    ctypes.c_size_t,  # tableid : JET_TABLEID
    ctypes.POINTER(ctypes.c_ushort),  # szIndexName : WORD*
    wintypes.DWORD,  # grbit : DWORD
    ctypes.POINTER(ctypes.c_ushort),  # szKey : WORD*
    wintypes.DWORD,  # cbKey : DWORD
    wintypes.DWORD,  # lDensity : DWORD
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ESENT.dll')
JetCreateIndexW = Fiddle::Function.new(
  lib['JetCreateIndexW'],
  [
    Fiddle::TYPE_UINTPTR_T,  # sesid : JET_SESID
    Fiddle::TYPE_UINTPTR_T,  # tableid : JET_TABLEID
    Fiddle::TYPE_VOIDP,  # szIndexName : WORD*
    -Fiddle::TYPE_INT,  # grbit : DWORD
    Fiddle::TYPE_VOIDP,  # szKey : WORD*
    -Fiddle::TYPE_INT,  # cbKey : DWORD
    -Fiddle::TYPE_INT,  # lDensity : DWORD
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "esent")]
extern "system" {
    fn JetCreateIndexW(
        sesid: usize,  // JET_SESID
        tableid: usize,  // JET_TABLEID
        szIndexName: *mut u16,  // WORD*
        grbit: u32,  // DWORD
        szKey: *mut u16,  // WORD*
        cbKey: u32,  // DWORD
        lDensity: u32  // DWORD
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("ESENT.dll", CharSet = CharSet.Unicode)]
public static extern int JetCreateIndexW(UIntPtr sesid, UIntPtr tableid, ref ushort szIndexName, uint grbit, ref ushort szKey, uint cbKey, uint lDensity);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ESENT_JetCreateIndexW' -Namespace Win32 -PassThru
# $api::JetCreateIndexW(sesid, tableid, szIndexName, grbit, szKey, cbKey, lDensity)

#uselib "ESENT.dll"
#func global JetCreateIndexW "JetCreateIndexW" wptr, wptr, wptr, wptr, wptr, wptr, wptr
; JetCreateIndexW sesid, tableid, varptr(szIndexName), grbit, varptr(szKey), cbKey, lDensity   ; 戻り値は stat
; sesid : JET_SESID -> "wptr"
; tableid : JET_TABLEID -> "wptr"
; szIndexName : WORD* -> "wptr"
; grbit : DWORD -> "wptr"
; szKey : WORD* -> "wptr"
; cbKey : DWORD -> "wptr"
; lDensity : DWORD -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

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