JetCreateTableColumnIndexA
関数シグネチャ
// ESENT.dll (ANSI / -A)
#include <windows.h>
INT JetCreateTableColumnIndexA(
JET_SESID sesid,
DWORD dbid,
JET_TABLECREATE_A* ptablecreate
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| sesid | JET_SESID | in | 操作に使用するセッションID。 |
| dbid | DWORD | in | テーブルを作成する対象データベースのID。 |
| ptablecreate | JET_TABLECREATE_A* | inout | テーブル・列・インデックスを一括定義するJET_TABLECREATE_A構造体へのポインタ。 |
戻り値の型: INT
公式ドキュメント
JetCreateTableColumnIndex 関数は、JET_TABLECREATE 構造体の配列から、初期インデックス群と初期カラム群を備えたテーブルを ESE データベース内に作成します。JetCreateTableColumnIndex という名前は、オブジェクトの作成順序に由来します。まずテーブルを作成し、次にカラム、最後にインデックスを作成します。
戻り値
この関数は JET_ERR データ型を返し、その値は以下のいずれかの戻りコードです。ESE で発生しうるエラーの詳細については、Extensible Storage Engine Errors および Error Handling Parameters を参照してください。
戻りコード |
説明 |
|---|---|
JET_errSuccess |
操作は正常に完了しました。 |
JET_errCallbackNotResolved |
コールバック関数を解決できませんでした。DLL が見つからなかったか、DLL 内の関数が見つからなかった可能性があります。十分なログ記録が有効になっている場合は、イベントログに詳細が記録されます。 |
JET_errCannotIndex |
escrow-update カラムまたは SLV カラムに対してインデックスを作成しようとしました (SLV カラムは非推奨である点に注意してください)。 |
JET_errCannotNestDDL |
ptablecreate->grbit に JET_bitTableCreateTemplateTable が指定されているにもかかわらず、ptablecreate->szTemplateTableName が NULL に設定されている場合。 |
JET_errColumnDuplicate |
カラムが既に存在します。 |
JET_errColumnNotFound |
存在しないカラムに対してインデックスを作成しようとしました。存在しないカラムに対して条件付きインデックスを作成しようとした場合にも、このエラーが発生することがあります。 |
JET_errColumnRedundant |
冗長なカラムを追加しようとしました。1 つのテーブルにつき、自動インクリメントカラムは 1 つまで、バージョンカラムも 1 つまでしか持てません。 |
JET_errDensityInvalid |
このエラーは、JET_INDEXCREATE 構造体の ulDensity メンバーが 20 未満または 100 を超える値に設定されている場合に返されます。 |
JET_errDDLNotInheritable |
JET_TABLECREATE 構造体の szTemplateTableName メンバーで指定されたテーブルが、テンプレートテーブルとしてマークされていない (つまり、そのテーブルに JET_bitTableCreateTemplateTable が設定されていない) ことを示します。 |
JET_errIndexDuplicate |
同一のインデックスを 2 つ定義しようとしました。 |
JET_errIndexHasPrimary |
1 つのテーブルに対して複数のプライマリインデックスを指定しようとしました。テーブルにはプライマリインデックスがちょうど 1 つ必要です。プライマリインデックスが指定されていない場合は、データベースエンジンが透過的に作成します。 |
JET_errIndexInvalidDef |
無効なインデックス定義が指定されました。このエラーが返される理由としては、次のようなものがあります。
|
JET_errIndexTuplesInvalidLimits |
Windows XP 以降。JET_TUPLELIMITS 構造体が指定されましたが、その制限値はサポートされていません。JET_TUPLELIMITS 構造体の解説セクションを参照してください。 |
JET_errIndexTuplesNonUniqueOnly |
Windows XP 以降。タプルインデックスは一意にできません (つまり、JET_INDEXCREATE 構造体の grbit メンバーに JET_bitIndexPrimary と 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_errInvalidCodePage |
JET_COLUMNCREATE 構造体の cp メンバーが有効なコードページに設定されていませんでした。テキストカラムで有効な値は English (1252) と Unicode (1200) のみです。値 0 は既定値 (English、1252) が使用されることを意味します。 |
JET_errInvalidColumnType |
JET_COLUMNCREATE 構造体の coltyp メンバーが有効なカラム型に設定されていませんでした。 |
JET_errInvalidCreateIndex |
このエラーが発生する理由としては、次のようなものがあります。
|
JET_errInvalidgrbit |
JET_TABLECREATE または JET_TABLECREATE2 で、grbit メンバーの無効な組み合わせが指定されました。 grbit メンバーに矛盾した値が含まれているため、インデックス定義が無効です。考えられる理由としては、次のようなものがあります。
|
JET_errInvalidLanguageId |
無効なロケール ID (LCID) が渡されました (JET_INDEXCREATE 構造体の pidxunicode メンバーが指す JET_UNICODEINDEX 構造体の lcid メンバー経由、または JET_INDEXCREATE 構造体の lcid フィールド経由のいずれか)。 |
JET_errInvalidParameter |
無効なパラメーターが指定されました。考えられる理由としては、次のようなものがあります。
|
JET_errRecordTooBig |
レコードが大きすぎます。すべての固定長カラムについての JET_COLUMNCREATE 構造体の cbMax メンバーの合計は、一定の値を超えてはなりません。 |
JET_errTableDuplicate |
テーブルが既に存在します。 |
JET_errTooManyColumns |
テーブルに追加しようとしたカラムが多すぎます。1 つのテーブルが持てるのは、固定長カラムが JET_ccolFixedMost 個まで、可変長カラムが JET_ccolVarMost 個まで、タグ付きカラムが JET_ccolTaggedMost 個までです。 |
JET_errUnicodeTranslationFail |
Unicode カラムを正規化しようとした際にエラーが発生しました。これはシステムリソースが不足した場合に発生することがあります。 |
解説
JetCreateTableColumnIndex の呼び出しは、JET_TABLECREATE2 構造体の各フィールドに JET_TABLECREATE の対応するフィールドの値を設定して JetCreateTableColumnIndex2 を呼び出すのと同じです。ただし、次の点が異なります。
JET_TABLECREATE2.cbStruct には sizeof( JET_TABLECREATE2) を設定
JET_TABLECREATE2.szCallback には NULL を設定
JET_TABLECREATE2.cbtyp には 0 を設定
詳細については、JetCreateTableColumnIndex2 を参照してください。
JetOpenTable と同様に、アプリケーションは返された tableid の使用を終えたら、通常は JetCloseTable で閉じる必要があります。
要件
| 要件 | 値 |
|---|---|
クライアント |
Windows Vista、Windows XP、または Windows 2000 Professional が必要です。 |
サーバー |
Windows Server 2008、Windows Server 2003、または Windows 2000 Server が必要です。 |
ヘッダー |
Esent.h で宣言されています。 |
ライブラリ |
ESENT.lib を使用します。 |
DLL |
ESENT.dll が必要です。 |
Unicode |
JetCreateTableColumnIndexW (Unicode) および JetCreateTableColumnIndexA (ANSI) として実装されています。 |
関連項目
JET_DBID JET_ERR JET_GRBIT JET_TABLEID JET_TABLECREATE JET_TABLECREATE2 JetAddColumn JetCreateTableColumnIndex JetCreateTableColumnIndex2
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp)
各言語での呼び出し定義
// ESENT.dll (ANSI / -A)
#include <windows.h>
INT JetCreateTableColumnIndexA(
JET_SESID sesid,
DWORD dbid,
JET_TABLECREATE_A* ptablecreate
);[DllImport("ESENT.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern int JetCreateTableColumnIndexA(
UIntPtr sesid, // JET_SESID
uint dbid, // DWORD
IntPtr ptablecreate // JET_TABLECREATE_A* in/out
);<DllImport("ESENT.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function JetCreateTableColumnIndexA(
sesid As UIntPtr, ' JET_SESID
dbid As UInteger, ' DWORD
ptablecreate As IntPtr ' JET_TABLECREATE_A* in/out
) As Integer
End Function' sesid : JET_SESID
' dbid : DWORD
' ptablecreate : JET_TABLECREATE_A* in/out
Declare PtrSafe Function JetCreateTableColumnIndexA Lib "esent" ( _
ByVal sesid As LongPtr, _
ByVal dbid As Long, _
ByVal ptablecreate As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
JetCreateTableColumnIndexA = ctypes.windll.esent.JetCreateTableColumnIndexA
JetCreateTableColumnIndexA.restype = ctypes.c_int
JetCreateTableColumnIndexA.argtypes = [
ctypes.c_size_t, # sesid : JET_SESID
wintypes.DWORD, # dbid : DWORD
ctypes.c_void_p, # ptablecreate : JET_TABLECREATE_A* in/out
]require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('ESENT.dll')
JetCreateTableColumnIndexA = Fiddle::Function.new(
lib['JetCreateTableColumnIndexA'],
[
Fiddle::TYPE_UINTPTR_T, # sesid : JET_SESID
-Fiddle::TYPE_INT, # dbid : DWORD
Fiddle::TYPE_VOIDP, # ptablecreate : JET_TABLECREATE_A* in/out
],
Fiddle::TYPE_INT)#[link(name = "esent")]
extern "system" {
fn JetCreateTableColumnIndexA(
sesid: usize, // JET_SESID
dbid: u32, // DWORD
ptablecreate: *mut JET_TABLECREATE_A // JET_TABLECREATE_A* in/out
) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[DllImport("ESENT.dll", CharSet = CharSet.Ansi)]
public static extern int JetCreateTableColumnIndexA(UIntPtr sesid, uint dbid, IntPtr ptablecreate);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ESENT_JetCreateTableColumnIndexA' -Namespace Win32 -PassThru
# $api::JetCreateTableColumnIndexA(sesid, dbid, ptablecreate)#uselib "ESENT.dll"
#func global JetCreateTableColumnIndexA "JetCreateTableColumnIndexA" sptr, sptr, sptr
; JetCreateTableColumnIndexA sesid, dbid, varptr(ptablecreate) ; 戻り値は stat
; sesid : JET_SESID -> "sptr"
; dbid : DWORD -> "sptr"
; ptablecreate : JET_TABLECREATE_A* in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "ESENT.dll" #cfunc global JetCreateTableColumnIndexA "JetCreateTableColumnIndexA" sptr, int, var ; res = JetCreateTableColumnIndexA(sesid, dbid, ptablecreate) ; sesid : JET_SESID -> "sptr" ; dbid : DWORD -> "int" ; ptablecreate : JET_TABLECREATE_A* in/out -> "var" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "ESENT.dll" #cfunc global JetCreateTableColumnIndexA "JetCreateTableColumnIndexA" sptr, int, sptr ; res = JetCreateTableColumnIndexA(sesid, dbid, varptr(ptablecreate)) ; sesid : JET_SESID -> "sptr" ; dbid : DWORD -> "int" ; ptablecreate : JET_TABLECREATE_A* in/out -> "sptr" ; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; INT JetCreateTableColumnIndexA(JET_SESID sesid, DWORD dbid, JET_TABLECREATE_A* ptablecreate) #uselib "ESENT.dll" #cfunc global JetCreateTableColumnIndexA "JetCreateTableColumnIndexA" intptr, int, var ; res = JetCreateTableColumnIndexA(sesid, dbid, ptablecreate) ; sesid : JET_SESID -> "intptr" ; dbid : DWORD -> "int" ; ptablecreate : JET_TABLECREATE_A* in/out -> "var" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。; INT JetCreateTableColumnIndexA(JET_SESID sesid, DWORD dbid, JET_TABLECREATE_A* ptablecreate) #uselib "ESENT.dll" #cfunc global JetCreateTableColumnIndexA "JetCreateTableColumnIndexA" intptr, int, intptr ; res = JetCreateTableColumnIndexA(sesid, dbid, varptr(ptablecreate)) ; sesid : JET_SESID -> "intptr" ; dbid : DWORD -> "int" ; ptablecreate : JET_TABLECREATE_A* in/out -> "intptr" ; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは varptr(変数))。
import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
esent = windows.NewLazySystemDLL("ESENT.dll")
procJetCreateTableColumnIndexA = esent.NewProc("JetCreateTableColumnIndexA")
)
// sesid (JET_SESID), dbid (DWORD), ptablecreate (JET_TABLECREATE_A* in/out)
r1, _, err := procJetCreateTableColumnIndexA.Call(
uintptr(sesid),
uintptr(dbid),
uintptr(ptablecreate),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // INTfunction JetCreateTableColumnIndexA(
sesid: NativeUInt; // JET_SESID
dbid: DWORD; // DWORD
ptablecreate: Pointer // JET_TABLECREATE_A* in/out
): Integer; stdcall;
external 'ESENT.dll' name 'JetCreateTableColumnIndexA';result := DllCall("ESENT\JetCreateTableColumnIndexA"
, "UPtr", sesid ; JET_SESID
, "UInt", dbid ; DWORD
, "Ptr", ptablecreate ; JET_TABLECREATE_A* in/out
, "Int") ; return: INT●JetCreateTableColumnIndexA(sesid, dbid, ptablecreate) = DLL("ESENT.dll", "int JetCreateTableColumnIndexA(int, dword, void*)")
# 呼び出し: JetCreateTableColumnIndexA(sesid, dbid, ptablecreate)
# sesid : JET_SESID -> "int"
# dbid : DWORD -> "dword"
# ptablecreate : JET_TABLECREATE_A* in/out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "esent" fn JetCreateTableColumnIndexA(
sesid: usize, // JET_SESID
dbid: u32, // DWORD
ptablecreate: [*c]JET_TABLECREATE_A // JET_TABLECREATE_A* in/out
) callconv(std.os.windows.WINAPI) i32;proc JetCreateTableColumnIndexA(
sesid: uint, # JET_SESID
dbid: uint32, # DWORD
ptablecreate: ptr JET_TABLECREATE_A # JET_TABLECREATE_A* in/out
): int32 {.importc: "JetCreateTableColumnIndexA", stdcall, dynlib: "ESENT.dll".}pragma(lib, "esent");
extern(Windows)
int JetCreateTableColumnIndexA(
size_t sesid, // JET_SESID
uint dbid, // DWORD
JET_TABLECREATE_A* ptablecreate // JET_TABLECREATE_A* in/out
);ccall((:JetCreateTableColumnIndexA, "ESENT.dll"), stdcall, Int32,
(Csize_t, UInt32, Ptr{JET_TABLECREATE_A}),
sesid, dbid, ptablecreate)
# sesid : JET_SESID -> Csize_t
# dbid : DWORD -> UInt32
# ptablecreate : JET_TABLECREATE_A* in/out -> Ptr{JET_TABLECREATE_A}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
int32_t JetCreateTableColumnIndexA(
uintptr_t sesid,
uint32_t dbid,
void* ptablecreate);
]]
local esent = ffi.load("esent")
-- esent.JetCreateTableColumnIndexA(sesid, dbid, ptablecreate)
-- sesid : JET_SESID
-- dbid : DWORD
-- ptablecreate : JET_TABLECREATE_A* in/out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('ESENT.dll');
const JetCreateTableColumnIndexA = lib.func('__stdcall', 'JetCreateTableColumnIndexA', 'int32_t', ['uintptr_t', 'uint32_t', 'void *']);
// JetCreateTableColumnIndexA(sesid, dbid, ptablecreate)
// sesid : JET_SESID -> 'uintptr_t'
// dbid : DWORD -> 'uint32_t'
// ptablecreate : JET_TABLECREATE_A* in/out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("ESENT.dll", {
JetCreateTableColumnIndexA: { parameters: ["usize", "u32", "pointer"], result: "i32" },
});
// lib.symbols.JetCreateTableColumnIndexA(sesid, dbid, ptablecreate)
// sesid : JET_SESID -> "usize"
// dbid : DWORD -> "u32"
// ptablecreate : JET_TABLECREATE_A* in/out -> "pointer"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
int32_t JetCreateTableColumnIndexA(
size_t sesid,
uint32_t dbid,
void* ptablecreate);
C, "ESENT.dll");
// $ffi->JetCreateTableColumnIndexA(sesid, dbid, ptablecreate);
// sesid : JET_SESID
// dbid : DWORD
// ptablecreate : JET_TABLECREATE_A* in/out
// 構造体/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 JetCreateTableColumnIndexA(
long sesid, // JET_SESID
int dbid, // DWORD
Pointer ptablecreate // JET_TABLECREATE_A* in/out
);
}@[Link("esent")]
lib LibESENT
fun JetCreateTableColumnIndexA = JetCreateTableColumnIndexA(
sesid : LibC::SizeT, # JET_SESID
dbid : UInt32, # DWORD
ptablecreate : JET_TABLECREATE_A* # JET_TABLECREATE_A* in/out
) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef JetCreateTableColumnIndexANative = Int32 Function(UintPtr, Uint32, Pointer<Void>);
typedef JetCreateTableColumnIndexADart = int Function(int, int, Pointer<Void>);
final JetCreateTableColumnIndexA = DynamicLibrary.open('ESENT.dll')
.lookupFunction<JetCreateTableColumnIndexANative, JetCreateTableColumnIndexADart>('JetCreateTableColumnIndexA');
// sesid : JET_SESID -> UintPtr
// dbid : DWORD -> Uint32
// ptablecreate : JET_TABLECREATE_A* in/out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function JetCreateTableColumnIndexA(
sesid: NativeUInt; // JET_SESID
dbid: DWORD; // DWORD
ptablecreate: Pointer // JET_TABLECREATE_A* in/out
): Integer; stdcall;
external 'ESENT.dll' name 'JetCreateTableColumnIndexA';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "JetCreateTableColumnIndexA"
c_JetCreateTableColumnIndexA :: CUIntPtr -> Word32 -> Ptr () -> IO Int32
-- sesid : JET_SESID -> CUIntPtr
-- dbid : DWORD -> Word32
-- ptablecreate : JET_TABLECREATE_A* in/out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let jetcreatetablecolumnindexa =
foreign "JetCreateTableColumnIndexA"
(size_t @-> uint32_t @-> (ptr void) @-> returning int32_t)
(* sesid : JET_SESID -> size_t *)
(* dbid : DWORD -> uint32_t *)
(* ptablecreate : JET_TABLECREATE_A* in/out -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)(cffi:define-foreign-library esent (t "ESENT.dll"))
(cffi:use-foreign-library esent)
(cffi:defcfun ("JetCreateTableColumnIndexA" jet-create-table-column-index-a :convention :stdcall) :int32
(sesid :uint64) ; JET_SESID
(dbid :uint32) ; DWORD
(ptablecreate :pointer)) ; JET_TABLECREATE_A* in/out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $JetCreateTableColumnIndexA = Win32::API::More->new('ESENT',
'int JetCreateTableColumnIndexA(WPARAM sesid, DWORD dbid, LPVOID ptablecreate)');
# my $ret = $JetCreateTableColumnIndexA->Call($sesid, $dbid, $ptablecreate);
# sesid : JET_SESID -> WPARAM
# dbid : DWORD -> DWORD
# ptablecreate : JET_TABLECREATE_A* in/out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。関連項目
- f JetCreateTableColumnIndexW (Unicode版) — 列とインデックスを含むESEテーブルを一括作成する。
- f JetCreateTableColumnIndex2A — 列とインデックスを含むESEテーブルを一括作成する(拡張ANSI版)。
- f JetCreateTableColumnIndex3A — 列とインデックスを含むESEテーブルを一括作成する(拡張ANSI版)。
- f JetCreateTableColumnIndex4A — 列とインデックスを含むESEテーブルを一括作成する(拡張ANSI版)。