SQLGetDiagField

関数

診断レコードの指定フィールド値を取得する。

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

シグネチャ

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

SHORT SQLGetDiagField(
    SHORT HandleType,
    void* Handle,
    SHORT RecNumber,
    SHORT DiagIdentifier,
    void* DiagInfo,   // optional
    SHORT BufferLength,
    SHORT* StringLength   // optional
);

パラメーター

名前	型	方向	説明
HandleType	SHORT	in	[入力] 診断を必要とするハンドルの種類を示すハンドル型識別子。次のいずれかである必要があります。 SQL_HANDLE_DBC SQL_HANDLE_DBC_INFO_TOKEN SQL_HANDLE_DESC SQL_HANDLE_ENV SQL_HANDLE_STMT SQL_HANDLE_DBC_INFO_TOKEN ハンドルは、ドライバーマネージャーとドライバーのみが使用します。アプリケーションではこのハンドル型を使用しないでください。SQL_HANDLE_DBC_INFO_TOKEN の詳細については、Developing Connection-Pool Awareness in an ODBC Driver を参照してください。
Handle	void*	inout	[入力] HandleType で示される型の、診断データ構造のハンドル。HandleType が SQL_HANDLE_ENV の場合、Handle は共有環境ハンドルと非共有環境ハンドルのどちらでもかまいません。
RecNumber	SHORT	in	[入力] アプリケーションが情報を取得しようとする状態レコードを示します。状態レコードには 1 から始まる番号が付けられます。DiagIdentifier 引数が診断ヘッダーのいずれかのフィールドを示している場合、RecNumber は無視されます。そうでない場合は、0 より大きい値である必要があります。
DiagIdentifier	SHORT	in	[入力] 値を返す対象となる診断のフィールドを示します。詳細については、「解説」内の「DiagIdentifier 引数」セクションを参照してください。
DiagInfo	void*	outoptional	診断情報を受け取るバッファへのポインタ。
BufferLength	SHORT	in	[入力] DiagIdentifier が ODBC で定義された診断であり、DiagInfoPtr が文字列またはバイナリバッファーを指す場合、この引数は *DiagInfoPtr の長さである必要があります。DiagIdentifier が ODBC で定義されたフィールドであり、*DiagInfoPtr が整数である場合、BufferLength は無視されます。DiagInfoPtr の値が Unicode 文字列である場合 (SQLGetDiagFieldW* を呼び出すとき)、BufferLength 引数は偶数である必要があります。 DiagIdentifier がドライバー定義のフィールドである場合、アプリケーションは BufferLength 引数を設定することで、そのフィールドの性質をドライバーマネージャーに示します。BufferLength には次の値を指定できます。 DiagInfoPtr が文字列へのポインターである場合、BufferLength は文字列の長さまたは SQL_NTS です。 DiagInfoPtr がバイナリバッファーへのポインターである場合、アプリケーションは SQL_LEN_BINARY_ATTR(length) マクロの結果を BufferLength に設定します。これにより、BufferLength には負の値が設定されます。 DiagInfoPtr が文字列またはバイナリ文字列以外の値へのポインターである場合、BufferLength の値は SQL_IS_POINTER である必要があります。 DiagInfoPtr に固定長のデータ型が格納されている場合、BufferLength* は状況に応じて SQL_IS_INTEGER、SQL_IS_UINTEGER、SQL_IS_SMALLINT、または SQL_IS_USMALLINT になります。
StringLength	SHORT*	outoptional	実際に書き込まれたバイト数を受け取るポインタ。NULL可。

戻り値の型: SHORT

公式ドキュメント

SQLGetDiagField は、エラー、警告、および状態の情報を格納する診断データ構造 (指定されたハンドルに関連付けられているもの) のレコードについて、あるフィールドの現在の値を返します。

戻り値

SQL_SUCCESS、SQL_SUCCESS_WITH_INFO、SQL_ERROR、SQL_INVALID_HANDLE、または SQL_NO_DATA。

解説(Remarks)

アプリケーションは通常、次の 3 つの目的のいずれかを達成するために SQLGetDiagField を呼び出します。

関数呼び出しが SQL_ERROR または SQL_SUCCESS_WITH_INFO (SQLBrowseConnect 関数の場合は SQL_NEED_DATA) を返したときに、特定のエラーまたは警告の情報を取得する。
SQLExecute、SQLExecDirect、SQLBulkOperations、または SQLSetPos の呼び出しによって挿入、削除、更新の各操作が実行されたときに、影響を受けたデータソース内の行数を判別する (SQL_DIAG_ROW_COUNT ヘッダーフィールドから)。または、ドライバーがこの情報を提供できる場合に、現在開いているカーソルに存在する行数を判別する (SQL_DIAG_CURSOR_ROW_COUNT ヘッダーフィールドから)。
SQLExecDirect または SQLExecute の呼び出しによってどの関数が実行されたかを判別する (SQL_DIAG_DYNAMIC_FUNCTION および SQL_DIAG_DYNAMIC_FUNCTION_CODE ヘッダーフィールドから)。

ODBC 関数はいずれも、呼び出されるたびに 0 個以上の診断レコードをポストする可能性があるため、アプリケーションは任意の ODBC 関数呼び出しの後に SQLGetDiagField を呼び出すことができます。一度に格納できる診断レコードの数に制限はありません。SQLGetDiagField は、Handle 引数で指定された診断データ構造に最後に関連付けられた診断情報のみを取得します。アプリケーションが SQLGetDiagField または SQLGetDiagRec 以外の ODBC 関数を呼び出すと、同じハンドルでの以前の呼び出しによる診断情報は失われます。

アプリケーションは、SQLGetDiagField が SQL_SUCCESS を返す間、RecNumber をインクリメントすることですべての診断レコードをスキャンできます。状態レコードの数は SQL_DIAG_NUMBER ヘッダーフィールドに示されます。SQLGetDiagField の呼び出しは、ヘッダーフィールドおよびレコードフィールドを破壊しません。同じハンドルにレコードをポストするような診断関数以外の関数がその間に呼び出されていない限り、アプリケーションは後で再度 SQLGetDiagField を呼び出してレコードからフィールドを取得できます。

アプリケーションは、いつでも SQLGetDiagField を呼び出して任意の診断フィールドを取得できます。ただし SQL_DIAG_CURSOR_ROW_COUNT と SQL_DIAG_ROW_COUNT は例外で、Handle がステートメントハンドルでない場合は SQL_ERROR を返します。それ以外の診断フィールドが未定義の場合、SQLGetDiagField の呼び出しは (他の診断が発生していなければ) SQL_SUCCESS を返し、そのフィールドには未定義の値が返されます。

詳細については、Using SQLGetDiagRec and SQLGetDiagField および Implementing SQLGetDiagRec and SQLGetDiagField を参照してください。

非同期に実行されている API 以外の API を呼び出すと、HY010「関数シーケンスエラー」が生成されます。ただし、非同期操作が完了するまでエラーレコードを取得することはできません。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 SQLGetDiagField(
    SHORT HandleType,
    void* Handle,
    SHORT RecNumber,
    SHORT DiagIdentifier,
    void* DiagInfo,   // optional
    SHORT BufferLength,
    SHORT* StringLength   // optional
);

[DllImport("ODBC32.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern short SQLGetDiagField(
    short HandleType,   // SHORT
    IntPtr Handle,   // void* in/out
    short RecNumber,   // SHORT
    short DiagIdentifier,   // SHORT
    IntPtr DiagInfo,   // void* optional, out
    short BufferLength,   // SHORT
    IntPtr StringLength   // SHORT* optional, out
);

<DllImport("ODBC32.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function SQLGetDiagField(
    HandleType As Short,   ' SHORT
    Handle As IntPtr,   ' void* in/out
    RecNumber As Short,   ' SHORT
    DiagIdentifier As Short,   ' SHORT
    DiagInfo As IntPtr,   ' void* optional, out
    BufferLength As Short,   ' SHORT
    StringLength As IntPtr   ' SHORT* optional, out
) As Short
End Function

' HandleType : SHORT
' Handle : void* in/out
' RecNumber : SHORT
' DiagIdentifier : SHORT
' DiagInfo : void* optional, out
' BufferLength : SHORT
' StringLength : SHORT* optional, out
Declare PtrSafe Function SQLGetDiagField Lib "odbc32" ( _
    ByVal HandleType As Integer, _
    ByVal Handle As LongPtr, _
    ByVal RecNumber As Integer, _
    ByVal DiagIdentifier As Integer, _
    ByVal DiagInfo As LongPtr, _
    ByVal BufferLength As Integer, _
    ByVal StringLength As LongPtr) As Integer
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

SQLGetDiagField = ctypes.windll.odbc32.SQLGetDiagField
SQLGetDiagField.restype = ctypes.c_short
SQLGetDiagField.argtypes = [
    ctypes.c_short,  # HandleType : SHORT
    ctypes.POINTER(None),  # Handle : void* in/out
    ctypes.c_short,  # RecNumber : SHORT
    ctypes.c_short,  # DiagIdentifier : SHORT
    ctypes.POINTER(None),  # DiagInfo : void* optional, out
    ctypes.c_short,  # BufferLength : SHORT
    ctypes.POINTER(ctypes.c_short),  # StringLength : SHORT* optional, out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ODBC32.dll')
SQLGetDiagField = Fiddle::Function.new(
  lib['SQLGetDiagField'],
  [
    Fiddle::TYPE_SHORT,  # HandleType : SHORT
    Fiddle::TYPE_VOIDP,  # Handle : void* in/out
    Fiddle::TYPE_SHORT,  # RecNumber : SHORT
    Fiddle::TYPE_SHORT,  # DiagIdentifier : SHORT
    Fiddle::TYPE_VOIDP,  # DiagInfo : void* optional, out
    Fiddle::TYPE_SHORT,  # BufferLength : SHORT
    Fiddle::TYPE_VOIDP,  # StringLength : SHORT* optional, out
  ],
  Fiddle::TYPE_SHORT)

#[link(name = "odbc32")]
extern "system" {
    fn SQLGetDiagField(
        HandleType: i16,  // SHORT
        Handle: *mut (),  // void* in/out
        RecNumber: i16,  // SHORT
        DiagIdentifier: i16,  // SHORT
        DiagInfo: *mut (),  // void* optional, out
        BufferLength: i16,  // SHORT
        StringLength: *mut i16  // SHORT* optional, out
    ) -> i16;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("ODBC32.dll", CharSet = CharSet.Ansi)]
public static extern short SQLGetDiagField(short HandleType, IntPtr Handle, short RecNumber, short DiagIdentifier, IntPtr DiagInfo, short BufferLength, IntPtr StringLength);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ODBC32_SQLGetDiagField' -Namespace Win32 -PassThru
# $api::SQLGetDiagField(HandleType, Handle, RecNumber, DiagIdentifier, DiagInfo, BufferLength, StringLength)

#uselib "ODBC32.dll"
#func global SQLGetDiagField "SQLGetDiagField" sptr, sptr, sptr, sptr, sptr, sptr, sptr
; SQLGetDiagField HandleType, Handle, RecNumber, DiagIdentifier, DiagInfo, BufferLength, varptr(StringLength)   ; 戻り値は stat
; HandleType : SHORT -> "sptr"
; Handle : void* in/out -> "sptr"
; RecNumber : SHORT -> "sptr"
; DiagIdentifier : SHORT -> "sptr"
; DiagInfo : void* optional, out -> "sptr"
; BufferLength : SHORT -> "sptr"
; StringLength : SHORT* optional, out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

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