SQLForeignKeysW

関数

テーブル間の外部キー関係の一覧を返す(Unicode)。

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

シグネチャ

// ODBC32.dll  (Unicode / -W)
#include <windows.h>

SHORT SQLForeignKeysW(
    void* hstmt,
    WORD* szPkCatalogName,   // optional
    SHORT cchPkCatalogName,
    WORD* szPkSchemaName,   // optional
    SHORT cchPkSchemaName,
    WORD* szPkTableName,   // optional
    SHORT cchPkTableName,
    WORD* szFkCatalogName,   // optional
    SHORT cchFkCatalogName,
    WORD* szFkSchemaName,   // optional
    SHORT cchFkSchemaName,
    WORD* szFkTableName,   // optional
    SHORT cchFkTableName
);

パラメーター

名前	型	方向
hstmt	void*	inout
szPkCatalogName	WORD*	inoptional
cchPkCatalogName	SHORT	in
szPkSchemaName	WORD*	inoptional
cchPkSchemaName	SHORT	in
szPkTableName	WORD*	inoptional
cchPkTableName	SHORT	in
szFkCatalogName	WORD*	inoptional
cchFkCatalogName	SHORT	in
szFkSchemaName	WORD*	inoptional
cchFkSchemaName	SHORT	in
szFkTableName	WORD*	inoptional
cchFkTableName	SHORT	in

戻り値の型: SHORT

各言語での呼び出し定義

// ODBC32.dll  (Unicode / -W)
#include <windows.h>

SHORT SQLForeignKeysW(
    void* hstmt,
    WORD* szPkCatalogName,   // optional
    SHORT cchPkCatalogName,
    WORD* szPkSchemaName,   // optional
    SHORT cchPkSchemaName,
    WORD* szPkTableName,   // optional
    SHORT cchPkTableName,
    WORD* szFkCatalogName,   // optional
    SHORT cchFkCatalogName,
    WORD* szFkSchemaName,   // optional
    SHORT cchFkSchemaName,
    WORD* szFkTableName,   // optional
    SHORT cchFkTableName
);

[DllImport("ODBC32.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern short SQLForeignKeysW(
    IntPtr hstmt,   // void* in/out
    IntPtr szPkCatalogName,   // WORD* optional
    short cchPkCatalogName,   // SHORT
    IntPtr szPkSchemaName,   // WORD* optional
    short cchPkSchemaName,   // SHORT
    IntPtr szPkTableName,   // WORD* optional
    short cchPkTableName,   // SHORT
    IntPtr szFkCatalogName,   // WORD* optional
    short cchFkCatalogName,   // SHORT
    IntPtr szFkSchemaName,   // WORD* optional
    short cchFkSchemaName,   // SHORT
    IntPtr szFkTableName,   // WORD* optional
    short cchFkTableName   // SHORT
);

<DllImport("ODBC32.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function SQLForeignKeysW(
    hstmt As IntPtr,   ' void* in/out
    szPkCatalogName As IntPtr,   ' WORD* optional
    cchPkCatalogName As Short,   ' SHORT
    szPkSchemaName As IntPtr,   ' WORD* optional
    cchPkSchemaName As Short,   ' SHORT
    szPkTableName As IntPtr,   ' WORD* optional
    cchPkTableName As Short,   ' SHORT
    szFkCatalogName As IntPtr,   ' WORD* optional
    cchFkCatalogName As Short,   ' SHORT
    szFkSchemaName As IntPtr,   ' WORD* optional
    cchFkSchemaName As Short,   ' SHORT
    szFkTableName As IntPtr,   ' WORD* optional
    cchFkTableName As Short   ' SHORT
) As Short
End Function

' hstmt : void* in/out
' szPkCatalogName : WORD* optional
' cchPkCatalogName : SHORT
' szPkSchemaName : WORD* optional
' cchPkSchemaName : SHORT
' szPkTableName : WORD* optional
' cchPkTableName : SHORT
' szFkCatalogName : WORD* optional
' cchFkCatalogName : SHORT
' szFkSchemaName : WORD* optional
' cchFkSchemaName : SHORT
' szFkTableName : WORD* optional
' cchFkTableName : SHORT
Declare PtrSafe Function SQLForeignKeysW Lib "odbc32" ( _
    ByVal hstmt As LongPtr, _
    ByVal szPkCatalogName As LongPtr, _
    ByVal cchPkCatalogName As Integer, _
    ByVal szPkSchemaName As LongPtr, _
    ByVal cchPkSchemaName As Integer, _
    ByVal szPkTableName As LongPtr, _
    ByVal cchPkTableName As Integer, _
    ByVal szFkCatalogName As LongPtr, _
    ByVal cchFkCatalogName As Integer, _
    ByVal szFkSchemaName As LongPtr, _
    ByVal cchFkSchemaName As Integer, _
    ByVal szFkTableName As LongPtr, _
    ByVal cchFkTableName As Integer) As Integer
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

SQLForeignKeysW = ctypes.windll.odbc32.SQLForeignKeysW
SQLForeignKeysW.restype = ctypes.c_short
SQLForeignKeysW.argtypes = [
    ctypes.POINTER(None),  # hstmt : void* in/out
    ctypes.POINTER(ctypes.c_ushort),  # szPkCatalogName : WORD* optional
    ctypes.c_short,  # cchPkCatalogName : SHORT
    ctypes.POINTER(ctypes.c_ushort),  # szPkSchemaName : WORD* optional
    ctypes.c_short,  # cchPkSchemaName : SHORT
    ctypes.POINTER(ctypes.c_ushort),  # szPkTableName : WORD* optional
    ctypes.c_short,  # cchPkTableName : SHORT
    ctypes.POINTER(ctypes.c_ushort),  # szFkCatalogName : WORD* optional
    ctypes.c_short,  # cchFkCatalogName : SHORT
    ctypes.POINTER(ctypes.c_ushort),  # szFkSchemaName : WORD* optional
    ctypes.c_short,  # cchFkSchemaName : SHORT
    ctypes.POINTER(ctypes.c_ushort),  # szFkTableName : WORD* optional
    ctypes.c_short,  # cchFkTableName : SHORT
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ODBC32.dll')
SQLForeignKeysW = Fiddle::Function.new(
  lib['SQLForeignKeysW'],
  [
    Fiddle::TYPE_VOIDP,  # hstmt : void* in/out
    Fiddle::TYPE_VOIDP,  # szPkCatalogName : WORD* optional
    Fiddle::TYPE_SHORT,  # cchPkCatalogName : SHORT
    Fiddle::TYPE_VOIDP,  # szPkSchemaName : WORD* optional
    Fiddle::TYPE_SHORT,  # cchPkSchemaName : SHORT
    Fiddle::TYPE_VOIDP,  # szPkTableName : WORD* optional
    Fiddle::TYPE_SHORT,  # cchPkTableName : SHORT
    Fiddle::TYPE_VOIDP,  # szFkCatalogName : WORD* optional
    Fiddle::TYPE_SHORT,  # cchFkCatalogName : SHORT
    Fiddle::TYPE_VOIDP,  # szFkSchemaName : WORD* optional
    Fiddle::TYPE_SHORT,  # cchFkSchemaName : SHORT
    Fiddle::TYPE_VOIDP,  # szFkTableName : WORD* optional
    Fiddle::TYPE_SHORT,  # cchFkTableName : SHORT
  ],
  Fiddle::TYPE_SHORT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "odbc32")]
extern "system" {
    fn SQLForeignKeysW(
        hstmt: *mut (),  // void* in/out
        szPkCatalogName: *mut u16,  // WORD* optional
        cchPkCatalogName: i16,  // SHORT
        szPkSchemaName: *mut u16,  // WORD* optional
        cchPkSchemaName: i16,  // SHORT
        szPkTableName: *mut u16,  // WORD* optional
        cchPkTableName: i16,  // SHORT
        szFkCatalogName: *mut u16,  // WORD* optional
        cchFkCatalogName: i16,  // SHORT
        szFkSchemaName: *mut u16,  // WORD* optional
        cchFkSchemaName: i16,  // SHORT
        szFkTableName: *mut u16,  // WORD* optional
        cchFkTableName: i16  // SHORT
    ) -> i16;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("ODBC32.dll", CharSet = CharSet.Unicode)]
public static extern short SQLForeignKeysW(IntPtr hstmt, IntPtr szPkCatalogName, short cchPkCatalogName, IntPtr szPkSchemaName, short cchPkSchemaName, IntPtr szPkTableName, short cchPkTableName, IntPtr szFkCatalogName, short cchFkCatalogName, IntPtr szFkSchemaName, short cchFkSchemaName, IntPtr szFkTableName, short cchFkTableName);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ODBC32_SQLForeignKeysW' -Namespace Win32 -PassThru
# $api::SQLForeignKeysW(hstmt, szPkCatalogName, cchPkCatalogName, szPkSchemaName, cchPkSchemaName, szPkTableName, cchPkTableName, szFkCatalogName, cchFkCatalogName, szFkSchemaName, cchFkSchemaName, szFkTableName, cchFkTableName)

#uselib "ODBC32.dll"
#func global SQLForeignKeysW "SQLForeignKeysW" wptr, wptr, wptr, wptr, wptr, wptr, wptr, wptr, wptr, wptr, wptr, wptr, wptr
; SQLForeignKeysW hstmt, varptr(szPkCatalogName), cchPkCatalogName, varptr(szPkSchemaName), cchPkSchemaName, varptr(szPkTableName), cchPkTableName, varptr(szFkCatalogName), cchFkCatalogName, varptr(szFkSchemaName), cchFkSchemaName, varptr(szFkTableName), cchFkTableName   ; 戻り値は stat
; hstmt : void* in/out -> "wptr"
; szPkCatalogName : WORD* optional -> "wptr"
; cchPkCatalogName : SHORT -> "wptr"
; szPkSchemaName : WORD* optional -> "wptr"
; cchPkSchemaName : SHORT -> "wptr"
; szPkTableName : WORD* optional -> "wptr"
; cchPkTableName : SHORT -> "wptr"
; szFkCatalogName : WORD* optional -> "wptr"
; cchFkCatalogName : SHORT -> "wptr"
; szFkSchemaName : WORD* optional -> "wptr"
; cchFkSchemaName : SHORT -> "wptr"
; szFkTableName : WORD* optional -> "wptr"
; cchFkTableName : SHORT -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

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

出力引数:

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

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

var (
	odbc32 = windows.NewLazySystemDLL("ODBC32.dll")
	procSQLForeignKeysW = odbc32.NewProc("SQLForeignKeysW")
)

// hstmt (void* in/out), szPkCatalogName (WORD* optional), cchPkCatalogName (SHORT), szPkSchemaName (WORD* optional), cchPkSchemaName (SHORT), szPkTableName (WORD* optional), cchPkTableName (SHORT), szFkCatalogName (WORD* optional), cchFkCatalogName (SHORT), szFkSchemaName (WORD* optional), cchFkSchemaName (SHORT), szFkTableName (WORD* optional), cchFkTableName (SHORT)
r1, _, err := procSQLForeignKeysW.Call(
	uintptr(hstmt),
	uintptr(szPkCatalogName),
	uintptr(cchPkCatalogName),
	uintptr(szPkSchemaName),
	uintptr(cchPkSchemaName),
	uintptr(szPkTableName),
	uintptr(cchPkTableName),
	uintptr(szFkCatalogName),
	uintptr(cchFkCatalogName),
	uintptr(szFkSchemaName),
	uintptr(cchFkSchemaName),
	uintptr(szFkTableName),
	uintptr(cchFkTableName),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // SHORT

function SQLForeignKeysW(
  hstmt: Pointer;   // void* in/out
  szPkCatalogName: Pointer;   // WORD* optional
  cchPkCatalogName: Smallint;   // SHORT
  szPkSchemaName: Pointer;   // WORD* optional
  cchPkSchemaName: Smallint;   // SHORT
  szPkTableName: Pointer;   // WORD* optional
  cchPkTableName: Smallint;   // SHORT
  szFkCatalogName: Pointer;   // WORD* optional
  cchFkCatalogName: Smallint;   // SHORT
  szFkSchemaName: Pointer;   // WORD* optional
  cchFkSchemaName: Smallint;   // SHORT
  szFkTableName: Pointer;   // WORD* optional
  cchFkTableName: Smallint   // SHORT
): Smallint; stdcall;
  external 'ODBC32.dll' name 'SQLForeignKeysW';

result := DllCall("ODBC32\SQLForeignKeysW"
    , "Ptr", hstmt   ; void* in/out
    , "Ptr", szPkCatalogName   ; WORD* optional
    , "Short", cchPkCatalogName   ; SHORT
    , "Ptr", szPkSchemaName   ; WORD* optional
    , "Short", cchPkSchemaName   ; SHORT
    , "Ptr", szPkTableName   ; WORD* optional
    , "Short", cchPkTableName   ; SHORT
    , "Ptr", szFkCatalogName   ; WORD* optional
    , "Short", cchFkCatalogName   ; SHORT
    , "Ptr", szFkSchemaName   ; WORD* optional
    , "Short", cchFkSchemaName   ; SHORT
    , "Ptr", szFkTableName   ; WORD* optional
    , "Short", cchFkTableName   ; SHORT
    , "Short")   ; return: SHORT

●SQLForeignKeysW(hstmt, szPkCatalogName, cchPkCatalogName, szPkSchemaName, cchPkSchemaName, szPkTableName, cchPkTableName, szFkCatalogName, cchFkCatalogName, szFkSchemaName, cchFkSchemaName, szFkTableName, cchFkTableName) = DLL("ODBC32.dll", "int SQLForeignKeysW(void*, void*, int, void*, int, void*, int, void*, int, void*, int, void*, int)")
# 呼び出し: SQLForeignKeysW(hstmt, szPkCatalogName, cchPkCatalogName, szPkSchemaName, cchPkSchemaName, szPkTableName, cchPkTableName, szFkCatalogName, cchFkCatalogName, szFkSchemaName, cchFkSchemaName, szFkTableName, cchFkTableName)
# hstmt : void* in/out -> "void*"
# szPkCatalogName : WORD* optional -> "void*"
# cchPkCatalogName : SHORT -> "int"
# szPkSchemaName : WORD* optional -> "void*"
# cchPkSchemaName : SHORT -> "int"
# szPkTableName : WORD* optional -> "void*"
# cchPkTableName : SHORT -> "int"
# szFkCatalogName : WORD* optional -> "void*"
# cchFkCatalogName : SHORT -> "int"
# szFkSchemaName : WORD* optional -> "void*"
# cchFkSchemaName : SHORT -> "int"
# szFkTableName : WORD* optional -> "void*"
# cchFkTableName : SHORT -> "int"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。