JetGetColumnInfoA

関数

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

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

シグネチャ

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

INT JetGetColumnInfoA(
    JET_SESID sesid,
    DWORD dbid,
    CHAR* szTableName,
    CHAR* pColumnNameOrId,   // optional
    void* pvResult,
    DWORD cbMax,
    DWORD InfoLevel
);

パラメーター

名前	型	方向	説明
sesid	JET_SESID	in	操作に使用するセッションID。
dbid	DWORD	in	対象テーブルを含むデータベースのID。
szTableName	CHAR*	in	対象テーブル名を指すANSI文字列。
pColumnNameOrId	CHAR*	inoptional	情報取得対象の列名またはJET_COLUMNIDを指すANSI文字列。
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  (ANSI / -A)
#include <windows.h>

INT JetGetColumnInfoA(
    JET_SESID sesid,
    DWORD dbid,
    CHAR* szTableName,
    CHAR* pColumnNameOrId,   // optional
    void* pvResult,
    DWORD cbMax,
    DWORD InfoLevel
);

[DllImport("ESENT.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern int JetGetColumnInfoA(
    UIntPtr sesid,   // JET_SESID
    uint dbid,   // DWORD
    IntPtr szTableName,   // CHAR*
    IntPtr pColumnNameOrId,   // CHAR* optional
    IntPtr pvResult,   // void* out
    uint cbMax,   // DWORD
    uint InfoLevel   // DWORD
);

<DllImport("ESENT.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function JetGetColumnInfoA(
    sesid As UIntPtr,   ' JET_SESID
    dbid As UInteger,   ' DWORD
    szTableName As IntPtr,   ' CHAR*
    pColumnNameOrId As IntPtr,   ' CHAR* optional
    pvResult As IntPtr,   ' void* out
    cbMax As UInteger,   ' DWORD
    InfoLevel As UInteger   ' DWORD
) As Integer
End Function

' sesid : JET_SESID
' dbid : DWORD
' szTableName : CHAR*
' pColumnNameOrId : CHAR* optional
' pvResult : void* out
' cbMax : DWORD
' InfoLevel : DWORD
Declare PtrSafe Function JetGetColumnInfoA Lib "esent" ( _
    ByVal sesid As LongPtr, _
    ByVal dbid As Long, _
    ByVal szTableName As LongPtr, _
    ByVal pColumnNameOrId As LongPtr, _
    ByVal pvResult As LongPtr, _
    ByVal cbMax As Long, _
    ByVal InfoLevel As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

JetGetColumnInfoA = ctypes.windll.esent.JetGetColumnInfoA
JetGetColumnInfoA.restype = ctypes.c_int
JetGetColumnInfoA.argtypes = [
    ctypes.c_size_t,  # sesid : JET_SESID
    wintypes.DWORD,  # dbid : DWORD
    ctypes.POINTER(ctypes.c_byte),  # szTableName : CHAR*
    ctypes.POINTER(ctypes.c_byte),  # pColumnNameOrId : CHAR* 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')
JetGetColumnInfoA = Fiddle::Function.new(
  lib['JetGetColumnInfoA'],
  [
    Fiddle::TYPE_UINTPTR_T,  # sesid : JET_SESID
    -Fiddle::TYPE_INT,  # dbid : DWORD
    Fiddle::TYPE_VOIDP,  # szTableName : CHAR*
    Fiddle::TYPE_VOIDP,  # pColumnNameOrId : CHAR* optional
    Fiddle::TYPE_VOIDP,  # pvResult : void* out
    -Fiddle::TYPE_INT,  # cbMax : DWORD
    -Fiddle::TYPE_INT,  # InfoLevel : DWORD
  ],
  Fiddle::TYPE_INT)

#[link(name = "esent")]
extern "system" {
    fn JetGetColumnInfoA(
        sesid: usize,  // JET_SESID
        dbid: u32,  // DWORD
        szTableName: *mut i8,  // CHAR*
        pColumnNameOrId: *mut i8,  // CHAR* 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.Ansi)]
public static extern int JetGetColumnInfoA(UIntPtr sesid, uint dbid, IntPtr szTableName, IntPtr pColumnNameOrId, IntPtr pvResult, uint cbMax, uint InfoLevel);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ESENT_JetGetColumnInfoA' -Namespace Win32 -PassThru
# $api::JetGetColumnInfoA(sesid, dbid, szTableName, pColumnNameOrId, pvResult, cbMax, InfoLevel)

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

出力引数:

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