SQLPutData
関数シグネチャ
// ODBC32.dll
#include <windows.h>
SHORT SQLPutData(
void* StatementHandle,
void* Data,
INT StrLen_or_Ind
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| StatementHandle | void* | inout | [入力] ステートメントハンドル。 |
| Data | void* | in | 送信するデータ本体へのポインタ。 |
| StrLen_or_Ind | INT | in | [入力] *DataPtr の長さ。SQLPutData の 1 回の呼び出しで送信されるデータ量を指定します。データ量は、特定のパラメーターまたは列に対する呼び出しごとに異なっていてもかまいません。StrLen_or_Ind は、次のいずれかの条件を満たす場合を除いて無視されます。
それ以外のすべての C データ型では、StrLen_or_Ind が SQL_NULL_DATA でも SQL_DEFAULT_PARAM でもない場合、ドライバーは *DataPtr バッファーのサイズが ValueType または TargetType で指定された C データ型のサイズであると想定し、データ値全体を送信します。詳細については、付録 D: データ型の C から SQL データ型へのデータの変換 を参照してください。 |
戻り値の型: SHORT
公式ドキュメント
SQLPutData を使用すると、アプリケーションはステートメントの実行時に、パラメーターまたは列のデータをドライバーへ送信できます。この関数は、文字型、バイナリ型、またはデータソース固有のデータ型を持つ列 (たとえば SQL_LONGVARBINARY 型や SQL_LONGVARCHAR 型のパラメーター) に対して、文字データまたはバイナリデータの値を分割して送信するために使用できます。SQLPutData は、基になるドライバーが Unicode データをサポートしていない場合でも、Unicode C データ型へのバインドをサポートします。
戻り値
解説(Remarks)
SQLPutData は、実行時データ (data-at-execution) を供給するために、次の 2 つの用途で呼び出すことができます。1 つは SQLExecute または SQLExecDirect の呼び出しで使用されるパラメーターデータ、もう 1 つは SQLBulkOperations の呼び出しによって行が更新または追加されるとき、あるいは SQLSetPos の呼び出しによって行が更新されるときに使用される列データです。
アプリケーションが SQLParamData を呼び出して送信すべきデータを判断すると、ドライバーは、どのパラメーターデータを送信すべきか、または列データがどこにあるかをアプリケーションが判断するために使用できるインジケーターを返します。さらに SQL_NEED_DATA も返します。これは、データを送信するために SQLPutData を呼び出す必要があることをアプリケーションに示すインジケーターです。アプリケーションは、SQLPutData の DataPtr 引数に、パラメーターまたは列の実際のデータを格納したバッファーへのポインターを渡します。
ドライバーが SQLPutData に対して SQL_SUCCESS を返すと、アプリケーションは SQLParamData を再度呼び出します。さらに送信すべきデータがある場合、SQLParamData は SQL_NEED_DATA を返し、その場合アプリケーションは SQLPutData を再度呼び出します。すべての実行時データが送信済みの場合は SQL_SUCCESS を返します。その後、アプリケーションは SQLParamData を再度呼び出します。ドライバーが SQL_NEED_DATA と *ValuePtrPtr 内の別のインジケーターを返した場合は、別のパラメーターまたは列のデータが必要であることを意味し、SQLPutData を再度呼び出します。ドライバーが SQL_SUCCESS を返した場合は、すべての実行時データが送信済みであり、SQL ステートメントを実行するか、SQLBulkOperations または SQLSetPos の呼び出しを処理できます。
実行時パラメーターデータがステートメントの実行時にどのように渡されるかの詳細については、SQLBindParameter の「Passing Parameter Values」、および ロングデータの送信 を参照してください。実行時列データがどのように更新または追加されるかの詳細については、SQLSetPos の「Using SQLSetPos」セクション、SQLBulkOperations の「Performing Bulk Updates Using Bookmarks」、および ロングデータと SQLSetPos および SQLBulkOperations を参照してください。
アプリケーションが SQLPutData でデータを分割して送信できるのは、文字型、バイナリ型、またはデータソース固有のデータ型を持つ列に文字 C データを送信する場合、または同じ種類の型を持つ列にバイナリ C データを送信する場合のみです。それ以外の条件で SQLPutData を複数回呼び出した場合は、SQL_ERROR と SQLSTATE HY019 (Non-character and non-binary data sent in pieces) を返します。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp)
各言語での呼び出し定義
// ODBC32.dll
#include <windows.h>
SHORT SQLPutData(
void* StatementHandle,
void* Data,
INT StrLen_or_Ind
);[DllImport("ODBC32.dll", ExactSpelling = true)]
static extern short SQLPutData(
IntPtr StatementHandle, // void* in/out
IntPtr Data, // void*
int StrLen_or_Ind // INT
);<DllImport("ODBC32.dll", ExactSpelling:=True)>
Public Shared Function SQLPutData(
StatementHandle As IntPtr, ' void* in/out
Data As IntPtr, ' void*
StrLen_or_Ind As Integer ' INT
) As Short
End Function' StatementHandle : void* in/out
' Data : void*
' StrLen_or_Ind : INT
Declare PtrSafe Function SQLPutData Lib "odbc32" ( _
ByVal StatementHandle As LongPtr, _
ByVal Data As LongPtr, _
ByVal StrLen_or_Ind As Long) As Integer
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
SQLPutData = ctypes.windll.odbc32.SQLPutData
SQLPutData.restype = ctypes.c_short
SQLPutData.argtypes = [
ctypes.POINTER(None), # StatementHandle : void* in/out
ctypes.POINTER(None), # Data : void*
ctypes.c_int, # StrLen_or_Ind : INT
]require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('ODBC32.dll')
SQLPutData = Fiddle::Function.new(
lib['SQLPutData'],
[
Fiddle::TYPE_VOIDP, # StatementHandle : void* in/out
Fiddle::TYPE_VOIDP, # Data : void*
Fiddle::TYPE_INT, # StrLen_or_Ind : INT
],
Fiddle::TYPE_SHORT)#[link(name = "odbc32")]
extern "system" {
fn SQLPutData(
StatementHandle: *mut (), // void* in/out
Data: *mut (), // void*
StrLen_or_Ind: i32 // INT
) -> i16;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[DllImport("ODBC32.dll")]
public static extern short SQLPutData(IntPtr StatementHandle, IntPtr Data, int StrLen_or_Ind);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ODBC32_SQLPutData' -Namespace Win32 -PassThru
# $api::SQLPutData(StatementHandle, Data, StrLen_or_Ind)#uselib "ODBC32.dll"
#func global SQLPutData "SQLPutData" sptr, sptr, sptr
; SQLPutData StatementHandle, Data, StrLen_or_Ind ; 戻り値は stat
; StatementHandle : void* in/out -> "sptr"
; Data : void* -> "sptr"
; StrLen_or_Ind : INT -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "ODBC32.dll"
#cfunc global SQLPutData "SQLPutData" sptr, sptr, int
; res = SQLPutData(StatementHandle, Data, StrLen_or_Ind)
; StatementHandle : void* in/out -> "sptr"
; Data : void* -> "sptr"
; StrLen_or_Ind : INT -> "int"; SHORT SQLPutData(void* StatementHandle, void* Data, INT StrLen_or_Ind)
#uselib "ODBC32.dll"
#cfunc global SQLPutData "SQLPutData" intptr, intptr, int
; res = SQLPutData(StatementHandle, Data, StrLen_or_Ind)
; StatementHandle : void* in/out -> "intptr"
; Data : void* -> "intptr"
; StrLen_or_Ind : INT -> "int"import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
odbc32 = windows.NewLazySystemDLL("ODBC32.dll")
procSQLPutData = odbc32.NewProc("SQLPutData")
)
// StatementHandle (void* in/out), Data (void*), StrLen_or_Ind (INT)
r1, _, err := procSQLPutData.Call(
uintptr(StatementHandle),
uintptr(Data),
uintptr(StrLen_or_Ind),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // SHORTfunction SQLPutData(
StatementHandle: Pointer; // void* in/out
Data: Pointer; // void*
StrLen_or_Ind: Integer // INT
): Smallint; stdcall;
external 'ODBC32.dll' name 'SQLPutData';result := DllCall("ODBC32\SQLPutData"
, "Ptr", StatementHandle ; void* in/out
, "Ptr", Data ; void*
, "Int", StrLen_or_Ind ; INT
, "Short") ; return: SHORT●SQLPutData(StatementHandle, Data, StrLen_or_Ind) = DLL("ODBC32.dll", "int SQLPutData(void*, void*, int)")
# 呼び出し: SQLPutData(StatementHandle, Data, StrLen_or_Ind)
# StatementHandle : void* in/out -> "void*"
# Data : void* -> "void*"
# StrLen_or_Ind : INT -> "int"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "odbc32" fn SQLPutData(
StatementHandle: ?*anyopaque, // void* in/out
Data: ?*anyopaque, // void*
StrLen_or_Ind: i32 // INT
) callconv(std.os.windows.WINAPI) i16;proc SQLPutData(
StatementHandle: pointer, # void* in/out
Data: pointer, # void*
StrLen_or_Ind: int32 # INT
): int16 {.importc: "SQLPutData", stdcall, dynlib: "ODBC32.dll".}pragma(lib, "odbc32");
extern(Windows)
short SQLPutData(
void* StatementHandle, // void* in/out
void* Data, // void*
int StrLen_or_Ind // INT
);ccall((:SQLPutData, "ODBC32.dll"), stdcall, Int16,
(Ptr{Cvoid}, Ptr{Cvoid}, Int32),
StatementHandle, Data, StrLen_or_Ind)
# StatementHandle : void* in/out -> Ptr{Cvoid}
# Data : void* -> Ptr{Cvoid}
# StrLen_or_Ind : INT -> Int32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
int16_t SQLPutData(
void* StatementHandle,
void* Data,
int32_t StrLen_or_Ind);
]]
local odbc32 = ffi.load("odbc32")
-- odbc32.SQLPutData(StatementHandle, Data, StrLen_or_Ind)
-- StatementHandle : void* in/out
-- Data : void*
-- StrLen_or_Ind : INT
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('ODBC32.dll');
const SQLPutData = lib.func('__stdcall', 'SQLPutData', 'int16_t', ['void *', 'void *', 'int32_t']);
// SQLPutData(StatementHandle, Data, StrLen_or_Ind)
// StatementHandle : void* in/out -> 'void *'
// Data : void* -> 'void *'
// StrLen_or_Ind : INT -> 'int32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("ODBC32.dll", {
SQLPutData: { parameters: ["pointer", "pointer", "i32"], result: "i16" },
});
// lib.symbols.SQLPutData(StatementHandle, Data, StrLen_or_Ind)
// StatementHandle : void* in/out -> "pointer"
// Data : void* -> "pointer"
// StrLen_or_Ind : INT -> "i32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
int16_t SQLPutData(
void* StatementHandle,
void* Data,
int32_t StrLen_or_Ind);
C, "ODBC32.dll");
// $ffi->SQLPutData(StatementHandle, Data, StrLen_or_Ind);
// StatementHandle : void* in/out
// Data : void*
// StrLen_or_Ind : INT
// 構造体/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 SQLPutData(
Pointer StatementHandle, // void* in/out
Pointer Data, // void*
int StrLen_or_Ind // INT
);
}@[Link("odbc32")]
lib LibODBC32
fun SQLPutData = SQLPutData(
StatementHandle : Void*, # void* in/out
Data : Void*, # void*
StrLen_or_Ind : Int32 # INT
) : Int16
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef SQLPutDataNative = Int16 Function(Pointer<Void>, Pointer<Void>, Int32);
typedef SQLPutDataDart = int Function(Pointer<Void>, Pointer<Void>, int);
final SQLPutData = DynamicLibrary.open('ODBC32.dll')
.lookupFunction<SQLPutDataNative, SQLPutDataDart>('SQLPutData');
// StatementHandle : void* in/out -> Pointer<Void>
// Data : void* -> Pointer<Void>
// StrLen_or_Ind : INT -> Int32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function SQLPutData(
StatementHandle: Pointer; // void* in/out
Data: Pointer; // void*
StrLen_or_Ind: Integer // INT
): Smallint; stdcall;
external 'ODBC32.dll' name 'SQLPutData';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "SQLPutData"
c_SQLPutData :: Ptr () -> Ptr () -> Int32 -> IO Int16
-- StatementHandle : void* in/out -> Ptr ()
-- Data : void* -> Ptr ()
-- StrLen_or_Ind : INT -> Int32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let sqlputdata =
foreign "SQLPutData"
((ptr void) @-> (ptr void) @-> int32_t @-> returning int16_t)
(* StatementHandle : void* in/out -> (ptr void) *)
(* Data : void* -> (ptr void) *)
(* StrLen_or_Ind : INT -> int32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)(cffi:define-foreign-library odbc32 (t "ODBC32.dll"))
(cffi:use-foreign-library odbc32)
(cffi:defcfun ("SQLPutData" sqlput-data :convention :stdcall) :int16
(statement-handle :pointer) ; void* in/out
(data :pointer) ; void*
(str-len-or-ind :int32)) ; INT
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $SQLPutData = Win32::API::More->new('ODBC32',
'short SQLPutData(LPVOID StatementHandle, LPVOID Data, int StrLen_or_Ind)');
# my $ret = $SQLPutData->Call($StatementHandle, $Data, $StrLen_or_Ind);
# StatementHandle : void* in/out -> LPVOID
# Data : void* -> LPVOID
# StrLen_or_Ind : INT -> int
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。