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

SQLEndTran

関数
指定ハンドルのトランザクションをコミットまたはロールバックする。
DLLODBC32.dll呼出規約winapi

シグネチャ

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

SHORT SQLEndTran(
    SHORT HandleType,
    void* Handle,
    SHORT CompletionType
);

パラメーター

名前型方向説明
HandleTypeSHORTin[入力] ハンドル型識別子。SQL_HANDLE_ENV (Handle が環境ハンドルの場合)、または SQL_HANDLE_DBC (Handle が接続ハンドルの場合) のいずれかを格納します。
Handlevoid*inout[入力] HandleType で示される型のハンドルで、トランザクションのスコープを示します。詳細については「Comments」を参照してください。
CompletionTypeSHORTin

[入力] 次の 2 つの値のいずれか。

SQL_COMMIT SQL_ROLLBACK

戻り値の型: SHORT

公式ドキュメント

SQLEndTran は、接続に関連付けられたすべてのステートメント上の、アクティブなすべての操作に対してコミットまたはロールバック操作を要求します。SQLEndTran は、環境に関連付けられたすべての接続に対してコミットまたはロールバック操作を実行するよう要求することもできます。

戻り値

SQL_SUCCESS、SQL_SUCCESS_WITH_INFO、SQL_ERROR、SQL_INVALID_HANDLE、または SQL_STILL_EXECUTING。

解説(Remarks)

ODBC 3.x ドライバーの場合、HandleType が SQL_HANDLE_ENV で Handle が有効な環境ハンドルであれば、ドライバーマネージャーはその環境に関連付けられた各ドライバーの SQLEndTran を呼び出します。ドライバーへの呼び出しにおける Handle 引数は、そのドライバーの環境ハンドルになります。ODBC 2.x ドライバーの場合、HandleType が SQL_HANDLE_ENV で Handle が有効な環境ハンドルであり、その環境内に接続状態の接続が複数存在するときは、ドライバーマネージャーは、その環境内で接続状態にある接続ごとに 1 回ずつ、ドライバーの SQLTransact を呼び出します。各呼び出しにおける Handle 引数は、その接続のハンドルになります。いずれの場合も、ドライバーは CompletionType の値に応じて、その環境上で接続状態にあるすべての接続でトランザクションのコミットまたはロールバックを試みます。アクティブでない接続はトランザクションに影響しません。

メモ

SQLEndTran は、共有環境上のトランザクションのコミットまたはロールバックには使用できません。Handle に共有環境のハンドル、または共有環境上の接続のハンドルを設定して SQLEndTran を呼び出した場合は、SQLSTATE HY092 (Invalid attribute/option identifier) が返されます。

ドライバーマネージャーは、各接続について SQL_SUCCESS を受け取った場合にのみ SQL_SUCCESS を返します。1 つ以上の接続で SQL_ERROR を受け取った場合は、アプリケーションに SQL_ERROR を返し、診断情報は環境の診断データ構造に格納されます。コミットまたはロールバック操作中にどの接続が失敗したかを判断するには、アプリケーションは各接続に対して SQLGetDiagRec を呼び出します。

メモ

ドライバーマネージャーは、すべての接続にまたがるグローバルトランザクションをシミュレートしないため、2 フェーズコミットプロトコルを使用しません。

CompletionType が SQL_COMMIT の場合、SQLEndTran は、影響を受ける接続に関連付けられた任意のステートメント上の、アクティブなすべての操作に対してコミット要求を発行します。CompletionType が SQL_ROLLBACK の場合、SQLEndTran は、影響を受ける接続に関連付けられた任意のステートメント上の、アクティブなすべての操作に対してロールバック要求を発行します。アクティブなトランザクションがない場合、SQLEndTran は SQL_SUCCESS を返し、どのデータソースにも影響しません。詳細については、「Committing and Rolling Back Transactions」を参照してください。

ドライバーが手動コミットモード (SQL_ATTR_AUTOCOMMIT 属性を SQL_AUTOCOMMIT_OFF に設定して SQLSetConnectAttr を呼び出した状態) にある場合、トランザクションに含めることができる SQL ステートメントが現在のデータソースに対して実行されると、新しいトランザクションが暗黙的に開始されます。詳細については、「Commit Mode」を参照してください。

トランザクション操作がカーソルにどのように影響するかを判断するには、アプリケーションは SQL_CURSOR_ROLLBACK_BEHAVIOR オプションおよび SQL_CURSOR_COMMIT_BEHAVIOR オプションを指定して SQLGetInfo を呼び出します。詳細については、以降の段落、および「Effect of Transactions on Cursors and Prepared Statements」を参照してください。

SQL_CURSOR_ROLLBACK_BEHAVIOR または SQL_CURSOR_COMMIT_BEHAVIOR の値が SQL_CB_DELETE の場合、SQLEndTran は、接続に関連付けられたすべてのステートメント上の開いているカーソルをすべて閉じて削除し、保留中の結果をすべて破棄します。SQLEndTran は、存在するステートメントを割り当て済み (未準備) の状態のままにします。アプリケーションは、それらを後続の SQL 要求に再利用することも、HandleType に SQL_HANDLE_STMT を指定して SQLFreeStmt または SQLFreeHandle を呼び出して解放することもできます。

SQL_CURSOR_ROLLBACK_BEHAVIOR または SQL_CURSOR_COMMIT_BEHAVIOR の値が SQL_CB_CLOSE の場合、SQLEndTran は、接続に関連付けられたすべてのステートメント上の開いているカーソルをすべて閉じます。SQLEndTran は、存在するステートメントを準備済みの状態のままにします。アプリケーションは、最初に SQLPrepare を呼び出すことなく、接続に関連付けられたステートメントに対して SQLExecute を呼び出すことができます。

SQL_CURSOR_ROLLBACK_BEHAVIOR または SQL_CURSOR_COMMIT_BEHAVIOR の値が SQL_CB_PRESERVE の場合、SQLEndTran は、接続に関連付けられた開いているカーソルに影響しません。カーソルは、SQLEndTran の呼び出し前に指していた行にとどまります。

トランザクションをサポートするドライバーおよびデータソースでは、アクティブなトランザクションがないときに SQL_COMMIT または SQL_ROLLBACK を指定して SQLEndTran を呼び出すと、SQL_SUCCESS が返され (コミットまたはロールバックすべき処理がないことを示します)、データソースには影響しません。

ドライバーが自動コミットモードにある場合、ドライバーマネージャーはドライバーの SQLEndTran を呼び出しません。SQLEndTran は、CompletionType に SQL_COMMIT と SQL_ROLLBACK のどちらを指定して呼び出された場合でも、常に SQL_SUCCESS を返します。

トランザクションをサポートしないドライバーまたはデータソース (SQLGetInfo の option SQL_TXN_CAPABLE が SQL_TC_NONE) は、事実上常に自動コミットモードであるため、CompletionType に SQL_COMMIT と SQL_ROLLBACK のどちらを指定して呼び出されたかにかかわらず、SQLEndTran に対して常に SQL_SUCCESS を返します。このようなドライバーおよびデータソースは、要求されても実際にはトランザクションをロールバックしません。

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

各言語での呼び出し定義

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

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

SQLEndTran = ctypes.windll.odbc32.SQLEndTran
SQLEndTran.restype = ctypes.c_short
SQLEndTran.argtypes = [
    ctypes.c_short,  # HandleType : SHORT
    ctypes.POINTER(None),  # Handle : void* in/out
    ctypes.c_short,  # CompletionType : SHORT
]
require 'fiddle'
require 'fiddle/import'

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

var (
	odbc32 = windows.NewLazySystemDLL("ODBC32.dll")
	procSQLEndTran = odbc32.NewProc("SQLEndTran")
)

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

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

typedef SQLEndTranNative = Int16 Function(Int16, Pointer<Void>, Int16);
typedef SQLEndTranDart = int Function(int, Pointer<Void>, int);
final SQLEndTran = DynamicLibrary.open('ODBC32.dll')
    .lookupFunction<SQLEndTranNative, SQLEndTranDart>('SQLEndTran');
// HandleType : SHORT -> Int16
// Handle : void* in/out -> Pointer<Void>
// CompletionType : SHORT -> Int16
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SQLEndTran(
  HandleType: Smallint;   // SHORT
  Handle: Pointer;   // void* in/out
  CompletionType: Smallint   // SHORT
): Smallint; stdcall;
  external 'ODBC32.dll' name 'SQLEndTran';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SQLEndTran"
  c_SQLEndTran :: Int16 -> Ptr () -> Int16 -> IO Int16
-- HandleType : SHORT -> Int16
-- Handle : void* in/out -> Ptr ()
-- CompletionType : SHORT -> Int16
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

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

(cffi:defcfun ("SQLEndTran" sqlend-tran :convention :stdcall) :int16
  (handle-type :int16)   ; SHORT
  (handle :pointer)   ; void* in/out
  (completion-type :int16))   ; SHORT
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SQLEndTran = Win32::API::More->new('ODBC32',
    'short SQLEndTran(short HandleType, LPVOID Handle, short CompletionType)');
# my $ret = $SQLEndTran->Call($HandleType, $Handle, $CompletionType);
# HandleType : SHORT -> short
# Handle : void* in/out -> LPVOID
# CompletionType : SHORT -> short
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。