IDatabase::GetIndexInfo method

  • Article

[GetIndexInfo is available for use in the operating systems specified in the Requirements section. It may be altered or unavailable in subsequent versions.]

Retrieves information about an index out of the database.

Syntax

HRESULT GetIndexInfo(
  [in]  INDEXORDINAL iIndex,
  [out] LPSTR        *ppszFilter,
  [out] LPTABLEINDEX pIndex
);

Parameters

iIndex [in]

Type: INDEXORDINAL

Specifies the index whose information is wanted.

ppszFilter [out]

Type: LPSTR*

Will receive the filter for the index. Must be freed by caller.

pIndex [out]

Type: LPTABLEINDEX

Will receive the TABLEINDEX information for this index.

Return value

Type: HRESULT

Returns one of the following values.

Return code Description
SUCCEEDED
 The index information has been successfully retrieved.
E_FAIL
 The index does not exist.

Requirements
Minimum supported client
 Windows XP [desktop apps only]
Minimum supported server
 Windows Server 2003 [desktop apps only]
Product
 Outlook Express 6.0
Header
Oledb.h
IDL
Directdb.idl
DLL
Directdb.dll (version 6.0 or later)