Name: revdb_closecursor

Type: function

Syntax: revdb_closecursor(<recordSetID>)

Summary: <execute|Executes> the <revCloseCursor> <command>.

Introduced: 1.1

OS: mac,windows,linux,ios,android

Platforms: desktop,server,web,mobile

Security: disk,network

Example:
revdb_closeCursor(3)

Example:
revdb_closeCursor(finalResults)

Parameters:
recordSetID: The number returned by the revQueryDatabase function when the record set was created.

Returns: The <revdb_closecursor> <function> returns an error message if the closure is not successful. Otherwise, it returns empty.

Description:
Use the <revdb_closecursor> <function> to clean up after using a <record set (database cursor)(glossary)>.

Evaluating the <revdb_closecursor> <function> has the same effect as <execute|executing> the <revCloseCursor> <command>. The only difference is that one is a <function call> and the other is a <command>.

>*Important:*  The <revdb_closecursor> <function> is part of the <Database library>. To ensure that the <function> works in a <standalone application>, you must include this <Revolution custom library|custom library> when you create your <standalone application|standalone>. In the Inclusions section of the General screen of the <Standalone Application Settings> window, make sure the "Database Support" checkbox is checked and the database drivers you are using are selected in the list of database drivers.

References: revCloseCursor (command), function (control_st), function call (glossary), Standalone Application Settings (glossary), command (glossary), standalone application (glossary), execute (glossary), record set (database cursor) (glossary), Database library (library), Revolution custom library (library)

Tags: database
