IEnroll4 interface (xenroll.h)
[This interface is no longer available for use as of Windows Server 2008 and Windows Vista.]
The IEnroll4 interface represents the Certificate Enrollment Control and is used primarily to generate certificate requests.
Inheritance
The IEnroll4 interface inherits from IEnroll and IEnroll2. IEnroll4 also has these types of members:
Methods
The IEnroll4 interface has these methods.
| IEnroll4::acceptFileResponseWStr Accepts delivery of the credentials issued in response to an earlier call to createFileRequestWStr, and it places the credentials in the appropriate store. |
| IEnroll4::acceptResponseBlob Accepts delivery of the credentials issued in response to an earlier call to createRequestWStr and places the credentials in the appropriate store. |
| IEnroll4::addAttributeToRequestWStr Adds an attribute to the certificate request. |
| IEnroll4::addBlobPropertyToCertificateWStr The IEnroll4::addBlobPropertyToCertificateWStr method adds a BLOB property to a certificate. |
| IEnroll4::AddCertTypeToRequestWStrEx Adds a certificate template (also known as certificate type) to a request. |
| IEnroll4::addExtensionToRequestWStr Adds an extension to the request. |
| IEnroll4::addNameValuePairToRequestWStr Adds an unauthenticated name-value string pair to the request. |
| IEnroll4::binaryBlobToString Converts a binary data BLOB to a string. This method uses the CryptBinaryToString function to perform the conversion. This method was first defined in the IEnroll4 interface. |
| IEnroll4::createFilePFXWStr Saves the accepted certificate chain and private key in a file in Personal Information Exchange (PFX) format. |
| IEnroll4::createFileRequestWStr Creates a PKCS (IEnroll4.createFileRequestWStr) |
| IEnroll4::createPFXWStr Saves the accepted certificate chain and private key in a Personal Information Exchange (PFX) format string. The PFX format is also known as PKCS (IEnroll4.createPFXWStr) |
| IEnroll4::createRequestWStr Creates a PKCS (IEnroll4.createRequestWStr) |
| IEnroll4::enumPendingRequestWStr Enumerates pending certificate requests and retrieves a specified property from each. |
| IEnroll4::get_ClientId The ClientId property sets or retrieves a client ID request attribute. The client ID request attribute indicates the source of the certificate request. This property was first defined in the IEnroll4 interface. (Get) |
| IEnroll4::get_IncludeSubjectKeyID The IncludeSubjectKeyID property of IEnroll4 determines whether the subject key ID extension is added to the certificate request that is generated. (Get) |
| IEnroll4::get_ThumbPrintWStr Sets or retrieves a hash of the certificate data. The thumbprint is used to point to the pending certificate. (Get) |
| IEnroll4::getCertContextFromFileResponseWStr Retrieves the certificate from a file containing a response from a certification authority. |
| IEnroll4::getCertContextFromResponseBlob Retrieves the certificate from a certification authority's response. |
| IEnroll4::GetKeyLenEx Retrieves size information for the signature and exchange keys. |
| IEnroll4::GetPrivateKeyArchiveCertificate The GetPrivateKeyArchiveCertificate method retrieves the certificate used to archive the private key. This method was first defined in the IEnroll4 interface. |
| IEnroll4::getProviderTypeWStr Retrieves the type of the specified cryptographic service provider (CSP). |
| IEnroll4::InstallPKCS7BlobEx The same as InstallPKCS7Blob except that it returns the number of certificates actually installed in local stores. |
| IEnroll4::put_ClientId The ClientId property sets or retrieves a client ID request attribute. The client ID request attribute indicates the source of the certificate request. This property was first defined in the IEnroll4 interface. (Put) |
| IEnroll4::put_IncludeSubjectKeyID The IncludeSubjectKeyID property of IEnroll4 determines whether the subject key ID extension is added to the certificate request that is generated. (Put) |
| IEnroll4::put_ThumbPrintWStr Sets or retrieves a hash of the certificate data. The thumbprint is used to point to the pending certificate. (Put) |
| IEnroll4::removePendingRequestWStr Removes a pending request from the client's request store. |
| IEnroll4::resetAttributes Removes all attributes from the request. |
| IEnroll4::resetExtensions Removes all extensions from the request. |
| IEnroll4::setPendingRequestInfoWStr Sets properties for a pending request. |
| IEnroll4::SetPrivateKeyArchiveCertificate The SetPrivateKeyArchiveCertificate method specifies the certificate used to archive the private key. This method was first defined in the IEnroll4 interface. |
| IEnroll4::SetSignerCertificate The SetSignerCertificate method specifies the signer's certificate. This method was first defined in the IEnroll4 interface. |
| IEnroll4::stringToBinaryBlob Converts an encoded string to a binary data BLOB. |
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 |
See also
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