Closes the cursor and releases the result
set.
|
Function |
Group |
Execution |
Windows |
Embedded |
Thin Client |
| DBCursorClose
|
Database/ERP |
Synchronous |
Supported |
Supported |
Supported |
Note: This
feature emulates SQL (Structured Query Language) database
operations. You should be familiar with how SQL commands are formed
and executed before you use this feature.
Syntax
DBCursorClose( numCur, "optStrErrorTag" )
- numCur
- The cursor handle of the result set. The cursor
handle is returned by
DBCursorOpen or
DBCursorOpenSQL.
- optStrErrorTag
- The name of a String tag that will receive detailed
error messages, if errors occur during runtime.
Note: The tag
name must be enclosed in quotes, as shown in the syntax diagram, or
else the project will try to get the value of the named tag.
This is an optional parameter.
Returned value
In case of error, returns a negative number.
Otherwise, returns 0.
Notes
When the cursor is closed, it is destroyed and cannot
be used again. You must create a new cursor using
DBCursorOpen or
DBCursorOpenSQL.
Examples
As used in a Math worksheet:
|
Tag Name |
Expression |
|
nErrorCode
|
DBCursorClose( nCursor )
|