Index

DXResultsOD

Purpose:

This is the class that is used to represent a results collection for OD.

Methods:

initialization
   init(LPDISPATCH ds);

This method must be called following the creation of a DXResultsOD object (except for methods returning a DXResultsOD object). The method initializes the collection object with the datastore. The input parameter LPDISPATCH pointer contains either a DXDatastoreOD object.

cardinality
   long cardinality();

Returns the number of elements in the collection.

createIterator
   LPDISPATCH createIterator();

Creates a iterator to iterate over a collection. The returned LPDISPATCH pointer contains a DXSequentialIteratorOD object

addElement
   addElement(VARIANT element);

Adds an element to the collection.

retrieveElementAt
   VARIANT retrieveElementAt(LPDISPATCH where);

Returns the element the iterator is pointing at.

removeElementAt
   removeElementAt(LPDISPATCH where);

Remove the element the iterator is pointing at. The input parameter LPDISPATCH pointer contains a DXSequentialIteratorOD object.

removeAllElements
   removeAllElements();

Removes all elements in the collection.

insertElementAt
   insertElementAt(VARIANT element, LPDISPATCH where);
 

Adds a new element, after the element the iterator is currently pointing to. The input parameter LPDISPATCH pointer contains a DXSequentialIteratorOD object

replaceElementAt
   replaceElementAt(VARIANT element, LPDISPATCH where);

Replaces the element the iterator is pointing at. The input parameter LPDISPATCH pointer contains a DXSequentialIteratorOD object

evaluate
   VARIANT evaluate(LPCTSTR query,
                    short ql_type
                    [,VARIANT paramList]);

Evaluates the given query of the given query language type with the optional parameter list of an array of DXNVPairOD objects and returns the results. The value of the returned VARIANT is a DXResultsOD object.

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