CDaoTableDef::GetIndexInfo

  • Article

void GetIndexInfo( intnIndex**,CDaoIndexInfo&indexinfo,DWORDdwInfoOptions= AFX_DAO_PRIMARY_INFO );
throw( CDaoException, CMemoryException );**

void GetIndexInfo( LPCTSTRlpszName**,CDaoIndexInfo&indexinfo, DWORD** dwInfoOptions**= AFX_DAO_PRIMARY_INFO );
throw( CDaoException, CMemoryException );**

Parameters

nIndex

The numeric index of the Index object in the table’s zero-based Indexes collection, for lookup by its position in the collection.

indexinfo

A reference to a CDaoIndexInfo structure.

dwInfoOptions

Options that specify which information about the index to retrieve. The available options are listed here along with what they cause the function to return:

  • AFX_DAO_PRIMARY_INFO   Name, Field Info, Fields. Use this option for fastest performance.

  • AFX_DAO_SECONDARY_INFO   Primary information, plus: Primary, Unique, Clustered, Ignore Nulls, Required, Foreign

  • AFX_DAO_ALL_INFO   Primary and secondary information, plus: Distinct Count

lpszName

A pointer to the name of the index object, for lookup by name.

Remarks

Call this member function to obtain various kinds of information about an index defined in the tabledef. One version of the function lets you look up an index by its position in the collection. The other version lets you look up an index by name.

For a description of the information returned, see the CDaoIndexInfo structure. This structure has members that correspond to the items of information listed above in the description of dwInfoOptions. When you request information at one level, you get information for any prior levels as well.

For more information on tabledefs, see the articles and in Visual C++ Programmer's Guide. For related information, see the topic "Attributes Property" in DAO Help.

CDaoTableDef Overview |  Class Members |  Hierarchy Chart

See Also   CDaoTableDef::GetFieldInfo, CDaoTableDef::GetIndexCount, CDaoTableDef::GetFieldCount