Data.SqlExpr.TSQLConnection.GetProcedureParams

提供: RAD Studio API Documentation
移動先: 案内検索

Delphi

procedure GetProcedureParams(ProcedureName : string; List: TProcParamList); overload;
procedure GetProcedureParams(ProcedureName, PackageName: string; List: TProcParamList); overload;
procedure GetProcedureParams(ProcedureName, PackageName, SchemaName: string; List: TProcParamList); overload;

C++

void __fastcall GetProcedureParams(System::UnicodeString ProcedureName, System::Generics::Collections::TList__1<SPParamDesc*>* List)/* overload */;
void __fastcall GetProcedureParams(System::UnicodeString ProcedureName, System::UnicodeString PackageName, System::Generics::Collections::TList__1<SPParamDesc*>* List)/* overload */;
void __fastcall GetProcedureParams(System::UnicodeString ProcedureName, System::UnicodeString PackageName, System::UnicodeString SchemaName, System::Generics::Collections::TList__1<SPParamDesc*>* List)/* overload */;

プロパティ

種類 可視性 ソース ユニット
procedure
function
public
Data.SqlExpr.pas
Data.SqlExpr.hpp
Data.SqlExpr TSQLConnection

説明

リストにストアドプロシージャ内のパラメータのパラメータ記述子を入れます。

GetProcedureParams を呼び出すと,指定したストアドプロシージャのパラメータに関する情報を取り出すことができます。

ProcedureName パラメータは,説明が必要なパラメータを保持するストアドプロシージャの名前です。

PackageName パラメータは,ストアドプロシージャが属す Oracle パッケージの名前です。このパラメータは,TSQLConnection が Oracle サーバーに接続している場合にのみ使用できます。

List パラメータは,パラメータ記述子を受け取る TList オブジェクトです。このオブジェクトは入力時に,空のリストでなければなりません。GetProcedureParams は,各パラメータについて SPParamDesc クラス(Delphi)または構造体(C++)への参照を追加します。 各 SPParamDesc は,指定したストアドプロシージャのパラメータの名前,インデックス,パラメータ型,項目型などを記述しています。GetProcedureParams メソッドが動的に割り当てたそれぞれの SPPParamDesc は,ユーザーによって解放される必要があります。FreeProcParams メソッドを使用すると,すべてのエントリとリストオブジェクトを解放できます。

メモ:  グローバルな LoadParamListItems 手続きを呼び出して,SPParamDesc のリストを,より使い慣れた TParams オブジェクトに変換できます。

関連項目