SQLGetTypeInfo
関数シグネチャ
// ODBC32.dll (ANSI / -A)
#include <windows.h>
SHORT SQLGetTypeInfo(
void* StatementHandle,
SHORT DataType
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| StatementHandle | void* | inout | [入力] 結果セット用のステートメントハンドル。 |
| DataType | SHORT | in | [入力] SQL データ型。付録 D: データ型 の SQL データ型 セクションに記載されている値のいずれか、またはドライバー固有の SQL データ型である必要があります。SQL_ALL_TYPES を指定すると、すべてのデータ型に関する情報が返されます。 |
戻り値の型: SHORT
公式ドキュメント
SQLGetTypeInfo は、データソースがサポートするデータ型に関する情報を返します。ドライバーは、その情報を SQL の結果セットの形式で返します。これらのデータ型は、データ定義言語 (DDL) ステートメントで使用することを想定しています。
戻り値
解説(Remarks)
SQLGetTypeInfo は、DATA_TYPE 順、次いでそのデータ型が対応する ODBC SQL データ型にどれだけ近くマップされるかの順に並べ替えた標準的な結果セットとして結果を返します。データソースで定義されたデータ型は、ユーザー定義データ型よりも優先されます。そのため、並べ替え順序は必ずしも一貫しているとは限りませんが、おおまかには DATA_TYPE が先で、その次に TYPE_NAME という昇順であると言えます。たとえば、あるデータソースが INTEGER と COUNTER のデータ型 (COUNTER は自動インクリメント) を定義しており、さらにユーザー定義データ型 WHOLENUM も定義されているとします。この場合、返される順序は INTEGER、WHOLENUM、COUNTER になります。これは、WHOLENUM が ODBC SQL データ型の SQL_INTEGER に近くマップされるのに対し、自動インクリメントのデータ型はデータソースでサポートされていても ODBC SQL データ型に近くマップされないためです。この情報の利用方法については、DDL ステートメント を参照してください。
DataType 引数に、ドライバーがサポートする ODBC のバージョンでは有効であるものの、そのドライバーではサポートされていないデータ型を指定した場合は、空の結果セットが返されます。
ODBC カタログ関数の一般的な使い方、引数、および返されるデータの詳細については、カタログ関数 を参照してください。
次の列は ODBC 3.x で名前が変更されました。アプリケーションは列番号でバインドするため、列名の変更が下位互換性に影響することはありません。
| ODBC 2.0 の列 | ODBC 3.x の列 |
|---|---|
| PRECISION | COLUMN_SIZE |
| MONEY | FIXED_PREC_SCALE |
| AUTO_INCREMENT | AUTO_UNIQUE_VALUE |
ODBC 3.x では、SQLGetTypeInfo が返す結果セットに次の列が追加されました。
SQL_DATA_TYPE
INTERVAL_PRECISION
SQL_DATETIME_SUB
NUM_PREC_RADIX
次の表は、結果セットの列を示しています。列 19 (INTERVAL_PRECISION) より後の列は、ドライバーが独自に定義できます。アプリケーションは、明示的な序数位置を指定するのではなく、結果セットの末尾から数えてドライバー固有の列にアクセスしてください。詳細については、カタログ関数から返されるデータ を参照してください。
SQLGetTypeInfo はすべてのデータ型を返すとは限りません。たとえば、ドライバーがユーザー定義データ型を返さないことがあります。アプリケーションは、SQLGetTypeInfo が返すかどうかにかかわらず、有効なデータ型であれば使用できます。SQLGetTypeInfo が返すデータ型は、データソースがサポートしているものです。これらはデータ定義言語 (DDL) ステートメントで使用することを想定しています。ドライバーは、SQLGetTypeInfo が返す型以外のデータ型を使用して結果セットのデータを返すことがあります。カタログ関数の結果セットを作成する際に、ドライバーがデータソースでサポートされていないデータ型を使用する場合もあります。
| 列名 | 列 番号 |
データ型 | コメント |
|---|---|---|---|
| TYPE_NAME (ODBC 2.0) | 1 | Varchar not NULL | データソース依存のデータ型名。たとえば "CHAR()"、"VARCHAR()"、"MONEY"、"LONG VARBINARY"、"CHAR ( ) FOR BIT DATA" など。アプリケーションは、CREATE TABLE ステートメントおよび ALTER TABLE ステートメントでこの名前を使用する必要があります。 |
| DATA_TYPE (ODBC 2.0) | 2 | Smallint not NULL | SQL データ型。ODBC SQL データ型またはドライバー固有の SQL データ型のいずれかです。datetime データ型または interval データ型の場合、この列は簡潔なデータ型 (SQL_TYPE_TIME や SQL_INTERVAL_YEAR_TO_MONTH など) を返します。有効な ODBC SQL データ型の一覧については、付録 D: データ型 の SQL データ型 を参照してください。ドライバー固有の SQL データ型については、そのドライバーのドキュメントを参照してください。 |
| COLUMN_SIZE (ODBC 2.0) | 3 | Integer | このデータ型に対してサーバーがサポートする最大の列サイズ。数値データの場合は最大有効桁数です。文字列データの場合は文字数で表した長さです。datetime データ型の場合は、文字列表現の文字数です (秒の小数部の有効桁数は許容される最大値であると仮定します)。列サイズが該当しないデータ型では NULL が返されます。interval データ型の場合は、間隔リテラルの文字表現における文字数です (interval leading precision によって定義されます。付録 D: データ型 の Interval データ型の長さ を参照してください)。 列サイズの詳細については、付録 D: データ型 の 列サイズ、小数桁数、転送オクテット長、および表示サイズ を参照してください。 |
| LITERAL_PREFIX (ODBC 2.0) | 4 | Varchar | リテラルの先頭に付ける 1 文字または複数の文字。たとえば、文字データ型では単一引用符 (')、バイナリデータ型では 0x など。リテラルのプレフィックスが該当しないデータ型では NULL が返されます。 |
| LITERAL_SUFFIX (ODBC 2.0) | 5 | Varchar | リテラルを終端する 1 文字または複数の文字。たとえば、文字データ型では単一引用符 (') など。リテラルのサフィックスが該当しないデータ型では NULL が返されます。 |
| CREATE_PARAMS (ODBC 2.0) | 6 | Varchar | TYPE_NAME フィールドで返される名前を使用する際に、アプリケーションがかっこ内で指定できる各パラメーターに対応する、コンマ区切りのキーワードの一覧。一覧に含まれるキーワードは length、precision、scale のいずれかです。これらは、構文上使用する必要がある順序で並びます。たとえば、DECIMAL の CREATE_PARAMS は "precision,scale"、VARCHAR の CREATE_PARAMS は "length" になります。INTEGER のようにデータ型の定義にパラメーターがない場合は NULL が返されます。 ドライバーは、使用される国/地域の言語で CREATE_PARAMS のテキストを提供します。 |
| NULLABLE (ODBC 2.0) | 7 | Smallint not NULL | データ型が NULL 値を受け入れるかどうか: データ型が NULL 値を受け入れない場合は SQL_NO_NULLS。 データ型が NULL 値を受け入れる場合は SQL_NULLABLE。 列が NULL 値を受け入れるかどうかが不明な場合は SQL_NULLABLE_UNKNOWN。 |
| CASE_SENSITIVE (ODBC 2.0) | 8 | Smallint not NULL | 文字データ型が照合と比較で大文字と小文字を区別するかどうか: データ型が文字データ型であり、大文字と小文字を区別する場合は SQL_TRUE。 データ型が文字データ型でない場合、または大文字と小文字を区別しない場合は SQL_FALSE。 |
| SEARCHABLE (ODBC 2.0) | 9 | Smallint not NULL | データ型が WHERE 句でどのように使用されるか: 列を WHERE 句で使用できない場合は SQL_PRED_NONE。(これは ODBC 2.x の SQL_UNSEARCHABLE 値と同じです。) 列を WHERE 句で使用できるが LIKE 述語でのみ使用できる場合は SQL_PRED_CHAR。(これは ODBC 2.x の SQL_LIKE_ONLY 値と同じです。) 列を WHERE 句で LIKE を除くすべての比較演算子 (比較、限定比較、BETWEEN、DISTINCT、IN、MATCH、UNIQUE) とともに使用できる場合は SQL_PRED_BASIC。(これは ODBC 2.x の SQL_ALL_EXCEPT_LIKE 値と同じです。) 列を WHERE 句で任意の比較演算子とともに使用できる場合は SQL_SEARCHABLE。 |
| UNSIGNED_ATTRIBUTE (ODBC 2.0) | 10 | Smallint | データ型が符号なしかどうか: データ型が符号なしの場合は SQL_TRUE。 データ型が符号付きの場合は SQL_FALSE。 この属性がデータ型に該当しない場合、またはデータ型が数値でない場合は NULL が返されます。 |
| FIXED_PREC_SCALE (ODBC 2.0) | 11 | Smallint not NULL | money データ型のように、データ型が定義済みの固定された有効桁数と小数点以下桁数 (データソース固有) を持つかどうか: 定義済みの固定された有効桁数と小数点以下桁数を持つ場合は SQL_TRUE。 定義済みの固定された有効桁数と小数点以下桁数を持たない場合は SQL_FALSE。 |
| AUTO_UNIQUE_VALUE (ODBC 2.0) | 12 | Smallint | データ型が自動インクリメントされるかどうか: データ型が自動インクリメントされる場合は SQL_TRUE。 データ型が自動インクリメントされない場合は SQL_FALSE。 この属性がデータ型に該当しない場合、またはデータ型が数値でない場合は NULL が返されます。 アプリケーションはこの属性を持つ列に値を挿入できますが、通常はその列の値を更新することはできません。 自動インクリメント列に挿入が行われると、挿入時にその列へ一意の値が挿入されます。増分値は定義されておらず、データソース固有です。アプリケーションは、自動インクリメント列が特定の値から始まる、または特定の値ずつ増加すると想定しないでください。 |
| LOCAL_TYPE_NAME (ODBC 2.0) | 13 | Varchar | データソース依存のデータ型名をローカライズしたもの。データソースがローカライズされた名前をサポートしていない場合は NULL が返されます。この名前は、ダイアログボックスなどでの表示専用を想定しています。 |
| MINIMUM_SCALE (ODBC 2.0) | 14 | Smallint | データソースにおけるそのデータ型の最小の小数点以下桁数。データ型が固定の小数点以下桁数を持つ場合、MINIMUM_SCALE 列と MAXIMUM_SCALE 列の両方にこの値が格納されます。たとえば、SQL_TYPE_TIMESTAMP 列は秒の小数部について固定の小数点以下桁数を持つことがあります。小数点以下桁数が該当しない場合は NULL が返されます。詳細については、付録 D: データ型 の 列サイズ、小数桁数、転送オクテット長、および表示サイズ を参照してください。 |
| MAXIMUM_SCALE (ODBC 2.0) | 15 | Smallint | データソースにおけるそのデータ型の最大の小数点以下桁数。小数点以下桁数が該当しない場合は NULL が返されます。最大の小数点以下桁数がデータソースで個別に定義されておらず、代わりに最大有効桁数と同じであると定義されている場合、この列には COLUMN_SIZE 列と同じ値が格納されます。詳細については、付録 D: データ型 の 列サイズ、小数桁数、転送オクテット長、および表示サイズ を参照してください。 |
| SQL_DATA_TYPE (ODBC 3.0) | 16 | Smallint NOT NULL | 記述子の SQL_DESC_TYPE フィールドに現れる SQL データ型の値。この列は、interval データ型と datetime データ型を除いて DATA_TYPE 列と同じです。 interval データ型と datetime データ型の場合、結果セットの SQL_DATA_TYPE フィールドは SQL_INTERVAL または SQL_DATETIME を返し、SQL_DATETIME_SUB フィールドは個々の interval または datetime データ型のサブコードを返します。(付録 D: データ型 を参照してください。) |
| SQL_DATETIME_SUB (ODBC 3.0) | 17 | Smallint | SQL_DATA_TYPE の値が SQL_DATETIME または SQL_INTERVAL の場合、この列には datetime/interval のサブコードが格納されます。datetime と interval 以外のデータ型では、このフィールドは NULL です。 interval データ型または datetime データ型の場合、結果セットの SQL_DATA_TYPE フィールドは SQL_INTERVAL または SQL_DATETIME を返し、SQL_DATETIME_SUB フィールドは個々の interval または datetime データ型のサブコードを返します。(付録 D: データ型 を参照してください。) |
| NUM_PREC_RADIX (ODBC 3.0) | 18 | Integer | データ型が概数値型の場合、この列には値 2 が格納され、COLUMN_SIZE がビット数を表すことを示します。真数値型の場合、この列には値 10 が格納され、COLUMN_SIZE が 10 進桁数を表すことを示します。それ以外の場合、この列は NULL です。 |
| INTERVAL_PRECISION (ODBC 3.0) | 19 | Smallint | データ型が interval データ型の場合、この列には interval leading precision の値が格納されます。(付録 D: データ型 の Interval データ型の有効桁数 を参照してください。) それ以外の場合、この列は NULL です。 |
属性情報は、データ型に適用される場合と、結果セット内の特定の列に適用される場合があります。SQLGetTypeInfo はデータ型に関連付けられた属性の情報を返し、SQLColAttribute は結果セット内の列に関連付けられた属性の情報を返します。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp)
各言語での呼び出し定義
// ODBC32.dll (ANSI / -A)
#include <windows.h>
SHORT SQLGetTypeInfo(
void* StatementHandle,
SHORT DataType
);[DllImport("ODBC32.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern short SQLGetTypeInfo(
IntPtr StatementHandle, // void* in/out
short DataType // SHORT
);<DllImport("ODBC32.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function SQLGetTypeInfo(
StatementHandle As IntPtr, ' void* in/out
DataType As Short ' SHORT
) As Short
End Function' StatementHandle : void* in/out
' DataType : SHORT
Declare PtrSafe Function SQLGetTypeInfo Lib "odbc32" ( _
ByVal StatementHandle As LongPtr, _
ByVal DataType As Integer) As Integer
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
SQLGetTypeInfo = ctypes.windll.odbc32.SQLGetTypeInfo
SQLGetTypeInfo.restype = ctypes.c_short
SQLGetTypeInfo.argtypes = [
ctypes.POINTER(None), # StatementHandle : void* in/out
ctypes.c_short, # DataType : SHORT
]require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('ODBC32.dll')
SQLGetTypeInfo = Fiddle::Function.new(
lib['SQLGetTypeInfo'],
[
Fiddle::TYPE_VOIDP, # StatementHandle : void* in/out
Fiddle::TYPE_SHORT, # DataType : SHORT
],
Fiddle::TYPE_SHORT)#[link(name = "odbc32")]
extern "system" {
fn SQLGetTypeInfo(
StatementHandle: *mut (), // void* in/out
DataType: i16 // SHORT
) -> i16;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[DllImport("ODBC32.dll", CharSet = CharSet.Ansi)]
public static extern short SQLGetTypeInfo(IntPtr StatementHandle, short DataType);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ODBC32_SQLGetTypeInfo' -Namespace Win32 -PassThru
# $api::SQLGetTypeInfo(StatementHandle, DataType)#uselib "ODBC32.dll"
#func global SQLGetTypeInfo "SQLGetTypeInfo" sptr, sptr
; SQLGetTypeInfo StatementHandle, DataType ; 戻り値は stat
; StatementHandle : void* in/out -> "sptr"
; DataType : SHORT -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "ODBC32.dll"
#cfunc global SQLGetTypeInfo "SQLGetTypeInfo" sptr, int
; res = SQLGetTypeInfo(StatementHandle, DataType)
; StatementHandle : void* in/out -> "sptr"
; DataType : SHORT -> "int"; SHORT SQLGetTypeInfo(void* StatementHandle, SHORT DataType)
#uselib "ODBC32.dll"
#cfunc global SQLGetTypeInfo "SQLGetTypeInfo" intptr, int
; res = SQLGetTypeInfo(StatementHandle, DataType)
; StatementHandle : void* in/out -> "intptr"
; DataType : SHORT -> "int"import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
odbc32 = windows.NewLazySystemDLL("ODBC32.dll")
procSQLGetTypeInfo = odbc32.NewProc("SQLGetTypeInfo")
)
// StatementHandle (void* in/out), DataType (SHORT)
r1, _, err := procSQLGetTypeInfo.Call(
uintptr(StatementHandle),
uintptr(DataType),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // SHORTfunction SQLGetTypeInfo(
StatementHandle: Pointer; // void* in/out
DataType: Smallint // SHORT
): Smallint; stdcall;
external 'ODBC32.dll' name 'SQLGetTypeInfo';result := DllCall("ODBC32\SQLGetTypeInfo"
, "Ptr", StatementHandle ; void* in/out
, "Short", DataType ; SHORT
, "Short") ; return: SHORT●SQLGetTypeInfo(StatementHandle, DataType) = DLL("ODBC32.dll", "int SQLGetTypeInfo(void*, int)")
# 呼び出し: SQLGetTypeInfo(StatementHandle, DataType)
# StatementHandle : void* in/out -> "void*"
# DataType : SHORT -> "int"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "odbc32" fn SQLGetTypeInfo(
StatementHandle: ?*anyopaque, // void* in/out
DataType: i16 // SHORT
) callconv(std.os.windows.WINAPI) i16;proc SQLGetTypeInfo(
StatementHandle: pointer, # void* in/out
DataType: int16 # SHORT
): int16 {.importc: "SQLGetTypeInfo", stdcall, dynlib: "ODBC32.dll".}pragma(lib, "odbc32");
extern(Windows)
short SQLGetTypeInfo(
void* StatementHandle, // void* in/out
short DataType // SHORT
);ccall((:SQLGetTypeInfo, "ODBC32.dll"), stdcall, Int16,
(Ptr{Cvoid}, Int16),
StatementHandle, DataType)
# StatementHandle : void* in/out -> Ptr{Cvoid}
# DataType : SHORT -> Int16
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
int16_t SQLGetTypeInfo(
void* StatementHandle,
int16_t DataType);
]]
local odbc32 = ffi.load("odbc32")
-- odbc32.SQLGetTypeInfo(StatementHandle, DataType)
-- StatementHandle : void* in/out
-- DataType : SHORT
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('ODBC32.dll');
const SQLGetTypeInfo = lib.func('__stdcall', 'SQLGetTypeInfo', 'int16_t', ['void *', 'int16_t']);
// SQLGetTypeInfo(StatementHandle, DataType)
// StatementHandle : void* in/out -> 'void *'
// DataType : SHORT -> 'int16_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("ODBC32.dll", {
SQLGetTypeInfo: { parameters: ["pointer", "i16"], result: "i16" },
});
// lib.symbols.SQLGetTypeInfo(StatementHandle, DataType)
// StatementHandle : void* in/out -> "pointer"
// DataType : SHORT -> "i16"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
int16_t SQLGetTypeInfo(
void* StatementHandle,
int16_t DataType);
C, "ODBC32.dll");
// $ffi->SQLGetTypeInfo(StatementHandle, DataType);
// StatementHandle : void* in/out
// DataType : SHORT
// 構造体/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 Odbc32 extends StdCallLibrary {
Odbc32 INSTANCE = Native.load("odbc32", Odbc32.class, W32APIOptions.ASCII_OPTIONS);
short SQLGetTypeInfo(
Pointer StatementHandle, // void* in/out
short DataType // SHORT
);
}@[Link("odbc32")]
lib LibODBC32
fun SQLGetTypeInfo = SQLGetTypeInfo(
StatementHandle : Void*, # void* in/out
DataType : Int16 # SHORT
) : Int16
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef SQLGetTypeInfoNative = Int16 Function(Pointer<Void>, Int16);
typedef SQLGetTypeInfoDart = int Function(Pointer<Void>, int);
final SQLGetTypeInfo = DynamicLibrary.open('ODBC32.dll')
.lookupFunction<SQLGetTypeInfoNative, SQLGetTypeInfoDart>('SQLGetTypeInfo');
// StatementHandle : void* in/out -> Pointer<Void>
// DataType : SHORT -> Int16
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function SQLGetTypeInfo(
StatementHandle: Pointer; // void* in/out
DataType: Smallint // SHORT
): Smallint; stdcall;
external 'ODBC32.dll' name 'SQLGetTypeInfo';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "SQLGetTypeInfo"
c_SQLGetTypeInfo :: Ptr () -> Int16 -> IO Int16
-- StatementHandle : void* in/out -> Ptr ()
-- DataType : SHORT -> Int16
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let sqlgettypeinfo =
foreign "SQLGetTypeInfo"
((ptr void) @-> int16_t @-> returning int16_t)
(* StatementHandle : void* in/out -> (ptr void) *)
(* DataType : SHORT -> int16_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)(cffi:define-foreign-library odbc32 (t "ODBC32.dll"))
(cffi:use-foreign-library odbc32)
(cffi:defcfun ("SQLGetTypeInfo" sqlget-type-info :convention :stdcall) :int16
(statement-handle :pointer) ; void* in/out
(data-type :int16)) ; SHORT
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $SQLGetTypeInfo = Win32::API::More->new('ODBC32',
'short SQLGetTypeInfo(LPVOID StatementHandle, short DataType)');
# my $ret = $SQLGetTypeInfo->Call($StatementHandle, $DataType);
# StatementHandle : void* in/out -> LPVOID
# DataType : SHORT -> short
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。関連項目
- f SQLGetTypeInfoA (ANSI版) — ODBCデータソースがサポートするデータ型の情報を取得する。
- f SQLGetTypeInfoW (Unicode版) — データソースが対応するSQLデータ型情報を取得する(Unicode)。