SQLSetCursorName

関数

ステートメントにカーソル名を設定する。

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

シグネチャ

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

SHORT SQLSetCursorName(
    void* StatementHandle,
    BYTE* CursorName,
    SHORT NameLength
);

パラメーター

名前	型	方向	説明
StatementHandle	void*	inout	[入力] ステートメントハンドル。
CursorName	BYTE*	in	[入力] カーソル名。効率的に処理するため、カーソル名の先頭および末尾にスペースを含めないようにし、カーソル名に区切り識別子が含まれる場合は、区切り文字をカーソル名の先頭の文字に配置してください。
NameLength	SHORT	in	[入力] *CursorName の文字数単位の長さ。

戻り値の型: SHORT

公式ドキュメント

SQLSetCursorName は、カーソル名をアクティブなステートメントに関連付けます。アプリケーションが SQLSetCursorName を呼び出さない場合、ドライバーは SQL ステートメントの処理に必要なカーソル名を生成します。

戻り値

SQL_SUCCESS、SQL_SUCCESS_WITH_INFO、SQL_ERROR、または SQL_INVALID_HANDLE。

解説(Remarks)

カーソル名は、位置指定の更新ステートメントおよび削除ステートメントでのみ使用されます (例: UPDATE table-name ...WHERE CURRENT OF cursor-name)。詳細については、Positioned Update and Delete Statements を参照してください。アプリケーションが SQLSetCursorName を呼び出してカーソル名を定義しない場合、クエリステートメントの実行時に、ドライバーは SQL_CUR で始まり、長さが 18 文字を超えない名前を生成します。

接続内のすべてのカーソル名は一意である必要があります。カーソル名の最大長はドライバーによって定義されます。相互運用性を最大にするため、アプリケーションではカーソル名を 18 文字以内に制限することをお勧めします。ODBC 3*.x* では、カーソル名が引用符付き識別子の場合、大文字と小文字が区別されて扱われ、空白や予約キーワードなど、SQL の構文では許可されない文字や特別に扱われる文字を含めることができます。カーソル名を大文字と小文字を区別して扱う必要がある場合は、引用符付き識別子として渡す必要があります。

明示的または暗黙的に設定されたカーソル名は、関連付けられたステートメントが SQLFreeHandle によって破棄されるまで有効です。カーソルが割り当て済みまたは準備済みの状態にある限り、SQLSetCursorName を呼び出してステートメント上のカーソルの名前を変更できます。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 SQLSetCursorName(
    void* StatementHandle,
    BYTE* CursorName,
    SHORT NameLength
);

[DllImport("ODBC32.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern short SQLSetCursorName(
    IntPtr StatementHandle,   // void* in/out
    IntPtr CursorName,   // BYTE*
    short NameLength   // SHORT
);

<DllImport("ODBC32.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function SQLSetCursorName(
    StatementHandle As IntPtr,   ' void* in/out
    CursorName As IntPtr,   ' BYTE*
    NameLength As Short   ' SHORT
) As Short
End Function

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

import ctypes
from ctypes import wintypes

SQLSetCursorName = ctypes.windll.odbc32.SQLSetCursorName
SQLSetCursorName.restype = ctypes.c_short
SQLSetCursorName.argtypes = [
    ctypes.POINTER(None),  # StatementHandle : void* in/out
    ctypes.POINTER(ctypes.c_ubyte),  # CursorName : BYTE*
    ctypes.c_short,  # NameLength : SHORT
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ODBC32.dll')
SQLSetCursorName = Fiddle::Function.new(
  lib['SQLSetCursorName'],
  [
    Fiddle::TYPE_VOIDP,  # StatementHandle : void* in/out
    Fiddle::TYPE_VOIDP,  # CursorName : BYTE*
    Fiddle::TYPE_SHORT,  # NameLength : SHORT
  ],
  Fiddle::TYPE_SHORT)

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

$sig = @"
[DllImport("ODBC32.dll", CharSet = CharSet.Ansi)]
public static extern short SQLSetCursorName(IntPtr StatementHandle, IntPtr CursorName, short NameLength);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ODBC32_SQLSetCursorName' -Namespace Win32 -PassThru
# $api::SQLSetCursorName(StatementHandle, CursorName, NameLength)

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

出力引数:

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