SQLExecDirect

関数

SQL文を準備せず直接実行する。

DLLODBC32.dll文字セットANSI (-A)呼出規約winapi

シグネチャ

// ODBC32.dll  (ANSI / -A)
#include <windows.h>

SHORT SQLExecDirect(
    void* StatementHandle,
    BYTE* StatementText,   // optional
    INT TextLength
);

パラメーター

名前	型	方向	説明
StatementHandle	void*	inout	[入力] ステートメントハンドル。
StatementText	BYTE*	inoptional	[入力] 実行する SQL ステートメント。
TextLength	INT	in	[入力] *StatementText の長さ (文字数)。

戻り値の型: SHORT

公式ドキュメント

SQLExecDirect は、ステートメントにパラメーターが存在する場合はパラメーターマーカー変数の現在の値を使用して、準備可能なステートメントを実行します。SQLExecDirect は、1 回限りの実行のために SQL ステートメントを送信する最も高速な方法です。

戻り値

SQL_SUCCESS、SQL_SUCCESS_WITH_INFO、SQL_NEED_DATA、SQL_STILL_EXECUTING、SQL_ERROR、SQL_NO_DATA、SQL_INVALID_HANDLE、または SQL_PARAM_DATA_AVAILABLE。

解説(Remarks)

データソースに SQL ステートメントを送信するには、SQLExecDirect を呼び出します。直接実行の詳細については、直接実行を参照してください。ドライバーは、データソースが使用する SQL の形式になるようにステートメントを変更したうえで、データソースに送信します。特にドライバーは、SQL で特定の機能を定義するために使用されるエスケープシーケンスを変更します。エスケープシーケンスの構文については、ODBC のエスケープシーケンスを参照してください。

SQL ステートメントには、1 つ以上のパラメーターマーカーを含めることができます。パラメーターマーカーを含めるには、SQL ステートメントの適切な位置に疑問符 (?) を埋め込みます。パラメーターの詳細については、ステートメントのパラメーターを参照してください。

結果セットを返す SQLExecDirect の呼び出し (SELECT ステートメントなど) に成功すると、ステートメントハンドルは結果セットの最初の行の手前に位置付けられます。その後、SQLFetch または SQLFetchScroll を呼び出して行を取得するか、SQLRowCount を呼び出して INSERT、UPDATE、DELETE ステートメントの影響を受けた行数を調べることができます。

SQL ステートメントが SELECT ステートメントであり、SQLSetCursorName を呼び出してカーソルをステートメントに関連付けている場合、ドライバーは指定されたカーソルを使用します。それ以外の場合、ドライバーはカーソル名を生成します。

データソースが手動コミットモード (トランザクションの明示的な開始が必要) であり、トランザクションがまだ開始されていない場合、ドライバーは SQL ステートメントを送信する前にトランザクションを開始します。詳細については、手動コミットモードを参照してください。

SQLExecDirect を使用して COMMIT または ROLLBACK ステートメントを送信した場合、DBMS 製品間での相互運用性はありません。トランザクションをコミットまたはロールバックするには、SQLEndTran を呼び出してください。

SQLExecDirect が実行時データ (data-at-execution) パラメーターを検出した場合は、SQL_NEED_DATA を返します。SQLParamData および SQLPutData を使用してデータを送信してください。SQLBindParameter、SQLParamData、SQLPutData、および長いデータの送信を参照してください。

SQLExecDirect が、データソースのどの行にも影響しない検索条件付きの更新、挿入、削除ステートメントを実行した場合、SQLExecDirect の呼び出しは SQL_NO_DATA を返します。

SQL_ATTR_PARAMSET_SIZE ステートメント属性の値が 1 より大きく、SQL ステートメントに少なくとも 1 つのパラメーターマーカーが含まれている場合、SQLExecDirect は、SQLBindParameter の呼び出しで ParameterValuePointer 引数が指す配列に含まれる各パラメーター値のセットに対して、SQL ステートメントを 1 回ずつ実行します。詳細については、パラメーター値の配列を参照してください。

ブックマークが有効になっている状態で、ブックマークをサポートできないクエリが実行された場合、ドライバーは属性値を変更して SQLSTATE 01S02 (オプション値が変更されました) を返すことにより、ブックマークをサポートする環境に強制することを試みる必要があります。属性を変更できない場合、ドライバーは SQLSTATE HY024 (属性値が無効です) を返す必要があります。

メモ

接続プーリングを使用する場合は、データソースが使用するカタログを変更する SQL Server の USE database ステートメントのように、データベースまたはデータベースのコンテキストを変更する SQL ステートメントを実行しないでください。

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

各言語での呼び出し定義

// ODBC32.dll  (ANSI / -A)
#include <windows.h>

SHORT SQLExecDirect(
    void* StatementHandle,
    BYTE* StatementText,   // optional
    INT TextLength
);

[DllImport("ODBC32.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern short SQLExecDirect(
    IntPtr StatementHandle,   // void* in/out
    IntPtr StatementText,   // BYTE* optional
    int TextLength   // INT
);

<DllImport("ODBC32.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function SQLExecDirect(
    StatementHandle As IntPtr,   ' void* in/out
    StatementText As IntPtr,   ' BYTE* optional
    TextLength As Integer   ' INT
) As Short
End Function

' StatementHandle : void* in/out
' StatementText : BYTE* optional
' TextLength : INT
Declare PtrSafe Function SQLExecDirect Lib "odbc32" ( _
    ByVal StatementHandle As LongPtr, _
    ByVal StatementText As LongPtr, _
    ByVal TextLength As Long) As Integer
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

SQLExecDirect = ctypes.windll.odbc32.SQLExecDirect
SQLExecDirect.restype = ctypes.c_short
SQLExecDirect.argtypes = [
    ctypes.POINTER(None),  # StatementHandle : void* in/out
    ctypes.POINTER(ctypes.c_ubyte),  # StatementText : BYTE* optional
    ctypes.c_int,  # TextLength : INT
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ODBC32.dll')
SQLExecDirect = Fiddle::Function.new(
  lib['SQLExecDirect'],
  [
    Fiddle::TYPE_VOIDP,  # StatementHandle : void* in/out
    Fiddle::TYPE_VOIDP,  # StatementText : BYTE* optional
    Fiddle::TYPE_INT,  # TextLength : INT
  ],
  Fiddle::TYPE_SHORT)

#[link(name = "odbc32")]
extern "system" {
    fn SQLExecDirect(
        StatementHandle: *mut (),  // void* in/out
        StatementText: *mut u8,  // BYTE* optional
        TextLength: i32  // INT
    ) -> i16;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("ODBC32.dll", CharSet = CharSet.Ansi)]
public static extern short SQLExecDirect(IntPtr StatementHandle, IntPtr StatementText, int TextLength);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ODBC32_SQLExecDirect' -Namespace Win32 -PassThru
# $api::SQLExecDirect(StatementHandle, StatementText, TextLength)

#uselib "ODBC32.dll"
#func global SQLExecDirect "SQLExecDirect" sptr, sptr, sptr
; SQLExecDirect StatementHandle, varptr(StatementText), TextLength   ; 戻り値は stat
; StatementHandle : void* in/out -> "sptr"
; StatementText : BYTE* optional -> "sptr"
; TextLength : INT -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "ODBC32.dll"
#cfunc global SQLExecDirect "SQLExecDirect" sptr, var, int
; res = SQLExecDirect(StatementHandle, StatementText, TextLength)
; StatementHandle : void* in/out -> "sptr"
; StatementText : BYTE* optional -> "var"
; TextLength : INT -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "ODBC32.dll"
#cfunc global SQLExecDirect "SQLExecDirect" sptr, sptr, int
; res = SQLExecDirect(StatementHandle, varptr(StatementText), TextLength)
; StatementHandle : void* in/out -> "sptr"
; StatementText : BYTE* optional -> "sptr"
; TextLength : INT -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。