Win32 API 日本語リファレンス
ホーム › Storage.Jet › JetDeleteColumn2W

JetDeleteColumn2W

関数
オプション指定付きでテーブルから列を削除する(Unicode版)。
DLLESENT.dll文字セットUnicode (-W)呼出規約winapi

シグネチャ

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

INT JetDeleteColumn2W(
    JET_SESID sesid,
    JET_TABLEID tableid,
    WORD* szColumnName,
    DWORD grbit
);

パラメーター

名前型方向説明
sesidJET_SESIDin操作に使用するセッションID。
tableidJET_TABLEIDin列を削除する対象テーブルのカーソルID。
szColumnNameWORD*in削除する列名を指すワイド文字列(WORD*)。
grbitDWORDin削除動作を制御する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) として実装されています。

関連項目

JET_ERR
JET_GRBIT
JET_SESID
JET_TABLEID
JetDeleteColumn

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp)

各言語での呼び出し定義

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

INT JetDeleteColumn2W(
    JET_SESID sesid,
    JET_TABLEID tableid,
    WORD* szColumnName,
    DWORD grbit
);
[DllImport("ESENT.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern int JetDeleteColumn2W(
    UIntPtr sesid,   // JET_SESID
    UIntPtr tableid,   // JET_TABLEID
    ref ushort szColumnName,   // WORD*
    uint grbit   // DWORD
);
<DllImport("ESENT.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function JetDeleteColumn2W(
    sesid As UIntPtr,   ' JET_SESID
    tableid As UIntPtr,   ' JET_TABLEID
    ByRef szColumnName As UShort,   ' WORD*
    grbit As UInteger   ' DWORD
) As Integer
End Function
' sesid : JET_SESID
' tableid : JET_TABLEID
' szColumnName : WORD*
' grbit : DWORD
Declare PtrSafe Function JetDeleteColumn2W Lib "esent" ( _
    ByVal sesid As LongPtr, _
    ByVal tableid As LongPtr, _
    ByRef szColumnName As Integer, _
    ByVal grbit 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

JetDeleteColumn2W = ctypes.windll.esent.JetDeleteColumn2W
JetDeleteColumn2W.restype = ctypes.c_int
JetDeleteColumn2W.argtypes = [
    ctypes.c_size_t,  # sesid : JET_SESID
    ctypes.c_size_t,  # tableid : JET_TABLEID
    ctypes.POINTER(ctypes.c_ushort),  # szColumnName : WORD*
    wintypes.DWORD,  # grbit : DWORD
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ESENT.dll')
JetDeleteColumn2W = Fiddle::Function.new(
  lib['JetDeleteColumn2W'],
  [
    Fiddle::TYPE_UINTPTR_T,  # sesid : JET_SESID
    Fiddle::TYPE_UINTPTR_T,  # tableid : JET_TABLEID
    Fiddle::TYPE_VOIDP,  # szColumnName : WORD*
    -Fiddle::TYPE_INT,  # grbit : DWORD
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "esent")]
extern "system" {
    fn JetDeleteColumn2W(
        sesid: usize,  // JET_SESID
        tableid: usize,  // JET_TABLEID
        szColumnName: *mut u16,  // WORD*
        grbit: u32  // DWORD
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("ESENT.dll", CharSet = CharSet.Unicode)]
public static extern int JetDeleteColumn2W(UIntPtr sesid, UIntPtr tableid, ref ushort szColumnName, uint grbit);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ESENT_JetDeleteColumn2W' -Namespace Win32 -PassThru
# $api::JetDeleteColumn2W(sesid, tableid, szColumnName, grbit)
#uselib "ESENT.dll"
#func global JetDeleteColumn2W "JetDeleteColumn2W" wptr, wptr, wptr, wptr
; JetDeleteColumn2W sesid, tableid, varptr(szColumnName), grbit   ; 戻り値は stat
; sesid : JET_SESID -> "wptr"
; tableid : JET_TABLEID -> "wptr"
; szColumnName : WORD* -> "wptr"
; grbit : DWORD -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "ESENT.dll"
#cfunc global JetDeleteColumn2W "JetDeleteColumn2W" sptr, sptr, var, int
; res = JetDeleteColumn2W(sesid, tableid, szColumnName, grbit)
; sesid : JET_SESID -> "sptr"
; tableid : JET_TABLEID -> "sptr"
; szColumnName : WORD* -> "var"
; grbit : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; INT JetDeleteColumn2W(JET_SESID sesid, JET_TABLEID tableid, WORD* szColumnName, DWORD grbit)
#uselib "ESENT.dll"
#cfunc global JetDeleteColumn2W "JetDeleteColumn2W" intptr, intptr, var, int
; res = JetDeleteColumn2W(sesid, tableid, szColumnName, grbit)
; sesid : JET_SESID -> "intptr"
; tableid : JET_TABLEID -> "intptr"
; szColumnName : WORD* -> "var"
; grbit : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	esent = windows.NewLazySystemDLL("ESENT.dll")
	procJetDeleteColumn2W = esent.NewProc("JetDeleteColumn2W")
)

// sesid (JET_SESID), tableid (JET_TABLEID), szColumnName (WORD*), grbit (DWORD)
r1, _, err := procJetDeleteColumn2W.Call(
	uintptr(sesid),
	uintptr(tableid),
	uintptr(szColumnName),
	uintptr(grbit),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // INT
function JetDeleteColumn2W(
  sesid: NativeUInt;   // JET_SESID
  tableid: NativeUInt;   // JET_TABLEID
  szColumnName: Pointer;   // WORD*
  grbit: DWORD   // DWORD
): Integer; stdcall;
  external 'ESENT.dll' name 'JetDeleteColumn2W';
result := DllCall("ESENT\JetDeleteColumn2W"
    , "UPtr", sesid   ; JET_SESID
    , "UPtr", tableid   ; JET_TABLEID
    , "Ptr", szColumnName   ; WORD*
    , "UInt", grbit   ; DWORD
    , "Int")   ; return: INT
●JetDeleteColumn2W(sesid, tableid, szColumnName, grbit) = DLL("ESENT.dll", "int JetDeleteColumn2W(int, int, void*, dword)")
# 呼び出し: JetDeleteColumn2W(sesid, tableid, szColumnName, grbit)
# sesid : JET_SESID -> "int"
# tableid : JET_TABLEID -> "int"
# szColumnName : WORD* -> "void*"
# grbit : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。
const std = @import("std");

extern "esent" fn JetDeleteColumn2W(
    sesid: usize, // JET_SESID
    tableid: usize, // JET_TABLEID
    szColumnName: [*c]u16, // WORD*
    grbit: u32 // DWORD
) callconv(std.os.windows.WINAPI) i32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc JetDeleteColumn2W(
    sesid: uint,  # JET_SESID
    tableid: uint,  # JET_TABLEID
    szColumnName: ptr uint16,  # WORD*
    grbit: uint32  # DWORD
): int32 {.importc: "JetDeleteColumn2W", stdcall, dynlib: "ESENT.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "esent");
extern(Windows)
int JetDeleteColumn2W(
    size_t sesid,   // JET_SESID
    size_t tableid,   // JET_TABLEID
    ushort* szColumnName,   // WORD*
    uint grbit   // DWORD
);
ccall((:JetDeleteColumn2W, "ESENT.dll"), stdcall, Int32,
      (Csize_t, Csize_t, Ptr{UInt16}, UInt32),
      sesid, tableid, szColumnName, grbit)
# sesid : JET_SESID -> Csize_t
# tableid : JET_TABLEID -> Csize_t
# szColumnName : WORD* -> Ptr{UInt16}
# grbit : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
int32_t JetDeleteColumn2W(
    uintptr_t sesid,
    uintptr_t tableid,
    uint16_t* szColumnName,
    uint32_t grbit);
]]
local esent = ffi.load("esent")
-- esent.JetDeleteColumn2W(sesid, tableid, szColumnName, grbit)
-- sesid : JET_SESID
-- tableid : JET_TABLEID
-- szColumnName : WORD*
-- grbit : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。
const koffi = require('koffi');
const lib = koffi.load('ESENT.dll');
const JetDeleteColumn2W = lib.func('__stdcall', 'JetDeleteColumn2W', 'int32_t', ['uintptr_t', 'uintptr_t', 'uint16_t *', 'uint32_t']);
// JetDeleteColumn2W(sesid, tableid, szColumnName, grbit)
// sesid : JET_SESID -> 'uintptr_t'
// tableid : JET_TABLEID -> 'uintptr_t'
// szColumnName : WORD* -> 'uint16_t *'
// grbit : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("ESENT.dll", {
  JetDeleteColumn2W: { parameters: ["usize", "usize", "pointer", "u32"], result: "i32" },
});
// lib.symbols.JetDeleteColumn2W(sesid, tableid, szColumnName, grbit)
// sesid : JET_SESID -> "usize"
// tableid : JET_TABLEID -> "usize"
// szColumnName : WORD* -> "pointer"
// grbit : DWORD -> "u32"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t JetDeleteColumn2W(
    size_t sesid,
    size_t tableid,
    uint16_t* szColumnName,
    uint32_t grbit);
C, "ESENT.dll");
// $ffi->JetDeleteColumn2W(sesid, tableid, szColumnName, grbit);
// sesid : JET_SESID
// tableid : JET_TABLEID
// szColumnName : WORD*
// grbit : DWORD
// 構造体/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.UNICODE_OPTIONS);
    int JetDeleteColumn2W(
        long sesid,   // JET_SESID
        long tableid,   // JET_TABLEID
        ShortByReference szColumnName,   // WORD*
        int grbit   // DWORD
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("esent")]
lib LibESENT
  fun JetDeleteColumn2W = JetDeleteColumn2W(
    sesid : LibC::SizeT,   # JET_SESID
    tableid : LibC::SizeT,   # JET_TABLEID
    szColumnName : UInt16*,   # WORD*
    grbit : UInt32   # DWORD
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef JetDeleteColumn2WNative = Int32 Function(UintPtr, UintPtr, Pointer<Uint16>, Uint32);
typedef JetDeleteColumn2WDart = int Function(int, int, Pointer<Uint16>, int);
final JetDeleteColumn2W = DynamicLibrary.open('ESENT.dll')
    .lookupFunction<JetDeleteColumn2WNative, JetDeleteColumn2WDart>('JetDeleteColumn2W');
// sesid : JET_SESID -> UintPtr
// tableid : JET_TABLEID -> UintPtr
// szColumnName : WORD* -> Pointer<Uint16>
// grbit : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function JetDeleteColumn2W(
  sesid: NativeUInt;   // JET_SESID
  tableid: NativeUInt;   // JET_TABLEID
  szColumnName: Pointer;   // WORD*
  grbit: DWORD   // DWORD
): Integer; stdcall;
  external 'ESENT.dll' name 'JetDeleteColumn2W';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "JetDeleteColumn2W"
  c_JetDeleteColumn2W :: CUIntPtr -> CUIntPtr -> Ptr Word16 -> Word32 -> IO Int32
-- sesid : JET_SESID -> CUIntPtr
-- tableid : JET_TABLEID -> CUIntPtr
-- szColumnName : WORD* -> Ptr Word16
-- grbit : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let jetdeletecolumn2w =
  foreign "JetDeleteColumn2W"
    (size_t @-> size_t @-> (ptr uint16_t) @-> uint32_t @-> returning int32_t)
(* sesid : JET_SESID -> size_t *)
(* tableid : JET_TABLEID -> size_t *)
(* szColumnName : WORD* -> (ptr uint16_t) *)
(* grbit : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library esent (t "ESENT.dll"))
(cffi:use-foreign-library esent)

(cffi:defcfun ("JetDeleteColumn2W" jet-delete-column2-w :convention :stdcall) :int32
  (sesid :uint64)   ; JET_SESID
  (tableid :uint64)   ; JET_TABLEID
  (sz-column-name :pointer)   ; WORD*
  (grbit :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $JetDeleteColumn2W = Win32::API::More->new('ESENT',
    'int JetDeleteColumn2W(WPARAM sesid, WPARAM tableid, LPVOID szColumnName, DWORD grbit)');
# my $ret = $JetDeleteColumn2W->Call($sesid, $tableid, $szColumnName, $grbit);
# sesid : JET_SESID -> WPARAM
# tableid : JET_TABLEID -> WPARAM
# szColumnName : WORD* -> LPVOID
# grbit : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い
類似 API