JetAddColumnA

関数

テーブルに新しい列を追加する(ANSI版)。

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

シグネチャ

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

INT JetAddColumnA(
    JET_SESID sesid,
    JET_TABLEID tableid,
    CHAR* szColumnName,
    const JET_COLUMNDEF* pcolumndef,
    void* pvDefault,   // optional
    DWORD cbDefault,
    DWORD* pcolumnid   // optional
);

パラメーター

名前	型	方向	説明
sesid	JET_SESID	in	操作に使用するセッションID。
tableid	JET_TABLEID	in	列を追加する対象テーブルのカーソルID。
szColumnName	CHAR*	in	追加する列名を指すANSI文字列。
pcolumndef	JET_COLUMNDEF*	in	追加する列の定義(型・属性等)を保持するJET_COLUMNDEF構造体へのポインタ。
pvDefault	void*	inoptional	列の既定値データへのポインタ。既定値なしの場合はNULL。
cbDefault	DWORD	in	pvDefaultが指す既定値データのバイト長。
pcolumnid	DWORD*	outoptional	割り当てられた列ID(JET_COLUMNID)を受け取るDWORDポインタ。

戻り値の型: INT

公式ドキュメント

JetAddColumn 関数は、ESE データベース内の既存のテーブルに新しい列を追加します。

戻り値

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

戻り値コード	説明
JET_errSuccess	操作は成功しました。
JET_errFixedDDL	固定 DDL のテーブルのデータ定義を変更しようとしました。固定 DDL を持つテーブルの例としては、テンプレートテーブルがあります。
JET_errInvalidParameter	無効なパラメーターが API に渡されました。無効なパラメーターの例を次に示します。 JET_COLUMNDEF 構造体の cbStruct メンバーに誤ったサイズを渡した。 JET_bitColumnUserDefinedDefault を渡したにもかかわらず、cbDefault に sizeof(JET_USERDEFINEDDEFAULT) を設定していない。
JET_errInTransaction	JET_bitColumnUnversioned ビットを設定して列を追加しようとしましたが、セッションは現在トランザクション中です。
JET_errColumnDuplicate	列が既に存在します。バージョン情報なしで列を追加しようとしましたが、その列は既に存在しています。
JET_errTableNotEmpty	テーブルにデータが含まれています。エスクロー更新列は、空のテーブルにのみ追加できます。
JET_errRecordTooBig	レコードが大きすぎます。固定列の cbMax パラメーターの合計は、一定の値を超えてはなりません。
JET_errTooManyColumns	テーブルに追加しようとした列が多すぎます。1 つのテーブルに設定できるのは、固定列が JET_ccolFixedMost 個まで、可変長列が JET_ccolVarMost 個まで、タグ付き列が JET_ccolTaggedMost 個までです。
JET_errColumnRedundant	冗長な列を追加しようとしました。1 つのテーブルにつき、自動インクリメント列は 1 つまで、バージョン列は 1 つまでです。
JET_errCallbackNotResolved	コールバック関数を解決できませんでした。DLL が見つからなかったか、DLL 内の関数が見つからなかった可能性があります。十分なログ記録が有効になっている場合は、イベントログに詳細が出力されます。
JET_wrnColumnMaxTruncated	固定列または可変長列の最大長 (cbMax) が JET_cbColumnMost より大きかったことを示す警告です。この制限は Long Value (すなわち JET_coltypLongBinary と JET_coltypLongText) には適用されません。
JET_errInvalidName	szColumnName として無効な名前が渡されました。制限の詳細については、szColumnName の条件を参照してください。
JET_errInvalidColumnType	coltyp フィールドに有効な列の型が設定されていません。
JET_errInvalidCodePage	JET_COLUMNDEF 構造体の cp パラメーターに有効なコードページが設定されていません。テキスト列で有効な値は English (1252) と Unicode (1200) のみです。値 0 は、既定値 (English、1252) が使用されることを意味します。
JET_errTaggedNotNULL	JET_bitColumnNotNULL は、タグ付き列、Long Value 列、または SLV 列では使用できません。
JET_errInvalidgrbit	grbits の組み合わせが無効です。このエラーが発生する理由には、次のようなものがあります。 JET_bitColumnFixed を、タグ付き列、Long Value 列、または SLV 列に使用した。 JET_bitColumnEscrowUpdate を、JET_coltypLong 型ではない列に使用した。 JET_bitColumnEscrowUpdate を、バージョン列 (JET_bitColumnVersion) に使用した。 JET_bitColumnEscrowUpdate を、自動インクリメント列 (JET_bitColumnAutoincrement) に使用した。 JET_bitColumnEscrowUpdate を、既定値を持たない列 (cbDefault が 0) に使用した。 JET_bitColumnFinalize を、エスクロー更新列ではない列 (JET_bitColumnEscrowUpdate が設定されていない列) に使用した。 JET_bitColumnDeleteOnZero を、エスクロー更新列ではない列 (JET_bitColumnEscrowUpdate が設定されていない列) に使用した。 JET_bitColumnAutoincrement を、JET_coltypLong ではない列に使用した。 Windows 2000: このエラーコードのこの理由は、Windows 2000 でのみ使用されます。 JET_bitColumnAutoincrement を、JET_coltypLong でも JET_coltypCurrency でもない列に使用した。 Windows XP: このエラーコードのこの理由は、Windows XP 以降のオペレーティングシステムで使用されます。 JET_bitColumnVersion を、JET_coltypLong ではない列に使用した。 JET_bitColumnVersion を、自動インクリメント列に使用した。 JET_bitColumnUserDefinedDefault を JET_bitColumnFixed と併用した。 JET_bitColumnUserDefinedDefault を JET_bitColumnNotNULL と併用した。 JET_bitColumnUserDefinedDefault を JET_bitColumnVersion と併用した。 JET_bitColumnUserDefinedDefault を JET_bitColumnAutoincrement と併用した。 JET_bitColumnUserDefinedDefault を JET_bitColumnUpdatable と併用した。 JET_bitColumnUserDefinedDefault を JET_bitColumnEscrowUpdate と併用した。 JET_bitColumnUserDefinedDefault を JET_bitColumnFinalize と併用した。 JET_bitColumnUserDefinedDefault を JET_bitColumnDeleteOnZero と併用した。 JET_bitColumnUserDefinedDefault を JET_bitColumnMaybeNull と併用した。 JET_bitColumnUserDefinedDefault を、タグ付きではない列 (すなわち固定列または可変長列) に使用した。
JET_errMultiValuedColumnMustBeTagged	複数値列 (JET_bitColumnMultiValued) は、タグ付き列または Long Value 列 (JET_coltypLongBinary または JET_coltypLongText) にのみ使用できます。
JET_errCannotBeTagged	タグ付きにできない可能性のある状況で、タグ付き列を使用しようとしました。タグ付き列が許可されない制約には、次のようなものがあります。エスクロー更新列 (JET_bitColumnEscrowUpdate) は、タグ付き列または Long Value 列 (JET_coltypLongBinary または JET_coltypLongText) には使用できません。自動インクリメント列はタグ付きにできません。バージョン列はタグ付きにできません。
JET_errExclusiveTableLockRequired	この操作には、テーブルに対する排他ロックが必要でした。
JET_wrnColumnMaxTruncated	固定列または可変長列の最大長 (cbMax) が JET_cbColumnMost より大きかったことを示す警告です。この制限は Long Value (すなわち JET_coltypLongBinary と JET_coltypLongText) には適用されません。

要件

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

各言語での呼び出し定義

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

INT JetAddColumnA(
    JET_SESID sesid,
    JET_TABLEID tableid,
    CHAR* szColumnName,
    const JET_COLUMNDEF* pcolumndef,
    void* pvDefault,   // optional
    DWORD cbDefault,
    DWORD* pcolumnid   // optional
);

[DllImport("ESENT.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern int JetAddColumnA(
    UIntPtr sesid,   // JET_SESID
    UIntPtr tableid,   // JET_TABLEID
    IntPtr szColumnName,   // CHAR*
    IntPtr pcolumndef,   // JET_COLUMNDEF*
    IntPtr pvDefault,   // void* optional
    uint cbDefault,   // DWORD
    IntPtr pcolumnid   // DWORD* optional, out
);

<DllImport("ESENT.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function JetAddColumnA(
    sesid As UIntPtr,   ' JET_SESID
    tableid As UIntPtr,   ' JET_TABLEID
    szColumnName As IntPtr,   ' CHAR*
    pcolumndef As IntPtr,   ' JET_COLUMNDEF*
    pvDefault As IntPtr,   ' void* optional
    cbDefault As UInteger,   ' DWORD
    pcolumnid As IntPtr   ' DWORD* optional, out
) As Integer
End Function

' sesid : JET_SESID
' tableid : JET_TABLEID
' szColumnName : CHAR*
' pcolumndef : JET_COLUMNDEF*
' pvDefault : void* optional
' cbDefault : DWORD
' pcolumnid : DWORD* optional, out
Declare PtrSafe Function JetAddColumnA Lib "esent" ( _
    ByVal sesid As LongPtr, _
    ByVal tableid As LongPtr, _
    ByVal szColumnName As LongPtr, _
    ByVal pcolumndef As LongPtr, _
    ByVal pvDefault As LongPtr, _
    ByVal cbDefault As Long, _
    ByVal pcolumnid As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

JetAddColumnA = ctypes.windll.esent.JetAddColumnA
JetAddColumnA.restype = ctypes.c_int
JetAddColumnA.argtypes = [
    ctypes.c_size_t,  # sesid : JET_SESID
    ctypes.c_size_t,  # tableid : JET_TABLEID
    ctypes.POINTER(ctypes.c_byte),  # szColumnName : CHAR*
    ctypes.c_void_p,  # pcolumndef : JET_COLUMNDEF*
    ctypes.POINTER(None),  # pvDefault : void* optional
    wintypes.DWORD,  # cbDefault : DWORD
    ctypes.POINTER(wintypes.DWORD),  # pcolumnid : DWORD* optional, out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ESENT.dll')
JetAddColumnA = Fiddle::Function.new(
  lib['JetAddColumnA'],
  [
    Fiddle::TYPE_UINTPTR_T,  # sesid : JET_SESID
    Fiddle::TYPE_UINTPTR_T,  # tableid : JET_TABLEID
    Fiddle::TYPE_VOIDP,  # szColumnName : CHAR*
    Fiddle::TYPE_VOIDP,  # pcolumndef : JET_COLUMNDEF*
    Fiddle::TYPE_VOIDP,  # pvDefault : void* optional
    -Fiddle::TYPE_INT,  # cbDefault : DWORD
    Fiddle::TYPE_VOIDP,  # pcolumnid : DWORD* optional, out
  ],
  Fiddle::TYPE_INT)

#[link(name = "esent")]
extern "system" {
    fn JetAddColumnA(
        sesid: usize,  // JET_SESID
        tableid: usize,  // JET_TABLEID
        szColumnName: *mut i8,  // CHAR*
        pcolumndef: *const JET_COLUMNDEF,  // JET_COLUMNDEF*
        pvDefault: *mut (),  // void* optional
        cbDefault: u32,  // DWORD
        pcolumnid: *mut u32  // DWORD* optional, out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("ESENT.dll", CharSet = CharSet.Ansi)]
public static extern int JetAddColumnA(UIntPtr sesid, UIntPtr tableid, IntPtr szColumnName, IntPtr pcolumndef, IntPtr pvDefault, uint cbDefault, IntPtr pcolumnid);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ESENT_JetAddColumnA' -Namespace Win32 -PassThru
# $api::JetAddColumnA(sesid, tableid, szColumnName, pcolumndef, pvDefault, cbDefault, pcolumnid)

#uselib "ESENT.dll"
#func global JetAddColumnA "JetAddColumnA" sptr, sptr, sptr, sptr, sptr, sptr, sptr
; JetAddColumnA sesid, tableid, varptr(szColumnName), varptr(pcolumndef), pvDefault, cbDefault, varptr(pcolumnid)   ; 戻り値は stat
; sesid : JET_SESID -> "sptr"
; tableid : JET_TABLEID -> "sptr"
; szColumnName : CHAR* -> "sptr"
; pcolumndef : JET_COLUMNDEF* -> "sptr"
; pvDefault : void* optional -> "sptr"
; cbDefault : DWORD -> "sptr"
; pcolumnid : DWORD* optional, out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "ESENT.dll"
#cfunc global JetAddColumnA "JetAddColumnA" sptr, sptr, var, var, sptr, int, var
; res = JetAddColumnA(sesid, tableid, szColumnName, pcolumndef, pvDefault, cbDefault, pcolumnid)
; sesid : JET_SESID -> "sptr"
; tableid : JET_TABLEID -> "sptr"
; szColumnName : CHAR* -> "var"
; pcolumndef : JET_COLUMNDEF* -> "var"
; pvDefault : void* optional -> "sptr"
; cbDefault : DWORD -> "int"
; pcolumnid : DWORD* optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "ESENT.dll"
#cfunc global JetAddColumnA "JetAddColumnA" sptr, sptr, sptr, sptr, sptr, int, sptr
; res = JetAddColumnA(sesid, tableid, varptr(szColumnName), varptr(pcolumndef), pvDefault, cbDefault, varptr(pcolumnid))
; sesid : JET_SESID -> "sptr"
; tableid : JET_TABLEID -> "sptr"
; szColumnName : CHAR* -> "sptr"
; pcolumndef : JET_COLUMNDEF* -> "sptr"
; pvDefault : void* optional -> "sptr"
; cbDefault : DWORD -> "int"
; pcolumnid : DWORD* optional, out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。