Index

DXDatastoreV4

Purpose:

This is the class that is used to represent a datastore for VisualInfo for AS/400.

Methods:

addObject
        addObject(LPDISPATCH ddobase);

Adds the data object to the datastore. The input parameter LPDISPATCH pointer contains a DXDDOV4 object.

checkedOutUserid
        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
        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
        checkOut(LPDISPATCH     dataObject);

Checks out a document or folder item from the datastore. The input parameter LPDISPATCH pointer contains a DXDDOV4 object.

commit
        commit();

Commits the current transaction. This is not supported.

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

Connects to a datastore.

Parameters:

datastoreName
The datastore name to connect to.

userName
The user name being used to connect to the content server.

authentication
The authentication or password being used to connect.

connectString
A string which supplies all of the specific connection parameters to establish and maintain a connection to the content server. Valid parameters include:

NPWD=value
The new password to be used to change the user's password at connect time.

createDDO
        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.

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 DXNVPairV4 objects. The returned LPDISPATCH pointer contains a DXParametricQueryV4 object.

datastoreDef
        LPDISPATCH datastoreDef();

Gets the datastore definition. The returned LPDISPATCH pointer contains a DXDatastoreDefV4 object.

datastoreName
        BSTR datastoreName();

Gets the datastore name.

datastoreType
        BSTR datastoreType();

Gets the datastore type.

deleteObject
        deleteObject(LPDISPATCH ddobase);

Deletes the data object from the datastore. The input parameter LPDISPATCH pointer contains a DXDDOV4 object.

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 DXNVPairV4 objects. The value of the returned VARIANT is a DXResultsV4 object.

evaluateQuery
        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.

execute
        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.

executeQuery
        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
        getOption(long option, VARIANT* value);

Gets the value for the specified datastore option.

initConfiguration
        initConfiguration(LPCTSTR       configuration);

Initializes the datastore with the specified configuration string. The configuration string supplies the specific initialization parameters. Valid parameters include:

CC2MIMEURL=value
The URL for the file containing the content class to MIME type mapping.

CC2MIMEFILE=value
The name of the file containing the content class to MIME type mapping. This parameter is ignored if the CC2MIMEURL is specified.

DSNAME=value
The name of this datastore

isCheckedOut
        BOOL isCheckedOut(LPDISPATCH dataObject);

Returns true if the specified folder or document is checked out. The input parameter LPDISPATCH pointer contains a DXDDOV4 object.

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 DXSequentialCollectionV4 object.

listEntities
        LPDISPATCH listEntities();

Gets a list of entities. The returned LPDISPATCH pointer contains a DXSequentialCollectionV4 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 DXSequentialCollectionV4 object.

listEntityNames
        VARIANT listEntityNames(long*   arraySize);

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

moveObject
        moveObject(LPDISPATCH   dataObject,     LPCTSTR entityName);

Moves current dataobject from one entity to another (to re-index).

retrieveFormOverlay
        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
        retrieveObject(LPDISPATCH       ddobase);

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

rollback
        rollback();

Rolls back the current transaction. This is not supported.

setOption
        setOption(long option, VARIANT value);

Sets the value for the specified option. See getOption for the list of options for VI400.

startTransaction
         startTransaction();

Starts a transaction. This is not supported.

unlockCheckedOut
         unlockCheckedOut(LPDISPATCH dataObject);

Unlocks the checked-out document or folder item.

updateObject
        updateObject(LPDISPATCH ddobase);

Updates the datastore with this data object. The input parameter LPDISPATCH pointer contains a DXDDOV4 object.

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.