sbIDatabaseResult Interface Reference

An object containing the results of a database SELECT query. More...

import "sbIDatabaseResult.idl";

List of all members.

Public Member Functions

PRInt32 getColumnCount ()
 The number of columns in the result.
AString getColumnName (in PRInt32 aColumnIndex)
 The name of a particular column.
PRInt32 getRowCount ()
 The number of rows in the result.
AString getRowCell (in PRInt32 aRowIndex, in PRInt32 aColumnIndex)
 Retrieve the value of a cell at a particular row and column.
AString getRowCellByColumn (in PRInt32 aRowIndex, in AString aColumnName)
 Retrieve the value of a cell at a particular row for a named column.
wstring getColumnNamePtr (in PRInt32 aColumnIndex)
 [noscript] Get the internal pointer to the column name.
wstring getRowCellPtr (in PRInt32 aRowIndex, in PRInt32 aColumnIndex)
 [noscript] Get the internal pointer to the cell value.
wstring getRowCellByColumnPtr (in PRInt32 aRowIndex, in AString aColumnName)
 [noscript] Get the internal pointer to the cell value (by named column).
void clearResultSet ()
 [noscript] Free the internally allocated resources of this results object.


Detailed Description

An object containing the results of a database SELECT query.

User code retrieves one of these objects from sbIDatabaseQuery::getResultObject()

See also:
sbIDatabaseQuery

Definition at line 43 of file sbIDatabaseResult.idl.


Member Function Documentation

void sbIDatabaseResult::clearResultSet (  ) 

[noscript] Free the internally allocated resources of this results object.

This method is not available from script. It deallocates the internal memory used to contain the results data. This allows code to free most of the used memory long before the garbage collector would.

See also:
sbIDatabaseQuery

PRInt32 sbIDatabaseResult::getColumnCount (  ) 

The number of columns in the result.

Returns:
The number of columns in the result.
See also:
sbIDatabaseQuery

AString sbIDatabaseResult::getColumnName ( in PRInt32  aColumnIndex  ) 

The name of a particular column.

Parameters:
aColumnIndex The index of the column to access.
Returns:
The name of the column.
See also:
sbIDatabaseQuery

wstring sbIDatabaseResult::getColumnNamePtr ( in PRInt32  aColumnIndex  ) 

[noscript] Get the internal pointer to the column name.

This method is not available from script. It returns the internal pointer to the value, to reduce unnecessary memory copies.

Parameters:
aColumnIndex The index of the column to access.
Returns:
The name of the column.
See also:
sbIDatabaseQuery

AString sbIDatabaseResult::getRowCell ( in PRInt32  aRowIndex,
in PRInt32  aColumnIndex 
)

Retrieve the value of a cell at a particular row and column.

Parameters:
aRowIndex The row index of the cell to retrieve.
aColumnIndex The column index of the cell to retrieve.
Returns:
The cell value.
See also:
sbIDatabaseQuery

AString sbIDatabaseResult::getRowCellByColumn ( in PRInt32  aRowIndex,
in AString  aColumnName 
)

Retrieve the value of a cell at a particular row for a named column.

Parameters:
aRowIndex The row index of the cell to retrieve.
aColumnName The column name of the cell to retrieve.
Returns:
The cell value.
See also:
sbIDatabaseQuery

wstring sbIDatabaseResult::getRowCellByColumnPtr ( in PRInt32  aRowIndex,
in AString  aColumnName 
)

[noscript] Get the internal pointer to the cell value (by named column).

This method is not available from script. It returns the internal pointer to the value, to reduce unnecessary memory copies.

Parameters:
aRowIndex The row index of the cell to retrieve.
aColumnName The column name of the cell to retrieve.
Returns:
The cell value.
See also:
sbIDatabaseQuery

wstring sbIDatabaseResult::getRowCellPtr ( in PRInt32  aRowIndex,
in PRInt32  aColumnIndex 
)

[noscript] Get the internal pointer to the cell value.

This method is not available from script. It returns the internal pointer to the value, to reduce unnecessary memory copies.

Parameters:
aRowIndex The row index of the cell to retrieve.
aColumnIndex The column index of the cell to retrieve.
Returns:
The cell value.
See also:
sbIDatabaseQuery

PRInt32 sbIDatabaseResult::getRowCount (  ) 

The number of rows in the result.

Returns:
The number of rows in the result.
See also:
sbIDatabaseQuery


The documentation for this interface was generated from the following file:
Generated on Mon Aug 21 21:01:55 2006 for Songbird by  doxygen 1.4.7