SQLForeignKeysA

関数

テーブルの外部キーと参照関係の情報を取得する。

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

シグネチャ

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

SHORT SQLForeignKeysA(
    void* hstmt,
    BYTE* szPkCatalogName,   // optional
    SHORT cbPkCatalogName,
    BYTE* szPkSchemaName,   // optional
    SHORT cbPkSchemaName,
    BYTE* szPkTableName,   // optional
    SHORT cbPkTableName,
    BYTE* szFkCatalogName,   // optional
    SHORT cbFkCatalogName,
    BYTE* szFkSchemaName,   // optional
    SHORT cbFkSchemaName,
    BYTE* szFkTableName,   // optional
    SHORT cbFkTableName
);

パラメーター

名前	型	方向
hstmt	void*	inout
szPkCatalogName	BYTE*	inoptional
cbPkCatalogName	SHORT	in
szPkSchemaName	BYTE*	inoptional
cbPkSchemaName	SHORT	in
szPkTableName	BYTE*	inoptional
cbPkTableName	SHORT	in
szFkCatalogName	BYTE*	inoptional
cbFkCatalogName	SHORT	in
szFkSchemaName	BYTE*	inoptional
cbFkSchemaName	SHORT	in
szFkTableName	BYTE*	inoptional
cbFkTableName	SHORT	in

戻り値の型: SHORT

各言語での呼び出し定義

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

SHORT SQLForeignKeysA(
    void* hstmt,
    BYTE* szPkCatalogName,   // optional
    SHORT cbPkCatalogName,
    BYTE* szPkSchemaName,   // optional
    SHORT cbPkSchemaName,
    BYTE* szPkTableName,   // optional
    SHORT cbPkTableName,
    BYTE* szFkCatalogName,   // optional
    SHORT cbFkCatalogName,
    BYTE* szFkSchemaName,   // optional
    SHORT cbFkSchemaName,
    BYTE* szFkTableName,   // optional
    SHORT cbFkTableName
);

[DllImport("ODBC32.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern short SQLForeignKeysA(
    IntPtr hstmt,   // void* in/out
    IntPtr szPkCatalogName,   // BYTE* optional
    short cbPkCatalogName,   // SHORT
    IntPtr szPkSchemaName,   // BYTE* optional
    short cbPkSchemaName,   // SHORT
    IntPtr szPkTableName,   // BYTE* optional
    short cbPkTableName,   // SHORT
    IntPtr szFkCatalogName,   // BYTE* optional
    short cbFkCatalogName,   // SHORT
    IntPtr szFkSchemaName,   // BYTE* optional
    short cbFkSchemaName,   // SHORT
    IntPtr szFkTableName,   // BYTE* optional
    short cbFkTableName   // SHORT
);

<DllImport("ODBC32.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function SQLForeignKeysA(
    hstmt As IntPtr,   ' void* in/out
    szPkCatalogName As IntPtr,   ' BYTE* optional
    cbPkCatalogName As Short,   ' SHORT
    szPkSchemaName As IntPtr,   ' BYTE* optional
    cbPkSchemaName As Short,   ' SHORT
    szPkTableName As IntPtr,   ' BYTE* optional
    cbPkTableName As Short,   ' SHORT
    szFkCatalogName As IntPtr,   ' BYTE* optional
    cbFkCatalogName As Short,   ' SHORT
    szFkSchemaName As IntPtr,   ' BYTE* optional
    cbFkSchemaName As Short,   ' SHORT
    szFkTableName As IntPtr,   ' BYTE* optional
    cbFkTableName As Short   ' SHORT
) As Short
End Function

' hstmt : void* in/out
' szPkCatalogName : BYTE* optional
' cbPkCatalogName : SHORT
' szPkSchemaName : BYTE* optional
' cbPkSchemaName : SHORT
' szPkTableName : BYTE* optional
' cbPkTableName : SHORT
' szFkCatalogName : BYTE* optional
' cbFkCatalogName : SHORT
' szFkSchemaName : BYTE* optional
' cbFkSchemaName : SHORT
' szFkTableName : BYTE* optional
' cbFkTableName : SHORT
Declare PtrSafe Function SQLForeignKeysA Lib "odbc32" ( _
    ByVal hstmt As LongPtr, _
    ByVal szPkCatalogName As LongPtr, _
    ByVal cbPkCatalogName As Integer, _
    ByVal szPkSchemaName As LongPtr, _
    ByVal cbPkSchemaName As Integer, _
    ByVal szPkTableName As LongPtr, _
    ByVal cbPkTableName As Integer, _
    ByVal szFkCatalogName As LongPtr, _
    ByVal cbFkCatalogName As Integer, _
    ByVal szFkSchemaName As LongPtr, _
    ByVal cbFkSchemaName As Integer, _
    ByVal szFkTableName As LongPtr, _
    ByVal cbFkTableName As Integer) As Integer
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

SQLForeignKeysA = ctypes.windll.odbc32.SQLForeignKeysA
SQLForeignKeysA.restype = ctypes.c_short
SQLForeignKeysA.argtypes = [
    ctypes.POINTER(None),  # hstmt : void* in/out
    ctypes.POINTER(ctypes.c_ubyte),  # szPkCatalogName : BYTE* optional
    ctypes.c_short,  # cbPkCatalogName : SHORT
    ctypes.POINTER(ctypes.c_ubyte),  # szPkSchemaName : BYTE* optional
    ctypes.c_short,  # cbPkSchemaName : SHORT
    ctypes.POINTER(ctypes.c_ubyte),  # szPkTableName : BYTE* optional
    ctypes.c_short,  # cbPkTableName : SHORT
    ctypes.POINTER(ctypes.c_ubyte),  # szFkCatalogName : BYTE* optional
    ctypes.c_short,  # cbFkCatalogName : SHORT
    ctypes.POINTER(ctypes.c_ubyte),  # szFkSchemaName : BYTE* optional
    ctypes.c_short,  # cbFkSchemaName : SHORT
    ctypes.POINTER(ctypes.c_ubyte),  # szFkTableName : BYTE* optional
    ctypes.c_short,  # cbFkTableName : SHORT
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ODBC32.dll')
SQLForeignKeysA = Fiddle::Function.new(
  lib['SQLForeignKeysA'],
  [
    Fiddle::TYPE_VOIDP,  # hstmt : void* in/out
    Fiddle::TYPE_VOIDP,  # szPkCatalogName : BYTE* optional
    Fiddle::TYPE_SHORT,  # cbPkCatalogName : SHORT
    Fiddle::TYPE_VOIDP,  # szPkSchemaName : BYTE* optional
    Fiddle::TYPE_SHORT,  # cbPkSchemaName : SHORT
    Fiddle::TYPE_VOIDP,  # szPkTableName : BYTE* optional
    Fiddle::TYPE_SHORT,  # cbPkTableName : SHORT
    Fiddle::TYPE_VOIDP,  # szFkCatalogName : BYTE* optional
    Fiddle::TYPE_SHORT,  # cbFkCatalogName : SHORT
    Fiddle::TYPE_VOIDP,  # szFkSchemaName : BYTE* optional
    Fiddle::TYPE_SHORT,  # cbFkSchemaName : SHORT
    Fiddle::TYPE_VOIDP,  # szFkTableName : BYTE* optional
    Fiddle::TYPE_SHORT,  # cbFkTableName : SHORT
  ],
  Fiddle::TYPE_SHORT)

#[link(name = "odbc32")]
extern "system" {
    fn SQLForeignKeysA(
        hstmt: *mut (),  // void* in/out
        szPkCatalogName: *mut u8,  // BYTE* optional
        cbPkCatalogName: i16,  // SHORT
        szPkSchemaName: *mut u8,  // BYTE* optional
        cbPkSchemaName: i16,  // SHORT
        szPkTableName: *mut u8,  // BYTE* optional
        cbPkTableName: i16,  // SHORT
        szFkCatalogName: *mut u8,  // BYTE* optional
        cbFkCatalogName: i16,  // SHORT
        szFkSchemaName: *mut u8,  // BYTE* optional
        cbFkSchemaName: i16,  // SHORT
        szFkTableName: *mut u8,  // BYTE* optional
        cbFkTableName: i16  // SHORT
    ) -> i16;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("ODBC32.dll", CharSet = CharSet.Ansi)]
public static extern short SQLForeignKeysA(IntPtr hstmt, IntPtr szPkCatalogName, short cbPkCatalogName, IntPtr szPkSchemaName, short cbPkSchemaName, IntPtr szPkTableName, short cbPkTableName, IntPtr szFkCatalogName, short cbFkCatalogName, IntPtr szFkSchemaName, short cbFkSchemaName, IntPtr szFkTableName, short cbFkTableName);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ODBC32_SQLForeignKeysA' -Namespace Win32 -PassThru
# $api::SQLForeignKeysA(hstmt, szPkCatalogName, cbPkCatalogName, szPkSchemaName, cbPkSchemaName, szPkTableName, cbPkTableName, szFkCatalogName, cbFkCatalogName, szFkSchemaName, cbFkSchemaName, szFkTableName, cbFkTableName)

#uselib "ODBC32.dll"
#func global SQLForeignKeysA "SQLForeignKeysA" sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr
; SQLForeignKeysA hstmt, varptr(szPkCatalogName), cbPkCatalogName, varptr(szPkSchemaName), cbPkSchemaName, varptr(szPkTableName), cbPkTableName, varptr(szFkCatalogName), cbFkCatalogName, varptr(szFkSchemaName), cbFkSchemaName, varptr(szFkTableName), cbFkTableName   ; 戻り値は stat
; hstmt : void* in/out -> "sptr"
; szPkCatalogName : BYTE* optional -> "sptr"
; cbPkCatalogName : SHORT -> "sptr"
; szPkSchemaName : BYTE* optional -> "sptr"
; cbPkSchemaName : SHORT -> "sptr"
; szPkTableName : BYTE* optional -> "sptr"
; cbPkTableName : SHORT -> "sptr"
; szFkCatalogName : BYTE* optional -> "sptr"
; cbFkCatalogName : SHORT -> "sptr"
; szFkSchemaName : BYTE* optional -> "sptr"
; cbFkSchemaName : SHORT -> "sptr"
; szFkTableName : BYTE* optional -> "sptr"
; cbFkTableName : SHORT -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "ODBC32.dll"
#cfunc global SQLForeignKeysA "SQLForeignKeysA" sptr, var, int, var, int, var, int, var, int, var, int, var, int
; res = SQLForeignKeysA(hstmt, szPkCatalogName, cbPkCatalogName, szPkSchemaName, cbPkSchemaName, szPkTableName, cbPkTableName, szFkCatalogName, cbFkCatalogName, szFkSchemaName, cbFkSchemaName, szFkTableName, cbFkTableName)
; hstmt : void* in/out -> "sptr"
; szPkCatalogName : BYTE* optional -> "var"
; cbPkCatalogName : SHORT -> "int"
; szPkSchemaName : BYTE* optional -> "var"
; cbPkSchemaName : SHORT -> "int"
; szPkTableName : BYTE* optional -> "var"
; cbPkTableName : SHORT -> "int"
; szFkCatalogName : BYTE* optional -> "var"
; cbFkCatalogName : SHORT -> "int"
; szFkSchemaName : BYTE* optional -> "var"
; cbFkSchemaName : SHORT -> "int"
; szFkTableName : BYTE* optional -> "var"
; cbFkTableName : SHORT -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "ODBC32.dll"
#cfunc global SQLForeignKeysA "SQLForeignKeysA" sptr, sptr, int, sptr, int, sptr, int, sptr, int, sptr, int, sptr, int
; res = SQLForeignKeysA(hstmt, varptr(szPkCatalogName), cbPkCatalogName, varptr(szPkSchemaName), cbPkSchemaName, varptr(szPkTableName), cbPkTableName, varptr(szFkCatalogName), cbFkCatalogName, varptr(szFkSchemaName), cbFkSchemaName, varptr(szFkTableName), cbFkTableName)
; hstmt : void* in/out -> "sptr"
; szPkCatalogName : BYTE* optional -> "sptr"
; cbPkCatalogName : SHORT -> "int"
; szPkSchemaName : BYTE* optional -> "sptr"
; cbPkSchemaName : SHORT -> "int"
; szPkTableName : BYTE* optional -> "sptr"
; cbPkTableName : SHORT -> "int"
; szFkCatalogName : BYTE* optional -> "sptr"
; cbFkCatalogName : SHORT -> "int"
; szFkSchemaName : BYTE* optional -> "sptr"
; cbFkSchemaName : SHORT -> "int"
; szFkTableName : BYTE* optional -> "sptr"
; cbFkTableName : SHORT -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。

出力引数:

; SHORT SQLForeignKeysA(void* hstmt, BYTE* szPkCatalogName, SHORT cbPkCatalogName, BYTE* szPkSchemaName, SHORT cbPkSchemaName, BYTE* szPkTableName, SHORT cbPkTableName, BYTE* szFkCatalogName, SHORT cbFkCatalogName, BYTE* szFkSchemaName, SHORT cbFkSchemaName, BYTE* szFkTableName, SHORT cbFkTableName)
#uselib "ODBC32.dll"
#cfunc global SQLForeignKeysA "SQLForeignKeysA" intptr, var, int, var, int, var, int, var, int, var, int, var, int
; res = SQLForeignKeysA(hstmt, szPkCatalogName, cbPkCatalogName, szPkSchemaName, cbPkSchemaName, szPkTableName, cbPkTableName, szFkCatalogName, cbFkCatalogName, szFkSchemaName, cbFkSchemaName, szFkTableName, cbFkTableName)
; hstmt : void* in/out -> "intptr"
; szPkCatalogName : BYTE* optional -> "var"
; cbPkCatalogName : SHORT -> "int"
; szPkSchemaName : BYTE* optional -> "var"
; cbPkSchemaName : SHORT -> "int"
; szPkTableName : BYTE* optional -> "var"
; cbPkTableName : SHORT -> "int"
; szFkCatalogName : BYTE* optional -> "var"
; cbFkCatalogName : SHORT -> "int"
; szFkSchemaName : BYTE* optional -> "var"
; cbFkSchemaName : SHORT -> "int"
; szFkTableName : BYTE* optional -> "var"
; cbFkTableName : SHORT -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。; SHORT SQLForeignKeysA(void* hstmt, BYTE* szPkCatalogName, SHORT cbPkCatalogName, BYTE* szPkSchemaName, SHORT cbPkSchemaName, BYTE* szPkTableName, SHORT cbPkTableName, BYTE* szFkCatalogName, SHORT cbFkCatalogName, BYTE* szFkSchemaName, SHORT cbFkSchemaName, BYTE* szFkTableName, SHORT cbFkTableName)
#uselib "ODBC32.dll"
#cfunc global SQLForeignKeysA "SQLForeignKeysA" intptr, intptr, int, intptr, int, intptr, int, intptr, int, intptr, int, intptr, int
; res = SQLForeignKeysA(hstmt, varptr(szPkCatalogName), cbPkCatalogName, varptr(szPkSchemaName), cbPkSchemaName, varptr(szPkTableName), cbPkTableName, varptr(szFkCatalogName), cbFkCatalogName, varptr(szFkSchemaName), cbFkSchemaName, varptr(szFkTableName), cbFkTableName)
; hstmt : void* in/out -> "intptr"
; szPkCatalogName : BYTE* optional -> "intptr"
; cbPkCatalogName : SHORT -> "int"
; szPkSchemaName : BYTE* optional -> "intptr"
; cbPkSchemaName : SHORT -> "int"
; szPkTableName : BYTE* optional -> "intptr"
; cbPkTableName : SHORT -> "int"
; szFkCatalogName : BYTE* optional -> "intptr"
; cbFkCatalogName : SHORT -> "int"
; szFkSchemaName : BYTE* optional -> "intptr"
; cbFkSchemaName : SHORT -> "int"
; szFkTableName : BYTE* optional -> "intptr"
; cbFkTableName : SHORT -> "int"
; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは varptr(変数))。

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

var (
	odbc32 = windows.NewLazySystemDLL("ODBC32.dll")
	procSQLForeignKeysA = odbc32.NewProc("SQLForeignKeysA")
)

// hstmt (void* in/out), szPkCatalogName (BYTE* optional), cbPkCatalogName (SHORT), szPkSchemaName (BYTE* optional), cbPkSchemaName (SHORT), szPkTableName (BYTE* optional), cbPkTableName (SHORT), szFkCatalogName (BYTE* optional), cbFkCatalogName (SHORT), szFkSchemaName (BYTE* optional), cbFkSchemaName (SHORT), szFkTableName (BYTE* optional), cbFkTableName (SHORT)
r1, _, err := procSQLForeignKeysA.Call(
	uintptr(hstmt),
	uintptr(szPkCatalogName),
	uintptr(cbPkCatalogName),
	uintptr(szPkSchemaName),
	uintptr(cbPkSchemaName),
	uintptr(szPkTableName),
	uintptr(cbPkTableName),
	uintptr(szFkCatalogName),
	uintptr(cbFkCatalogName),
	uintptr(szFkSchemaName),
	uintptr(cbFkSchemaName),
	uintptr(szFkTableName),
	uintptr(cbFkTableName),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // SHORT

function SQLForeignKeysA(
  hstmt: Pointer;   // void* in/out
  szPkCatalogName: Pointer;   // BYTE* optional
  cbPkCatalogName: Smallint;   // SHORT
  szPkSchemaName: Pointer;   // BYTE* optional
  cbPkSchemaName: Smallint;   // SHORT
  szPkTableName: Pointer;   // BYTE* optional
  cbPkTableName: Smallint;   // SHORT
  szFkCatalogName: Pointer;   // BYTE* optional
  cbFkCatalogName: Smallint;   // SHORT
  szFkSchemaName: Pointer;   // BYTE* optional
  cbFkSchemaName: Smallint;   // SHORT
  szFkTableName: Pointer;   // BYTE* optional
  cbFkTableName: Smallint   // SHORT
): Smallint; stdcall;
  external 'ODBC32.dll' name 'SQLForeignKeysA';

result := DllCall("ODBC32\SQLForeignKeysA"
    , "Ptr", hstmt   ; void* in/out
    , "Ptr", szPkCatalogName   ; BYTE* optional
    , "Short", cbPkCatalogName   ; SHORT
    , "Ptr", szPkSchemaName   ; BYTE* optional
    , "Short", cbPkSchemaName   ; SHORT
    , "Ptr", szPkTableName   ; BYTE* optional
    , "Short", cbPkTableName   ; SHORT
    , "Ptr", szFkCatalogName   ; BYTE* optional
    , "Short", cbFkCatalogName   ; SHORT
    , "Ptr", szFkSchemaName   ; BYTE* optional
    , "Short", cbFkSchemaName   ; SHORT
    , "Ptr", szFkTableName   ; BYTE* optional
    , "Short", cbFkTableName   ; SHORT
    , "Short")   ; return: SHORT

●SQLForeignKeysA(hstmt, szPkCatalogName, cbPkCatalogName, szPkSchemaName, cbPkSchemaName, szPkTableName, cbPkTableName, szFkCatalogName, cbFkCatalogName, szFkSchemaName, cbFkSchemaName, szFkTableName, cbFkTableName) = DLL("ODBC32.dll", "int SQLForeignKeysA(void*, void*, int, void*, int, void*, int, void*, int, void*, int, void*, int)")
# 呼び出し: SQLForeignKeysA(hstmt, szPkCatalogName, cbPkCatalogName, szPkSchemaName, cbPkSchemaName, szPkTableName, cbPkTableName, szFkCatalogName, cbFkCatalogName, szFkSchemaName, cbFkSchemaName, szFkTableName, cbFkTableName)
# hstmt : void* in/out -> "void*"
# szPkCatalogName : BYTE* optional -> "void*"
# cbPkCatalogName : SHORT -> "int"
# szPkSchemaName : BYTE* optional -> "void*"
# cbPkSchemaName : SHORT -> "int"
# szPkTableName : BYTE* optional -> "void*"
# cbPkTableName : SHORT -> "int"
# szFkCatalogName : BYTE* optional -> "void*"
# cbFkCatalogName : SHORT -> "int"
# szFkSchemaName : BYTE* optional -> "void*"
# cbFkSchemaName : SHORT -> "int"
# szFkTableName : BYTE* optional -> "void*"
# cbFkTableName : SHORT -> "int"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。