IX509Enrollment interface (certenroll.h)
The IX509Enrollment interface represents the top level object and enables you to enroll in a certificate hierarchy and install a certificate response. The enrollment process supports the following three scenarios:
-
Out-of-band enrollment
- Call any initialization method implemented by the IX509Enrollment object.
- Call the CreateRequest method.
- Submit the request out of band (manually or through some other process).
- Receive the response from a certification or registration authority.
- Call the InstallResponse method.
- Automatic enrollment
- Call any initialization method implemented by the IX509Enrollment object.
- Call the Enroll method.
- Delayed enrollment
- Call any initialization method implemented by the IX509Enrollment object.
- Call the CreateRequest method.
- Store the request for a period of time such as days or weeks.
- Call the Initialize method to create a request object when you are ready to enroll.
- Populate the request object from your stored request.
- Call the InstallResponse method.
Inheritance
The IX509Enrollment interface inherits from the IDispatch interface. IX509Enrollment also has these types of members:
Methods
The IX509Enrollment interface has these methods.
| IX509Enrollment::CreatePFX Creates a Personal Information Exchange (PFX) message. |
| IX509Enrollment::CreateRequest Retrieves an encoded certificate request. |
| IX509Enrollment::Enroll Encodes a request, submits it to an appropriate certification authority (CA), and installs the response. |
| IX509Enrollment::get_CAConfigString Retrieves the configuration string that identifies the certification authority (CA) to which the certificate request was submitted. |
| IX509Enrollment::get_Certificate Retrieves the installed certificate. |
| IX509Enrollment::get_CertificateDescription Specifies or retrieves a string that contains a description of the certificate. (Get) |
| IX509Enrollment::get_CertificateFriendlyName Specifies or retrieves the display name of a certificate. (Get) |
| IX509Enrollment::get_EnrollmentContext Retrieves an enrollment context that identifies whether the certificate is intended for a computer or an end-user. |
| IX509Enrollment::get_NameValuePairs Retrieves a collection of name-value pairs associated with the enrollment object. |
| IX509Enrollment::get_ParentWindow Specifies or retrieves the ID of the window used to display the enrollment information. (Get) |
| IX509Enrollment::get_Request Retrieves the certificate request associated with the enrollment object. |
| IX509Enrollment::get_RequestId Retrieves a unique identifier for the certificate request sent to the certification authority by the Enroll method. |
| IX509Enrollment::get_Response Retrieves the certificate response returned from a certification authority. |
| IX509Enrollment::get_Silent Specifies or retrieves a Boolean value that indicates whether a user interface is displayed during the certificate enrollment process. (Get) |
| IX509Enrollment::get_Status Retrieves an IX509EnrollmentStatus object that can be used to monitor the status of the enrollment process and retrieve error information. |
| IX509Enrollment::Initialize Initializes the enrollment object and creates a default PKCS |
| IX509Enrollment::InitializeFromRequest Initializes the enrollment object from an existing IX509CertificateRequest object. |
| IX509Enrollment::InitializeFromTemplateName Initializes the enrollment object from a template common name (CN). |
| IX509Enrollment::InstallResponse Installs a certificate chain on the end-entity computer. (IX509Enrollment.InstallResponse) |
| IX509Enrollment::put_CertificateDescription Specifies or retrieves a string that contains a description of the certificate. (Put) |
| IX509Enrollment::put_CertificateFriendlyName Specifies or retrieves the display name of a certificate. (Put) |
| IX509Enrollment::put_ParentWindow Specifies or retrieves the ID of the window used to display the enrollment information. (Put) |
| IX509Enrollment::put_Silent Specifies or retrieves a Boolean value that indicates whether a user interface is displayed during the certificate enrollment process. (Put) |
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 |