SQLAllocHandle
関数シグネチャ
// ODBC32.dll
#include <windows.h>
SHORT SQLAllocHandle(
SHORT HandleType,
void* InputHandle,
void** OutputHandle
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| HandleType | SHORT | in | [入力] SQLAllocHandle によって割り当てられるハンドルの種類。次のいずれかの値である必要があります。 SQL_HANDLE_DBC_INFO_TOKEN ハンドルは、ドライバーマネージャーとドライバーのみが使用します。アプリケーションでこのハンドルの種類を使用しないでください。SQL_HANDLE_DBC_INFO_TOKEN の詳細については、Developing Connection-Pool Awareness in an ODBC Driver を参照してください。 |
| InputHandle | void* | inout | [入力] 新しいハンドルを割り当てるコンテキストとなる入力ハンドル。HandleType が SQL_HANDLE_ENV の場合、これは SQL_NULL_HANDLE です。HandleType が SQL_HANDLE_DBC の場合は環境ハンドルである必要があり、SQL_HANDLE_STMT または SQL_HANDLE_DESC の場合は接続ハンドルである必要があります。 |
| OutputHandle | void** | out | 確保されたハンドルを受け取る出力ポインタ。 |
戻り値の型: SHORT
公式ドキュメント
SQLAllocHandle は、環境、接続、ステートメント、または記述子のハンドルを割り当てます。
戻り値
SQL_SUCCESS、SQL_SUCCESS_WITH_INFO、SQL_INVALID_HANDLE、または SQL_ERROR。
環境ハンドル以外のハンドルを割り当てる際に SQLAllocHandle が SQL_ERROR を返した場合、出力引数が null ポインターでない限り、HandleType の値に応じて OutputHandlePtr に SQL_NULL_HDBC、SQL_NULL_HSTMT、または SQL_NULL_HDESC が設定されます。アプリケーションはその後、InputHandle 引数のハンドルに関連付けられた診断データ構造体から追加情報を取得できます。
解説(Remarks)
SQLAllocHandle は、以下のセクションで説明するように、環境、接続、ステートメント、および記述子のハンドルを割り当てるために使用します。ハンドルに関する一般的な情報については、Handles を参照してください。
ドライバーが複数の割り当てをサポートしている場合、アプリケーションは一度に複数の環境、接続、またはステートメントのハンドルを割り当てることができます。ODBC では、同時に割り当てられる環境、接続、ステートメント、または記述子のハンドルの数に制限は定義されていません。ドライバーは、一度に割り当て可能な特定の種類のハンドルの数に制限を設ける場合があります。詳細については、ドライバーのドキュメントを参照してください。
アプリケーションが、既に存在する環境、接続、ステートメント、または記述子のハンドルを *OutputHandlePtr に設定して SQLAllocHandle を呼び出した場合、アプリケーションが接続プールを使用しているとき (このセクションの後半の "Allocating an Environment Attribute for Connection Pooling" を参照) を除いて、ドライバーはその handle に関連付けられた情報を上書きします。ドライバーマネージャーは、*OutputHandlePtr に指定された handle が既に使用されているかどうかを確認せず、上書きする前にハンドルの以前の内容を確認することもありません。
同じアプリケーション変数を *OutputHandlePtr に指定して SQLAllocHandle を 2 回呼び出す際に、再割り当ての前に SQLFreeHandle を呼び出してハンドルを解放しないのは、ODBC アプリケーションのプログラミングとして誤りです。このような方法で ODBC ハンドルを上書きすると、ODBC ドライバー側で一貫性のない動作やエラーが発生する可能性があります。
複数のスレッドをサポートするオペレーティングシステムでは、アプリケーションは同じ環境、接続、ステートメント、または記述子のハンドルを異なるスレッドで使用できます。そのため、ドライバーはこの情報への安全なマルチスレッドアクセスをサポートする必要があります。これを実現する方法の一例としては、クリティカルセクションやセマフォの使用が挙げられます。スレッド処理の詳細については、Multithreading を参照してください。
SQLAllocHandle は、環境ハンドルを割り当てるために呼び出されたときに SQL_ATTR_ODBC_VERSION 環境属性を設定しません。この環境属性はアプリケーションが設定する必要があります。設定しない場合、接続ハンドルを割り当てるために SQLAllocHandle が呼び出されたときに SQLSTATE HY010 (関数シーケンスエラー) が返されます。
標準に準拠したアプリケーションでは、SQLAllocHandle はコンパイル時に SQLAllocHandleStd にマップされます。この 2 つの関数の違いは、SQLAllocHandleStd が HandleType 引数に SQL_HANDLE_ENV を設定して呼び出されたときに、SQL_ATTR_ODBC_VERSION 環境属性を SQL_OV_ODBC3 に設定する点です。これは、標準に準拠したアプリケーションが常に ODBC 3.x アプリケーションであるためです。さらに、標準ではアプリケーションのバージョンを登録することは要求されていません。これがこの 2 つの関数の唯一の違いであり、それ以外は同一です。SQLAllocHandleStd は、ドライバーマネージャー内部で SQLAllocHandle にマップされます。そのため、サードパーティのドライバーが SQLAllocHandleStd を実装する必要はありません。
ODBC 3.8 アプリケーションでは、次のようにしてください。
環境ハンドルを割り当てるには、SQLAllocHandleStd ではなく SQLAllocHandle を使用します。
SQLSetEnvAttr を使用して、SQL_ATTR_ODBC_VERSION 環境属性を SQL_OV_ODBC3_80 に設定します。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp)
各言語での呼び出し定義
// ODBC32.dll
#include <windows.h>
SHORT SQLAllocHandle(
SHORT HandleType,
void* InputHandle,
void** OutputHandle
);[DllImport("ODBC32.dll", ExactSpelling = true)]
static extern short SQLAllocHandle(
short HandleType, // SHORT
IntPtr InputHandle, // void* in/out
IntPtr OutputHandle // void** out
);<DllImport("ODBC32.dll", ExactSpelling:=True)>
Public Shared Function SQLAllocHandle(
HandleType As Short, ' SHORT
InputHandle As IntPtr, ' void* in/out
OutputHandle As IntPtr ' void** out
) As Short
End Function' HandleType : SHORT
' InputHandle : void* in/out
' OutputHandle : void** out
Declare PtrSafe Function SQLAllocHandle Lib "odbc32" ( _
ByVal HandleType As Integer, _
ByVal InputHandle As LongPtr, _
ByVal OutputHandle As LongPtr) As Integer
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
SQLAllocHandle = ctypes.windll.odbc32.SQLAllocHandle
SQLAllocHandle.restype = ctypes.c_short
SQLAllocHandle.argtypes = [
ctypes.c_short, # HandleType : SHORT
ctypes.POINTER(None), # InputHandle : void* in/out
ctypes.c_void_p, # OutputHandle : void** out
]require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('ODBC32.dll')
SQLAllocHandle = Fiddle::Function.new(
lib['SQLAllocHandle'],
[
Fiddle::TYPE_SHORT, # HandleType : SHORT
Fiddle::TYPE_VOIDP, # InputHandle : void* in/out
Fiddle::TYPE_VOIDP, # OutputHandle : void** out
],
Fiddle::TYPE_SHORT)#[link(name = "odbc32")]
extern "system" {
fn SQLAllocHandle(
HandleType: i16, // SHORT
InputHandle: *mut (), // void* in/out
OutputHandle: *mut *mut () // void** out
) -> i16;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[DllImport("ODBC32.dll")]
public static extern short SQLAllocHandle(short HandleType, IntPtr InputHandle, IntPtr OutputHandle);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ODBC32_SQLAllocHandle' -Namespace Win32 -PassThru
# $api::SQLAllocHandle(HandleType, InputHandle, OutputHandle)#uselib "ODBC32.dll"
#func global SQLAllocHandle "SQLAllocHandle" sptr, sptr, sptr
; SQLAllocHandle HandleType, InputHandle, OutputHandle ; 戻り値は stat
; HandleType : SHORT -> "sptr"
; InputHandle : void* in/out -> "sptr"
; OutputHandle : void** out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "ODBC32.dll"
#cfunc global SQLAllocHandle "SQLAllocHandle" int, sptr, sptr
; res = SQLAllocHandle(HandleType, InputHandle, OutputHandle)
; HandleType : SHORT -> "int"
; InputHandle : void* in/out -> "sptr"
; OutputHandle : void** out -> "sptr"; SHORT SQLAllocHandle(SHORT HandleType, void* InputHandle, void** OutputHandle)
#uselib "ODBC32.dll"
#cfunc global SQLAllocHandle "SQLAllocHandle" int, intptr, intptr
; res = SQLAllocHandle(HandleType, InputHandle, OutputHandle)
; HandleType : SHORT -> "int"
; InputHandle : void* in/out -> "intptr"
; OutputHandle : void** out -> "intptr"import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
odbc32 = windows.NewLazySystemDLL("ODBC32.dll")
procSQLAllocHandle = odbc32.NewProc("SQLAllocHandle")
)
// HandleType (SHORT), InputHandle (void* in/out), OutputHandle (void** out)
r1, _, err := procSQLAllocHandle.Call(
uintptr(HandleType),
uintptr(InputHandle),
uintptr(OutputHandle),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // SHORTfunction SQLAllocHandle(
HandleType: Smallint; // SHORT
InputHandle: Pointer; // void* in/out
OutputHandle: Pointer // void** out
): Smallint; stdcall;
external 'ODBC32.dll' name 'SQLAllocHandle';result := DllCall("ODBC32\SQLAllocHandle"
, "Short", HandleType ; SHORT
, "Ptr", InputHandle ; void* in/out
, "Ptr", OutputHandle ; void** out
, "Short") ; return: SHORT●SQLAllocHandle(HandleType, InputHandle, OutputHandle) = DLL("ODBC32.dll", "int SQLAllocHandle(int, void*, void*)")
# 呼び出し: SQLAllocHandle(HandleType, InputHandle, OutputHandle)
# HandleType : SHORT -> "int"
# InputHandle : void* in/out -> "void*"
# OutputHandle : void** out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "odbc32" fn SQLAllocHandle(
HandleType: i16, // SHORT
InputHandle: ?*anyopaque, // void* in/out
OutputHandle: ?*anyopaque // void** out
) callconv(std.os.windows.WINAPI) i16;proc SQLAllocHandle(
HandleType: int16, # SHORT
InputHandle: pointer, # void* in/out
OutputHandle: pointer # void** out
): int16 {.importc: "SQLAllocHandle", stdcall, dynlib: "ODBC32.dll".}pragma(lib, "odbc32");
extern(Windows)
short SQLAllocHandle(
short HandleType, // SHORT
void* InputHandle, // void* in/out
void** OutputHandle // void** out
);ccall((:SQLAllocHandle, "ODBC32.dll"), stdcall, Int16,
(Int16, Ptr{Cvoid}, Ptr{Cvoid}),
HandleType, InputHandle, OutputHandle)
# HandleType : SHORT -> Int16
# InputHandle : void* in/out -> Ptr{Cvoid}
# OutputHandle : void** out -> Ptr{Cvoid}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
int16_t SQLAllocHandle(
int16_t HandleType,
void* InputHandle,
void** OutputHandle);
]]
local odbc32 = ffi.load("odbc32")
-- odbc32.SQLAllocHandle(HandleType, InputHandle, OutputHandle)
-- HandleType : SHORT
-- InputHandle : void* in/out
-- OutputHandle : void** out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('ODBC32.dll');
const SQLAllocHandle = lib.func('__stdcall', 'SQLAllocHandle', 'int16_t', ['int16_t', 'void *', 'void *']);
// SQLAllocHandle(HandleType, InputHandle, OutputHandle)
// HandleType : SHORT -> 'int16_t'
// InputHandle : void* in/out -> 'void *'
// OutputHandle : void** out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("ODBC32.dll", {
SQLAllocHandle: { parameters: ["i16", "pointer", "pointer"], result: "i16" },
});
// lib.symbols.SQLAllocHandle(HandleType, InputHandle, OutputHandle)
// HandleType : SHORT -> "i16"
// InputHandle : void* in/out -> "pointer"
// OutputHandle : void** out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
int16_t SQLAllocHandle(
int16_t HandleType,
void* InputHandle,
void** OutputHandle);
C, "ODBC32.dll");
// $ffi->SQLAllocHandle(HandleType, InputHandle, OutputHandle);
// HandleType : SHORT
// InputHandle : void* in/out
// OutputHandle : void** 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 SQLAllocHandle(
short HandleType, // SHORT
Pointer InputHandle, // void* in/out
Pointer OutputHandle // void** out
);
}@[Link("odbc32")]
lib LibODBC32
fun SQLAllocHandle = SQLAllocHandle(
HandleType : Int16, # SHORT
InputHandle : Void*, # void* in/out
OutputHandle : Void** # void** out
) : Int16
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef SQLAllocHandleNative = Int16 Function(Int16, Pointer<Void>, Pointer<Void>);
typedef SQLAllocHandleDart = int Function(int, Pointer<Void>, Pointer<Void>);
final SQLAllocHandle = DynamicLibrary.open('ODBC32.dll')
.lookupFunction<SQLAllocHandleNative, SQLAllocHandleDart>('SQLAllocHandle');
// HandleType : SHORT -> Int16
// InputHandle : void* in/out -> Pointer<Void>
// OutputHandle : void** out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function SQLAllocHandle(
HandleType: Smallint; // SHORT
InputHandle: Pointer; // void* in/out
OutputHandle: Pointer // void** out
): Smallint; stdcall;
external 'ODBC32.dll' name 'SQLAllocHandle';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "SQLAllocHandle"
c_SQLAllocHandle :: Int16 -> Ptr () -> Ptr () -> IO Int16
-- HandleType : SHORT -> Int16
-- InputHandle : void* in/out -> Ptr ()
-- OutputHandle : void** out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let sqlallochandle =
foreign "SQLAllocHandle"
(int16_t @-> (ptr void) @-> (ptr void) @-> returning int16_t)
(* HandleType : SHORT -> int16_t *)
(* InputHandle : void* in/out -> (ptr void) *)
(* OutputHandle : void** 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 ("SQLAllocHandle" sqlalloc-handle :convention :stdcall) :int16
(handle-type :int16) ; SHORT
(input-handle :pointer) ; void* in/out
(output-handle :pointer)) ; void** out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $SQLAllocHandle = Win32::API::More->new('ODBC32',
'short SQLAllocHandle(short HandleType, LPVOID InputHandle, LPVOID OutputHandle)');
# my $ret = $SQLAllocHandle->Call($HandleType, $InputHandle, $OutputHandle);
# HandleType : SHORT -> short
# InputHandle : void* in/out -> LPVOID
# OutputHandle : void** out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。