GetProcedureColumnsメソッド

機能

ストアドプロシジャのパラメタ一覧を取得するために,classListProcedureColumnsオブジェクトへのポインタを取得します。

形式

classListProcedureColumns *GetProcedureColumns
                                (LPCTSTR lpctOwner,
                                 LPCTSTR lpctProcedureName,
                                 UINT32 dwMaxSize=0,
                                 LPCTSTR lpctCondition = NULL,
                                 LPCTSTR lpctEscChar = NULL)
                                                 throw DBSQLCA

引数

lpctOwner

プロシジャの所有者名を指定します。

lpctProcedureName

プロシジャ名を指定します。

dwMaxSize

取得するパラメタの数の最大値を指定します。

0を指定した場合は,対象になるすべてのパラメタを検索します。

lpctCondition

一覧に含むプロシジャのパラメタ名を,ワイルドカードを使用して指定します。この指定には,SQLのLIKE演算子に指定する文字列の形式を使用してください。

lpctEscChar

ワイルドカード文字列中に含むエスケープ文字を1文字指定します。2文字以上を指定した場合は先頭の文字を使用します。SQL Anywhere,Adaptive Server Anywhere,SQL Serverの場合,この引数は指定できません。

戻り値

データ型:classListProcedureColumns*

classListProcedureColumnsオブジェクトへのポインタ。

機能詳細

ストアドプロシジャのパラメタ一覧を取得するために,classListProcedureColumnsオブジェクトへのポインタを取得します。

ストアドプロシジャで定義した順番をキーにして,昇順にソートして取得します。ただし,SQL Anywhere,Adaptive Server Anywhereの場合は,順序はDBMSに依存するため,ソートされません。

このメソッドは,非同期実行可能なメソッドです。

XDM/RDの場合
ストアドプロシジャのパラメタ一覧は取得できません。

発生する例外

DBSQLCA(RetCode)

DB_ERROR_NOT_ENOUGH_MEMORY
メモリ容量が不足しています。
DB_ERROR_CANNOT_BE_NULL
所有者名,又はプロシジャ名にNULLを指定しています。
DB_ERROR_ARGUMENT_OUT_OF_RANGE
最大件数の指定が範囲内ではありません。
DB_ERROR_DRIVER_ERROR
DBMSでエラーが発生しました。
DB_ERROR_DAB_ACCESS_ERROR
DABrokerでエラーが発生しました。
DBSQLCAクラスで詳細コードを確認してください。
DB_ERROR_DAB_SYSTEMCALL_ERROR
システムコールでエラーが発生しました。
DBSQLCAクラスで詳細コードを確認してください。
DB_ERROR_DAB_ILLEGAL_VALUE
指定した引数が不正です。
DBSQLCAクラスで詳細コードを確認してください。
DB_ERROR_TIMEOUT
タイムアウトが発生したため制御を戻します。