SQLDescribeColA

関数

結果セット列の名前や型などの属性を取得する(ANSI)。

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

シグネチャ

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

SHORT SQLDescribeColA(
    void* hstmt,
    WORD icol,
    BYTE* szColName,   // optional
    SHORT cbColNameMax,
    SHORT* pcbColName,   // optional
    SHORT* pfSqlType,   // optional
    DWORD* pcbColDef,   // optional
    SHORT* pibScale,   // optional
    SHORT* pfNullable   // optional
);

パラメーター

名前	型	方向
hstmt	void*	inout
icol	WORD	in
szColName	BYTE*	outoptional
cbColNameMax	SHORT	in
pcbColName	SHORT*	outoptional
pfSqlType	SHORT*	outoptional
pcbColDef	DWORD*	outoptional
pibScale	SHORT*	outoptional
pfNullable	SHORT*	outoptional

戻り値の型: SHORT

各言語での呼び出し定義

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

SHORT SQLDescribeColA(
    void* hstmt,
    WORD icol,
    BYTE* szColName,   // optional
    SHORT cbColNameMax,
    SHORT* pcbColName,   // optional
    SHORT* pfSqlType,   // optional
    DWORD* pcbColDef,   // optional
    SHORT* pibScale,   // optional
    SHORT* pfNullable   // optional
);

[DllImport("ODBC32.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern short SQLDescribeColA(
    IntPtr hstmt,   // void* in/out
    ushort icol,   // WORD
    IntPtr szColName,   // BYTE* optional, out
    short cbColNameMax,   // SHORT
    IntPtr pcbColName,   // SHORT* optional, out
    IntPtr pfSqlType,   // SHORT* optional, out
    IntPtr pcbColDef,   // DWORD* optional, out
    IntPtr pibScale,   // SHORT* optional, out
    IntPtr pfNullable   // SHORT* optional, out
);

<DllImport("ODBC32.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function SQLDescribeColA(
    hstmt As IntPtr,   ' void* in/out
    icol As UShort,   ' WORD
    szColName As IntPtr,   ' BYTE* optional, out
    cbColNameMax As Short,   ' SHORT
    pcbColName As IntPtr,   ' SHORT* optional, out
    pfSqlType As IntPtr,   ' SHORT* optional, out
    pcbColDef As IntPtr,   ' DWORD* optional, out
    pibScale As IntPtr,   ' SHORT* optional, out
    pfNullable As IntPtr   ' SHORT* optional, out
) As Short
End Function

' hstmt : void* in/out
' icol : WORD
' szColName : BYTE* optional, out
' cbColNameMax : SHORT
' pcbColName : SHORT* optional, out
' pfSqlType : SHORT* optional, out
' pcbColDef : DWORD* optional, out
' pibScale : SHORT* optional, out
' pfNullable : SHORT* optional, out
Declare PtrSafe Function SQLDescribeColA Lib "odbc32" ( _
    ByVal hstmt As LongPtr, _
    ByVal icol As Integer, _
    ByVal szColName As LongPtr, _
    ByVal cbColNameMax As Integer, _
    ByVal pcbColName As LongPtr, _
    ByVal pfSqlType As LongPtr, _
    ByVal pcbColDef As LongPtr, _
    ByVal pibScale As LongPtr, _
    ByVal pfNullable As LongPtr) As Integer
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

SQLDescribeColA = ctypes.windll.odbc32.SQLDescribeColA
SQLDescribeColA.restype = ctypes.c_short
SQLDescribeColA.argtypes = [
    ctypes.POINTER(None),  # hstmt : void* in/out
    ctypes.c_ushort,  # icol : WORD
    ctypes.POINTER(ctypes.c_ubyte),  # szColName : BYTE* optional, out
    ctypes.c_short,  # cbColNameMax : SHORT
    ctypes.POINTER(ctypes.c_short),  # pcbColName : SHORT* optional, out
    ctypes.POINTER(ctypes.c_short),  # pfSqlType : SHORT* optional, out
    ctypes.POINTER(wintypes.DWORD),  # pcbColDef : DWORD* optional, out
    ctypes.POINTER(ctypes.c_short),  # pibScale : SHORT* optional, out
    ctypes.POINTER(ctypes.c_short),  # pfNullable : SHORT* optional, out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ODBC32.dll')
SQLDescribeColA = Fiddle::Function.new(
  lib['SQLDescribeColA'],
  [
    Fiddle::TYPE_VOIDP,  # hstmt : void* in/out
    -Fiddle::TYPE_SHORT,  # icol : WORD
    Fiddle::TYPE_VOIDP,  # szColName : BYTE* optional, out
    Fiddle::TYPE_SHORT,  # cbColNameMax : SHORT
    Fiddle::TYPE_VOIDP,  # pcbColName : SHORT* optional, out
    Fiddle::TYPE_VOIDP,  # pfSqlType : SHORT* optional, out
    Fiddle::TYPE_VOIDP,  # pcbColDef : DWORD* optional, out
    Fiddle::TYPE_VOIDP,  # pibScale : SHORT* optional, out
    Fiddle::TYPE_VOIDP,  # pfNullable : SHORT* optional, out
  ],
  Fiddle::TYPE_SHORT)

#[link(name = "odbc32")]
extern "system" {
    fn SQLDescribeColA(
        hstmt: *mut (),  // void* in/out
        icol: u16,  // WORD
        szColName: *mut u8,  // BYTE* optional, out
        cbColNameMax: i16,  // SHORT
        pcbColName: *mut i16,  // SHORT* optional, out
        pfSqlType: *mut i16,  // SHORT* optional, out
        pcbColDef: *mut u32,  // DWORD* optional, out
        pibScale: *mut i16,  // SHORT* optional, out
        pfNullable: *mut i16  // SHORT* optional, out
    ) -> i16;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("ODBC32.dll", CharSet = CharSet.Ansi)]
public static extern short SQLDescribeColA(IntPtr hstmt, ushort icol, IntPtr szColName, short cbColNameMax, IntPtr pcbColName, IntPtr pfSqlType, IntPtr pcbColDef, IntPtr pibScale, IntPtr pfNullable);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ODBC32_SQLDescribeColA' -Namespace Win32 -PassThru
# $api::SQLDescribeColA(hstmt, icol, szColName, cbColNameMax, pcbColName, pfSqlType, pcbColDef, pibScale, pfNullable)

#uselib "ODBC32.dll"
#func global SQLDescribeColA "SQLDescribeColA" sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr
; SQLDescribeColA hstmt, icol, varptr(szColName), cbColNameMax, varptr(pcbColName), varptr(pfSqlType), varptr(pcbColDef), varptr(pibScale), varptr(pfNullable)   ; 戻り値は stat
; hstmt : void* in/out -> "sptr"
; icol : WORD -> "sptr"
; szColName : BYTE* optional, out -> "sptr"
; cbColNameMax : SHORT -> "sptr"
; pcbColName : SHORT* optional, out -> "sptr"
; pfSqlType : SHORT* optional, out -> "sptr"
; pcbColDef : DWORD* optional, out -> "sptr"
; pibScale : SHORT* optional, out -> "sptr"
; pfNullable : SHORT* optional, out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "ODBC32.dll"
#cfunc global SQLDescribeColA "SQLDescribeColA" sptr, int, var, int, var, var, var, var, var
; res = SQLDescribeColA(hstmt, icol, szColName, cbColNameMax, pcbColName, pfSqlType, pcbColDef, pibScale, pfNullable)
; hstmt : void* in/out -> "sptr"
; icol : WORD -> "int"
; szColName : BYTE* optional, out -> "var"
; cbColNameMax : SHORT -> "int"
; pcbColName : SHORT* optional, out -> "var"
; pfSqlType : SHORT* optional, out -> "var"
; pcbColDef : DWORD* optional, out -> "var"
; pibScale : SHORT* optional, out -> "var"
; pfNullable : SHORT* optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "ODBC32.dll"
#cfunc global SQLDescribeColA "SQLDescribeColA" sptr, int, sptr, int, sptr, sptr, sptr, sptr, sptr
; res = SQLDescribeColA(hstmt, icol, varptr(szColName), cbColNameMax, varptr(pcbColName), varptr(pfSqlType), varptr(pcbColDef), varptr(pibScale), varptr(pfNullable))
; hstmt : void* in/out -> "sptr"
; icol : WORD -> "int"
; szColName : BYTE* optional, out -> "sptr"
; cbColNameMax : SHORT -> "int"
; pcbColName : SHORT* optional, out -> "sptr"
; pfSqlType : SHORT* optional, out -> "sptr"
; pcbColDef : DWORD* optional, out -> "sptr"
; pibScale : SHORT* optional, out -> "sptr"
; pfNullable : SHORT* optional, out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。

出力引数:

; SHORT SQLDescribeColA(void* hstmt, WORD icol, BYTE* szColName, SHORT cbColNameMax, SHORT* pcbColName, SHORT* pfSqlType, DWORD* pcbColDef, SHORT* pibScale, SHORT* pfNullable)
#uselib "ODBC32.dll"
#cfunc global SQLDescribeColA "SQLDescribeColA" intptr, int, var, int, var, var, var, var, var
; res = SQLDescribeColA(hstmt, icol, szColName, cbColNameMax, pcbColName, pfSqlType, pcbColDef, pibScale, pfNullable)
; hstmt : void* in/out -> "intptr"
; icol : WORD -> "int"
; szColName : BYTE* optional, out -> "var"
; cbColNameMax : SHORT -> "int"
; pcbColName : SHORT* optional, out -> "var"
; pfSqlType : SHORT* optional, out -> "var"
; pcbColDef : DWORD* optional, out -> "var"
; pibScale : SHORT* optional, out -> "var"
; pfNullable : SHORT* optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。; SHORT SQLDescribeColA(void* hstmt, WORD icol, BYTE* szColName, SHORT cbColNameMax, SHORT* pcbColName, SHORT* pfSqlType, DWORD* pcbColDef, SHORT* pibScale, SHORT* pfNullable)
#uselib "ODBC32.dll"
#cfunc global SQLDescribeColA "SQLDescribeColA" intptr, int, intptr, int, intptr, intptr, intptr, intptr, intptr
; res = SQLDescribeColA(hstmt, icol, varptr(szColName), cbColNameMax, varptr(pcbColName), varptr(pfSqlType), varptr(pcbColDef), varptr(pibScale), varptr(pfNullable))
; hstmt : void* in/out -> "intptr"
; icol : WORD -> "int"
; szColName : BYTE* optional, out -> "intptr"
; cbColNameMax : SHORT -> "int"
; pcbColName : SHORT* optional, out -> "intptr"
; pfSqlType : SHORT* optional, out -> "intptr"
; pcbColDef : DWORD* optional, out -> "intptr"
; pibScale : SHORT* optional, out -> "intptr"
; pfNullable : SHORT* optional, out -> "intptr"
; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは varptr(変数))。

import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	odbc32 = windows.NewLazySystemDLL("ODBC32.dll")
	procSQLDescribeColA = odbc32.NewProc("SQLDescribeColA")
)

// hstmt (void* in/out), icol (WORD), szColName (BYTE* optional, out), cbColNameMax (SHORT), pcbColName (SHORT* optional, out), pfSqlType (SHORT* optional, out), pcbColDef (DWORD* optional, out), pibScale (SHORT* optional, out), pfNullable (SHORT* optional, out)
r1, _, err := procSQLDescribeColA.Call(
	uintptr(hstmt),
	uintptr(icol),
	uintptr(szColName),
	uintptr(cbColNameMax),
	uintptr(pcbColName),
	uintptr(pfSqlType),
	uintptr(pcbColDef),
	uintptr(pibScale),
	uintptr(pfNullable),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // SHORT

function SQLDescribeColA(
  hstmt: Pointer;   // void* in/out
  icol: Word;   // WORD
  szColName: Pointer;   // BYTE* optional, out
  cbColNameMax: Smallint;   // SHORT
  pcbColName: Pointer;   // SHORT* optional, out
  pfSqlType: Pointer;   // SHORT* optional, out
  pcbColDef: Pointer;   // DWORD* optional, out
  pibScale: Pointer;   // SHORT* optional, out
  pfNullable: Pointer   // SHORT* optional, out
): Smallint; stdcall;
  external 'ODBC32.dll' name 'SQLDescribeColA';

result := DllCall("ODBC32\SQLDescribeColA"
    , "Ptr", hstmt   ; void* in/out
    , "UShort", icol   ; WORD
    , "Ptr", szColName   ; BYTE* optional, out
    , "Short", cbColNameMax   ; SHORT
    , "Ptr", pcbColName   ; SHORT* optional, out
    , "Ptr", pfSqlType   ; SHORT* optional, out
    , "Ptr", pcbColDef   ; DWORD* optional, out
    , "Ptr", pibScale   ; SHORT* optional, out
    , "Ptr", pfNullable   ; SHORT* optional, out
    , "Short")   ; return: SHORT

●SQLDescribeColA(hstmt, icol, szColName, cbColNameMax, pcbColName, pfSqlType, pcbColDef, pibScale, pfNullable) = DLL("ODBC32.dll", "int SQLDescribeColA(void*, int, void*, int, void*, void*, void*, void*, void*)")
# 呼び出し: SQLDescribeColA(hstmt, icol, szColName, cbColNameMax, pcbColName, pfSqlType, pcbColDef, pibScale, pfNullable)
# hstmt : void* in/out -> "void*"
# icol : WORD -> "int"
# szColName : BYTE* optional, out -> "void*"
# cbColNameMax : SHORT -> "int"
# pcbColName : SHORT* optional, out -> "void*"
# pfSqlType : SHORT* optional, out -> "void*"
# pcbColDef : DWORD* optional, out -> "void*"
# pibScale : SHORT* optional, out -> "void*"
# pfNullable : SHORT* optional, out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。