ICEnroll4 interface (xenroll.h)
[This interface is no longer available for use as of Windows Server 2008 and Windows Vista.]
The ICEnroll4 interface is one of several interfaces that represent the Certificate Enrollment Control. It is primarily of interest if you are not using Automation. If, on the other hand, you are programming in Visual Basic or another Automation language, see the CEnroll object.
Inheritance
The ICEnroll4 interface inherits from ICEnroll, ICEnroll2, ICEnroll3, and IDispatch. ICEnroll4 also has these types of members:
Methods
The ICEnroll4 interface has these methods.
| ICEnroll4::acceptFileResponse Accepts delivery of the credentials issued in response to an earlier call to createFileRequest, and it places the credentials in the appropriate store. |
| ICEnroll4::acceptResponse Accepts delivery of the credentials issued in response to an earlier call to createRequest and places the credentials in the appropriate store. |
| ICEnroll4::addAttributeToRequest Adds an attribute to the certificate request. This method was first defined in the ICEnroll4 interface. |
| ICEnroll4::addBlobPropertyToCertificate Adds a BLOB property to a certificate. |
| ICEnroll4::addCertTypeToRequestEx Adds a certificate template (or "certificate type") to a request. |
| ICEnroll4::addExtensionToRequest The ICEnroll4::addExtensionToRequest method adds an extension to the request. |
| ICEnroll4::addNameValuePairToRequest Adds an unauthenticated name-value string pair to the request. This method was first defined in the ICEnroll4 interface. |
| ICEnroll4::binaryToString Converts a binary data BLOB to a string. This method was first defined in the ICEnroll4 interface. |
| ICEnroll4::createFilePFX Saves the accepted certificate chain and private key in a file in Personal Information Exchange (PFX) format. This method was first defined in the ICEnroll4 interface. |
| ICEnroll4::createFileRequest Creates a PKCS (ICEnroll4.createFileRequest) |
| ICEnroll4::createPFX Saves the accepted certificate chain and private key in a Personal Information Exchange (PFX) format string. The PFX format is also known as PKCS (ICEnroll4.createPFX) |
| ICEnroll4::createRequest Creates a PKCS (ICEnroll4.createRequest) |
| ICEnroll4::enumPendingRequest Enumerates pending certificate requests and retrieves a specified property from each. This method was first defined in the ICEnroll4 interface. |
| ICEnroll4::get_ClientId 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 ICEnroll4 interface. (Get) |
| ICEnroll4::get_IncludeSubjectKeyID Determines whether the subject key ID extension is added to the certificate request that is generated. (Get) |
| ICEnroll4::get_PrivateKeyArchiveCertificate Sets or retrieves the certificate that is used to archive a private key with a PKCS (Get) |
| ICEnroll4::get_ThumbPrint Sets or retrieves a hash of the certificate data. (Get) |
| ICEnroll4::getCertFromFileResponse Retrieves the certificate from a file containing a response from a certification authority. This method was first defined in the ICEnroll4 interface. |
| ICEnroll4::getCertFromResponse Retrieves the certificate from a certification authority's response. This method was first defined by the ICEnroll4 interface. |
| ICEnroll4::GetKeyLenEx Retrieves size information for the signature and exchange keys. This method was first defined in the ICEnroll4 interface. |
| ICEnroll4::getProviderType Retrieves the type of the specified cryptographic service provider (CSP). This method was first defined in the ICEnroll4 interface. |
| ICEnroll4::InstallPKCS7Ex Processes a certificate or chain of certificates, placing them into the appropriate certificate stores.InstallPKCS7 except that it returns the number of certificates actually installed in local stores. |
| ICEnroll4::put_ClientId 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 ICEnroll4 interface. (Put) |
| ICEnroll4::put_IncludeSubjectKeyID Determines whether the subject key ID extension is added to the certificate request that is generated. (Put) |
| ICEnroll4::put_PrivateKeyArchiveCertificate Sets or retrieves the certificate that is used to archive a private key with a PKCS (Put) |
| ICEnroll4::put_SignerCertificate Sets the signer's certificate. |
| ICEnroll4::put_ThumbPrint Sets or retrieves a hash of the certificate data. (Put) |
| ICEnroll4::removePendingRequest Removes a pending request from the client's request store. This method was first defined in the ICEnroll4 interface. |
| ICEnroll4::resetAttributes Removes all attributes from the request. This method was first defined in the ICEnroll4 interface. |
| ICEnroll4::resetBlobProperties Resets the properties of a BLOB. |
| ICEnroll4::resetExtensions Removes all extensions from the request. This method was first defined in the ICEnroll4 interface. |
| ICEnroll4::setPendingRequestInfo Sets properties for a pending request. This method was first defined in the ICEnroll4 interface. |
| ICEnroll4::stringToBinary Converts an encoded string to a binary data BLOB. This method was first defined in the ICEnroll4 interface. |
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 |