Index

DXDatastoreDD

Purpose:

This is the class that is used to represent a datastore for Domino.Doc.

Methods:

addObject
   addObject(LPDISPATCH ddobase);

Add the data object to the datastore. The input parameter LPDISPATCH pointer contains a DXDDODD object.

commit
   commit();

Commits the current transaction. Not supported for this release.

connect
   connect(LPCTSTR datastoreName, LPCTSTR userName,
 
           LPCTSTR authentication, VARIANT connectString);

Connects to a datastore.

Parameters:

createQuery
   LPDISPATCH createQuery(LPCTSTR command,
 
                          short commandLangType
 
                          [,VARIANT paramList]);

Creates a query object using a command. The parameter list is in the form of an array of DXNVPairDD objects. The returned LPDISPATCH pointer contains a DXParametricQueryDD object.

datastoreDef
   LPDISPATCH datastoreDef();

Gets the datastore def. The returned LPDISPATCH pointer contains a DXDatastoreDefDD object.

datastoreName
   BSTR datastoreName();

Gets the datastore name.

datastoreType
   BSTR datastoreType();

Gets the datastore type.

deleteObject
   deleteObject(LPDISPATCH ddobase);

Delete the data object from the datastore. Not supported for this release.

disconnect
   disconnect()

Disconnects from the datastore.

evaluate
   VARIANT evaluate(LPCTSTR command,
 
                    short commandLangType
 
                    [,VARIANT paramList]);

Evaluate a query using a command. The parameter list is in the form of an array of DXNVPairDD objects. The value of the returned VARIANT is a DXResultsDD object.

evaluateQuery
   VARIANT evaluateQuery(LPDISPATCH query);

Evaluate a query using a query object. The value of the returned VARIANT is a DXResultsDD object. The input parameter LPDISPATCH pointer contains a DXParametricQueryDD object.

execute
   LPDISPATCH execute(LPCTSTR command,
 
                      short commandLangType
 
                      [,VARIANT paramList]);

Execute a query using a command. The parameter list is in the form of an array of DXNVPairDD objects. The returned LPDISPATCH pointer contains a DXResultSetCursorDD object.

executeQuery
   LPDISPATCH executeQuery(LPDISPATCH query);

Execute a query using a query object. The input parameter LPDISPATCH pointer contains a DXParametricQueryDD object. The returned LPDISPATCH pointer contains a DXResultSetCursorDD object.

getEntityById
   LPDISPATCH getEntityById(short entityType, LPCTSTR id);

Gets an entity by its id. The returned entity is either a Cabinet, a Binder or a Document.

getOption
   getOption(long option, VARIANT* value);

Gets the value for the specified datastore option.

isConnected
   BOOL isConnected();

Returns true if datastore is connected.

listDataSourceNames
   VARIANT listDataSourceNames(long* arraySize);

Gets a list of server names. The output parameter arraySize is the size of the array.

listDataSources
   LPDISPATCH listDataSources();

Gets a list of servers. The returned LPDISPATCH pointer contains a DXSequentialCollectionDD object.

listEntities
   LPDISPATCH listEntities();

Gets a list of entities. The returned LPDISPATCH pointer contains a DXSequentialCollectionDD object.

listEntityAttrNames
   VARIANT listEntityAttrNames(LPCTSTR entityName, long* arraySize);

Gets a list of entity attribute names. The output parameter arraySize is the size of the array.

listEntityAttrs
   LPDISPATCH listEntityAttrs(LPCTSTR entityName);

Gets a list of entity attributes. The returned LPDISPATCH pointer contains a DXSequentialCollectionDD object.

listEntityNames
   VARIANT listEntityNames(long* arraySize);

Gets a list of entity names. The output parameter arraySize is the size of the array.

listSearchableEntities
   LPDISPATCH listSearchableEntities();

Gets a list of Cabinet names from a Domino.Doc library.

listSearchableEntityNames
   VARIANT listEntityNames(long* arraySize);

Gets a list of Cabinets' names from a Domino.Doc library.

retrieveObject
   retrieveObject(LPDISPATCH ddobase);

Retrieve the data object from the persistent datastore into memory. The input parameter LPDISPATCH pointer contains a DXDDODD object.

rollback
   rollback();

Rollback the current transaction. Not supported for this release.

setOption
   setOption(long option, VARIANT value);

Sets the value for the specified option.

updateObject
   updateObject(LPDISPATCH ddobase);

Update the datastore with this data object. The input parameter LPDISPATCH pointer contains a DXDDODD object. Not supported for this release.

userName
   BSTR userName();

Returns the user name that was used to connect to the datastore.

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