Index

DXResultSetCursorDES

Purpose:

The DXResultSetCursorDES class represents a result set cursor for Domino Extended Search (DES).

Methods:

isValid
BOOL isValid();

Returns TRUE if cursor is valid.

isOpen
BOOL isOpen();

Returns TRUE if cursor is opened.

isBegin
BOOL isBegin();

Returns TRUE if cursor is positioned at the beginning.

isEnd
BOOL isEnd();

Returns TRUE if cursor is positioned at the end.

isInBetween
BOOL isInBetween();

Returns TRUE if cursor is positioned in between data objects in the result set.

getPosition
long getPosition();

Gets the current position of the cursor.

setPosition
void setPosition(long position, const VARIANT FAR& value);

Sets the current position of the cursor.

setToNext
setToNext();

Sets the cursor to point to the position of the next data object.

fetchObject
LPDISPATCH fetchObject();

Fetches the element of the result set at the current position and return it as a DXDDODES. The returned LPDISPATCH pointer contains a DXDDODES object.

fetchNext
LPDISPATCH fetchNext();

Fetches the next element of the result set and returns it as a DXDDODES. The returned LPDISPATCH pointer contains a DXDDODES object.

fetchNextN
BOOL fetchNextN(long how_many, LPDISPATCH collection);

Fetches next N elements of the result set and insert them into the given collection. Returns true if there is at least one data object returned. The input parameter LPDISPATCH pointer contains a DXSequentialCollectionDES object.

fetchObjectByName
VARIANT fetchObjectByName(LPCTSTR dataItemName);

Fetches a value of the data object by data item name.

fetchNextByName
VARIANT fetchNextByName(LPCTSTR dataItemName);

Fetches value of the next data object by data item name.

fetchNextNByName
BOOL fetchNextNByName(LPCTSTR dataItemName, long how_many, 
                      VARIANT* array, long arraySize);

Fetches values of the next n data objects by data item name and insert them into the given array. The size of array and how_many input parameter determine how many values are put into the array. Returns true if there is at least one value returned.

findObject
LPDISPATCH findObject(long position, LPCTSTR predicate);

Finds the data object which satisfies the given predicate, move the cursor to that position, fetch and return the data object. The returned LPDISPATCH pointer contains a DXDDODES object.

open
open();

Opens the cursor.

close
close();

Closes the cursor.

destroy
destroy();

Destroys the result set cursor. This method allows for cleanup.

datastoreName
BSTR datastoreName();

Gets the datastore name.

datastoreType
BSTR datastoreType();

Gets the datastore type.

cardinality
long cardinality();

Returns the number of results.

(c) Copyright International Business Machines Corporation 1996, 2002. IBM Corp. All rights reserved.