JetGetColumnInfoW

関数

テーブル名と列名から列の定義情報を取得する(Unicode版)。

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

シグネチャ

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

INT JetGetColumnInfoW(
    JET_SESID sesid,
    DWORD dbid,
    WORD* szTableName,
    WORD* pwColumnNameOrId,   // optional
    void* pvResult,
    DWORD cbMax,
    DWORD InfoLevel
);

パラメーター

名前	型	方向	説明
sesid	JET_SESID	in	操作に使用するセッションID。
dbid	DWORD	in	対象テーブルを含むデータベースのID。
szTableName	WORD*	in	対象テーブル名を指すワイド文字列(WORD*)。
pwColumnNameOrId	WORD*	inoptional	情報取得対象の列名またはJET_COLUMNIDを指すワイド文字列(WORD*)。
pvResult	void*	out	取得した列情報を受け取る出力バッファへのポインタ。
cbMax	DWORD	in	pvResultバッファのバイトサイズ。
InfoLevel	DWORD	in	取得する情報レベル(JET_ColInfo系定数)。

戻り値の型: INT

公式ドキュメント

JetGetColumnInfo 関数は、列に関する情報を取得します。

戻り値

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

リターンコード	説明
JET_errSuccess	操作は正常に完了しました。
JET_errColumnNotFound	szColumnName で指定された名前の列がテーブル内に見つかりませんでした。
JET_errFeatureNotAvailable	不正な InfoLevel が指定されました。
JET_errInvalidName	このエラーは、次の場合に返されることがあります。 szTableName に不正な名前が指定された。 szColumnName に不正な名前が指定された。
JET_errInvalidParameter	このエラーは、次の場合に返されることがあります。不正な InfoLevel が指定された。 NULL の szTableName が渡された。バッファーが小さすぎる。

解説

JetGetTableColumnInfo と JetGetColumnInfo は、いずれも列に関する情報を取得します。両者の違いは、テーブルの識別方法にあります。

JetGetTableColumnInfo は、tableid によってテーブルを識別します。
JetGetColumnInfo は、dbid と szTableName の組み合わせによってテーブルを識別します。

JET_ColInfoList、JET_ColInfoListSortColumnid、または JET_ColInfoListCompact でデータを取得する場合、一時テーブルが開かれます。この一時テーブルにはデータが格納され、JET_COLUMNLIST 構造体には一時テーブルを走査するのに十分な情報が含まれます。一時テーブルは JetCloseTable で閉じる必要があります。

要件

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

各言語での呼び出し定義

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

INT JetGetColumnInfoW(
    JET_SESID sesid,
    DWORD dbid,
    WORD* szTableName,
    WORD* pwColumnNameOrId,   // optional
    void* pvResult,
    DWORD cbMax,
    DWORD InfoLevel
);

[DllImport("ESENT.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern int JetGetColumnInfoW(
    UIntPtr sesid,   // JET_SESID
    uint dbid,   // DWORD
    ref ushort szTableName,   // WORD*
    IntPtr pwColumnNameOrId,   // WORD* optional
    IntPtr pvResult,   // void* out
    uint cbMax,   // DWORD
    uint InfoLevel   // DWORD
);

<DllImport("ESENT.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function JetGetColumnInfoW(
    sesid As UIntPtr,   ' JET_SESID
    dbid As UInteger,   ' DWORD
    ByRef szTableName As UShort,   ' WORD*
    pwColumnNameOrId As IntPtr,   ' WORD* optional
    pvResult As IntPtr,   ' void* out
    cbMax As UInteger,   ' DWORD
    InfoLevel As UInteger   ' DWORD
) As Integer
End Function

' sesid : JET_SESID
' dbid : DWORD
' szTableName : WORD*
' pwColumnNameOrId : WORD* optional
' pvResult : void* out
' cbMax : DWORD
' InfoLevel : DWORD
Declare PtrSafe Function JetGetColumnInfoW Lib "esent" ( _
    ByVal sesid As LongPtr, _
    ByVal dbid As Long, _
    ByRef szTableName As Integer, _
    ByVal pwColumnNameOrId As LongPtr, _
    ByVal pvResult As LongPtr, _
    ByVal cbMax As Long, _
    ByVal InfoLevel 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

JetGetColumnInfoW = ctypes.windll.esent.JetGetColumnInfoW
JetGetColumnInfoW.restype = ctypes.c_int
JetGetColumnInfoW.argtypes = [
    ctypes.c_size_t,  # sesid : JET_SESID
    wintypes.DWORD,  # dbid : DWORD
    ctypes.POINTER(ctypes.c_ushort),  # szTableName : WORD*
    ctypes.POINTER(ctypes.c_ushort),  # pwColumnNameOrId : WORD* optional
    ctypes.POINTER(None),  # pvResult : void* out
    wintypes.DWORD,  # cbMax : DWORD
    wintypes.DWORD,  # InfoLevel : DWORD
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ESENT.dll')
JetGetColumnInfoW = Fiddle::Function.new(
  lib['JetGetColumnInfoW'],
  [
    Fiddle::TYPE_UINTPTR_T,  # sesid : JET_SESID
    -Fiddle::TYPE_INT,  # dbid : DWORD
    Fiddle::TYPE_VOIDP,  # szTableName : WORD*
    Fiddle::TYPE_VOIDP,  # pwColumnNameOrId : WORD* optional
    Fiddle::TYPE_VOIDP,  # pvResult : void* out
    -Fiddle::TYPE_INT,  # cbMax : DWORD
    -Fiddle::TYPE_INT,  # InfoLevel : DWORD
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "esent")]
extern "system" {
    fn JetGetColumnInfoW(
        sesid: usize,  // JET_SESID
        dbid: u32,  // DWORD
        szTableName: *mut u16,  // WORD*
        pwColumnNameOrId: *mut u16,  // WORD* optional
        pvResult: *mut (),  // void* out
        cbMax: u32,  // DWORD
        InfoLevel: u32  // DWORD
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("ESENT.dll", CharSet = CharSet.Unicode)]
public static extern int JetGetColumnInfoW(UIntPtr sesid, uint dbid, ref ushort szTableName, IntPtr pwColumnNameOrId, IntPtr pvResult, uint cbMax, uint InfoLevel);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ESENT_JetGetColumnInfoW' -Namespace Win32 -PassThru
# $api::JetGetColumnInfoW(sesid, dbid, szTableName, pwColumnNameOrId, pvResult, cbMax, InfoLevel)

#uselib "ESENT.dll"
#func global JetGetColumnInfoW "JetGetColumnInfoW" wptr, wptr, wptr, wptr, wptr, wptr, wptr
; JetGetColumnInfoW sesid, dbid, varptr(szTableName), varptr(pwColumnNameOrId), pvResult, cbMax, InfoLevel   ; 戻り値は stat
; sesid : JET_SESID -> "wptr"
; dbid : DWORD -> "wptr"
; szTableName : WORD* -> "wptr"
; pwColumnNameOrId : WORD* optional -> "wptr"
; pvResult : void* out -> "wptr"
; cbMax : DWORD -> "wptr"
; InfoLevel : DWORD -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "ESENT.dll"
#cfunc global JetGetColumnInfoW "JetGetColumnInfoW" sptr, int, var, var, sptr, int, int
; res = JetGetColumnInfoW(sesid, dbid, szTableName, pwColumnNameOrId, pvResult, cbMax, InfoLevel)
; sesid : JET_SESID -> "sptr"
; dbid : DWORD -> "int"
; szTableName : WORD* -> "var"
; pwColumnNameOrId : WORD* optional -> "var"
; pvResult : void* out -> "sptr"
; cbMax : DWORD -> "int"
; InfoLevel : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "ESENT.dll"
#cfunc global JetGetColumnInfoW "JetGetColumnInfoW" sptr, int, sptr, sptr, sptr, int, int
; res = JetGetColumnInfoW(sesid, dbid, varptr(szTableName), varptr(pwColumnNameOrId), pvResult, cbMax, InfoLevel)
; sesid : JET_SESID -> "sptr"
; dbid : DWORD -> "int"
; szTableName : WORD* -> "sptr"
; pwColumnNameOrId : WORD* optional -> "sptr"
; pvResult : void* out -> "sptr"
; cbMax : DWORD -> "int"
; InfoLevel : DWORD -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。