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.22 GET-RECORD-COUNT Method

��Class

FJDB-RECORDSET-class

��Function

Returns a count of the number of rows in the recordset accessed.

��Syntax

INVOKE RECORDSET-A "GET-RECORD-COUNT" USING ROW-COUNT RETURNING RET-CODE.

��Object identifier

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

Specifies an object of the FJDB-RECORDSET class.

��Arguments

ROW-COUNT [attribute:�FS9(9) COMP-5]

Returns a count of the number of rows accessed.

��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 GET-RECORD-COUNT method enables the user to check the number of rows in the recordset that have been accessed.

If a GET-RECORD-COUNT method is issued after adding rows to the record with an ADD-NEW-RECORD method and an UPDATE-RECORD method, a total count of the number of rows including the additional rows is returned.

If a GET-RECORD-COUNT method is issued after deleting rows from the record with a DELTE-RECORD method, a total count of the number of rows excluding the deleted rows is returned.

If a GET-RECORD-COUNT method is issued immediately after access is made to the last row in the recordset or after a MOVE-LAST method is issued to the recordset, a total count of the number of rows in the recordset that remain undeleted is returned.

If a GET-RECORD-COUNT method is issued while the recordset is empty, a value of 0 is returned.

Contents Index