Remarksメソッド

機能

パラメタにコメントがある場合,そのコメントを取得します。

形式

LPCTSTR Remarks(UINT32 dwIndex) throw DBSQLCA

引数

dwIndex

1から始まる一覧中のインデクスを指定します。

戻り値

データ型:LPCTSTR

コメントを文字列で返します。

機能詳細

インデクスで指定したプロシジャのパラメタのコメントを文字列で取得します。

なお,SQL Anywhere,Adaptive Server Anywhere,SQL Serverの場合だけ指定できます。これ以外のDBMSの場合は,常に空文字列(長さ0の文字列)を返します。

発生する例外

DBSQLCA(RetCode)

DB_ERROR_ARGUMENT_OUT_OF_RANGE
引数が指定できる範囲を超えています。
DB_ERROR_IN_ASYNC_EXECUTE
非同期実行処理中です。