Index

DXResultsFed

Purpose:

This class represents a results collection for federated.

Methods:

Initialization
  init(LPCTSTR ds);
 

This method must be called following the creation of a DXResultsFed object (except for methods returning a DXResultsFed object). The method initializes the collection object with the datastore. The input parameter LPDISPATCH pointer contains either a DXDatastoreFed object. If this method is used, it must be called following the creation of a DXPidXDOFed object (except for methods returning a DXPidXDOFed object). Initializes the PID with the PID string.

cardinality
  long cardinality();

Returns the number of all individual leaf elements (non-collection) across the collection boundaries. This is the total of all elements in each sub-collection.

createIterator
  LPDISPATCH createIterator();

Creates an iterator to iterate over a collection. Each member that the iterator returns is always a leaf element rather than a collection. The returned LPDISPATCH pointer contains a DXResultsIteratorFed object.

addElement
  addElement(VARIANT element);

Adds an element to the collection.

retrieveElementAt
  VARIANT retrieveElementAt(LPDISPATCH where);

Returns the element the iterator currently points at. The input parameter LPDISPATCH pointer contains a DXSequentialIteratorFed object or a DXResultsIterator object.

removeElementAt
  removeElementAt(LPDISPATCH where);

Removes the element the iterator currently points at. The input parameter LPDISPATCH pointer contains a DXSequentialIteratorFed object or a DXResultsIterator object.

removeAllElements
  removeAllElements();

Removes all elements in the collection.

insertElementAt
  insertElementAt(VARIANT element, LPDISPATCH where);

Adds a new element after the element the iterator currently points to. The input parameter LPDISPATCH pointer contains a DXSequentialIteratorFed object or a DXResultsIterator object.

replaceElementAt
  replaceElementAt(VARIANT element, LPDISPATCH where);

Replaces the element the iterator currently points at. The input parameter LPDISPATCH pointer contains a DXSequentialIteratorFed object or a DXResultsIterator 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 DXNVPairFed objects and returns the results. The value of the returned VARIANT is a DXResultsFed object.

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