ICspStatus::get_EnrollmentStatus method (certenroll.h)

Article
04/02/2021

The EnrollmentStatus property retrieves an IX509EnrollmentStatus object that contains information about the certificate enrollment.

This property is read-only.

Syntax

HRESULT get_EnrollmentStatus(
  IX509EnrollmentStatus **ppValue
);

Parameters

ppValue

Return value

None

Remarks

This property returns an IX509EnrollmentStatus object. This object is typically populated when you create a PKCS #10 certificate request. The following three properties returned by this object provide information about the provider/algorithm pair represented by an ICspStatus object:

The Display property specifies whether the provider and algorithm should be displayed in a user interface.
The Selected property specifies whether the provider and algorithm can be used to create a key pair for a certificate request.
The Status property specifies whether the provider and algorithm were skipped or resulted in an error during request initialization.

To understand how these properties are important, assume that a certificate request is based on a template that specifies a particular provider and algorithm. The Display and Status properties for this provider/algorithm pair are enabled. For other ICspStatus objects, one or both of these properties may not be enabled. For more complete examples, see the Ordinal property.

The Status property is set to EnrollUnknown when the IX509EnrollmentStatus object is first created. If a provider/algorithm pair is not selected, the status may be set to EnrollSkipped. The status will be set to EnrollError if key creation fails for the selected provider and algorithm during certificate initialization.

Requirements

Requirement	Value
Minimum supported client	Windows Vista [desktop apps only]
Minimum supported server	Windows Server 2008 [desktop apps only]
Target Platform	Windows
Header	certenroll.h
DLL	CertEnroll.dll