Index

DXIndexClassDefDL

Purpose:

This class defines methods to access entity information for an index class.

Methods:

datastoreName
BSTR datastoreName();

Gets the name of this datastore object.

datastoreType
BSTR datastoreType();

Gets the type for this datastore object.

getId
short getId();

Gets entity ID.

setId
setId(short id);

Sets entity ID.

getName
BSTR getName();

Gets entity name.

setName
setName(LPCTSTR name);

Sets entity name.

getType
short getType();

Gets type of this entity.

setType
setType(short type);

Sets type of this entity.

getDescription
BSTR getDescription();

Gets description to this attribute.

setDescription
setDescription(LPCTSTR name);

Sets description to this attribute.

isSearchable
BOOL isSearchable();

Returns TRUE if searchable.

getAttr
LPDISPATCH getAttr(LPCTSTR attrName);

Gets the attribute definition. The returned LPDISPATCH pointer contains a DXAttrDefDL object.

listAttrs
LPDISPATCH listAttrs();

Lists the attribute definitions. The returned LPDISPATCH pointer contains a DXSequentialCollectionDL object.

listAttrNames
VARIANT listAttrNames(long* arraySize);

Lists the attribute definition names. The output parameter arraySize is the size of the array.

getDatastore
LPDISPATCH getDatastore();

Gets the datastore. The returned LPDISPATCH pointer contains a DXDatastoreDL object.

setDatastore
setDatastore(LPDISPATCH ds);

Sets the datastore. The input parameter LPDISPATCH pointer contains a DXDatastoreDL object.

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