Purpose:
This is the class that is used to represent a datastore for VisualInfo for AS/400.
Methods:
addObject(LPDISPATCH ddobase);
Adds the data object to the datastore. The input parameter LPDISPATCH pointer contains a DXDDOV4 object.
BSTR checkedOutUserid(LPDISPATCH dataObject);
Returns the user ID who currently has the document or folder checked out. The input parameter LPDISPATCH pointer contains a DXDDOV4 object.
checkIn(LPDISPATCH dataObject);
Checks in a document or folder item previously checked out from the datastore. The input parameter LPDISPATCH pointer contains a DXDDOV4 object.
checkOut(LPDISPATCH dataObject);
Checks out a document or folder item from the datastore. The input parameter LPDISPATCH pointer contains a DXDDOV4 object.
commit();
connect(LPCTSTR datastoreName, LPCTSTR userName, LPCTSTR authentication, VARIANT connectString);
Connects to a datastore.
Parameters:
LPDISPATCH createDDO(LPCTSTR objectType, long flag);
Creates a new DDO with object type, properties and attributes set for VI400. Valid values for flag are DX_V4_FOLDER and DX_V4_DOCUMENT.
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 DXNVPairV4 objects. The returned LPDISPATCH pointer contains a DXParametricQueryV4 object.
LPDISPATCH datastoreDef();
Gets the datastore definition. The returned LPDISPATCH pointer contains a DXDatastoreDefV4 object.
BSTR datastoreName();
BSTR datastoreType();
deleteObject(LPDISPATCH ddobase);
Deletes the data object from the datastore. The input parameter LPDISPATCH pointer contains a DXDDOV4 object.
disconnect()
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 DXNVPairV4 objects. The value of the returned VARIANT is a DXResultsV4 object.
VARIANT evaluateQuery(LPDISPATCH query);
Evaluate a query using a query object. The value of the returned VARIANT is a DXResultsV4 object. The input parameter LPDISPATCH pointer contains a DXParametricQueryV4 object.
LPDISPATCH execute(LPCTSTR command, short commandLangType [,VARIANT paramList]);
Executes a query using a command. The parameter list is in the form of an array of DXNVPairV4 objects. The returned LPDISPATCH pointer contains a DXResultSetCursorV4 object.
LPDISPATCH executeQuery(LPDISPATCH query);
Executes a query using a query object. The input parameter LPDISPATCH pointer contains a DXParametricQueryV4 object. The returned LPDISPATCH pointer contains a DXResultSetCursorV4 object.
getOption(long option, VARIANT* value);
initConfiguration(LPCTSTR configuration);
Initializes the datastore with the specified configuration string. The configuration string supplies the specific initialization parameters. Valid parameters include:
BOOL isCheckedOut(LPDISPATCH dataObject);
Returns true if the specified folder or document is checked out. The input parameter LPDISPATCH pointer contains a DXDDOV4 object.
BOOL isConnected();
VARIANT listDataSourceNames(long* arraySize);
Gets a list of server names. The output parameter arraySize is the size of the array.
LPDISPATCH listDataSources();
Gets a list of servers. The returned LPDISPATCH pointer contains a DXSequentialCollectionV4 object.
LPDISPATCH listEntities();
Gets a list of entities. The returned LPDISPATCH pointer contains a DXSequentialCollectionV4 object.
VARIANT listEntityAttrNames(LPCTSTR entityName, long* arraySize);
Gets a list of entity attribute names. The output parameter arraySize is the size of the array.
LPDISPATCH listEntityAttrs(LPCTSTR entityName);
Gets a list of entity attributes. The returned LPDISPATCH pointer contains a DXSequentialCollectionV4 object.
VARIANT listEntityNames(long* arraySize);
Gets a list of entity names. The output parameter arraySize is the size of the array.
moveObject(LPDISPATCH dataObject, LPCTSTR entityName);
Moves current dataobject from one entity to another (to re-index).
LPDISPATCH retrieveFormOverlay(LPCTSTR objid);
Retrieves the form overlay object based on the specified ID string for the form overlay object to be retrieved. The returned LPDISPATCH pointer contains a DXBlobV4 object.
retrieveObject(LPDISPATCH ddobase);
Retrieves the data object from the persistent datastore into memory. The input parameter LPDISPATCH pointer contains a DXDDOV4 object.
rollback();
setOption(long option, VARIANT value);
Sets the value for the specified option. See getOption for the list of options for VI400.
startTransaction();
unlockCheckedOut(LPDISPATCH dataObject);
updateObject(LPDISPATCH ddobase);
Updates the datastore with this data object. The input parameter LPDISPATCH pointer contains a DXDDOV4 object.
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.