Remarksメソッド

機能

インデクスで指定したテーブルのコメントを返します。

形式

LPCTSTR Remarks(UINT32 dwIndex) throw DBSQLCA

引数

dwIndex

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

戻り値

データ型:LPCTSTR

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

機能詳細

コメントが設定されていればインデクスで指定したテーブルのコメントを返します。

コメントが設定されていなければ空文字列を返します。

ORACLEの場合,SYNONYM(システム所有のものを含む)はコメントを取得できません。

発生する例外

DBSQLCA(RetCode)

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