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

JetGetTableColumnInfoA

関数
テーブルIDで指定したテーブルの列情報を取得する(ANSI版)。
DLLESENT.dll文字セットANSI (-A)呼出規約winapi

シグネチャ

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

INT JetGetTableColumnInfoA(
    JET_SESID sesid,
    JET_TABLEID tableid,
    CHAR* szColumnName,   // optional
    void* pvResult,
    DWORD cbMax,
    DWORD InfoLevel
);

パラメーター

名前型方向説明
sesidJET_SESIDin操作に使用するセッションID。
tableidJET_TABLEIDin対象テーブルのカーソルID。
szColumnNameCHAR*inoptional情報を取得する列名を指すANSI文字列。
pvResultvoid*out取得した列情報を受け取る出力バッファへのポインタ。
cbMaxDWORDinpvResultバッファのバイトサイズ。
InfoLevelDWORDin取得する情報レベル(JET_ColInfo系定数)。

戻り値の型: INT

公式ドキュメント

JetGetTableColumnInfo 関数は、テーブルの列に関する情報を取得します。

戻り値

この関数は 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 は、どちらも列に関する情報を取得します。両者の違いは、テーブルの識別方法です。

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

JetGetTableColumnInfoW (Unicode) および JetGetTableColumnInfoA (ANSI) として実装されています。

関連項目

Extensible Storage Engine Errors
Error Handling Parameters
JET_COLUMNBASE
JET_COLUMNDEF
JET_COLUMNID
JET_COLUMNLIST
JET_ERR
JET_GRBIT
JET_SESID
JET_TABLEID
JetCloseTable
JetGetColumnInfo
JetGetTableColumnInfo

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

各言語での呼び出し定義

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

INT JetGetTableColumnInfoA(
    JET_SESID sesid,
    JET_TABLEID tableid,
    CHAR* szColumnName,   // optional
    void* pvResult,
    DWORD cbMax,
    DWORD InfoLevel
);
[DllImport("ESENT.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern int JetGetTableColumnInfoA(
    UIntPtr sesid,   // JET_SESID
    UIntPtr tableid,   // JET_TABLEID
    IntPtr szColumnName,   // CHAR* optional
    IntPtr pvResult,   // void* out
    uint cbMax,   // DWORD
    uint InfoLevel   // DWORD
);
<DllImport("ESENT.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function JetGetTableColumnInfoA(
    sesid As UIntPtr,   ' JET_SESID
    tableid As UIntPtr,   ' JET_TABLEID
    szColumnName As IntPtr,   ' CHAR* optional
    pvResult As IntPtr,   ' void* out
    cbMax As UInteger,   ' DWORD
    InfoLevel As UInteger   ' DWORD
) As Integer
End Function
' sesid : JET_SESID
' tableid : JET_TABLEID
' szColumnName : CHAR* optional
' pvResult : void* out
' cbMax : DWORD
' InfoLevel : DWORD
Declare PtrSafe Function JetGetTableColumnInfoA Lib "esent" ( _
    ByVal sesid As LongPtr, _
    ByVal tableid As LongPtr, _
    ByVal szColumnName 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

JetGetTableColumnInfoA = ctypes.windll.esent.JetGetTableColumnInfoA
JetGetTableColumnInfoA.restype = ctypes.c_int
JetGetTableColumnInfoA.argtypes = [
    ctypes.c_size_t,  # sesid : JET_SESID
    ctypes.c_size_t,  # tableid : JET_TABLEID
    ctypes.POINTER(ctypes.c_byte),  # szColumnName : 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')
JetGetTableColumnInfoA = Fiddle::Function.new(
  lib['JetGetTableColumnInfoA'],
  [
    Fiddle::TYPE_UINTPTR_T,  # sesid : JET_SESID
    Fiddle::TYPE_UINTPTR_T,  # tableid : JET_TABLEID
    Fiddle::TYPE_VOIDP,  # szColumnName : 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 JetGetTableColumnInfoA(
        sesid: usize,  // JET_SESID
        tableid: usize,  // JET_TABLEID
        szColumnName: *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 JetGetTableColumnInfoA(UIntPtr sesid, UIntPtr tableid, IntPtr szColumnName, IntPtr pvResult, uint cbMax, uint InfoLevel);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ESENT_JetGetTableColumnInfoA' -Namespace Win32 -PassThru
# $api::JetGetTableColumnInfoA(sesid, tableid, szColumnName, pvResult, cbMax, InfoLevel)
#uselib "ESENT.dll"
#func global JetGetTableColumnInfoA "JetGetTableColumnInfoA" sptr, sptr, sptr, sptr, sptr, sptr
; JetGetTableColumnInfoA sesid, tableid, varptr(szColumnName), pvResult, cbMax, InfoLevel   ; 戻り値は stat
; sesid : JET_SESID -> "sptr"
; tableid : JET_TABLEID -> "sptr"
; szColumnName : CHAR* optional -> "sptr"
; pvResult : void* out -> "sptr"
; cbMax : DWORD -> "sptr"
; InfoLevel : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "ESENT.dll"
#cfunc global JetGetTableColumnInfoA "JetGetTableColumnInfoA" sptr, sptr, var, sptr, int, int
; res = JetGetTableColumnInfoA(sesid, tableid, szColumnName, pvResult, cbMax, InfoLevel)
; sesid : JET_SESID -> "sptr"
; tableid : JET_TABLEID -> "sptr"
; szColumnName : CHAR* optional -> "var"
; pvResult : void* out -> "sptr"
; cbMax : DWORD -> "int"
; InfoLevel : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; INT JetGetTableColumnInfoA(JET_SESID sesid, JET_TABLEID tableid, CHAR* szColumnName, void* pvResult, DWORD cbMax, DWORD InfoLevel)
#uselib "ESENT.dll"
#cfunc global JetGetTableColumnInfoA "JetGetTableColumnInfoA" intptr, intptr, var, intptr, int, int
; res = JetGetTableColumnInfoA(sesid, tableid, szColumnName, pvResult, cbMax, InfoLevel)
; sesid : JET_SESID -> "intptr"
; tableid : JET_TABLEID -> "intptr"
; szColumnName : CHAR* optional -> "var"
; pvResult : void* out -> "intptr"
; cbMax : DWORD -> "int"
; InfoLevel : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	esent = windows.NewLazySystemDLL("ESENT.dll")
	procJetGetTableColumnInfoA = esent.NewProc("JetGetTableColumnInfoA")
)

// sesid (JET_SESID), tableid (JET_TABLEID), szColumnName (CHAR* optional), pvResult (void* out), cbMax (DWORD), InfoLevel (DWORD)
r1, _, err := procJetGetTableColumnInfoA.Call(
	uintptr(sesid),
	uintptr(tableid),
	uintptr(szColumnName),
	uintptr(pvResult),
	uintptr(cbMax),
	uintptr(InfoLevel),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // INT
function JetGetTableColumnInfoA(
  sesid: NativeUInt;   // JET_SESID
  tableid: NativeUInt;   // JET_TABLEID
  szColumnName: Pointer;   // CHAR* optional
  pvResult: Pointer;   // void* out
  cbMax: DWORD;   // DWORD
  InfoLevel: DWORD   // DWORD
): Integer; stdcall;
  external 'ESENT.dll' name 'JetGetTableColumnInfoA';
result := DllCall("ESENT\JetGetTableColumnInfoA"
    , "UPtr", sesid   ; JET_SESID
    , "UPtr", tableid   ; JET_TABLEID
    , "Ptr", szColumnName   ; CHAR* optional
    , "Ptr", pvResult   ; void* out
    , "UInt", cbMax   ; DWORD
    , "UInt", InfoLevel   ; DWORD
    , "Int")   ; return: INT
●JetGetTableColumnInfoA(sesid, tableid, szColumnName, pvResult, cbMax, InfoLevel) = DLL("ESENT.dll", "int JetGetTableColumnInfoA(int, int, void*, void*, dword, dword)")
# 呼び出し: JetGetTableColumnInfoA(sesid, tableid, szColumnName, pvResult, cbMax, InfoLevel)
# sesid : JET_SESID -> "int"
# tableid : JET_TABLEID -> "int"
# szColumnName : CHAR* optional -> "void*"
# pvResult : void* out -> "void*"
# cbMax : DWORD -> "dword"
# InfoLevel : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "esent" fn JetGetTableColumnInfoA(
    sesid: usize, // JET_SESID
    tableid: usize, // JET_TABLEID
    szColumnName: [*c]i8, // CHAR* optional
    pvResult: ?*anyopaque, // void* out
    cbMax: u32, // DWORD
    InfoLevel: u32 // DWORD
) callconv(std.os.windows.WINAPI) i32;
proc JetGetTableColumnInfoA(
    sesid: uint,  # JET_SESID
    tableid: uint,  # JET_TABLEID
    szColumnName: ptr int8,  # CHAR* optional
    pvResult: pointer,  # void* out
    cbMax: uint32,  # DWORD
    InfoLevel: uint32  # DWORD
): int32 {.importc: "JetGetTableColumnInfoA", stdcall, dynlib: "ESENT.dll".}
pragma(lib, "esent");
extern(Windows)
int JetGetTableColumnInfoA(
    size_t sesid,   // JET_SESID
    size_t tableid,   // JET_TABLEID
    byte* szColumnName,   // CHAR* optional
    void* pvResult,   // void* out
    uint cbMax,   // DWORD
    uint InfoLevel   // DWORD
);
ccall((:JetGetTableColumnInfoA, "ESENT.dll"), stdcall, Int32,
      (Csize_t, Csize_t, Ptr{Int8}, Ptr{Cvoid}, UInt32, UInt32),
      sesid, tableid, szColumnName, pvResult, cbMax, InfoLevel)
# sesid : JET_SESID -> Csize_t
# tableid : JET_TABLEID -> Csize_t
# szColumnName : CHAR* optional -> Ptr{Int8}
# pvResult : void* out -> Ptr{Cvoid}
# cbMax : DWORD -> UInt32
# InfoLevel : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t JetGetTableColumnInfoA(
    uintptr_t sesid,
    uintptr_t tableid,
    int8_t* szColumnName,
    void* pvResult,
    uint32_t cbMax,
    uint32_t InfoLevel);
]]
local esent = ffi.load("esent")
-- esent.JetGetTableColumnInfoA(sesid, tableid, szColumnName, pvResult, cbMax, InfoLevel)
-- sesid : JET_SESID
-- tableid : JET_TABLEID
-- szColumnName : CHAR* optional
-- pvResult : void* out
-- cbMax : DWORD
-- InfoLevel : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('ESENT.dll');
const JetGetTableColumnInfoA = lib.func('__stdcall', 'JetGetTableColumnInfoA', 'int32_t', ['uintptr_t', 'uintptr_t', 'int8_t *', 'void *', 'uint32_t', 'uint32_t']);
// JetGetTableColumnInfoA(sesid, tableid, szColumnName, pvResult, cbMax, InfoLevel)
// sesid : JET_SESID -> 'uintptr_t'
// tableid : JET_TABLEID -> 'uintptr_t'
// szColumnName : CHAR* optional -> 'int8_t *'
// pvResult : void* out -> 'void *'
// cbMax : DWORD -> 'uint32_t'
// InfoLevel : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("ESENT.dll", {
  JetGetTableColumnInfoA: { parameters: ["usize", "usize", "pointer", "pointer", "u32", "u32"], result: "i32" },
});
// lib.symbols.JetGetTableColumnInfoA(sesid, tableid, szColumnName, pvResult, cbMax, InfoLevel)
// sesid : JET_SESID -> "usize"
// tableid : JET_TABLEID -> "usize"
// szColumnName : CHAR* optional -> "pointer"
// pvResult : void* out -> "pointer"
// cbMax : DWORD -> "u32"
// InfoLevel : DWORD -> "u32"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t JetGetTableColumnInfoA(
    size_t sesid,
    size_t tableid,
    int8_t* szColumnName,
    void* pvResult,
    uint32_t cbMax,
    uint32_t InfoLevel);
C, "ESENT.dll");
// $ffi->JetGetTableColumnInfoA(sesid, tableid, szColumnName, pvResult, cbMax, InfoLevel);
// sesid : JET_SESID
// tableid : JET_TABLEID
// szColumnName : CHAR* optional
// pvResult : void* out
// cbMax : DWORD
// InfoLevel : 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.ASCII_OPTIONS);
    int JetGetTableColumnInfoA(
        long sesid,   // JET_SESID
        long tableid,   // JET_TABLEID
        byte[] szColumnName,   // CHAR* optional
        Pointer pvResult,   // void* out
        int cbMax,   // DWORD
        int InfoLevel   // DWORD
    );
}
@[Link("esent")]
lib LibESENT
  fun JetGetTableColumnInfoA = JetGetTableColumnInfoA(
    sesid : LibC::SizeT,   # JET_SESID
    tableid : LibC::SizeT,   # JET_TABLEID
    szColumnName : Int8*,   # CHAR* optional
    pvResult : Void*,   # void* out
    cbMax : UInt32,   # DWORD
    InfoLevel : 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 JetGetTableColumnInfoANative = Int32 Function(UintPtr, UintPtr, Pointer<Int8>, Pointer<Void>, Uint32, Uint32);
typedef JetGetTableColumnInfoADart = int Function(int, int, Pointer<Int8>, Pointer<Void>, int, int);
final JetGetTableColumnInfoA = DynamicLibrary.open('ESENT.dll')
    .lookupFunction<JetGetTableColumnInfoANative, JetGetTableColumnInfoADart>('JetGetTableColumnInfoA');
// sesid : JET_SESID -> UintPtr
// tableid : JET_TABLEID -> UintPtr
// szColumnName : CHAR* optional -> Pointer<Int8>
// pvResult : void* out -> Pointer<Void>
// cbMax : DWORD -> Uint32
// InfoLevel : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function JetGetTableColumnInfoA(
  sesid: NativeUInt;   // JET_SESID
  tableid: NativeUInt;   // JET_TABLEID
  szColumnName: Pointer;   // CHAR* optional
  pvResult: Pointer;   // void* out
  cbMax: DWORD;   // DWORD
  InfoLevel: DWORD   // DWORD
): Integer; stdcall;
  external 'ESENT.dll' name 'JetGetTableColumnInfoA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "JetGetTableColumnInfoA"
  c_JetGetTableColumnInfoA :: CUIntPtr -> CUIntPtr -> Ptr Int8 -> Ptr () -> Word32 -> Word32 -> IO Int32
-- sesid : JET_SESID -> CUIntPtr
-- tableid : JET_TABLEID -> CUIntPtr
-- szColumnName : CHAR* optional -> Ptr Int8
-- pvResult : void* out -> Ptr ()
-- cbMax : DWORD -> Word32
-- InfoLevel : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let jetgettablecolumninfoa =
  foreign "JetGetTableColumnInfoA"
    (size_t @-> size_t @-> (ptr int8_t) @-> (ptr void) @-> uint32_t @-> uint32_t @-> returning int32_t)
(* sesid : JET_SESID -> size_t *)
(* tableid : JET_TABLEID -> size_t *)
(* szColumnName : CHAR* optional -> (ptr int8_t) *)
(* pvResult : void* out -> (ptr void) *)
(* cbMax : DWORD -> uint32_t *)
(* InfoLevel : 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 ("JetGetTableColumnInfoA" jet-get-table-column-info-a :convention :stdcall) :int32
  (sesid :uint64)   ; JET_SESID
  (tableid :uint64)   ; JET_TABLEID
  (sz-column-name :pointer)   ; CHAR* optional
  (pv-result :pointer)   ; void* out
  (cb-max :uint32)   ; DWORD
  (info-level :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $JetGetTableColumnInfoA = Win32::API::More->new('ESENT',
    'int JetGetTableColumnInfoA(WPARAM sesid, WPARAM tableid, LPVOID szColumnName, LPVOID pvResult, DWORD cbMax, DWORD InfoLevel)');
# my $ret = $JetGetTableColumnInfoA->Call($sesid, $tableid, $szColumnName, $pvResult, $cbMax, $InfoLevel);
# sesid : JET_SESID -> WPARAM
# tableid : JET_TABLEID -> WPARAM
# szColumnName : CHAR* optional -> LPVOID
# pvResult : void* out -> LPVOID
# cbMax : DWORD -> DWORD
# InfoLevel : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

文字セット違い