LibreOffice
LibreOffice 6.2 SDK API Reference
Public Member Functions | List of all members
XMultipleResults Interface Referencepublished

is used for inspecting multiple results produced by the execution of a SQL statement. More...

import"XMultipleResults.idl";

Inheritance diagram for XMultipleResults:
XInterface PreparedStatement Statement PreparedStatement CallableStatement PreparedStatement Statement CallableStatement CallableStatement

Public Member Functions

XResultSet getResultSet () raises (SQLException)
 returns the current result as a com::sun::star::sdbc::ResultSet object. More...
 
long getUpdateCount () raises (SQLException)
 returns the current result as an update count. More...
 
boolean getMoreResults () raises (SQLException)
 moves to a Statement's next result. More...
 
- Public Member Functions inherited from XInterface
any queryInterface ([in] type aType)
 queries for a new interface to an existing UNO object. More...
 
void acquire ()
 increases the reference counter by one. More...
 
void release ()
 decreases the reference counter by one. More...
 

Detailed Description

is used for inspecting multiple results produced by the execution of a SQL statement.

Under some (uncommon) situations a single SQL statement may return multiple result sets and/or update counts. Normally you can ignore this unless you are (1) executing a stored procedure that you know may return multiple results or (2) you are dynamically executing an unknown SQL string. The methods com::sun::star::sdbc::XMultipleResults::getMoreResults() , com::sun::star::sdbc::XMultipleResults::getResultSet() and com::sun::star::sdbc::XMultipleResults::getUpdateCount() let you navigate through multiple results.

See also
com::sun::star::sdbc::XStatement
com::sun::star::sdbc::XPreparedStatement

Member Function Documentation

boolean getMoreResults ( )
raises (SQLException
)

moves to a Statement's next result.

It returns TRUE if this result is a ResultSet. This method also implicitly closes any current ResultSet obtained with getResultSet.

There are no more results when (!getMoreResults() && getUpdateCount() == -1).

Returns
TRUE if there exists more ResultSet objects
Exceptions
SQLExceptionif a database access error occurs.
XResultSet getResultSet ( )
raises (SQLException
)

returns the current result as a com::sun::star::sdbc::ResultSet object.

This method should be called only once per result.

Returns
the ResultSet object
Exceptions
SQLExceptionif a database access error occurs.
long getUpdateCount ( )
raises (SQLException
)

returns the current result as an update count.

If the result is a ResultSet or there are no more results, -1 is returned. This method should be called only once per result.

Returns
the current result as an update count.
Exceptions
SQLExceptionif a database access error occurs.

The documentation for this interface was generated from the following file: