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

SQLCancelHandle

関数
指定ハンドルの処理中の操作をキャンセルする。
DLLODBC32.dll呼出規約winapi

シグネチャ

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

SHORT SQLCancelHandle(
    SHORT HandleType,
    void* InputHandle
);

パラメーター

名前型方向説明
HandleTypeSHORTin[入力] 処理をキャンセルするハンドルの種類。有効な値は SQL_HANDLE_DBC または SQL_HANDLE_STMT です。
InputHandlevoid*inoutキャンセル対象のハンドル。実行中の処理を中断する。

戻り値の型: SHORT

公式ドキュメント

ほとんどの ODBC 3.8 (以降) のドライバーは、この関数を実装していることが想定されます。実装していない場合、Handle パラメーターに接続ハンドルを指定して SQLCancelHandle を呼び出すと、SQLSTATE が IM001 で 'Driver does not support this function' というメッセージを伴う SQL_ERROR が返されます。Handle パラメーターにステートメントハンドルを指定して SQLCancelHandle を呼び出した場合は、ドライバーマネージャーによって SQLCancel の呼び出しにマップされ、ドライバーが SQLCancel を実装していれば処理できます。アプリケーションは SQLGetFunctions を使用して、ドライバーが SQLCancelHandle をサポートしているかどうかを判断できます。

戻り値

SQL_SUCCESS、SQL_SUCCESS_WITH_INFO、SQL_ERROR、または SQL_INVALID_HANDLE。

解説(Remarks)

この関数は SQLCancel に似ていますが、ステートメントハンドルだけでなく、接続ハンドルまたはステートメントハンドルのいずれかをパラメーターとして受け取ることができます。HandleType が SQL_HANDLE_STMT の場合、ドライバーマネージャーは SQLCancelHandle の呼び出しを SQLCancel の呼び出しにマップします。これにより、ドライバーが SQLCancelHandle を実装していない場合でも、アプリケーションは SQLCancelHandle を使用してステートメント操作をキャンセルできます。

ステートメント操作のキャンセルの詳細については、SQLCancel Function を参照してください。

Handle に対して進行中の操作がない場合、SQLCancelHandle の呼び出しは何の効果もありません。

接続ハンドルに対する SQLCancelHandle では、次の種類の処理をキャンセルできます。

接続で非同期に実行されている関数をキャンセルするために SQLCancelHandle が呼び出された場合、SQLCancelHandle が通知する診断レコードは、キャンセル対象の操作が返す診断レコードに追加されます。ただし、別のスレッドで接続上で実行されている関数をキャンセルする場合、SQLCancelHandle は診断レコードを返しません。

SQLCancelHandle を使用して SQLEndTran をキャンセルすると、接続が中断 (suspended) 状態になることがあります。中断状態の詳細については、SQLEndTran Function を参照してください。

メモ

Windows 7 より前の Windows オペレーティングシステムに配置されるアプリケーションで SQLCancelHandle を使用する方法については、Compatibility Matrix を参照してください。

接続に関連する非同期処理のキャンセル

関数が SQL_STILL_EXECUTING を返した場合、アプリケーションは SQLCancelHandle を呼び出して操作をキャンセルできます。キャンセル要求が成功すると、SQLCancelHandle は SQL_SUCCESS を返します。これは元の関数がキャンセルされたことを意味するのではなく、キャンセル要求が処理されたことを示します。操作をいつキャンセルするか、またはキャンセルするかどうかは、ドライバーとデータソースが決定します。アプリケーションは、戻り値が SQL_STILL_EXECUTING でなくなるまで元の関数を呼び出し続ける必要があります。元の関数がキャンセルされた場合、戻り値は SQL_ERROR、SQLSTATE は HY008 (Operation canceled) になります。元の関数が通常の処理を完了した (キャンセルされなかった) 場合、戻り値は SQL_SUCCESS または SQL_SUCCESS_WITH_INFO になります。元の関数が失敗した場合は、SQL_ERROR と HY008 (Operation canceled) 以外の SQLSTATE が返されます。

別のスレッドで実行されている関数のキャンセル

マルチスレッドアプリケーションでは、アプリケーションは別のスレッドで実行されている操作をキャンセルできます。操作をキャンセルするには、アプリケーションはその関数が使用しているハンドルを指定して、別のスレッドで SQLCancelHandle を呼び出します。操作をどのようにキャンセルするかは、ドライバーとオペレーティングシステムが決定します。SQLCancelHandle の戻り値は、ドライバーが要求を処理したかどうかを示し、SQL_SUCCESS または SQL_ERROR のいずれかが返されます (診断情報は返されません)。元の関数の処理がキャンセルされた場合、元の関数は SQL_ERROR と SQLSTATE HY008 (Operation canceled) を返します。

関数の実行中に、その関数をキャンセルするために別のスレッドで SQLCancelHandle が呼び出された場合でも、キャンセルが有効になる前に関数が成功して SQL_SUCCESS を返すことがあります。SQLCancelHandle がキャンセルする前に操作が完了していた場合、SQLCancelHandle の呼び出しは何の効果もありません。

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

各言語での呼び出し定義

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

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

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

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

var (
	odbc32 = windows.NewLazySystemDLL("ODBC32.dll")
	procSQLCancelHandle = odbc32.NewProc("SQLCancelHandle")
)

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

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

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

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

let sqlcancelhandle =
  foreign "SQLCancelHandle"
    (int16_t @-> (ptr void) @-> returning int16_t)
(* HandleType : SHORT -> int16_t *)
(* InputHandle : void* in/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 ("SQLCancelHandle" sqlcancel-handle :convention :stdcall) :int16
  (handle-type :int16)   ; SHORT
  (input-handle :pointer))   ; void* in/out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SQLCancelHandle = Win32::API::More->new('ODBC32',
    'short SQLCancelHandle(short HandleType, LPVOID InputHandle)');
# my $ret = $SQLCancelHandle->Call($HandleType, $InputHandle);
# HandleType : SHORT -> short
# InputHandle : void* in/out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。