IEnroll interface (xenroll.h)
[This interface is no longer available for use as of Windows Server 2008 and Windows Vista.]
The IEnroll interface represents the Certificate Enrollment Control and is used primarily to generate certificate requests.
Inheritance
The IEnroll interface inherits from the IUnknown interface. IEnroll also has these types of members:
Methods
The IEnroll interface has these methods.
| IEnroll::acceptFilePKCS7WStr Accepts and processes a PKCS (IEnroll.acceptFilePKCS7WStr) |
| IEnroll::acceptPKCS7Blob Accepts and processes a PKCS (IEnroll.acceptPKCS7Blob) |
| IEnroll::AddAuthenticatedAttributesToPKCS7Request The AddAuthenticatedAttributesToPKCS7Request method adds authenticated attributes to a PKCS |
| IEnroll::AddCertTypeToRequestWStr Adds a certificate template to a request (used to support the enterprise certification authority (CA)). |
| IEnroll::AddExtensionsToRequest The AddExtensionsToRequest method adds extensions to the certificate request. This method was first defined in the IEnroll interface. |
| IEnroll::AddNameValuePairToSignatureWStr Adds the authenticated name-value pair of an attribute to the request. The certification authority (CA) interprets the meaning of the name-value pair. |
| IEnroll::createFilePKCS10WStr Creates a base64-encoded PKCS (IEnroll.createFilePKCS10WStr) |
| IEnroll::createPKCS10WStr Creates a base64-encoded PKCS (IEnroll.createPKCS10WStr) |
| IEnroll::CreatePKCS7RequestFromRequest The CreatePKCS7RequestFromRequest method creates a PKCS |
| IEnroll::enumContainersWStr Retrieves the names of containers for the cryptographic service provider (CSP) specified by the ProviderNameWStr property. |
| IEnroll::enumProvidersWStr The IEnroll4::enumProvidersWStr method retrieves the names of the available cryptographic service providers (CSPs) specified by the ProviderType property. |
| IEnroll::freeRequestInfoBlob The freeRequestInfoBlob method deletes a certificate context. This method was first defined in the IEnroll interface. |
| IEnroll::get_CAStoreFlags The CAStoreFlags property of IEnroll4 sets or retrieves a flag that controls the certification authority (CA) store when the store is opened. (Get) |
| IEnroll::get_CAStoreNameWStr The CAStoreNameWStr property of IEnroll4 sets or retrieves the name of the store where all non-"ROOT" and non-"MY" certificates are kept. (Get) |
| IEnroll::get_CAStoreTypeWStr Sets or retrieves the type of store to use for the store specified by the CAStoreNameWStr property. (Get) |
| IEnroll::get_ContainerNameWStr Sets or retrieves the name of the key container to use. (Get) |
| IEnroll::get_DeleteRequestCert The DeleteRequestCert property of IEnroll4 sets or retrieves a Boolean value that determines whether dummy certificates in the request store are deleted. (Get) |
| IEnroll::get_EnableT61DNEncoding Sets or retrieves a Boolean value that determines whether the distinguished name in the request is encoded as a T61 string instead of as a Unicode string. (Get) |
| IEnroll::get_GenKeyFlags Sets or retrieves the values passed to CryptGenKey when the certificate request is generated. (Get) |
| IEnroll::get_HashAlgorithmWStr Sets or retrieves only the signature hashing algorithm used to sign the PKCS (IEnroll.get_HashAlgorithmWStr) |
| IEnroll::get_KeySpec Sets or retrieves the type of key generated. (Get) |
| IEnroll::get_MyStoreFlags Sets or retrieves the registry location used for the MY store. (Get) |
| IEnroll::get_MyStoreNameWStr The MyStoreNameWStr property of IEnroll4 sets or retrieves the name of the store where certificates with linked private keys are kept. (Get) |
| IEnroll::get_MyStoreTypeWStr Sets or retrieves the type of store specified by the MyStoreTypeWStr property. (Get) |
| IEnroll::get_ProviderFlags The ProviderFlags property of IEnroll4 sets or retrieves the provider type. (Get) |
| IEnroll::get_ProviderNameWStr Sets or retrieves the name of the cryptographic service provider (CSP) to use. (Get) |
| IEnroll::get_ProviderType Sets or retrieves the type of provider. (Get) |
| IEnroll::get_PVKFileNameWStr Sets or retrieves the name of the file that will contain exported keys. (Get) |
| IEnroll::get_RenewalCertificate Specifies the certificate context for the renewal certificate. (Get) |
| IEnroll::get_RequestStoreFlags The RequestStoreFlags property of IEnroll4 sets or retrieves the registry location used for the request store. (Get) |
| IEnroll::get_RequestStoreNameWStr The RequestStoreNameWStr property of IEnroll4 sets or retrieves the name of the store that contains the dummy certificate. (Get) |
| IEnroll::get_RequestStoreTypeWStr Sets or retrieves the type of store to use for the store specified by the RequestStoreNameWStr property. This store type is passed directly to the CertOpenStore function. (Get) |
| IEnroll::get_RootStoreFlags Sets or retrieves the registry location used for the root store. (Get) |
| IEnroll::get_RootStoreNameWStr The RootStoreNameWStr property of IEnroll4 sets or retrieves the name of the root store where all intrinsically trusted, self-signed root certificates are kept. (Get) |
| IEnroll::get_RootStoreTypeWStr Sets or retrieves the type of store to use for the store specified by the RootStoreNameWStr property. (Get) |
| IEnroll::get_SPCFileNameWStr The SPCFileNameWStr property of IEnroll4 sets or retrieves the name of the file to which to write the base64-encoded PKCS (Get) |
| IEnroll::get_UseExistingKeySet The UseExistingKeySet property of IEnroll4 sets or retrieves a Boolean value that determines whether the existing keys should be used. (Get) |
| IEnroll::get_WriteCertToCSP Sets or retrieves a Boolean value that determines whether a certificate should be written to the cryptographic service provider (CSP). (Get) |
| IEnroll::get_WriteCertToUserDS The WriteCertToUserDS property of IEnroll4 sets or retrieves a Boolean value that determines whether the certificate is written to the user's Active Directory store. (Get) |
| IEnroll::getCAStore The getCAStore method is not implemented. |
| IEnroll::getCertContextFromPKCS7 Retrieves a certificate context based on a PKCS |
| IEnroll::getMyStore The getMyStore method is not implemented. |
| IEnroll::getROOTHStore The getROOTHStore method is not implemented. |
| IEnroll::put_CAStoreFlags The CAStoreFlags property of IEnroll4 sets or retrieves a flag that controls the certification authority (CA) store when the store is opened. (Put) |
| IEnroll::put_CAStoreNameWStr The CAStoreNameWStr property of IEnroll4 sets or retrieves the name of the store where all non-"ROOT" and non-"MY" certificates are kept. (Put) |
| IEnroll::put_CAStoreTypeWStr Sets or retrieves the type of store to use for the store specified by the CAStoreNameWStr property. (Put) |
| IEnroll::put_ContainerNameWStr Sets or retrieves the name of the key container to use. (Put) |
| IEnroll::put_DeleteRequestCert The DeleteRequestCert property of IEnroll4 sets or retrieves a Boolean value that determines whether dummy certificates in the request store are deleted. (Put) |
| IEnroll::put_EnableT61DNEncoding Sets or retrieves a Boolean value that determines whether the distinguished name in the request is encoded as a T61 string instead of as a Unicode string. (Put) |
| IEnroll::put_GenKeyFlags Sets or retrieves the values passed to CryptGenKey when the certificate request is generated. (Put) |
| IEnroll::put_HashAlgorithmWStr Sets or retrieves only the signature hashing algorithm used to sign the PKCS (IEnroll.put_HashAlgorithmWStr) |
| IEnroll::put_KeySpec Sets or retrieves the type of key generated. (Put) |
| IEnroll::put_MyStoreFlags Sets or retrieves the registry location used for the MY store. (Put) |
| IEnroll::put_MyStoreNameWStr The MyStoreNameWStr property of IEnroll4 sets or retrieves the name of the store where certificates with linked private keys are kept. (Put) |
| IEnroll::put_MyStoreTypeWStr Sets or retrieves the type of store specified by the MyStoreTypeWStr property. (Put) |
| IEnroll::put_ProviderFlags The ProviderFlags property of IEnroll4 sets or retrieves the provider type. (Put) |
| IEnroll::put_ProviderNameWStr Sets or retrieves the name of the cryptographic service provider (CSP) to use. (Put) |
| IEnroll::put_ProviderType Sets or retrieves the type of provider. (Put) |
| IEnroll::put_PVKFileNameWStr Sets or retrieves the name of the file that will contain exported keys. (Put) |
| IEnroll::put_RenewalCertificate Specifies the certificate context for the renewal certificate. (Put) |
| IEnroll::put_RequestStoreFlags The RequestStoreFlags property of IEnroll4 sets or retrieves the registry location used for the request store. (Put) |
| IEnroll::put_RequestStoreNameWStr The RequestStoreNameWStr property of IEnroll4 sets or retrieves the name of the store that contains the dummy certificate. (Put) |
| IEnroll::put_RequestStoreTypeWStr Sets or retrieves the type of store to use for the store specified by the RequestStoreNameWStr property. This store type is passed directly to the CertOpenStore function. (Put) |
| IEnroll::put_RootStoreFlags Sets or retrieves the registry location used for the root store. (Put) |
| IEnroll::put_RootStoreNameWStr The RootStoreNameWStr property of IEnroll4 sets or retrieves the name of the root store where all intrinsically trusted, self-signed root certificates are kept. (Put) |
| IEnroll::put_RootStoreTypeWStr Sets or retrieves the type of store to use for the store specified by the RootStoreNameWStr property. (Put) |
| IEnroll::put_SPCFileNameWStr The SPCFileNameWStr property of IEnroll4 sets or retrieves the name of the file to which to write the base64-encoded PKCS (Put) |
| IEnroll::put_UseExistingKeySet The UseExistingKeySet property of IEnroll4 sets or retrieves a Boolean value that determines whether the existing keys should be used. (Put) |
| IEnroll::put_WriteCertToCSP Sets or retrieves a Boolean value that determines whether a certificate should be written to the cryptographic service provider (CSP). (Put) |
| IEnroll::put_WriteCertToUserDS The WriteCertToUserDS property of IEnroll4 sets or retrieves a Boolean value that determines whether the certificate is written to the user's Active Directory store. (Put) |
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client | Windows XP [desktop apps only] |
| Minimum supported server | Windows Server 2003 [desktop apps only] |
| Target Platform | Windows |
| Header | xenroll.h |
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for