SQLColumns
関数シグネチャ
// ODBC32.dll (ANSI / -A)
#include <windows.h>
SHORT SQLColumns(
void* StatementHandle,
BYTE* CatalogName, // optional
SHORT NameLength1,
BYTE* SchemaName, // optional
SHORT NameLength2,
BYTE* TableName, // optional
SHORT NameLength3,
BYTE* ColumnName, // optional
SHORT NameLength4
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| StatementHandle | void* | inout | [入力] ステートメントハンドル。 |
| CatalogName | BYTE* | inoptional | [入力] カタログ名。ドライバーが異なる DBMS からデータを取得する場合など、一部のテーブルについてのみカタログをサポートするときは、空文字列 ("") はカタログを持たないテーブルを示します。CatalogName に文字列検索パターンを含めることはできません。 メモ
SQL_ATTR_METADATA_ID ステートメント属性が SQL_TRUE に設定されている場合、CatalogName は識別子として扱われ、大文字と小文字は区別されません。SQL_FALSE の場合、CatalogName は通常の引数であり、文字どおりに扱われ、大文字と小文字が区別されます。詳細については、Arguments in Catalog Functions を参照してください。 |
| NameLength1 | SHORT | in | [入力] *CatalogName の長さ (文字数)。 |
| SchemaName | BYTE* | inoptional | [入力] スキーマ名の文字列検索パターン。ドライバーが異なる DBMS からデータを取得する場合など、一部のテーブルについてのみスキーマをサポートするときは、空文字列 ("") はスキーマを持たないテーブルを示します。 メモ
SQL_ATTR_METADATA_ID ステートメント属性が SQL_TRUE に設定されている場合、SchemaName は識別子として扱われ、大文字と小文字は区別されません。SQL_FALSE の場合、SchemaName はパターン値の引数であり、文字どおりに扱われ、大文字と小文字が区別されます。 |
| NameLength2 | SHORT | in | [入力] *SchemaName の長さ (文字数)。 |
| TableName | BYTE* | inoptional | [入力] テーブル名の文字列検索パターン。 メモ
SQL_ATTR_METADATA_ID ステートメント属性が SQL_TRUE に設定されている場合、TableName は識別子として扱われ、大文字と小文字は区別されません。SQL_FALSE の場合、TableName はパターン値の引数であり、文字どおりに扱われ、大文字と小文字が区別されます。 |
| NameLength3 | SHORT | in | [入力] *TableName の長さ (文字数)。 |
| ColumnName | BYTE* | inoptional | [入力] 列名の文字列検索パターン。 メモ
SQL_ATTR_METADATA_ID ステートメント属性が SQL_TRUE に設定されている場合、ColumnName は識別子として扱われ、大文字と小文字は区別されません。SQL_FALSE の場合、ColumnName はパターン値の引数であり、文字どおりに扱われ、大文字と小文字が区別されます。 |
| NameLength4 | SHORT | in | [入力] *ColumnName の長さ (文字数)。 |
戻り値の型: SHORT
公式ドキュメント
SQLColumns は、指定されたテーブル内の列名の一覧を返します。ドライバーはこの情報を、指定された StatementHandle 上の結果セットとして返します。
戻り値
解説(Remarks)
この関数は通常、ステートメントの実行前に、データソースのカタログからテーブル (1 つまたは複数) の列に関する情報を取得するために使用します。SQLColumns は、SQLTables が返すすべての種類の項目についてデータを取得するために使用できます。ベーステーブルに加えて、ビュー、シノニム、システムテーブルなどが含まれる場合もあります (これらに限りません)。これに対して、SQLColAttribute 関数と SQLDescribeCol 関数は結果セット内の列を記述し、SQLNumResultCols 関数は結果セット内の列数を返します。詳細については、Uses of Catalog Data を参照してください。
ODBC カタログ関数の一般的な使用方法、引数、および返されるデータの詳細については、Catalog Functions を参照してください。
SQLColumns は、TABLE_CAT、TABLE_SCHEM、TABLE_NAME、ORDINAL_POSITION の順に並べ替えられた標準の結果セットとして結果を返します。
アプリケーションが ODBC 2.x ドライバーを使用する場合、結果セットに ORDINAL_POSITION 列は返されません。そのため、ODBC 2.x ドライバーを使用する場合、SQLColumns が返す列リスト内の列の順序は、そのテーブルのすべての列に対して SELECT ステートメントを実行したときに返される列の順序と必ずしも同じではありません。
SQLColumns はすべての列を返すとは限りません。たとえば、ドライバーは Oracle の ROWID のような擬似列に関する情報を返さないことがあります。アプリケーションは、SQLColumns によって返されるかどうかにかかわらず、有効な列であれば使用できます。
SQLStatistics が返す列の一部は、SQLColumns では返されません。たとえば、SQLColumns は、SALARY + BENEFITS や DEPT = 0012 のような式やフィルターに対して作成されたインデックスの列を返しません。
VARCHAR 列の長さは表に示されていません。実際の長さはデータソースによって異なります。TABLE_CAT、TABLE_SCHEM、TABLE_NAME、COLUMN_NAME の各列の実際の長さを判断するには、アプリケーションは SQL_MAX_CATALOG_NAME_LEN、SQL_MAX_SCHEMA_NAME_LEN、SQL_MAX_TABLE_NAME_LEN、SQL_MAX_COLUMN_NAME_LEN の各オプションを指定して SQLGetInfo を呼び出します。
ODBC 3.x では次の列の名前が変更されました。アプリケーションは列番号でバインドするため、列名の変更が下位互換性に影響することはありません。
| ODBC 2.0 の列 | ODBC 3.x の列 |
|---|---|
| TABLE_QUALIFIER | TABLE_CAT |
| TABLE_OWNER | TABLE_SCHEM |
| PRECISION | COLUMN_SIZE |
| LENGTH | BUFFER_LENGTH |
| SCALE | DECIMAL_DIGITS |
| RADIX | NUM_PREC_RADIX |
ODBC 3.x では、SQLColumns が返す結果セットに次の列が追加されました。
:::row:::
:::column:::
CHAR_OCTET_LENGTH
COLUMN_DEF
:::column-end:::
:::column:::
IS_NULLABLE
ORDINAL_POSITION
:::column-end:::
:::column:::
SQL_DATA_TYPE
SQL_DATETIME_SUB
:::column-end:::
:::row-end:::
次の表に、結果セット内の列を示します。18 列目 (IS_NULLABLE) より後の追加の列は、ドライバーが定義できます。アプリケーションは、明示的な序数位置を指定するのではなく、結果セットの末尾から逆に数えることでドライバー固有の列にアクセスしてください。詳細については、Data Returned by Catalog Functions を参照してください。
| 列名 | 列 番号 |
データ型 | コメント |
|---|---|---|---|
| TABLE_CAT (ODBC 1.0) | 1 | Varchar | カタログ名。データソースに該当しない場合は NULL。ドライバーが異なる DBMS からデータを取得する場合など、一部のテーブルについてのみカタログをサポートするときは、カタログを持たないテーブルに対して空文字列 ("") を返します。 |
| TABLE_SCHEM (ODBC 1.0) | 2 | Varchar | スキーマ名。データソースに該当しない場合は NULL。ドライバーが異なる DBMS からデータを取得する場合など、一部のテーブルについてのみスキーマをサポートするときは、スキーマを持たないテーブルに対して空文字列 ("") を返します。 |
| TABLE_NAME (ODBC 1.0) | 3 | Varchar not NULL | テーブル名。 |
| COLUMN_NAME (ODBC 1.0) | 4 | Varchar not NULL | 列名。名前を持たない列に対しては、ドライバーは空文字列を返します。 |
| DATA_TYPE (ODBC 1.0) | 5 | Smallint not NULL | SQL データ型。ODBC SQL データ型またはドライバー固有の SQL データ型のいずれかです。datetime 型と interval 型のデータ型については、この列は簡潔形式のデータ型 (SQL_DATETIME や SQL_INTERVAL のような非簡潔形式ではなく、SQL_TYPE_DATE や SQL_INTERVAL_YEAR_TO_MONTH など) を返します。有効な ODBC SQL データ型の一覧については、付録 D: データ型の SQL Data Types を参照してください。ドライバー固有の SQL データ型については、ドライバーのドキュメントを参照してください。 ODBC 3.x アプリケーションと ODBC 2.x アプリケーションとで、返されるデータ型が異なる場合があります。詳細については、Backward Compatibility and Standards Compliance を参照してください。 |
| TYPE_NAME (ODBC 1.0) | 6 | Varchar not NULL | データソースに依存するデータ型名。たとえば "CHAR"、"VARCHAR"、"MONEY"、"LONG VARBINAR"、"CHAR ( ) FOR BIT DATA" など。 |
| COLUMN_SIZE (ODBC 1.0) | 7 | Integer | DATA_TYPE が SQL_CHAR または SQL_VARCHAR の場合、この列にはその列の最大長が文字数で格納されます。datetime データ型については、値を文字に変換して表示するために必要な文字数の合計です。数値データ型については、NUM_PREC_RADIX 列に応じて、その列に許可される桁数の合計またはビット数の合計です。interval データ型については、interval リテラルの文字表現における文字数です (interval の先頭精度によって定義されます。付録 D: データ型の Interval Data Type Length を参照)。詳細については、付録 D: データ型の Column Size, Decimal Digits, Transfer Octet Length, and Display Size を参照してください。 |
| BUFFER_LENGTH (ODBC 1.0) | 8 | Integer | SQL_C_DEFAULT が指定された場合に、SQLGetData、SQLFetch、または SQLFetchScroll の操作で転送されるデータのバイト単位の長さ。数値データの場合、このサイズはデータソースに格納されているデータのサイズと異なることがあります。文字データの場合、この値は COLUMN_SIZE 列と異なることがあります。長さの詳細については、付録 D: データ型の Column Size, Decimal Digits, Transfer Octet Length, and Display Size を参照してください。 |
| DECIMAL_DIGITS (ODBC 1.0) | 9 | Smallint | 小数点の右側にある有効桁数の合計。SQL_TYPE_TIME と SQL_TYPE_TIMESTAMP については、この列には秒の小数部の桁数が格納されます。その他のデータ型については、データソース上のその列の小数桁数です。時刻要素を含む interval データ型については、この列には小数点の右側の桁数 (秒の小数部) が格納されます。時刻要素を含まない interval データ型については、この列は 0 です。小数桁数の詳細については、付録 D: データ型の Column Size, Decimal Digits, Transfer Octet Length, and Display Size を参照してください。DECIMAL_DIGITS が該当しないデータ型については NULL が返されます。 |
| NUM_PREC_RADIX (ODBC 1.0) | 10 | Smallint | 数値データ型については 10 または 2 のいずれか。10 の場合、COLUMN_SIZE と DECIMAL_DIGITS の値は、その列に許可される 10 進数の桁数を表します。たとえば DECIMAL(12,5) の列は、NUM_PREC_RADIX として 10、COLUMN_SIZE として 12、DECIMAL_DIGITS として 5 を返します。FLOAT の列は、NUM_PREC_RADIX として 10、COLUMN_SIZE として 15、DECIMAL_DIGITS として NULL を返すことがあります。 2 の場合、COLUMN_SIZE と DECIMAL_DIGITS の値は、その列に許可されるビット数を表します。たとえば FLOAT の列は、RADIX として 2、COLUMN_SIZE として 53、DECIMAL_DIGITS として NULL を返すことがあります。 NUM_PREC_RADIX が該当しないデータ型については NULL が返されます。 |
| NULLABLE (ODBC 1.0) | 11 | Smallint not NULL | その列が NULL 値を含められない場合は SQL_NO_NULLS。 その列が NULL 値を受け入れる場合は SQL_NULLABLE。 その列が NULL 値を受け入れるかどうかが不明な場合は SQL_NULLABLE_UNKNOWN。 この列で返される値は、IS_NULLABLE 列で返される値とは異なります。NULLABLE 列は、列が NULL を受け入れられることは確実に示しますが、列が NULL を受け入れないことを確実に示すことはできません。IS_NULLABLE 列は、列が NULL を受け入れられないことは確実に示しますが、列が NULL を受け入れることを確実に示すことはできません。 |
| REMARKS (ODBC 1.0) | 12 | Varchar | 列の説明。 |
| COLUMN_DEF (ODBC 3.0) | 13 | Varchar | 列の既定値。この列の値が引用符で囲まれている場合は、文字列として解釈してください。 既定値として NULL が指定されている場合、この列は引用符で囲まれない NULL という語になります。既定値を切り捨てずに表現できない場合、この列には単一引用符で囲まれない TRUNCATED が格納されます。既定値が指定されていない場合、この列は NULL です。 COLUMN_DEF の値は、TRUNCATED という値が格納されている場合を除き、新しい列定義の生成に使用できます。 |
| SQL_DATA_TYPE (ODBC 3.0) | 14 | Smallint not NULL | IRD の SQL_DESC_TYPE レコードフィールドに現れる形の SQL データ型。ODBC SQL データ型またはドライバー固有の SQL データ型のいずれかです。この列は、datetime 型と interval 型のデータ型を除いて DATA_TYPE 列と同じです。datetime 型と interval 型のデータ型については、この列は簡潔形式のデータ型 (SQL_TYPE_DATE や SQL_INTERVAL_YEAR_TO_MONTH など) ではなく、非簡潔形式のデータ型 (SQL_DATETIME や SQL_INTERVAL など) を返します。この列が SQL_DATETIME または SQL_INTERVAL を返す場合、具体的なデータ型は SQL_DATETIME_SUB 列から判断できます。有効な ODBC SQL データ型の一覧については、付録 D: データ型の SQL Data Types を参照してください。ドライバー固有の SQL データ型については、ドライバーのドキュメントを参照してください。 ODBC 3.x アプリケーションと ODBC 2.x アプリケーションとで、返されるデータ型が異なる場合があります。詳細については、Backward Compatibility and Standards Compliance を参照してください。 |
| SQL_DATETIME_SUB (ODBC 3.0) | 15 | Smallint | datetime 型と interval 型のデータ型のサブタイプコード。その他のデータ型については、この列は NULL を返します。datetime および interval のサブコードの詳細については、SQLSetDescField の "SQL_DESC_DATETIME_INTERVAL_CODE" を参照してください。 |
| CHAR_OCTET_LENGTH (ODBC 3.0) | 16 | Integer | 文字型またはバイナリ型のデータ型の列の最大長 (バイト単位)。その他のすべてのデータ型については、この列は NULL を返します。 |
| ORDINAL_POSITION (ODBC 3.0) | 17 | Integer not NULL | テーブル内での列の序数位置。テーブルの最初の列は 1 番です。 |
| IS_NULLABLE (ODBC 3.0) | 18 | Varchar | その列が NULL を含まない場合は "NO"。 その列が NULL を含む可能性がある場合は "YES"。 NULL 許容性が不明な場合、この列は長さ 0 の文字列を返します。 NULL 許容性の判断には ISO 規則が適用されます。ISO SQL に準拠した DBMS は空文字列を返すことはできません。 この列で返される値は、NULLABLE 列で返される値とは異なります (NULLABLE 列の説明を参照してください)。 |
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp)
各言語での呼び出し定義
// ODBC32.dll (ANSI / -A)
#include <windows.h>
SHORT SQLColumns(
void* StatementHandle,
BYTE* CatalogName, // optional
SHORT NameLength1,
BYTE* SchemaName, // optional
SHORT NameLength2,
BYTE* TableName, // optional
SHORT NameLength3,
BYTE* ColumnName, // optional
SHORT NameLength4
);[DllImport("ODBC32.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern short SQLColumns(
IntPtr StatementHandle, // void* in/out
IntPtr CatalogName, // BYTE* optional
short NameLength1, // SHORT
IntPtr SchemaName, // BYTE* optional
short NameLength2, // SHORT
IntPtr TableName, // BYTE* optional
short NameLength3, // SHORT
IntPtr ColumnName, // BYTE* optional
short NameLength4 // SHORT
);<DllImport("ODBC32.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function SQLColumns(
StatementHandle As IntPtr, ' void* in/out
CatalogName As IntPtr, ' BYTE* optional
NameLength1 As Short, ' SHORT
SchemaName As IntPtr, ' BYTE* optional
NameLength2 As Short, ' SHORT
TableName As IntPtr, ' BYTE* optional
NameLength3 As Short, ' SHORT
ColumnName As IntPtr, ' BYTE* optional
NameLength4 As Short ' SHORT
) As Short
End Function' StatementHandle : void* in/out
' CatalogName : BYTE* optional
' NameLength1 : SHORT
' SchemaName : BYTE* optional
' NameLength2 : SHORT
' TableName : BYTE* optional
' NameLength3 : SHORT
' ColumnName : BYTE* optional
' NameLength4 : SHORT
Declare PtrSafe Function SQLColumns Lib "odbc32" ( _
ByVal StatementHandle As LongPtr, _
ByVal CatalogName As LongPtr, _
ByVal NameLength1 As Integer, _
ByVal SchemaName As LongPtr, _
ByVal NameLength2 As Integer, _
ByVal TableName As LongPtr, _
ByVal NameLength3 As Integer, _
ByVal ColumnName As LongPtr, _
ByVal NameLength4 As Integer) As Integer
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
SQLColumns = ctypes.windll.odbc32.SQLColumns
SQLColumns.restype = ctypes.c_short
SQLColumns.argtypes = [
ctypes.POINTER(None), # StatementHandle : void* in/out
ctypes.POINTER(ctypes.c_ubyte), # CatalogName : BYTE* optional
ctypes.c_short, # NameLength1 : SHORT
ctypes.POINTER(ctypes.c_ubyte), # SchemaName : BYTE* optional
ctypes.c_short, # NameLength2 : SHORT
ctypes.POINTER(ctypes.c_ubyte), # TableName : BYTE* optional
ctypes.c_short, # NameLength3 : SHORT
ctypes.POINTER(ctypes.c_ubyte), # ColumnName : BYTE* optional
ctypes.c_short, # NameLength4 : SHORT
]require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('ODBC32.dll')
SQLColumns = Fiddle::Function.new(
lib['SQLColumns'],
[
Fiddle::TYPE_VOIDP, # StatementHandle : void* in/out
Fiddle::TYPE_VOIDP, # CatalogName : BYTE* optional
Fiddle::TYPE_SHORT, # NameLength1 : SHORT
Fiddle::TYPE_VOIDP, # SchemaName : BYTE* optional
Fiddle::TYPE_SHORT, # NameLength2 : SHORT
Fiddle::TYPE_VOIDP, # TableName : BYTE* optional
Fiddle::TYPE_SHORT, # NameLength3 : SHORT
Fiddle::TYPE_VOIDP, # ColumnName : BYTE* optional
Fiddle::TYPE_SHORT, # NameLength4 : SHORT
],
Fiddle::TYPE_SHORT)#[link(name = "odbc32")]
extern "system" {
fn SQLColumns(
StatementHandle: *mut (), // void* in/out
CatalogName: *mut u8, // BYTE* optional
NameLength1: i16, // SHORT
SchemaName: *mut u8, // BYTE* optional
NameLength2: i16, // SHORT
TableName: *mut u8, // BYTE* optional
NameLength3: i16, // SHORT
ColumnName: *mut u8, // BYTE* optional
NameLength4: i16 // SHORT
) -> i16;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[DllImport("ODBC32.dll", CharSet = CharSet.Ansi)]
public static extern short SQLColumns(IntPtr StatementHandle, IntPtr CatalogName, short NameLength1, IntPtr SchemaName, short NameLength2, IntPtr TableName, short NameLength3, IntPtr ColumnName, short NameLength4);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ODBC32_SQLColumns' -Namespace Win32 -PassThru
# $api::SQLColumns(StatementHandle, CatalogName, NameLength1, SchemaName, NameLength2, TableName, NameLength3, ColumnName, NameLength4)#uselib "ODBC32.dll"
#func global SQLColumns "SQLColumns" sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr
; SQLColumns StatementHandle, varptr(CatalogName), NameLength1, varptr(SchemaName), NameLength2, varptr(TableName), NameLength3, varptr(ColumnName), NameLength4 ; 戻り値は stat
; StatementHandle : void* in/out -> "sptr"
; CatalogName : BYTE* optional -> "sptr"
; NameLength1 : SHORT -> "sptr"
; SchemaName : BYTE* optional -> "sptr"
; NameLength2 : SHORT -> "sptr"
; TableName : BYTE* optional -> "sptr"
; NameLength3 : SHORT -> "sptr"
; ColumnName : BYTE* optional -> "sptr"
; NameLength4 : SHORT -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "ODBC32.dll" #cfunc global SQLColumns "SQLColumns" sptr, var, int, var, int, var, int, var, int ; res = SQLColumns(StatementHandle, CatalogName, NameLength1, SchemaName, NameLength2, TableName, NameLength3, ColumnName, NameLength4) ; StatementHandle : void* in/out -> "sptr" ; CatalogName : BYTE* optional -> "var" ; NameLength1 : SHORT -> "int" ; SchemaName : BYTE* optional -> "var" ; NameLength2 : SHORT -> "int" ; TableName : BYTE* optional -> "var" ; NameLength3 : SHORT -> "int" ; ColumnName : BYTE* optional -> "var" ; NameLength4 : SHORT -> "int" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "ODBC32.dll" #cfunc global SQLColumns "SQLColumns" sptr, sptr, int, sptr, int, sptr, int, sptr, int ; res = SQLColumns(StatementHandle, varptr(CatalogName), NameLength1, varptr(SchemaName), NameLength2, varptr(TableName), NameLength3, varptr(ColumnName), NameLength4) ; StatementHandle : void* in/out -> "sptr" ; CatalogName : BYTE* optional -> "sptr" ; NameLength1 : SHORT -> "int" ; SchemaName : BYTE* optional -> "sptr" ; NameLength2 : SHORT -> "int" ; TableName : BYTE* optional -> "sptr" ; NameLength3 : SHORT -> "int" ; ColumnName : BYTE* optional -> "sptr" ; NameLength4 : SHORT -> "int" ; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; SHORT SQLColumns(void* StatementHandle, BYTE* CatalogName, SHORT NameLength1, BYTE* SchemaName, SHORT NameLength2, BYTE* TableName, SHORT NameLength3, BYTE* ColumnName, SHORT NameLength4) #uselib "ODBC32.dll" #cfunc global SQLColumns "SQLColumns" intptr, var, int, var, int, var, int, var, int ; res = SQLColumns(StatementHandle, CatalogName, NameLength1, SchemaName, NameLength2, TableName, NameLength3, ColumnName, NameLength4) ; StatementHandle : void* in/out -> "intptr" ; CatalogName : BYTE* optional -> "var" ; NameLength1 : SHORT -> "int" ; SchemaName : BYTE* optional -> "var" ; NameLength2 : SHORT -> "int" ; TableName : BYTE* optional -> "var" ; NameLength3 : SHORT -> "int" ; ColumnName : BYTE* optional -> "var" ; NameLength4 : SHORT -> "int" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。; SHORT SQLColumns(void* StatementHandle, BYTE* CatalogName, SHORT NameLength1, BYTE* SchemaName, SHORT NameLength2, BYTE* TableName, SHORT NameLength3, BYTE* ColumnName, SHORT NameLength4) #uselib "ODBC32.dll" #cfunc global SQLColumns "SQLColumns" intptr, intptr, int, intptr, int, intptr, int, intptr, int ; res = SQLColumns(StatementHandle, varptr(CatalogName), NameLength1, varptr(SchemaName), NameLength2, varptr(TableName), NameLength3, varptr(ColumnName), NameLength4) ; StatementHandle : void* in/out -> "intptr" ; CatalogName : BYTE* optional -> "intptr" ; NameLength1 : SHORT -> "int" ; SchemaName : BYTE* optional -> "intptr" ; NameLength2 : SHORT -> "int" ; TableName : BYTE* optional -> "intptr" ; NameLength3 : SHORT -> "int" ; ColumnName : BYTE* optional -> "intptr" ; NameLength4 : SHORT -> "int" ; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは varptr(変数))。
import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
odbc32 = windows.NewLazySystemDLL("ODBC32.dll")
procSQLColumns = odbc32.NewProc("SQLColumns")
)
// StatementHandle (void* in/out), CatalogName (BYTE* optional), NameLength1 (SHORT), SchemaName (BYTE* optional), NameLength2 (SHORT), TableName (BYTE* optional), NameLength3 (SHORT), ColumnName (BYTE* optional), NameLength4 (SHORT)
r1, _, err := procSQLColumns.Call(
uintptr(StatementHandle),
uintptr(CatalogName),
uintptr(NameLength1),
uintptr(SchemaName),
uintptr(NameLength2),
uintptr(TableName),
uintptr(NameLength3),
uintptr(ColumnName),
uintptr(NameLength4),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // SHORTfunction SQLColumns(
StatementHandle: Pointer; // void* in/out
CatalogName: Pointer; // BYTE* optional
NameLength1: Smallint; // SHORT
SchemaName: Pointer; // BYTE* optional
NameLength2: Smallint; // SHORT
TableName: Pointer; // BYTE* optional
NameLength3: Smallint; // SHORT
ColumnName: Pointer; // BYTE* optional
NameLength4: Smallint // SHORT
): Smallint; stdcall;
external 'ODBC32.dll' name 'SQLColumns';result := DllCall("ODBC32\SQLColumns"
, "Ptr", StatementHandle ; void* in/out
, "Ptr", CatalogName ; BYTE* optional
, "Short", NameLength1 ; SHORT
, "Ptr", SchemaName ; BYTE* optional
, "Short", NameLength2 ; SHORT
, "Ptr", TableName ; BYTE* optional
, "Short", NameLength3 ; SHORT
, "Ptr", ColumnName ; BYTE* optional
, "Short", NameLength4 ; SHORT
, "Short") ; return: SHORT●SQLColumns(StatementHandle, CatalogName, NameLength1, SchemaName, NameLength2, TableName, NameLength3, ColumnName, NameLength4) = DLL("ODBC32.dll", "int SQLColumns(void*, void*, int, void*, int, void*, int, void*, int)")
# 呼び出し: SQLColumns(StatementHandle, CatalogName, NameLength1, SchemaName, NameLength2, TableName, NameLength3, ColumnName, NameLength4)
# StatementHandle : void* in/out -> "void*"
# CatalogName : BYTE* optional -> "void*"
# NameLength1 : SHORT -> "int"
# SchemaName : BYTE* optional -> "void*"
# NameLength2 : SHORT -> "int"
# TableName : BYTE* optional -> "void*"
# NameLength3 : SHORT -> "int"
# ColumnName : BYTE* optional -> "void*"
# NameLength4 : SHORT -> "int"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "odbc32" fn SQLColumns(
StatementHandle: ?*anyopaque, // void* in/out
CatalogName: [*c]u8, // BYTE* optional
NameLength1: i16, // SHORT
SchemaName: [*c]u8, // BYTE* optional
NameLength2: i16, // SHORT
TableName: [*c]u8, // BYTE* optional
NameLength3: i16, // SHORT
ColumnName: [*c]u8, // BYTE* optional
NameLength4: i16 // SHORT
) callconv(std.os.windows.WINAPI) i16;proc SQLColumns(
StatementHandle: pointer, # void* in/out
CatalogName: ptr uint8, # BYTE* optional
NameLength1: int16, # SHORT
SchemaName: ptr uint8, # BYTE* optional
NameLength2: int16, # SHORT
TableName: ptr uint8, # BYTE* optional
NameLength3: int16, # SHORT
ColumnName: ptr uint8, # BYTE* optional
NameLength4: int16 # SHORT
): int16 {.importc: "SQLColumns", stdcall, dynlib: "ODBC32.dll".}pragma(lib, "odbc32");
extern(Windows)
short SQLColumns(
void* StatementHandle, // void* in/out
ubyte* CatalogName, // BYTE* optional
short NameLength1, // SHORT
ubyte* SchemaName, // BYTE* optional
short NameLength2, // SHORT
ubyte* TableName, // BYTE* optional
short NameLength3, // SHORT
ubyte* ColumnName, // BYTE* optional
short NameLength4 // SHORT
);ccall((:SQLColumns, "ODBC32.dll"), stdcall, Int16,
(Ptr{Cvoid}, Ptr{UInt8}, Int16, Ptr{UInt8}, Int16, Ptr{UInt8}, Int16, Ptr{UInt8}, Int16),
StatementHandle, CatalogName, NameLength1, SchemaName, NameLength2, TableName, NameLength3, ColumnName, NameLength4)
# StatementHandle : void* in/out -> Ptr{Cvoid}
# CatalogName : BYTE* optional -> Ptr{UInt8}
# NameLength1 : SHORT -> Int16
# SchemaName : BYTE* optional -> Ptr{UInt8}
# NameLength2 : SHORT -> Int16
# TableName : BYTE* optional -> Ptr{UInt8}
# NameLength3 : SHORT -> Int16
# ColumnName : BYTE* optional -> Ptr{UInt8}
# NameLength4 : SHORT -> Int16
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
int16_t SQLColumns(
void* StatementHandle,
uint8_t* CatalogName,
int16_t NameLength1,
uint8_t* SchemaName,
int16_t NameLength2,
uint8_t* TableName,
int16_t NameLength3,
uint8_t* ColumnName,
int16_t NameLength4);
]]
local odbc32 = ffi.load("odbc32")
-- odbc32.SQLColumns(StatementHandle, CatalogName, NameLength1, SchemaName, NameLength2, TableName, NameLength3, ColumnName, NameLength4)
-- StatementHandle : void* in/out
-- CatalogName : BYTE* optional
-- NameLength1 : SHORT
-- SchemaName : BYTE* optional
-- NameLength2 : SHORT
-- TableName : BYTE* optional
-- NameLength3 : SHORT
-- ColumnName : BYTE* optional
-- NameLength4 : SHORT
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('ODBC32.dll');
const SQLColumns = lib.func('__stdcall', 'SQLColumns', 'int16_t', ['void *', 'uint8_t *', 'int16_t', 'uint8_t *', 'int16_t', 'uint8_t *', 'int16_t', 'uint8_t *', 'int16_t']);
// SQLColumns(StatementHandle, CatalogName, NameLength1, SchemaName, NameLength2, TableName, NameLength3, ColumnName, NameLength4)
// StatementHandle : void* in/out -> 'void *'
// CatalogName : BYTE* optional -> 'uint8_t *'
// NameLength1 : SHORT -> 'int16_t'
// SchemaName : BYTE* optional -> 'uint8_t *'
// NameLength2 : SHORT -> 'int16_t'
// TableName : BYTE* optional -> 'uint8_t *'
// NameLength3 : SHORT -> 'int16_t'
// ColumnName : BYTE* optional -> 'uint8_t *'
// NameLength4 : SHORT -> 'int16_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("ODBC32.dll", {
SQLColumns: { parameters: ["pointer", "pointer", "i16", "pointer", "i16", "pointer", "i16", "pointer", "i16"], result: "i16" },
});
// lib.symbols.SQLColumns(StatementHandle, CatalogName, NameLength1, SchemaName, NameLength2, TableName, NameLength3, ColumnName, NameLength4)
// StatementHandle : void* in/out -> "pointer"
// CatalogName : BYTE* optional -> "pointer"
// NameLength1 : SHORT -> "i16"
// SchemaName : BYTE* optional -> "pointer"
// NameLength2 : SHORT -> "i16"
// TableName : BYTE* optional -> "pointer"
// NameLength3 : SHORT -> "i16"
// ColumnName : BYTE* optional -> "pointer"
// NameLength4 : SHORT -> "i16"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
int16_t SQLColumns(
void* StatementHandle,
uint8_t* CatalogName,
int16_t NameLength1,
uint8_t* SchemaName,
int16_t NameLength2,
uint8_t* TableName,
int16_t NameLength3,
uint8_t* ColumnName,
int16_t NameLength4);
C, "ODBC32.dll");
// $ffi->SQLColumns(StatementHandle, CatalogName, NameLength1, SchemaName, NameLength2, TableName, NameLength3, ColumnName, NameLength4);
// StatementHandle : void* in/out
// CatalogName : BYTE* optional
// NameLength1 : SHORT
// SchemaName : BYTE* optional
// NameLength2 : SHORT
// TableName : BYTE* optional
// NameLength3 : SHORT
// ColumnName : BYTE* optional
// NameLength4 : 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 SQLColumns(
Pointer StatementHandle, // void* in/out
byte[] CatalogName, // BYTE* optional
short NameLength1, // SHORT
byte[] SchemaName, // BYTE* optional
short NameLength2, // SHORT
byte[] TableName, // BYTE* optional
short NameLength3, // SHORT
byte[] ColumnName, // BYTE* optional
short NameLength4 // SHORT
);
}@[Link("odbc32")]
lib LibODBC32
fun SQLColumns = SQLColumns(
StatementHandle : Void*, # void* in/out
CatalogName : UInt8*, # BYTE* optional
NameLength1 : Int16, # SHORT
SchemaName : UInt8*, # BYTE* optional
NameLength2 : Int16, # SHORT
TableName : UInt8*, # BYTE* optional
NameLength3 : Int16, # SHORT
ColumnName : UInt8*, # BYTE* optional
NameLength4 : 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 SQLColumnsNative = Int16 Function(Pointer<Void>, Pointer<Uint8>, Int16, Pointer<Uint8>, Int16, Pointer<Uint8>, Int16, Pointer<Uint8>, Int16);
typedef SQLColumnsDart = int Function(Pointer<Void>, Pointer<Uint8>, int, Pointer<Uint8>, int, Pointer<Uint8>, int, Pointer<Uint8>, int);
final SQLColumns = DynamicLibrary.open('ODBC32.dll')
.lookupFunction<SQLColumnsNative, SQLColumnsDart>('SQLColumns');
// StatementHandle : void* in/out -> Pointer<Void>
// CatalogName : BYTE* optional -> Pointer<Uint8>
// NameLength1 : SHORT -> Int16
// SchemaName : BYTE* optional -> Pointer<Uint8>
// NameLength2 : SHORT -> Int16
// TableName : BYTE* optional -> Pointer<Uint8>
// NameLength3 : SHORT -> Int16
// ColumnName : BYTE* optional -> Pointer<Uint8>
// NameLength4 : SHORT -> Int16
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function SQLColumns(
StatementHandle: Pointer; // void* in/out
CatalogName: Pointer; // BYTE* optional
NameLength1: Smallint; // SHORT
SchemaName: Pointer; // BYTE* optional
NameLength2: Smallint; // SHORT
TableName: Pointer; // BYTE* optional
NameLength3: Smallint; // SHORT
ColumnName: Pointer; // BYTE* optional
NameLength4: Smallint // SHORT
): Smallint; stdcall;
external 'ODBC32.dll' name 'SQLColumns';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "SQLColumns"
c_SQLColumns :: Ptr () -> Ptr Word8 -> Int16 -> Ptr Word8 -> Int16 -> Ptr Word8 -> Int16 -> Ptr Word8 -> Int16 -> IO Int16
-- StatementHandle : void* in/out -> Ptr ()
-- CatalogName : BYTE* optional -> Ptr Word8
-- NameLength1 : SHORT -> Int16
-- SchemaName : BYTE* optional -> Ptr Word8
-- NameLength2 : SHORT -> Int16
-- TableName : BYTE* optional -> Ptr Word8
-- NameLength3 : SHORT -> Int16
-- ColumnName : BYTE* optional -> Ptr Word8
-- NameLength4 : SHORT -> Int16
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let sqlcolumns =
foreign "SQLColumns"
((ptr void) @-> (ptr uint8_t) @-> int16_t @-> (ptr uint8_t) @-> int16_t @-> (ptr uint8_t) @-> int16_t @-> (ptr uint8_t) @-> int16_t @-> returning int16_t)
(* StatementHandle : void* in/out -> (ptr void) *)
(* CatalogName : BYTE* optional -> (ptr uint8_t) *)
(* NameLength1 : SHORT -> int16_t *)
(* SchemaName : BYTE* optional -> (ptr uint8_t) *)
(* NameLength2 : SHORT -> int16_t *)
(* TableName : BYTE* optional -> (ptr uint8_t) *)
(* NameLength3 : SHORT -> int16_t *)
(* ColumnName : BYTE* optional -> (ptr uint8_t) *)
(* NameLength4 : 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 ("SQLColumns" sqlcolumns :convention :stdcall) :int16
(statement-handle :pointer) ; void* in/out
(catalog-name :pointer) ; BYTE* optional
(name-length1 :int16) ; SHORT
(schema-name :pointer) ; BYTE* optional
(name-length2 :int16) ; SHORT
(table-name :pointer) ; BYTE* optional
(name-length3 :int16) ; SHORT
(column-name :pointer) ; BYTE* optional
(name-length4 :int16)) ; SHORT
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $SQLColumns = Win32::API::More->new('ODBC32',
'short SQLColumns(LPVOID StatementHandle, LPVOID CatalogName, short NameLength1, LPVOID SchemaName, short NameLength2, LPVOID TableName, short NameLength3, LPVOID ColumnName, short NameLength4)');
# my $ret = $SQLColumns->Call($StatementHandle, $CatalogName, $NameLength1, $SchemaName, $NameLength2, $TableName, $NameLength3, $ColumnName, $NameLength4);
# StatementHandle : void* in/out -> LPVOID
# CatalogName : BYTE* optional -> LPVOID
# NameLength1 : SHORT -> short
# SchemaName : BYTE* optional -> LPVOID
# NameLength2 : SHORT -> short
# TableName : BYTE* optional -> LPVOID
# NameLength3 : SHORT -> short
# ColumnName : BYTE* optional -> LPVOID
# NameLength4 : SHORT -> short
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。関連項目
- f SQLColumnsA (ANSI版) — 指定したテーブルの列の一覧情報を取得する。
- f SQLColumnsW (Unicode版) — 指定テーブルの列情報一覧を結果セットで返す(Unicode)。