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

SQLSetEnvAttr

関数
環境属性に値を設定する。
DLLODBC32.dll呼出規約winapi

シグネチャ

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

SHORT SQLSetEnvAttr(
    void* EnvironmentHandle,
    INT Attribute,
    void* Value,   // optional
    INT StringLength
);

パラメーター

名前型方向説明
EnvironmentHandlevoid*inout[入力] 環境ハンドル。
AttributeINTin[入力] 設定する属性。「解説」に一覧があります。
Valuevoid*inoptional設定する属性値。整数または文字列バッファへのポインタ。
StringLengthINTin

[入力] ValuePtr が文字列またはバイナリバッファーを指す場合、この引数は *ValuePtr の長さである必要があります。文字列データの場合、この引数には文字列のバイト数を指定します。

ValuePtr が整数の場合、StringLength は無視されます。

戻り値の型: SHORT

公式ドキュメント

SQLSetEnvAttr は、環境の各種動作を制御する属性を設定します。

戻り値

SQL_SUCCESS、SQL_SUCCESS_WITH_INFO、SQL_ERROR、または SQL_INVALID_HANDLE。

解説(Remarks)

アプリケーションが SQLSetEnvAttr を呼び出せるのは、その環境に接続ハンドルが 1 つも割り当てられていない場合のみです。アプリケーションがその環境に対して正常に設定したすべての環境属性は、その環境に対して SQLFreeHandle が呼び出されるまで保持されます。ODBC 3.x では、複数の環境ハンドルを同時に割り当てることができます。

ValuePtr を通じて設定される情報の形式は、指定した Attribute によって異なります。SQLSetEnvAttr は、属性情報を null で終わる文字列または 32 ビット整数値のいずれかの形式で受け取ります。それぞれの形式は、各属性の説明に記載されています。

ドライバー固有の環境属性はありません。

接続属性は SQLSetEnvAttr の呼び出しでは設定できません。設定しようとすると、SQLSTATE HY092 (無効な属性/オプション識別子) が返されます。

Attribute ValuePtr の内容
SQL_ATTR_CONNECTION_POOLING (ODBC 3.8) 環境レベルで接続プーリングを有効または無効にする 32 ビットの SQLUINTEGER 値です。次の値を使用します。

SQL_CP_OFF = 接続プーリングを無効にします。これが既定値です。

SQL_CP_ONE_PER_DRIVER = ドライバーごとに 1 つの接続プールがサポートされます。プール内のすべての接続は 1 つのドライバーに関連付けられます。

SQL_CP_ONE_PER_HENV = 環境ごとに 1 つの接続プールがサポートされます。プール内のすべての接続は 1 つの環境に関連付けられます。

SQL_CP_DRIVER_AWARE = ドライバーが接続プール対応機能を備えている場合は、その機能を使用します。ドライバーが接続プール対応をサポートしていない場合、SQL_CP_DRIVER_AWARE は無視され、SQL_CP_ONE_PER_HENV が使用されます。詳細については、Driver-Aware Connection Pooling を参照してください。接続プール対応をサポートするドライバーとサポートしないドライバーが混在する環境では、SQL_CP_DRIVER_AWARE によってサポートするドライバーで接続プール対応機能を有効にできますが、サポートしないドライバーでは SQL_CP_ONE_PER_HENV を設定した場合と同じ動作になります。

接続プーリングは、SQLSetEnvAttr を呼び出して SQL_ATTR_CONNECTION_POOLING 属性を SQL_CP_ONE_PER_DRIVER または SQL_CP_ONE_PER_HENV に設定することで有効になります。この呼び出しは、接続プーリングを有効にする対象の共有環境をアプリケーションが割り当てる前に行う必要があります。SQLSetEnvAttr の呼び出しでは環境ハンドルに null を設定します。これにより、SQL_ATTR_CONNECTION_POOLING はプロセスレベルの属性になります。接続プーリングを有効にした後、アプリケーションは InputHandle 引数に SQL_HANDLE_ENV を指定して SQLAllocHandle を呼び出し、暗黙の共有環境を割り当てます。

接続プーリングが有効になり、アプリケーションに対して共有環境が選択された後は、その環境に対して SQL_ATTR_CONNECTION_POOLING を再設定することはできません。これは、この属性の設定時に SQLSetEnvAttr が null の環境ハンドルで呼び出されるためです。共有環境で接続プーリングが既に有効になっている状態でこの属性を設定した場合、その属性は以降に割り当てられる共有環境にのみ影響します。

接続プーリングは環境単位で有効にすることもできます。環境の接続プーリングについては、次の点に注意してください。

- NULL ハンドルに対して接続プーリングを有効にすることは、プロセスレベルの属性です。以降に割り当てられる環境は共有環境となり、プロセスレベルの接続プーリング設定を継承します。
- 環境の割り当て後も、アプリケーションはその接続プール設定を変更できます。
- 環境の接続プーリングが有効で、かつ接続のドライバーがドライバープーリングを使用する場合は、環境のプーリングが優先されます。

SQL_ATTR_CONNECTION_POOLING はドライバーマネージャーの内部で実装されています。ドライバーが SQL_ATTR_CONNECTION_POOLING を実装する必要はありません。ODBC 2.0 および 3.0 のアプリケーションは、この環境属性を設定できます。

詳細については、ODBC Connection Pooling を参照してください。
SQL_ATTR_CP_MATCH (ODBC 3.0) 接続プールから接続をどのように選択するかを決定する 32 ビットの SQLUINTEGER 値です。SQLConnect または SQLDriverConnect が呼び出されると、ドライバーマネージャーはプール内のどの接続を再利用するかを決定します。ドライバーマネージャーは、呼び出し時の接続オプションおよびアプリケーションが設定した接続属性を、プール内の接続のキーワードおよび接続属性と照合しようとします。この属性の値によって、照合条件の厳密さのレベルが決まります。

この属性の値を設定するには、次の値を使用します。

SQL_CP_STRICT_MATCH = 呼び出し時の接続オプションおよびアプリケーションが設定した接続属性に完全に一致する接続のみが再利用されます。これが既定値です。

SQL_CP_RELAXED_MATCH = 接続文字列のキーワードが一致する接続を使用できます。キーワードは一致する必要がありますが、すべての接続属性が一致する必要はありません。

プールされた接続に接続する際にドライバーマネージャーが照合を行う方法の詳細については、SQLConnect を参照してください。接続プーリングの詳細については、ODBC Connection Pooling を参照してください。
SQL_ATTR_ODBC_VERSION (ODBC 3.0) 特定の機能が ODBC 2.x の動作を示すか、ODBC 3.x の動作を示すかを決定する 32 ビット整数です。この属性の値を設定するには、次の値を使用します。

SQL_OV_ODBC3_80 = ドライバーマネージャーとドライバーは、次の ODBC 3.8 の動作を示します。

- ドライバーは、日付、時刻、タイムスタンプについて ODBC 3.x のコードを返し、また期待します。
- SQLError、SQLGetDiagField、または SQLGetDiagRec が呼び出されると、ドライバーは ODBC 3.x の SQLSTATE コードを返します。
- SQLTables の呼び出しにおける CatalogName 引数は検索パターンを受け付けます。
- ドライバーマネージャーは C データ型の拡張性をサポートします。C データ型の拡張性の詳細については、C Data Types in ODBC を参照してください。

詳細については、What's New in ODBC 3.8 を参照してください。

SQL_OV_ODBC3 = ドライバーマネージャーとドライバーは、次の ODBC 3.x の動作を示します。

- ドライバーは、日付、時刻、タイムスタンプについて ODBC 3.x のコードを返し、また期待します。
- SQLError、SQLGetDiagField、または SQLGetDiagRec が呼び出されると、ドライバーは ODBC 3.x の SQLSTATE コードを返します。
- SQLTables の呼び出しにおける CatalogName 引数は検索パターンを受け付けます。
- ドライバーマネージャーは C データ型の拡張性をサポートしません。

SQL_OV_ODBC2 = ドライバーマネージャーとドライバーは、次の ODBC 2.x の動作を示します。これは、ODBC 3.x ドライバーを使用する ODBC 2.x アプリケーションで特に有用です。

- ドライバーは、日付、時刻、タイムスタンプについて ODBC 2.x のコードを返し、また期待します。
- SQLError、SQLGetDiagField、または SQLGetDiagRec が呼び出されると、ドライバーは ODBC 2.x の SQLSTATE コードを返します。
- SQLTables の呼び出しにおける CatalogName 引数は検索パターンを受け付けません。
- ドライバーマネージャーは C データ型の拡張性をサポートしません。

アプリケーションは、SQLHENV 引数を持つ関数を呼び出す前に、この環境属性を設定する必要があります。設定しない場合、その呼び出しは SQLSTATE HY010 (関数シーケンスエラー) を返します。これらの環境フラグに追加の動作があるかどうかは、ドライバー固有です。

- 詳細については、Declaring the Application's ODBC Version および Behavioral Changes を参照してください。
SQL_ATTR_OUTPUT_NTS (ODBC 3.0) ドライバーが文字列データをどのように返すかを決定する 32 ビット整数です。SQL_TRUE の場合、ドライバーは null で終わる文字列データを返します。SQL_FALSE の場合、ドライバーは文字列データを null 終端では返しません。

この属性の既定値は SQL_TRUE です。SQL_TRUE に設定する SQLSetEnvAttr の呼び出しは SQL_SUCCESS を返します。SQL_FALSE に設定する SQLSetEnvAttr の呼び出しは SQL_ERROR と SQLSTATE HYC00 (オプション機能は実装されていません) を返します。
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp)

各言語での呼び出し定義

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

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

SQLSetEnvAttr = ctypes.windll.odbc32.SQLSetEnvAttr
SQLSetEnvAttr.restype = ctypes.c_short
SQLSetEnvAttr.argtypes = [
    ctypes.POINTER(None),  # EnvironmentHandle : void* in/out
    ctypes.c_int,  # Attribute : INT
    ctypes.POINTER(None),  # Value : void* optional
    ctypes.c_int,  # StringLength : INT
]
require 'fiddle'
require 'fiddle/import'

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

var (
	odbc32 = windows.NewLazySystemDLL("ODBC32.dll")
	procSQLSetEnvAttr = odbc32.NewProc("SQLSetEnvAttr")
)

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

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

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

let sqlsetenvattr =
  foreign "SQLSetEnvAttr"
    ((ptr void) @-> int32_t @-> (ptr void) @-> int32_t @-> returning int16_t)
(* EnvironmentHandle : void* in/out -> (ptr void) *)
(* Attribute : INT -> int32_t *)
(* Value : void* optional -> (ptr void) *)
(* StringLength : 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 ("SQLSetEnvAttr" sqlset-env-attr :convention :stdcall) :int16
  (environment-handle :pointer)   ; void* in/out
  (attribute :int32)   ; INT
  (value :pointer)   ; void* optional
  (string-length :int32))   ; INT
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SQLSetEnvAttr = Win32::API::More->new('ODBC32',
    'short SQLSetEnvAttr(LPVOID EnvironmentHandle, int Attribute, LPVOID Value, int StringLength)');
# my $ret = $SQLSetEnvAttr->Call($EnvironmentHandle, $Attribute, $Value, $StringLength);
# EnvironmentHandle : void* in/out -> LPVOID
# Attribute : INT -> int
# Value : void* optional -> LPVOID
# StringLength : INT -> int
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。