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

SQLParamData

関数
データ実行時パラメータの次の処理対象を取得する。
DLLODBC32.dll呼出規約winapi

シグネチャ

// ODBC32.dll
#include <windows.h>

SHORT SQLParamData(
    void* StatementHandle,
    void** Value   // optional
);

パラメーター

名前型方向説明
StatementHandlevoid*inout[入力] ステートメントハンドル。
Valuevoid**outoptionalSQLBindParameterで設定したアプリ定義の値ポインタを受け取る出力。

戻り値の型: SHORT

公式ドキュメント

SQLParamData は、ステートメントの実行時にパラメーターデータを提供するために SQLPutData と組み合わせて使用され、また、ストリーミングされた出力パラメーターデータを取得するために SQLGetData と組み合わせて使用されます。

戻り値

SQL_SUCCESS、SQL_SUCCESS_WITH_INFO、SQL_NEED_DATA、SQL_NO_DATA、SQL_STILL_EXECUTING、SQL_ERROR、SQL_INVALID_HANDLE、または SQL_PARAM_DATA_AVAILABLE。

解説(Remarks)

SQLParamData は、2 つの用途で実行時データ (data-at-execution) を提供するために呼び出すことができます。すなわち、SQLExecute または SQLExecDirect の呼び出しで使用されるパラメーターデータと、SQLBulkOperations の呼び出しによって行が更新または追加されるとき、あるいは SQLSetPos の呼び出しによって行が更新されるときに使用される列データです。実行時に、SQLParamData はドライバーが必要とするデータを示すインジケーターをアプリケーションに返します。

アプリケーションが SQLExecute、SQLExecDirect、SQLBulkOperations、または SQLSetPos を呼び出したとき、実行時データが必要であればドライバーは SQL_NEED_DATA を返します。次にアプリケーションは SQLParamData を呼び出して、どのデータを送信するかを判断します。ドライバーがパラメーターデータを必要とする場合、ドライバーは *ValuePtrPtr 出力バッファーに、アプリケーションがロウセットバッファーに格納した値を返します。アプリケーションはこの値を使用して、ドライバーがどのパラメーターデータを要求しているかを判断できます。ドライバーが列データを必要とする場合、ドライバーは *ValuePtrPtr バッファーに、その列が元々バインドされていたアドレスを次のように返します。

Bound Address + Binding Offset + ((Row Number - 1) x Element Size)

ここで、各変数は次の表に示すとおりに定義されます。

変数 説明
Bound Address SQLBindCol の TargetValuePtr 引数で指定されたアドレス。
Binding Offset SQL_ATTR_ROW_BIND_OFFSET_PTR ステートメント属性で指定されたアドレスに格納されている値。
Row Number ロウセット内の行の 1 から始まる番号。既定である単一行のフェッチの場合、これは 1 です。
Element Size データバッファーと長さ/インジケーターバッファーの両方に対する SQL_ATTR_ROW_BIND_TYPE ステートメント属性の値。

また、SQL_NEED_DATA も返されます。これは、データを送信するために SQLPutData を呼び出す必要があることをアプリケーションに示すインジケーターです。

アプリケーションは、その列またはパラメーターの実行時データを送信するために必要な回数だけ SQLPutData を呼び出します。その列またはパラメーターのすべてのデータを送信した後、アプリケーションは再び SQLParamData を呼び出します。SQLParamData が再び SQL_NEED_DATA を返した場合は、別のパラメーターまたは列のデータを送信する必要があります。そのため、アプリケーションは再度 SQLPutData を呼び出します。すべてのパラメーターまたは列について実行時データがすべて送信された場合、SQLParamData は SQL_SUCCESS または SQL_SUCCESS_WITH_INFO を返し、*ValuePtrPtr の値は未定義となり、SQL ステートメントを実行するか、SQLBulkOperations または SQLSetPos の呼び出しを処理できます。

SQLParamData が、データソース上のどの行にも影響しない検索条件付きの更新または削除ステートメントに対してパラメーターデータを提供した場合、SQLParamData の呼び出しは SQL_NO_DATA を返します。

ステートメントの実行時に実行時パラメーターデータがどのように渡されるかの詳細については、SQLBindParameter の「Passing Parameter Values」および Sending Long Data を参照してください。実行時列データがどのように更新または追加されるかの詳細については、SQLSetPos の「Using SQLSetPos」セクション、SQLBulkOperations の「Performing Bulk Updates Using Bookmarks」、および Long Data and SQLSetPos and SQLBulkOperations を参照してください。

SQLParamData は、ストリーミングされた出力パラメーターを取得するために呼び出すこともできます。SQLMoreResults、SQLExecute、SQLGetData、または SQLExecDirect が SQL_PARAM_DATA_AVAILABLE を返した場合、SQLParamData を呼び出して、どのパラメーターの値が利用可能かを判断します。SQL_PARAM_DATA_AVAILABLE とストリーミングされた出力パラメーターの詳細については、Retrieving Output Parameters Using SQLGetData を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp)

各言語での呼び出し定義

// ODBC32.dll
#include <windows.h>

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

SQLParamData = ctypes.windll.odbc32.SQLParamData
SQLParamData.restype = ctypes.c_short
SQLParamData.argtypes = [
    ctypes.POINTER(None),  # StatementHandle : void* in/out
    ctypes.c_void_p,  # Value : void** optional, out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ODBC32.dll')
SQLParamData = Fiddle::Function.new(
  lib['SQLParamData'],
  [
    Fiddle::TYPE_VOIDP,  # StatementHandle : void* in/out
    Fiddle::TYPE_VOIDP,  # Value : void** optional, out
  ],
  Fiddle::TYPE_SHORT)
#[link(name = "odbc32")]
extern "system" {
    fn SQLParamData(
        StatementHandle: *mut (),  // void* in/out
        Value: *mut *mut ()  // void** optional, out
    ) -> i16;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("ODBC32.dll")]
public static extern short SQLParamData(IntPtr StatementHandle, IntPtr Value);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ODBC32_SQLParamData' -Namespace Win32 -PassThru
# $api::SQLParamData(StatementHandle, Value)
#uselib "ODBC32.dll"
#func global SQLParamData "SQLParamData" sptr, sptr
; SQLParamData StatementHandle, Value   ; 戻り値は stat
; StatementHandle : void* in/out -> "sptr"
; Value : void** optional, out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "ODBC32.dll"
#cfunc global SQLParamData "SQLParamData" sptr, sptr
; res = SQLParamData(StatementHandle, Value)
; StatementHandle : void* in/out -> "sptr"
; Value : void** optional, out -> "sptr"
; SHORT SQLParamData(void* StatementHandle, void** Value)
#uselib "ODBC32.dll"
#cfunc global SQLParamData "SQLParamData" intptr, intptr
; res = SQLParamData(StatementHandle, Value)
; StatementHandle : void* in/out -> "intptr"
; Value : void** optional, out -> "intptr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	odbc32 = windows.NewLazySystemDLL("ODBC32.dll")
	procSQLParamData = odbc32.NewProc("SQLParamData")
)

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

extern "odbc32" fn SQLParamData(
    StatementHandle: ?*anyopaque, // void* in/out
    Value: ?*anyopaque // void** optional, out
) callconv(std.os.windows.WINAPI) i16;
proc SQLParamData(
    StatementHandle: pointer,  # void* in/out
    Value: pointer  # void** optional, out
): int16 {.importc: "SQLParamData", stdcall, dynlib: "ODBC32.dll".}
pragma(lib, "odbc32");
extern(Windows)
short SQLParamData(
    void* StatementHandle,   // void* in/out
    void** Value   // void** optional, out
);
ccall((:SQLParamData, "ODBC32.dll"), stdcall, Int16,
      (Ptr{Cvoid}, Ptr{Cvoid}),
      StatementHandle, Value)
# StatementHandle : void* in/out -> Ptr{Cvoid}
# Value : void** optional, out -> Ptr{Cvoid}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int16_t SQLParamData(
    void* StatementHandle,
    void** Value);
]]
local odbc32 = ffi.load("odbc32")
-- odbc32.SQLParamData(StatementHandle, Value)
-- StatementHandle : void* in/out
-- Value : void** optional, out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('ODBC32.dll');
const SQLParamData = lib.func('__stdcall', 'SQLParamData', 'int16_t', ['void *', 'void *']);
// SQLParamData(StatementHandle, Value)
// StatementHandle : void* in/out -> 'void *'
// Value : void** optional, out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("ODBC32.dll", {
  SQLParamData: { parameters: ["pointer", "pointer"], result: "i16" },
});
// lib.symbols.SQLParamData(StatementHandle, Value)
// StatementHandle : void* in/out -> "pointer"
// Value : void** optional, out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int16_t SQLParamData(
    void* StatementHandle,
    void** Value);
C, "ODBC32.dll");
// $ffi->SQLParamData(StatementHandle, Value);
// StatementHandle : void* in/out
// Value : void** 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);
    short SQLParamData(
        Pointer StatementHandle,   // void* in/out
        Pointer Value   // void** optional, out
    );
}
@[Link("odbc32")]
lib LibODBC32
  fun SQLParamData = SQLParamData(
    StatementHandle : Void*,   # void* in/out
    Value : Void**   # void** 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 SQLParamDataNative = Int16 Function(Pointer<Void>, Pointer<Void>);
typedef SQLParamDataDart = int Function(Pointer<Void>, Pointer<Void>);
final SQLParamData = DynamicLibrary.open('ODBC32.dll')
    .lookupFunction<SQLParamDataNative, SQLParamDataDart>('SQLParamData');
// StatementHandle : void* in/out -> Pointer<Void>
// Value : void** optional, out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SQLParamData(
  StatementHandle: Pointer;   // void* in/out
  Value: Pointer   // void** optional, out
): Smallint; stdcall;
  external 'ODBC32.dll' name 'SQLParamData';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

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

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