DB Access Class Library for COBOL V1.0 API Reference - Microsoft(R) Windows(R) - - Microsoft(R) Windows NT(R) - - Microsoft(R) Windows(R) 2000 -

Contents Index

Chapter 6 DB Access Library API Reference

6.2 Methods

6.2.24 GET-SQL Method

Click the buttons shown below to scroll to class-specific explanations.

��Class

FJDB-COMMAND-class

FJDB-RECORDSET-class

��[FJDB-COMMAND class]

��Function

Refer to SQL statement of an object of the FJDB-COMMAND class.

��Syntax

INVOKE COMMAND-A "GET-SQL" USING SQL SQL-SIZE RETURNING RET-CODE.

��Object identifier

COMMAND-A [attribute:�FOBJECT REFERENCE FJDB-COMMAND]

Specifies an object of the FJDB-COMMAND class.

��Arguments

SQL [attribute:�FX(nn) nn is an area length]

Specifies the area in which the SQL statement is stored.

SQL-SIZE [attribute:�FS9(9) COMP-5]

Returns the length of the character string.

��Return value

RET-CODE [attribute:�FS9(9) COMP-5]

Returns a value of 0 if the method ends normally; otherwise, returns an error code.

��Explanation

The SQL statement specified with an CREATE-COMMAND method or CREATE-OBJECT method of FJDB-COMMAND class is returned.

��[FJDB-RECORDSET class]

��Function

Returns the SQL statement that is specified when an object of the FJDB-RECORDSET class is created.

��Syntax

INVOKE RECORDSET-A "GET-SQL" USING SQL SQL-SIZE RETURNING RET-CODE.

��Object identifier

RECORDSET-A [attribute:�FOBJECT REFERENCE FJDB-RECORDSET]

Specifies an object of the FJDB-RECORDSET class.

��Arguments

SQL [attribute:�FX(nn) nn is an area length]

Specifies the area in which the SQL statement is stored.

SQL-SIZE [attribute:�FS9(9) COMP-5]

Returns the length of the character string.

��Return value

RET-CODE [attribute:�FS9(9) COMP-5]

Returns a value of 0 if the method ends normally; otherwise, returns an error code.

��Explanation

The SQL statement specified with an OPEN-RECORDSET method or CREATE-OBJECT method of FJDB-RECORDSET class is returned.

Contents Index