odbc_procedurecolumns

PHP 4, PHP 5, PHP 7, PHP 8
odbc_procedurecolumns - Retrieve information about parameters to procedures
Manual
Code Examples

odbc_procedurecolumns(
     resource$odbc,
     [string|null$catalog = null],
     [string|null$schema = null],
     [string|null$procedure = null],
     [string|null$column = null]
): resource|false

Retrieve information about parameters to procedures.

Parameters

odbc

The ODBC connection identifier, see odbc_connect for details.

catalog

The catalog ('qualifier' in ODBC 2 parlance).

schema

The schema ('owner' in ODBC 2 parlance). This parameter accepts the following search patterns: % to match zero or more characters, and _ to match a single character.

procedure

The proc. This parameter accepts the following search patterns: % to match zero or more characters, and _ to match a single character.

column

The column. This parameter accepts the following search patterns: % to match zero or more characters, and _ to match a single character.

Return Values

Returns the list of input and output parameters, as well as the columns that make up the result set for the specified procedures. Returns an ODBC result identifier or false on failure.

The result set has the following columns:

PROCEDURE_CAT

PROCEDURE_SCHEM

PROCEDURE_NAME

COLUMN_NAME

COLUMN_TYPE

DATA_TYPE

TYPE_NAME

COLUMN_SIZE

BUFFER_LENGTH

DECIMAL_DIGITS

NUM_PREC_RADIX

NULLABLE

REMARKS

COLUMN_DEF

SQL_DATA_TYPE

SQL_DATETIME_SUB

CHAR_OCTET_LENGTH

ORDINAL_POSITION

IS_NULLABLE

Drivers can report additional columns.

The result set is ordered by PROCEDURE_CAT, PROCEDURE_SCHEM, PROCEDURE_NAME and COLUMN_TYPE.

Changelog

Version Description
8.0.0 Prior to this version, the function could only be called with either one or five arguments.

Related Functions

Example of odbc_procedurecolumns

Show all examples for odbc_procedurecolumns

PHP Version: