IEnumCERTVIEWCOLUMN::IsIndexed method (certview.h)

Article
02/22/2024

The IsIndexed method reports whether the data in the column is indexed.

Syntax

HRESULT IsIndexed(
  [out] LONG *pIndexed
);

Parameters

[out] pIndexed

A pointer to a variable of type LONG that indicates TRUE if the data is indexed and FALSE if the data is not indexed. This method fails if pIndexed is set to NULL.

Return value

C++

If the method succeeds, the method returns S_OK and the pIndexed is set to TRUE or FALSE.

If the method fails, it returns an HRESULT value that indicates the error. For a list of common error codes, see Common HRESULT Values.

VB

One if the column is indexed; otherwise, zero.

Remarks

This method is used to determine whether the data of the current column referenced by the column-enumeration sequence is indexed.

If the column-enumeration sequence is not referencing a valid column, IsIndexed will fail. Use one of the following methods to navigate through the enumeration:

IEnumCERTVIEWCOLUMN::Reset: Moves to the beginning of the enumeration sequence.
IEnumCERTVIEWCOLUMN::Next: Moves to the next column in the enumeration sequence.
IEnumCERTVIEWCOLUMN::Skip: Skips a specified number of columns.

Examples

HRESULT  hr;
LONG     bIsindexed;

// pEnumCol is previously instantiated IEnumCERTVIEWCOLUMN object
hr = pEnumCol->IsIndexed(&bIsindexed);
if (S_OK == hr)
    printf( bIsindexed ? "Indexed\n" : "Not indexed\n");

Requirements

Requirement	Value
Minimum supported client	None supported
Minimum supported server	Windows Server 2003 [desktop apps only]
Target Platform	Windows
Header	certview.h (include Certsrv.h)
Library	Certidl.lib
DLL	Certadm.dll

Share via