DB_Procedures Function

Action

Returns the list of procedure names stored in a specific data source.

Syntax

hstmnt = DB_Procedures (hdbc, catalog-name, schema-name, proc-name)
Variable Description
hstmnt

The returned handle to the executed SQL statement. This is an input parameter for other DBTester functions, for example DB_FetchNext. HSQL.

hdbc

The handle to a database as returned by DB_Connect. HDATABASE.

catalog-name

Catalog name. STRING.

schema-name

String search pattern for schema names. STRING.

proc-name

String search pattern for procedure names. STRING.

Notes

  • Procedure is a generic term used to describe an executable object, or a named entity that can be invoked using input and output parameters.

  • DB_Procedures corresponds to SQLProcedures. For additional information about SQLProcedures, see SQLProcedures Function.

  • The catalog-name argument cannot contain a wildcard.

  • The following wildcard characters are supported for arguments:
    Wildcard character Matches
    % The percent sign matches any character sequence.
    _ The underscore matches any single character.
  • To omit a variable argument, which is not a required argument, specify the argument as an empty string ("").

  • When you receive a valid statement handle, you can call DB_FetchNext or DB_FetchPrevious to manipulate the information.

Example

[ ] STRING cat, sch, ignore, proc-name
[ ] hstmnt = DB_Procedures (hdbc, cat, sch, "")
[ ] // retrieve procedure names; ignore the rest.
[-] while (DB_FetchNext (hstmt, ignore, ignore, proc-name) == TRUE) { 
	[ ] //print procedure names
[-] }