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

JetAddColumnW

関数
テーブルに新しい列を追加する(Unicode版)。
DLLESENT.dll文字セットUnicode (-W)呼出規約winapi

シグネチャ

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

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

パラメーター

名前方向説明
sesidJET_SESIDin操作に使用するセッションID。
tableidJET_TABLEIDin列を追加する対象テーブルのカーソルID。
szColumnNameWORD*in追加する列名を指すワイド文字列(WORD*)。
pcolumndefJET_COLUMNDEF*in追加する列の定義(型・属性等)を保持するJET_COLUMNDEF構造体へのポインタ。
pvDefaultvoid*inoptional列の既定値データへのポインタ。既定値なしの場合はNULL。
cbDefaultDWORDinpvDefaultが指す既定値データのバイト長。
pcolumnidDWORD*outoptional割り当てられた列ID(JET_COLUMNID)を受け取るDWORDポインタ。

戻り値の型: INT

各言語での呼び出し定義

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

INT JetAddColumnW(
    JET_SESID sesid,
    JET_TABLEID tableid,
    WORD* szColumnName,
    const JET_COLUMNDEF* pcolumndef,
    void* pvDefault,   // optional
    DWORD cbDefault,
    DWORD* pcolumnid   // optional
);
[DllImport("ESENT.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern int JetAddColumnW(
    UIntPtr sesid,   // JET_SESID
    UIntPtr tableid,   // JET_TABLEID
    ref ushort szColumnName,   // WORD*
    IntPtr pcolumndef,   // JET_COLUMNDEF*
    IntPtr pvDefault,   // void* optional
    uint cbDefault,   // DWORD
    IntPtr pcolumnid   // DWORD* optional, out
);
<DllImport("ESENT.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function JetAddColumnW(
    sesid As UIntPtr,   ' JET_SESID
    tableid As UIntPtr,   ' JET_TABLEID
    ByRef szColumnName As UShort,   ' WORD*
    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 : WORD*
' pcolumndef : JET_COLUMNDEF*
' pvDefault : void* optional
' cbDefault : DWORD
' pcolumnid : DWORD* optional, out
Declare PtrSafe Function JetAddColumnW Lib "esent" ( _
    ByVal sesid As LongPtr, _
    ByVal tableid As LongPtr, _
    ByRef szColumnName As Integer, _
    ByVal pcolumndef As LongPtr, _
    ByVal pvDefault As LongPtr, _
    ByVal cbDefault As Long, _
    ByVal pcolumnid As LongPtr) 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

JetAddColumnW = ctypes.windll.esent.JetAddColumnW
JetAddColumnW.restype = ctypes.c_int
JetAddColumnW.argtypes = [
    ctypes.c_size_t,  # sesid : JET_SESID
    ctypes.c_size_t,  # tableid : JET_TABLEID
    ctypes.POINTER(ctypes.c_ushort),  # szColumnName : WORD*
    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')
JetAddColumnW = Fiddle::Function.new(
  lib['JetAddColumnW'],
  [
    Fiddle::TYPE_UINTPTR_T,  # sesid : JET_SESID
    Fiddle::TYPE_UINTPTR_T,  # tableid : JET_TABLEID
    Fiddle::TYPE_VOIDP,  # szColumnName : WORD*
    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)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "esent")]
extern "system" {
    fn JetAddColumnW(
        sesid: usize,  // JET_SESID
        tableid: usize,  // JET_TABLEID
        szColumnName: *mut u16,  // WORD*
        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.Unicode)]
public static extern int JetAddColumnW(UIntPtr sesid, UIntPtr tableid, ref ushort szColumnName, IntPtr pcolumndef, IntPtr pvDefault, uint cbDefault, IntPtr pcolumnid);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ESENT_JetAddColumnW' -Namespace Win32 -PassThru
# $api::JetAddColumnW(sesid, tableid, szColumnName, pcolumndef, pvDefault, cbDefault, pcolumnid)
#uselib "ESENT.dll"
#func global JetAddColumnW "JetAddColumnW" wptr, wptr, wptr, wptr, wptr, wptr, wptr
; JetAddColumnW sesid, tableid, varptr(szColumnName), varptr(pcolumndef), pvDefault, cbDefault, varptr(pcolumnid)   ; 戻り値は stat
; sesid : JET_SESID -> "wptr"
; tableid : JET_TABLEID -> "wptr"
; szColumnName : WORD* -> "wptr"
; pcolumndef : JET_COLUMNDEF* -> "wptr"
; pvDefault : void* optional -> "wptr"
; cbDefault : DWORD -> "wptr"
; pcolumnid : DWORD* optional, out -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "ESENT.dll"
#cfunc global JetAddColumnW "JetAddColumnW" sptr, sptr, var, var, sptr, int, var
; res = JetAddColumnW(sesid, tableid, szColumnName, pcolumndef, pvDefault, cbDefault, pcolumnid)
; sesid : JET_SESID -> "sptr"
; tableid : JET_TABLEID -> "sptr"
; szColumnName : WORD* -> "var"
; pcolumndef : JET_COLUMNDEF* -> "var"
; pvDefault : void* optional -> "sptr"
; cbDefault : DWORD -> "int"
; pcolumnid : DWORD* optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; INT JetAddColumnW(JET_SESID sesid, JET_TABLEID tableid, WORD* szColumnName, JET_COLUMNDEF* pcolumndef, void* pvDefault, DWORD cbDefault, DWORD* pcolumnid)
#uselib "ESENT.dll"
#cfunc global JetAddColumnW "JetAddColumnW" intptr, intptr, var, var, intptr, int, var
; res = JetAddColumnW(sesid, tableid, szColumnName, pcolumndef, pvDefault, cbDefault, pcolumnid)
; sesid : JET_SESID -> "intptr"
; tableid : JET_TABLEID -> "intptr"
; szColumnName : WORD* -> "var"
; pcolumndef : JET_COLUMNDEF* -> "var"
; pvDefault : void* optional -> "intptr"
; cbDefault : DWORD -> "int"
; pcolumnid : DWORD* optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	esent = windows.NewLazySystemDLL("ESENT.dll")
	procJetAddColumnW = esent.NewProc("JetAddColumnW")
)

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

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

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

foreign import stdcall safe "JetAddColumnW"
  c_JetAddColumnW :: CUIntPtr -> CUIntPtr -> Ptr Word16 -> Ptr () -> Ptr () -> Word32 -> Ptr Word32 -> IO Int32
-- sesid : JET_SESID -> CUIntPtr
-- tableid : JET_TABLEID -> CUIntPtr
-- szColumnName : WORD* -> Ptr Word16
-- pcolumndef : JET_COLUMNDEF* -> Ptr ()
-- pvDefault : void* optional -> Ptr ()
-- cbDefault : DWORD -> Word32
-- pcolumnid : DWORD* optional, out -> Ptr Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let jetaddcolumnw =
  foreign "JetAddColumnW"
    (size_t @-> size_t @-> (ptr uint16_t) @-> (ptr void) @-> (ptr void) @-> uint32_t @-> (ptr uint32_t) @-> returning int32_t)
(* sesid : JET_SESID -> size_t *)
(* tableid : JET_TABLEID -> size_t *)
(* szColumnName : WORD* -> (ptr uint16_t) *)
(* pcolumndef : JET_COLUMNDEF* -> (ptr void) *)
(* pvDefault : void* optional -> (ptr void) *)
(* cbDefault : DWORD -> uint32_t *)
(* pcolumnid : DWORD* optional, out -> (ptr uint32_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library esent (t "ESENT.dll"))
(cffi:use-foreign-library esent)

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

関連項目

文字セット違い
使用する型