Win32 API 日本語リファレンス
ホーム › System.Search › SQLGetStmtAttr

SQLGetStmtAttr

関数
ステートメント属性の現在値を取得する。
DLLODBC32.dll文字セットANSI (-A)呼出規約winapi
📘 Microsoft Learn (日本語) · English

シグネチャ

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

SHORT SQLGetStmtAttr(
    void* StatementHandle,
    INT Attribute,
    void* Value,   // optional
    INT BufferLength,
    INT* StringLength   // optional
);

パラメーター

名前型方向説明
StatementHandlevoid*inout属性を取得するステートメントハンドル。
AttributeINTin取得するステートメント属性のID。SQL_ATTR_*定数を指定する。
Valuevoid*outoptional属性値を受け取るバッファへのポインタ。
BufferLengthINTinValueバッファのバイト長。文字列属性で意味を持つ。
StringLengthINT*outoptional実際に書き込まれたバイト数を受け取るポインタ。NULL可。

戻り値の型: SHORT

各言語での呼び出し定義

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

SHORT SQLGetStmtAttr(
    void* StatementHandle,
    INT Attribute,
    void* Value,   // optional
    INT BufferLength,
    INT* StringLength   // optional
);
[DllImport("ODBC32.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern short SQLGetStmtAttr(
    IntPtr StatementHandle,   // void* in/out
    int Attribute,   // INT
    IntPtr Value,   // void* optional, out
    int BufferLength,   // INT
    IntPtr StringLength   // INT* optional, out
);
<DllImport("ODBC32.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function SQLGetStmtAttr(
    StatementHandle As IntPtr,   ' void* in/out
    Attribute As Integer,   ' INT
    Value As IntPtr,   ' void* optional, out
    BufferLength As Integer,   ' INT
    StringLength As IntPtr   ' INT* optional, out
) As Short
End Function
' StatementHandle : void* in/out
' Attribute : INT
' Value : void* optional, out
' BufferLength : INT
' StringLength : INT* optional, out
Declare PtrSafe Function SQLGetStmtAttr Lib "odbc32" ( _
    ByVal StatementHandle As LongPtr, _
    ByVal Attribute As Long, _
    ByVal Value As LongPtr, _
    ByVal BufferLength As Long, _
    ByVal StringLength As LongPtr) As Integer
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

SQLGetStmtAttr = ctypes.windll.odbc32.SQLGetStmtAttr
SQLGetStmtAttr.restype = ctypes.c_short
SQLGetStmtAttr.argtypes = [
    ctypes.POINTER(None),  # StatementHandle : void* in/out
    ctypes.c_int,  # Attribute : INT
    ctypes.POINTER(None),  # Value : void* optional, out
    ctypes.c_int,  # BufferLength : INT
    ctypes.POINTER(ctypes.c_int),  # StringLength : INT* optional, out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ODBC32.dll')
SQLGetStmtAttr = Fiddle::Function.new(
  lib['SQLGetStmtAttr'],
  [
    Fiddle::TYPE_VOIDP,  # StatementHandle : void* in/out
    Fiddle::TYPE_INT,  # Attribute : INT
    Fiddle::TYPE_VOIDP,  # Value : void* optional, out
    Fiddle::TYPE_INT,  # BufferLength : INT
    Fiddle::TYPE_VOIDP,  # StringLength : INT* optional, out
  ],
  Fiddle::TYPE_SHORT)
#[link(name = "odbc32")]
extern "system" {
    fn SQLGetStmtAttr(
        StatementHandle: *mut (),  // void* in/out
        Attribute: i32,  // INT
        Value: *mut (),  // void* optional, out
        BufferLength: i32,  // INT
        StringLength: *mut i32  // INT* optional, out
    ) -> i16;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("ODBC32.dll", CharSet = CharSet.Ansi)]
public static extern short SQLGetStmtAttr(IntPtr StatementHandle, int Attribute, IntPtr Value, int BufferLength, IntPtr StringLength);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ODBC32_SQLGetStmtAttr' -Namespace Win32 -PassThru
# $api::SQLGetStmtAttr(StatementHandle, Attribute, Value, BufferLength, StringLength)
#uselib "ODBC32.dll"
#func global SQLGetStmtAttr "SQLGetStmtAttr" sptr, sptr, sptr, sptr, sptr
; SQLGetStmtAttr StatementHandle, Attribute, Value, BufferLength, varptr(StringLength)   ; 戻り値は stat
; StatementHandle : void* in/out -> "sptr"
; Attribute : INT -> "sptr"
; Value : void* optional, out -> "sptr"
; BufferLength : INT -> "sptr"
; StringLength : INT* optional, out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数: 
#uselib "ODBC32.dll"
#cfunc global SQLGetStmtAttr "SQLGetStmtAttr" sptr, int, sptr, int, var
; res = SQLGetStmtAttr(StatementHandle, Attribute, Value, BufferLength, StringLength)
; StatementHandle : void* in/out -> "sptr"
; Attribute : INT -> "int"
; Value : void* optional, out -> "sptr"
; BufferLength : INT -> "int"
; StringLength : INT* optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数: 
; SHORT SQLGetStmtAttr(void* StatementHandle, INT Attribute, void* Value, INT BufferLength, INT* StringLength)
#uselib "ODBC32.dll"
#cfunc global SQLGetStmtAttr "SQLGetStmtAttr" intptr, int, intptr, int, var
; res = SQLGetStmtAttr(StatementHandle, Attribute, Value, BufferLength, StringLength)
; StatementHandle : void* in/out -> "intptr"
; Attribute : INT -> "int"
; Value : void* optional, out -> "intptr"
; BufferLength : INT -> "int"
; StringLength : INT* optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	odbc32 = windows.NewLazySystemDLL("ODBC32.dll")
	procSQLGetStmtAttr = odbc32.NewProc("SQLGetStmtAttr")
)

// StatementHandle (void* in/out), Attribute (INT), Value (void* optional, out), BufferLength (INT), StringLength (INT* optional, out)
r1, _, err := procSQLGetStmtAttr.Call(
	uintptr(StatementHandle),
	uintptr(Attribute),
	uintptr(Value),
	uintptr(BufferLength),
	uintptr(StringLength),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // SHORT
function SQLGetStmtAttr(
  StatementHandle: Pointer;   // void* in/out
  Attribute: Integer;   // INT
  Value: Pointer;   // void* optional, out
  BufferLength: Integer;   // INT
  StringLength: Pointer   // INT* optional, out
): Smallint; stdcall;
  external 'ODBC32.dll' name 'SQLGetStmtAttr';
result := DllCall("ODBC32\SQLGetStmtAttr"
    , "Ptr", StatementHandle   ; void* in/out
    , "Int", Attribute   ; INT
    , "Ptr", Value   ; void* optional, out
    , "Int", BufferLength   ; INT
    , "Ptr", StringLength   ; INT* optional, out
    , "Short")   ; return: SHORT
●SQLGetStmtAttr(StatementHandle, Attribute, Value, BufferLength, StringLength) = DLL("ODBC32.dll", "int SQLGetStmtAttr(void*, int, void*, int, void*)")
# 呼び出し: SQLGetStmtAttr(StatementHandle, Attribute, Value, BufferLength, StringLength)
# StatementHandle : void* in/out -> "void*"
# Attribute : INT -> "int"
# Value : void* optional, out -> "void*"
# BufferLength : INT -> "int"
# StringLength : INT* optional, out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "odbc32" fn SQLGetStmtAttr(
    StatementHandle: ?*anyopaque, // void* in/out
    Attribute: i32, // INT
    Value: ?*anyopaque, // void* optional, out
    BufferLength: i32, // INT
    StringLength: [*c]i32 // INT* optional, out
) callconv(std.os.windows.WINAPI) i16;
proc SQLGetStmtAttr(
    StatementHandle: pointer,  # void* in/out
    Attribute: int32,  # INT
    Value: pointer,  # void* optional, out
    BufferLength: int32,  # INT
    StringLength: ptr int32  # INT* optional, out
): int16 {.importc: "SQLGetStmtAttr", stdcall, dynlib: "ODBC32.dll".}
pragma(lib, "odbc32");
extern(Windows)
short SQLGetStmtAttr(
    void* StatementHandle,   // void* in/out
    int Attribute,   // INT
    void* Value,   // void* optional, out
    int BufferLength,   // INT
    int* StringLength   // INT* optional, out
);
ccall((:SQLGetStmtAttr, "ODBC32.dll"), stdcall, Int16,
      (Ptr{Cvoid}, Int32, Ptr{Cvoid}, Int32, Ptr{Int32}),
      StatementHandle, Attribute, Value, BufferLength, StringLength)
# StatementHandle : void* in/out -> Ptr{Cvoid}
# Attribute : INT -> Int32
# Value : void* optional, out -> Ptr{Cvoid}
# BufferLength : INT -> Int32
# StringLength : INT* optional, out -> Ptr{Int32}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int16_t SQLGetStmtAttr(
    void* StatementHandle,
    int32_t Attribute,
    void* Value,
    int32_t BufferLength,
    int32_t* StringLength);
]]
local odbc32 = ffi.load("odbc32")
-- odbc32.SQLGetStmtAttr(StatementHandle, Attribute, Value, BufferLength, StringLength)
-- StatementHandle : void* in/out
-- Attribute : INT
-- Value : void* optional, out
-- BufferLength : INT
-- StringLength : INT* optional, out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('ODBC32.dll');
const SQLGetStmtAttr = lib.func('__stdcall', 'SQLGetStmtAttr', 'int16_t', ['void *', 'int32_t', 'void *', 'int32_t', 'int32_t *']);
// SQLGetStmtAttr(StatementHandle, Attribute, Value, BufferLength, StringLength)
// StatementHandle : void* in/out -> 'void *'
// Attribute : INT -> 'int32_t'
// Value : void* optional, out -> 'void *'
// BufferLength : INT -> 'int32_t'
// StringLength : INT* optional, out -> 'int32_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("ODBC32.dll", {
  SQLGetStmtAttr: { parameters: ["pointer", "i32", "pointer", "i32", "pointer"], result: "i16" },
});
// lib.symbols.SQLGetStmtAttr(StatementHandle, Attribute, Value, BufferLength, StringLength)
// StatementHandle : void* in/out -> "pointer"
// Attribute : INT -> "i32"
// Value : void* optional, out -> "pointer"
// BufferLength : INT -> "i32"
// StringLength : INT* optional, out -> "pointer"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int16_t SQLGetStmtAttr(
    void* StatementHandle,
    int32_t Attribute,
    void* Value,
    int32_t BufferLength,
    int32_t* StringLength);
C, "ODBC32.dll");
// $ffi->SQLGetStmtAttr(StatementHandle, Attribute, Value, BufferLength, StringLength);
// StatementHandle : void* in/out
// Attribute : INT
// Value : void* optional, out
// BufferLength : INT
// StringLength : INT* optional, out
// 構造体/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 SQLGetStmtAttr(
        Pointer StatementHandle,   // void* in/out
        int Attribute,   // INT
        Pointer Value,   // void* optional, out
        int BufferLength,   // INT
        IntByReference StringLength   // INT* optional, out
    );
}
@[Link("odbc32")]
lib LibODBC32
  fun SQLGetStmtAttr = SQLGetStmtAttr(
    StatementHandle : Void*,   # void* in/out
    Attribute : Int32,   # INT
    Value : Void*,   # void* optional, out
    BufferLength : Int32,   # INT
    StringLength : Int32*   # INT* optional, out
  ) : Int16
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef SQLGetStmtAttrNative = Int16 Function(Pointer<Void>, Int32, Pointer<Void>, Int32, Pointer<Int32>);
typedef SQLGetStmtAttrDart = int Function(Pointer<Void>, int, Pointer<Void>, int, Pointer<Int32>);
final SQLGetStmtAttr = DynamicLibrary.open('ODBC32.dll')
    .lookupFunction<SQLGetStmtAttrNative, SQLGetStmtAttrDart>('SQLGetStmtAttr');
// StatementHandle : void* in/out -> Pointer<Void>
// Attribute : INT -> Int32
// Value : void* optional, out -> Pointer<Void>
// BufferLength : INT -> Int32
// StringLength : INT* optional, out -> Pointer<Int32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SQLGetStmtAttr(
  StatementHandle: Pointer;   // void* in/out
  Attribute: Integer;   // INT
  Value: Pointer;   // void* optional, out
  BufferLength: Integer;   // INT
  StringLength: Pointer   // INT* optional, out
): Smallint; stdcall;
  external 'ODBC32.dll' name 'SQLGetStmtAttr';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SQLGetStmtAttr"
  c_SQLGetStmtAttr :: Ptr () -> Int32 -> Ptr () -> Int32 -> Ptr Int32 -> IO Int16
-- StatementHandle : void* in/out -> Ptr ()
-- Attribute : INT -> Int32
-- Value : void* optional, out -> Ptr ()
-- BufferLength : INT -> Int32
-- StringLength : INT* optional, out -> Ptr Int32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let sqlgetstmtattr =
  foreign "SQLGetStmtAttr"
    ((ptr void) @-> int32_t @-> (ptr void) @-> int32_t @-> (ptr int32_t) @-> returning int16_t)
(* StatementHandle : void* in/out -> (ptr void) *)
(* Attribute : INT -> int32_t *)
(* Value : void* optional, out -> (ptr void) *)
(* BufferLength : INT -> int32_t *)
(* StringLength : INT* optional, out -> (ptr int32_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library odbc32 (t "ODBC32.dll"))
(cffi:use-foreign-library odbc32)

(cffi:defcfun ("SQLGetStmtAttr" sqlget-stmt-attr :convention :stdcall) :int16
  (statement-handle :pointer)   ; void* in/out
  (attribute :int32)   ; INT
  (value :pointer)   ; void* optional, out
  (buffer-length :int32)   ; INT
  (string-length :pointer))   ; INT* optional, out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SQLGetStmtAttr = Win32::API::More->new('ODBC32',
    'short SQLGetStmtAttr(LPVOID StatementHandle, int Attribute, LPVOID Value, int BufferLength, LPVOID StringLength)');
# my $ret = $SQLGetStmtAttr->Call($StatementHandle, $Attribute, $Value, $BufferLength, $StringLength);
# StatementHandle : void* in/out -> LPVOID
# Attribute : INT -> int
# Value : void* optional, out -> LPVOID
# BufferLength : INT -> int
# StringLength : INT* optional, out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

文字セット違い