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

import"sbIDatabaseResult.idl";

Inheritance diagram for sbIDatabaseResult:

Collaboration diagram for sbIDatabaseResult:

Public Member Functions
unsigned long	getColumnCount ()
	The number of columns in the result. More...

AString	getColumnName (in unsigned long aColumnIndex)
	The name of a particular column. More...

unsigned long	getColumnIndex (in AString aColumnName)
	The index of a particular column. More...

unsigned long	getRowCount ()
	The number of rows in the result. More...

AString	getRowCell (in unsigned long aRowIndex, in unsigned long aColumnIndex)
	Retrieve the value of a cell at a particular row and column. More...

AString	getRowCellByColumn (in unsigned long aRowIndex, in AString aColumnName)
	Retrieve the value of a cell at a particular row for a named column. More...

wstring	getColumnNamePtr (in unsigned long aColumnIndex)
	[noscript] Get the internal pointer to the column name. More...

wstring	getRowCellPtr (in unsigned long aRowIndex, in unsigned long aColumnIndex)
	[noscript] Get the internal pointer to the cell value. More...

wstring	getRowCellByColumnPtr (in unsigned long aRowIndex, in AString aColumnName)
	[noscript] Get the internal pointer to the cell value (by named column). More...

void	clearResultSet ()
	[noscript] Free the internally allocated resources of this results object. More...

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

unsigned long sbIDatabaseResult::getColumnCount ( )

The number of columns in the result.

Returns: The number of columns in the result.

See Also: sbIDatabaseQuery

unsigned long sbIDatabaseResult::getColumnIndex ( in AString aColumnName )

The index of a particular column.

Parameters

aColumnName The name of the column to access.

Returns: The index of the column.

See Also: sbIDatabaseQuery

AString sbIDatabaseResult::getColumnName ( in unsigned long 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 unsigned long 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 unsigned long	aRowIndex,
		in unsigned long	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 unsigned long	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 unsigned long	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 unsigned long	aRowIndex,
		in unsigned long	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

unsigned long 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:

/home/martin/dev/nightingale-hacking/components/dbengine/public/sbIDatabaseResult.idl

Public Member Functions

Detailed Description

Member Function Documentation