Remarksメソッド

機能

インデクスで指定したフィールドのコメントを取得します。

形式

LPCTSTR Remarks(UINT32 dwIndex) throw DBSQLCA

引数

dwIndex

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

戻り値

データ型:LPCTSTR

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

機能詳細

コメントが設定されている場合,インデクスで指定したフィールドのコメントを文字列で取得します。

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

フィールドのコメントを取得できるのはSQL Anywhere,Adaptive Server Anywhere,SQL Server及びHiRDBです。他のDBMSの場合は常に空文字列(長さ0の文字列)を返します。

発生する例外

DBSQLCA(RetCode)

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