16.7.5　SQLDescribeParam

(1)　機能

SQLPrepareの実行によって得られた，？パラメタの情報を返します。この情報は，IPDのフィールドに設定されている情報です。

ページの先頭へ

(2)　形式

SQLRETURN SQLDescribeParam
(
  SQLHSTMT          StatementHandle,    /* In */
  SQLUSMALLINT      ParameterNumber,    /* In */
  SQLSMALLINT     * DataTypePtr,        /* Out */
  SQLULEN         * ParameterSizePtr,   /* Out */
  SQLSMALLINT     * DecimalDigitsPtr,   /* Out */
  SQLSMALLINT     * NullablePtr         /* Out */
)

ページの先頭へ

(3)　引数

StatementHandle：

ステートメントハンドルを指定します。

ParameterNumber：

パラメタ番号を指定します。パラメタの昇順に1から番号が付けられます。

DataTypePtr：

パラメタのSQLデータ型を返すバッファへのポインタを指定します。

ParameterSizePtr：

対応するパラメタの列または式のサイズを返すバッファへのポインタを指定します。データソースで定義された内容が返されます。

DecimalDigitsPtr：

対応するパラメタの列または式の小数の桁数を返すバッファへのポインタを指定します。データソースで定義された内容が返されます。

NullablePtr：

パラメタがナル値を受け付けるかどうかを示す値を返すバッファへのポインタを指定します。この値はIPDのSQL_DESC_NULLABLEフィールドから読み出されます。次のどちらかの値が返されます。

• SQL_NO_NULLS

  パラメタはナル値を受け付けません。

• SQL_NULLABLE

  パラメタはナル値を受け付けます。

ページの先頭へ

(4)　戻り値

SQL_SUCCESS，SQL_ERROR，またはSQL_INVALID_HANDLEが返されます。

ページの先頭へ

(5)　SQLSTATE

この関数では次のSQLSTATEを返します。

SQLSTATE	説明	備考	返却
01000	一般警告	−	×
07009	無効なディスクリプタインデクス		○
08S01	通信リンク失敗		×
21S01	挿入する値の一覧と列の一覧の不一致		×
HY000	一般エラー		×
HY001	メモリ割り当てエラー		×
HY008	動作がキャンセルされた		×
HY010	関数シーケンスエラー		○
HY013	メモリ管理エラー		×
HYT01	接続タイムアウト終了		×
IM001	ドライバはこの関数をサポートしていない		×

（凡例）

○：HADB ODBCドライバが返すことがあるSQLSTATEです。

×：HADB ODBCドライバが返さないSQLSTATEです。

−：なし。

ページの先頭へ