<< Click to Display Table of Contents >> Navigation:  »No topics above this level« DbiOpenSPParamList

C syntax

DBIResult DBIFN DbiOpenSPParamList (hdb, pszSPName, bPhyTypes, uOverload, phCur );

Delphi syntax

function DbiOpenSPParamList (hDb: hDBIDb; pszSPName: PChar; bPhyTypes: Bool; uOverload: Word; var hCur: hDBICur): DBIResult stdcall;

Description

The function DbiOpenSPParamList creates a table listing the parameters associated with a specified stored procedure. Records in the table are described by SPParamDesc.

Parameters

hDb                Type: hDBIDb                (Input)
Specifies the database handle associated with the database where the stored procedure exists.

pszSPName                Type: pCHAR                (Input)
Pointer to the stored procedure name.

bPhyTypes                Type: BOOL                (Input)
Specifies whether parameter field types are returned in physical or logical datatypes.

uOverload                Type: UINT16                (Input)
Overload number. Not available for all drivers. This value is 0 unless the driver supports it and has overloaded functions. For an example, see uOverload

phCur                Type: phDBICur                (Output)
Pointer to the cursor handle.

Usage

Standard: Not Supported.

Access: The SPParamDesc structure fields iUnits1, uOffset, uLen and uNullOffset are not used. When bPhySypes is False, uFldType and uSubType are not used.

SQL: Supported.

Sybase: DbiOpenSPParamList returns the parameters, but eParamType is always equal to paramUNKNOWN.

Oracle: For full stored procedure support, your server must be a production Oracle7 server set up with the Procedural option. If it has not been set up properly, you might get the following error from DbiOpenSPParamList: "DBMS_DESCRIBE is not defined ...".

Completion state

Returns list of the parameters associated with a specified stored procedure. The record description for the table is SPParamDesc.

See also

DbiOpenSPList