ICertServerPolicy::EnumerateAttributes method (certif.h)

Article
02/22/2024

The EnumerateAttributes method retrieves the name of the current attribute and moves the internal enumeration pointer to the next attribute.

Syntax

HRESULT EnumerateAttributes(
  [out] BSTR *pstrAttributeName
);

Parameters

[out] pstrAttributeName

A pointer to the attribute name.

Return value

C++

If the method succeeds, the method returns S_OK, and the pstrAttributeName parameter is set to a BSTR that contains the name of the attribute. A value of S_FALSE is returned if the last attribute was already enumerated.

To use this method, create a variable of BSTR type, set the variable equal to NULL, and then pass the address of this variable as pstrAttributeName.

When you have finished using the BSTR, free it by calling the SysFreeString function.

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

Returns a string that contains the name of the attribute, or an empty string if the last attribute was already enumerated.

Remarks

Before calling the EnumerateAttributes method for the first time, call the EnumerateAttributesSetup method to initialize the enumeration pointer to the first attribute.

When done enumerating, call
the EnumerateAttributesClose method to free resources used by the enumeration calls.

Requirements

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