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

SQLCopyDesc

関数
記述子ハンドルの内容を別の記述子へ複写する。
DLLODBC32.dll呼出規約winapi

シグネチャ

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

SHORT SQLCopyDesc(
    void* SourceDescHandle,
    void* TargetDescHandle
);

パラメーター

名前型方向説明
SourceDescHandlevoid*inout[入力] コピー元の記述子ハンドル。
TargetDescHandlevoid*inout[入力] コピー先の記述子ハンドル。TargetDescHandle 引数には、アプリケーション記述子または IPD のハンドルを指定できます。TargetDescHandle に IRD のハンドルを設定することはできません。設定した場合、SQLCopyDesc は SQLSTATE HY016 (Cannot modify an implementation row descriptor) を返します。

戻り値の型: SHORT

公式ドキュメント

SQLCopyDesc は、ある記述子ハンドルから別の記述子ハンドルへ記述子情報をコピーします。

戻り値

SQL_SUCCESS、SQL_SUCCESS_WITH_INFO、SQL_ERROR、または SQL_INVALID_HANDLE。

解説(Remarks)

SQLCopyDesc を呼び出すと、コピー元の記述子ハンドルのフィールドがコピー先の記述子ハンドルにコピーされます。フィールドをコピーできるのはアプリケーション記述子または IPD に対してのみであり、IRD にはコピーできません。コピー元はアプリケーション記述子と実装記述子のどちらでもかまいません。

IRD からフィールドをコピーできるのは、ステートメントハンドルが準備済みまたは実行済みの状態にある場合のみです。それ以外の場合、関数は SQLSTATE HY007 (Associated statement is not prepared) を返します。

IPD からのフィールドのコピーは、ステートメントが準備されているかどうかにかかわらず可能です。動的パラメーターを含む SQL ステートメントが準備されており、IPD の自動設定がサポートされ有効になっている場合、IPD はドライバーによって設定されます。SourceDescHandle に IPD を指定して SQLCopyDesc を呼び出すと、設定されたフィールドがコピーされます。ドライバーが IPD を設定しない場合は、元々 IPD にあるフィールドの内容がコピーされます。

SQL_DESC_ALLOC_TYPE (記述子ハンドルが自動的に割り当てられたか明示的に割り当てられたかを示します) を除く記述子のすべてのフィールドが、そのフィールドがコピー先の記述子に対して定義されているかどうかにかかわらずコピーされます。コピーされたフィールドは既存のフィールドを上書きします。

SourceDescHandle 引数と TargetDescHandle 引数が同じドライバーに関連付けられている場合、たとえそれらのドライバーが 2 つの異なる接続または環境上にあっても、ドライバーはすべての記述子フィールドをコピーします。SourceDescHandle 引数と TargetDescHandle 引数が異なるドライバーに関連付けられている場合、ドライバーマネージャーは ODBC で定義されたフィールドはコピーしますが、ドライバー定義のフィールドや、その記述子の種類に対して ODBC で定義されていないフィールドはコピーしません。

エラーが発生した場合、SQLCopyDesc の呼び出しは直ちに中止されます。

SQL_DESC_DATA_PTR フィールドがコピーされるとき、コピー先の記述子に対して整合性チェックが実行されます。整合性チェックが失敗すると、SQLSTATE HY021 (Inconsistent descriptor information) が返され、SQLCopyDesc の呼び出しは直ちに中止されます。整合性チェックの詳細については、SQLSetDescRec Function の "Consistency Checks" (整合性チェック) を参照してください。

記述子ハンドルは、接続が異なる環境に属している場合であっても、接続をまたいでコピーできます。コピー元とコピー先の記述子ハンドルが同じ接続に属しておらず、かつ 2 つの接続が別々のドライバーに属していることをドライバーマネージャーが検出した場合、ドライバーマネージャーは SQLGetDescField と SQLSetDescField を使用してフィールドごとにコピーを行うことで SQLCopyDesc を実装します。

SourceDescHandle があるドライバー上にあり、TargetDescHandle が別のドライバー上にある状態で SQLCopyDesc が呼び出されると、SourceDescHandle のエラーキューがクリアされます。これは、この場合の SQLCopyDesc が SQLGetDescField と SQLSetDescField の呼び出しによって実装されるためです。

メモ

アプリケーションは、SQLCopyDesc を呼び出して一方の記述子から他方の記述子へフィールドをコピーする代わりに、明示的に割り当てた記述子ハンドルを StatementHandle に関連付けることができる場合があります。明示的に割り当てられた記述子は、SQL_ATTR_APP_ROW_DESC または SQL_ATTR_APP_PARAM_DESC ステートメント属性にその記述子のハンドルを設定することで、同じ ConnectionHandle 上の別の StatementHandle に関連付けることができます。これを行った場合、記述子のフィールド値を一方の記述子から他方の記述子へコピーするために SQLCopyDesc を呼び出す必要はありません。ただし、記述子ハンドルを別の ConnectionHandle 上の StatementHandle に関連付けることはできません。異なる ConnectionHandles 上の StatementHandles で同じ記述子のフィールド値を使用するには、SQLCopyDesc を呼び出す必要があります。

記述子ヘッダーまたはレコード内のフィールドの説明については、SQLSetDescField Function を参照してください。記述子の詳細については、Descriptors を参照してください。

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

各言語での呼び出し定義

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

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

SQLCopyDesc = ctypes.windll.odbc32.SQLCopyDesc
SQLCopyDesc.restype = ctypes.c_short
SQLCopyDesc.argtypes = [
    ctypes.POINTER(None),  # SourceDescHandle : void* in/out
    ctypes.POINTER(None),  # TargetDescHandle : void* in/out
]
require 'fiddle'
require 'fiddle/import'

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

var (
	odbc32 = windows.NewLazySystemDLL("ODBC32.dll")
	procSQLCopyDesc = odbc32.NewProc("SQLCopyDesc")
)

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

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

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

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