JetDeleteColumnW

関数

テーブルから指定した列を削除する(Unicode版)。

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

シグネチャ

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

INT JetDeleteColumnW(
    JET_SESID sesid,
    JET_TABLEID tableid,
    WORD* szColumnName
);

パラメーター

名前	型	方向	説明
sesid	JET_SESID	in	操作に使用するセッションID。
tableid	JET_TABLEID	in	列を削除する対象テーブルのカーソルID。
szColumnName	WORD*	in	削除する列名を指すワイド文字列(WORD*)。

戻り値の型: INT

公式ドキュメント

JetDeleteColumn 関数は、ESE データベースのテーブルから列を削除します。

戻り値

この関数は 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 2000 Professional が必要です。
サーバー	Windows Server 2008、Windows Server 2003、または Windows 2000 Server が必要です。
ヘッダー	Esent.h で宣言されています。
ライブラリ	ESENT.lib を使用します。
DLL	ESENT.dll が必要です。
Unicode	JetDeleteColumnW (Unicode) および JetDeleteColumnA (ANSI) として実装されています。

各言語での呼び出し定義

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

INT JetDeleteColumnW(
    JET_SESID sesid,
    JET_TABLEID tableid,
    WORD* szColumnName
);

[DllImport("ESENT.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern int JetDeleteColumnW(
    UIntPtr sesid,   // JET_SESID
    UIntPtr tableid,   // JET_TABLEID
    ref ushort szColumnName   // WORD*
);

<DllImport("ESENT.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function JetDeleteColumnW(
    sesid As UIntPtr,   ' JET_SESID
    tableid As UIntPtr,   ' JET_TABLEID
    ByRef szColumnName As UShort   ' WORD*
) As Integer
End Function

' sesid : JET_SESID
' tableid : JET_TABLEID
' szColumnName : WORD*
Declare PtrSafe Function JetDeleteColumnW Lib "esent" ( _
    ByVal sesid As LongPtr, _
    ByVal tableid As LongPtr, _
    ByRef szColumnName As Integer) 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

JetDeleteColumnW = ctypes.windll.esent.JetDeleteColumnW
JetDeleteColumnW.restype = ctypes.c_int
JetDeleteColumnW.argtypes = [
    ctypes.c_size_t,  # sesid : JET_SESID
    ctypes.c_size_t,  # tableid : JET_TABLEID
    ctypes.POINTER(ctypes.c_ushort),  # szColumnName : WORD*
]

require 'fiddle'
require 'fiddle/import'

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

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

$sig = @"
[DllImport("ESENT.dll", CharSet = CharSet.Unicode)]
public static extern int JetDeleteColumnW(UIntPtr sesid, UIntPtr tableid, ref ushort szColumnName);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ESENT_JetDeleteColumnW' -Namespace Win32 -PassThru
# $api::JetDeleteColumnW(sesid, tableid, szColumnName)

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

出力引数:

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