CDaoRecordset::GetIndexInfo

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

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

Parameters

nIndex

The zero-based index in the table’s Indexes collection, for lookup by numerical position.

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. For best performance, retrieve only the level of information you need:

AFX_DAO_PRIMARY_INFO (Default) Name, Field Info, Fields
AFX_DAO_SECONDARY_INFO Primary information, plus: Primary, Unique, Clustered, IgnoreNulls, 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 base table underlying a recordset. One version of the function lets you look up a 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 about creating recordsets, see the article DAO Recordset: Creating Recordsets in Visual C++ Programmer's Guide. For related information, see the topic "Attributes Property" in DAO Help.

CDaoRecordset Overview | Class Members | Hierarchy Chart