IEnumCERTVIEWROW::EnumCertViewAttribute method (certview.h)

Article
10/13/2021

The EnumCertViewAttribute method obtains an instance of an attribute-enumeration sequence for the current row of the row-enumeration sequence.

Syntax

HRESULT EnumCertViewAttribute(
  [in]  LONG                   Flags,
  [out] IEnumCERTVIEWATTRIBUTE **ppenum
);

Parameters

[in] Flags

C++	A LONG value. Must be zero.
VB	A Long value. Must be zero.

[out] ppenum

A pointer to a pointer of IEnumCERTVIEWATTRIBUTE type. Upon successful completion of this method, ppenum is set to a pointer of IEnumCERTVIEWATTRIBUTE type.

Return value

C++

If the method succeeds, the method returns S_OK.

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

The returned value is an attribute-enumeration sequence object.

Remarks

The attribute-enumeration sequence obtained by this call can be used to enumerate the attributes associated with the certificate in the current row. This enumeration can be accessed through the methods of the IEnumCERTVIEWATTRIBUTE interface.

To reference a different row, call one of the following methods to navigate through the row-enumeration sequence:

IEnumCERTVIEWROW::Reset: Moves to the beginning of the enumeration sequence.
IEnumCERTVIEWROW::Next: Moves to the next row in the enumeration sequence.
IEnumCERTVIEWROW::Skip: Skips a specified number of rows.

Examples

// pEnumRow is previously instantiated pointer to IEnumCERTVIEWROW
HRESULT                  hr;
LONG                     Index;
IEnumCERTVIEWATTRIBUTE * pEnumAttr = NULL;

// obtain enumerator for attributes
hr = pEnumRow->EnumCertViewAttribute(0, &pEnumAttr);
if (FAILED(hr))
{
    printf("Failed EnumCertViewAttribute - %x\n", hr);
    goto error;
}
// enumerate each attribute
while (S_OK == pEnumAttr->Next(&Index))
{
    // Use this attribute as needed.
}
error:

// Free resources.
if (NULL != pEnumAttr)
    pEnumAttr->Release();

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