JetDeleteColumn2A

関数

オプション指定付きでテーブルから列を削除する(ANSI版)。

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

シグネチャ

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

INT JetDeleteColumn2A(
    JET_SESID sesid,
    JET_TABLEID tableid,
    CHAR* szColumnName,
    DWORD grbit
);

パラメーター

名前	型	方向	説明
sesid	JET_SESID	in	操作に使用するセッションID。
tableid	JET_TABLEID	in	列を削除する対象テーブルのカーソルID。
szColumnName	CHAR*	in	削除する列名を指すANSI文字列。
grbit	DWORD	in	削除動作を制御するJET_bitDeleteColumnIgnoreTemplateColumns等のフラグ。

戻り値の型: INT

公式ドキュメント

JetDeleteColumn2 関数は、ESE データベースのテーブルから列を削除します。また、grbit オプションを指定できます。

戻り値

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

リターンコード	説明
JET_errSuccess	操作は正常に完了しました。
JET_errColumnInUse	その列は現在使用中です。インデックスによって使用されている可能性があります。
JET_errFixedDDL	固定 DDL を変更しようとしました。
JET_errFixedInheritedDDL	szColumnName で指定された列がテンプレートテーブルに存在します。テンプレートテーブルの DDL は変更できません。
JET_errInvalidName	szColumnName に不正な名前が指定された場合に返されることがあります。
JET_errPermissionDenied	テーブルが書き込み可能ではありません。データベースが読み取り専用モードで開かれている場合に返されることがあります。
JET_errTransReadOnly	そのトランザクションは読み取り専用トランザクションです。

解説

JetDeleteColumn を呼び出すことは、grbit に 0 (ゼロ) を設定して JetDeleteColumn2 を呼び出すことと同じです。

要件

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

各言語での呼び出し定義

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

INT JetDeleteColumn2A(
    JET_SESID sesid,
    JET_TABLEID tableid,
    CHAR* szColumnName,
    DWORD grbit
);

[DllImport("ESENT.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern int JetDeleteColumn2A(
    UIntPtr sesid,   // JET_SESID
    UIntPtr tableid,   // JET_TABLEID
    IntPtr szColumnName,   // CHAR*
    uint grbit   // DWORD
);

<DllImport("ESENT.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function JetDeleteColumn2A(
    sesid As UIntPtr,   ' JET_SESID
    tableid As UIntPtr,   ' JET_TABLEID
    szColumnName As IntPtr,   ' CHAR*
    grbit As UInteger   ' DWORD
) As Integer
End Function

' sesid : JET_SESID
' tableid : JET_TABLEID
' szColumnName : CHAR*
' grbit : DWORD
Declare PtrSafe Function JetDeleteColumn2A Lib "esent" ( _
    ByVal sesid As LongPtr, _
    ByVal tableid As LongPtr, _
    ByVal szColumnName As LongPtr, _
    ByVal grbit As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

JetDeleteColumn2A = ctypes.windll.esent.JetDeleteColumn2A
JetDeleteColumn2A.restype = ctypes.c_int
JetDeleteColumn2A.argtypes = [
    ctypes.c_size_t,  # sesid : JET_SESID
    ctypes.c_size_t,  # tableid : JET_TABLEID
    ctypes.POINTER(ctypes.c_byte),  # szColumnName : CHAR*
    wintypes.DWORD,  # grbit : DWORD
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ESENT.dll')
JetDeleteColumn2A = Fiddle::Function.new(
  lib['JetDeleteColumn2A'],
  [
    Fiddle::TYPE_UINTPTR_T,  # sesid : JET_SESID
    Fiddle::TYPE_UINTPTR_T,  # tableid : JET_TABLEID
    Fiddle::TYPE_VOIDP,  # szColumnName : CHAR*
    -Fiddle::TYPE_INT,  # grbit : DWORD
  ],
  Fiddle::TYPE_INT)

#[link(name = "esent")]
extern "system" {
    fn JetDeleteColumn2A(
        sesid: usize,  // JET_SESID
        tableid: usize,  // JET_TABLEID
        szColumnName: *mut i8,  // CHAR*
        grbit: u32  // DWORD
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

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

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

出力引数:

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