TSQLConnection.GetProcedureParams Method (UnicodeString, TList)

Populates a list with parameter descriptors for the parameters in a stored procedure.

Pascal

procedure GetProcedureParams(ProcedureName: UnicodeString; List: TList); overload;
procedure GetProcedureParams(ProcedureName: UnicodeString; PackageName: UnicodeString; List: TList); overload;
procedure GetProcedureParams(ProcedureName: UnicodeString; PackageName: UnicodeString; SchemaName: UnicodeString; List: TList); overload;

C++

__fastcall GetProcedureParams(UnicodeString ProcedureName, TList List);
__fastcall GetProcedureParams(UnicodeString ProcedureName, UnicodeString PackageName, TList List);
__fastcall GetProcedureParams(UnicodeString ProcedureName, UnicodeString PackageName, UnicodeString SchemaName, TList List);

Description

Call GetProcedureParams to retrieve information about the parameters of a specified stored procedure.

ProcedureName is the name of the stored procedure for whose parameters you want descriptions.

PackageName is the name of the Oracle package to which the stored procedure belongs. This parameter should only be used if TSQLConnection connects to an Oracle server.

List is a TList object that receives the parameter descriptions. It should be an empty list on entry. For each parameter, GetProcedureParams adds a reference to an SPParamDesc class (Delphi) or structure (C++). Each SPParamDesc entity describes a parameter of a specified stored procedure, including its name, index, parameter type, field type, and so on. You are responsible for freeing the individual SPPParamDesc entities that GetProcedureParams dynamically allocates. (You can use FreeProcParams to free all the entries and the list object as well).

Note: You can convert the list of SPParamDesc entities to the more familiar TParams object by calling the global LoadParamListItems procedure.