Export (0) Print
Expand All

ICEnroll4 interface

[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 all the methods and properties of the ICEnroll3 interface.

Members

The ICEnroll4 interface inherits from ICEnroll, ICEnroll2, ICEnroll3, and IDispatch. ICEnroll4 also has these types of members:

Methods

The ICEnroll4 interface has these methods.

MethodDescription
acceptFilePKCS7

Accepts and processes a file that contains a PKCS #7 message containing a certificate.

(Inherited from ICEnroll)
acceptFileResponse

Accepts delivery of the credentials issued in response to an earlier call to createFileRequest, and it places the credentials in the appropriate store.

(Inherited from ICEnroll4)
acceptPKCS7

Accepts and processes a PKCS #7 message containing a certificate. The PKCS #7 is input as a parameter.

(Inherited from ICEnroll)
acceptResponse

Accepts delivery of the credentials issued in response to an earlier call to createRequest and places the credentials in the appropriate store.

(Inherited from ICEnroll4)
addAttributeToRequest

Adds an attribute to the certificate request.

(Inherited from ICEnroll4)
addBlobPropertyToCertificate

Adds a BLOB property to a certificate.

(Inherited from ICEnroll4)
addCertTypeToRequest

Adds a certificate template to a request (used to support the enterprise certification authority (CA)).

(Inherited from ICEnroll2)
addCertTypeToRequestEx

Adds a certificate template (or "certificate type") to a request.

(Inherited from ICEnroll4)
addExtensionToRequest

Adds an extension to the request.

(Inherited from ICEnroll4)
addNameValuePairToRequest

Adds a name-value string pair to the request.

(Inherited from ICEnroll4)
addNameValuePairToSignature

Adds the name and value pair of an attribute to the request. It is up to the CA to interpret the meaning of the name-value pair.

(Inherited from ICEnroll2)
binaryToString

Converts a binary data BLOB to a string.

(Inherited from ICEnroll4)
createFilePFX

Saves the accepted certificate chain and private key in a file in Personal Information Exchange (PFX) format.

(Inherited from ICEnroll4)
createFilePKCS10

Creates a base64-encoded PKCS #10 certificate request and saves it in a file.

(Inherited from ICEnroll)
createFileRequest

Creates a PKCS #10 certificate request, a PKCS #7 request, or a full CMC request and stores it in a file.

(Inherited from ICEnroll4)
createPFX

Saves the accepted certificate chain and private key in a PFX format string. The PFX format is also known as PKCS #12.

(Inherited from ICEnroll4)
createPKCS10

Creates a base64-encoded PKCS #10 certificate request.

(Inherited from ICEnroll)
createRequest

Creates a PKCS #10, PKCS #7, or full Certificate Management over CMS (CMC) format certificate request and stores it in a string.

(Inherited from ICEnroll4)
EnumAlgs

Retrieves the IDs of cryptographic algorithms in a given algorithm class that are supported by the current CSP.

(Inherited from ICEnroll3)
enumContainers

Retrieves the names of the containers for the cryptographic service provider (CSP) specified by the ProviderName property.

(Inherited from ICEnroll)
enumPendingRequest

Enumerates pending certificate requests and retrieves a specified property from each.

(Inherited from ICEnroll4)
enumProviders

Retrieves the names of the available CSPs specified by the ProviderType property.

(Inherited from ICEnroll)
freeRequestInfo

Cleans up the stores if an error occurs. Currently not implemented.

(Inherited from ICEnroll)
get_CAStoreFlags

Retrieves the value of the CAStoreFlags property.

(Inherited from ICEnroll)
get_CAStoreName

Retrieves the value of the CAStoreName property.

(Inherited from ICEnroll)
get_CAStoreType

Retrieves the value of the CAStoreType property.

(Inherited from ICEnroll)
get_ClientId

Sets the value of the ClientId property.

(Inherited from ICEnroll4)
get_ContainerName

Retrieves the value of the ContainerName property.

(Inherited from ICEnroll)
get_DeleteRequestCert

Retrieves the value of the DeleteRequestCert property.

(Inherited from ICEnroll)
get_EnableSMIMECapabilities

Sets the value of the EnableSMIMECapabilities property.

(Inherited from ICEnroll3)
get_EnableT61DNEncoding

Retrieves the value of the EnableT61DNEncoding property.

(Inherited from ICEnroll2)
get_GenKeyFlags

Retrieves the value of the GenKeyFlags property.

(Inherited from ICEnroll)
get_HashAlgID

Sets the value of the HashAlgID property.

(Inherited from ICEnroll3)
get_HashAlgorithm

Retrieves the value of the HashAlgorithm property.

(Inherited from ICEnroll)
get_IncludeSubjectKeyID

Sets the value of the IncludeSubjectKeyID property.

(Inherited from ICEnroll4)
get_KeySpec

Retrieves the value of the KeySpec property.

(Inherited from ICEnroll)
get_LimitExchangeKeyToEncipherment

Sets the value of the LimitExchangeKeyToEncipherment property.

(Inherited from ICEnroll3)
get_MyStoreFlags

Retrieves the value of the MyStoreFlags property.

(Inherited from ICEnroll)
get_MyStoreName

Retrieves the value of the MyStoreName property.

(Inherited from ICEnroll)
get_MyStoreType

Retrieves the value of the MyStoreType property.

(Inherited from ICEnroll)
get_PrivateKeyArchiveCertificate

Sets the value of the PrivateKeyArchiveCertificate property.

(Inherited from ICEnroll4)
get_ProviderFlags

Retrieves the value of the ProviderFlags property.

(Inherited from ICEnroll)
get_ProviderName

Retrieves the value of the ProviderName property.

(Inherited from ICEnroll)
get_ProviderType

Retrieves the value of the ProviderType property.

(Inherited from ICEnroll)
get_PVKFileName

Retrieves the value of the PVKFileName property.

(Inherited from ICEnroll)
get_RequestStoreFlags

Retrieves the value of the RequestStoreFlags property.

(Inherited from ICEnroll)
get_RequestStoreName

Retrieves the value of the RequestStoreName property.

(Inherited from ICEnroll)
get_RequestStoreType

Retrieves the value of the RequestStoreType property.

(Inherited from ICEnroll)
get_ReuseHardwareKeyIfUnableToGenNew

Sets the value of the ReuseHardwareKeyIfUnableToGenNew property.

(Inherited from ICEnroll3)
get_RootStoreFlags

Retrieves the value of the RootStoreFlags property.

(Inherited from ICEnroll)
get_RootStoreName

Retrieves the value of the RootStoreName property.

(Inherited from ICEnroll)
get_RootStoreType

Retrieves the value of the RootStoreType property.

(Inherited from ICEnroll)
get_SPCFileName

Retrieves the value of the SPCFileName property.

(Inherited from ICEnroll)
get_ThumbPrint

Sets the value of the ThumbPrint property.

(Inherited from ICEnroll4)
get_UseExistingKeySet

Retrieves the value of the UseExistingKeySet property.

(Inherited from ICEnroll)
get_WriteCertToCSP

Retrieves the value of the WriteCertToCSP property.

(Inherited from ICEnroll)
get_WriteCertToUserDS

Retrieves the value of the WriteCertToUserDS property.

(Inherited from ICEnroll2)
GetAlgName

Retrieves the name of a cryptographic algorithm given its ID. The values retrieved by this method depend on the current CSP.

(Inherited from ICEnroll3)
getCertFromFileResponse

Retrieves the certificate from a file containing a response from a CA.

(Inherited from ICEnroll4)
getCertFromPKCS7

Retrieves the certificate, contained in a PKCS #7 message, that was issued in response to a PKCS #10 certificate request.

(Inherited from ICEnroll)
getCertFromResponse

Retrieves the certificate from a CA's response.

(Inherited from ICEnroll4)
GetKeyLen

Retrieves the minimum and maximum key lengths for the signature and exchange keys.

(Inherited from ICEnroll3)
GetKeyLenEx

Retrieves size information for the signature and exchange keys.

(Inherited from ICEnroll4)
getProviderType

Retrieves the type of the specified CSP.

(Inherited from ICEnroll4)
GetSupportedKeySpec

Retrieves information regarding the CSP's support for signature or exchange keys.

(Inherited from ICEnroll3)
InstallPKCS7

Processes a certificate or chain of certificates, placing them into the appropriate certificate stores. This method differs from the acceptPKCS7 method in that InstallPKCS7 does not receive a request certificate.

(Inherited from ICEnroll3)
InstallPKCS7Ex

The same as InstallPKCS7 except that it returns the number of certificates actually installed in local stores.

(Inherited from ICEnroll4)
put MyStoreFlags

Sets the value of the MyStoreFlags property.

(Inherited from ICEnroll)
put_CAStoreFlags

Sets the value of the CAStoreFlags property.

(Inherited from ICEnroll)
put_CAStoreName

Sets the value of the CAStoreName property.

(Inherited from ICEnroll)
put_CAStoreType

Sets the value of the CAStoreType property.

(Inherited from ICEnroll)
put_ClientId

Sets the value of the ClientId property.

(Inherited from ICEnroll4)
put_ContainerName

Sets the value of the ContainerName property.

(Inherited from ICEnroll)
put_DeleteRequestCert

Sets the value of the DeleteRequestCert property.

(Inherited from ICEnroll)
put_EnableSMIMECapabilities

Retrieves the value of the EnableSMIMECapabilities property.

(Inherited from ICEnroll3)
put_EnableT61DNEncoding

Sets the value of the EnableT61DNEncoding property.

(Inherited from ICEnroll2)
put_GenKeyFlags

Sets the value of the GenKeyFlags property.

(Inherited from ICEnroll)
put_HashAlgID

Retrieves the value of the HashAlgID property.

(Inherited from ICEnroll3)
put_HashAlgorithm

Sets the value of the HashAlgorithm property.

(Inherited from ICEnroll)
put_IncludeSubjectKeyID

Sets the value of the IncludeSubjectKeyID property.

(Inherited from ICEnroll4)
put_KeySpec

Sets the value of the KeySpec property.

(Inherited from ICEnroll)
put_LimitExchangeKeyToEncipherment

Retrieves the value of the LimitExchangeKeyToEncipherment property.

(Inherited from ICEnroll3)
put_MyStoreName

Sets the value of the MyStoreName property.

(Inherited from ICEnroll)
put_MyStoreType

Sets the value of the MyStoreType property.

(Inherited from ICEnroll)
put_PrivateKeyArchiveCertificate

Retrieves the value of the PrivateKeyArchiveCertificate property.

(Inherited from ICEnroll4)
put_ProviderFlags

Sets the value of the ProviderFlags property.

(Inherited from ICEnroll)
put_ProviderName

Sets the value of the ProviderName property.

(Inherited from ICEnroll)
put_ProviderType

Sets the value of the ProviderType property.

(Inherited from ICEnroll)
put_PVKFileName

Sets the value of the PVKFileName property.

(Inherited from ICEnroll)
put_RequestStoreFlags

Sets the value of the RequestStoreFlags property.

(Inherited from ICEnroll)
put_RequestStoreName

Sets the value of the RequestStoreName property.

(Inherited from ICEnroll)
put_RequestStoreType

Sets the value of the RequestStoreType property.

(Inherited from ICEnroll)
put_ReuseHardwareKeyIfUnableToGenNew

Retrieves the value of the ReuseHardwareKeyIfUnableToGenNew property.

(Inherited from ICEnroll3)
put_RootStoreFlags

Sets the value of the RootStoreFlags property.

(Inherited from ICEnroll)
put_RootStoreName

Sets the value of the RootStoreName property.

(Inherited from ICEnroll)
put_RootStoreType

Sets the value of the RootStoreType property.

(Inherited from ICEnroll)
put_SignerCertificate

Retrieves the value of the SignerCertificate property.

(Inherited from ICEnroll4)
put_SPCFileName

Sets the value of the SPCFileName property.

(Inherited from ICEnroll)
put_ThumbPrint

Retrieves the value of the ThumbPrint property.

(Inherited from ICEnroll4)
put_UseExistingKeySet

Sets the value of the UseExistingKeySet property.

(Inherited from ICEnroll)
put_WriteCertToCSP

Sets the value of the WriteCertToCSP property.

(Inherited from ICEnroll)
put_WriteCertToUserDS

Sets the value of the WriteCertToUserDS property.

(Inherited from ICEnroll2)
removePendingRequest

Removes a pending request from the client's request store.

(Inherited from ICEnroll4)
Reset

Returns the certificate enrollment control object to its initial state.

(Inherited from ICEnroll3)
resetAttributes

Removes all attributes from the request.

(Inherited from ICEnroll4)
resetBlobProperties

Resets the properties of a BLOB.

(Inherited from ICEnroll4)
resetExtensions

Removes all extensions from the request.

(Inherited from ICEnroll4)
setPendingRequestInfo

Sets properties for a pending request.

(Inherited from ICEnroll4)
stringToBinary

Converts an encoded string to a binary data BLOB.

(Inherited from ICEnroll4)

 

Properties

The ICEnroll4 interface has these properties.

PropertyAccess typeDescription

CAStoreFlags

Read/write

Sets or retrieves a flag that controls the certificate store when it is opened.

(Inherited from ICEnroll)

CAStoreName

Read/write

Sets or retrieves the name of the store where all non-"ROOT" and non-"MY" certificates are kept.

(Inherited from ICEnroll)

CAStoreType

Read/write

Sets or retrieves the type of store to use for the store specified by the CAStoreName property.

(Inherited from ICEnroll)

ClientId

Sets or retrieves the client ID request attribute.

(Inherited from ICEnroll4)

ContainerName

Read/write

Sets or retrieves the name of the key container to use.

(Inherited from ICEnroll)

DeleteRequestCert

Read/write

Sets or retrieves a Boolean indicator that controls whether dummy certificates in the request store are deleted.

(Inherited from ICEnroll)

EnableSMIMECapabilities

Read/write

Sets or retrieves a Boolean value that controls whether the PKCS10 will contain a signed attribute for Secure/Multipurpose Internet Mail Extensions (S/MIME) capabilities.

(Inherited from ICEnroll3)

EnableT61DNEncoding

Read/write

Sets or retrieves a Boolean value that controls whether the distinguished name in the request is encoded as a T61 string instead of as a UNICODE string.

(Inherited from ICEnroll2)

GenKeyFlags

Read/write

Sets or retrieves the values passed to CryptGenKey when the certificate request is generated.

(Inherited from ICEnroll)

HashAlgID

Read/write

Sets or retrieves the hash algorithm used when signing a PKCS #10 certificate request.

(Inherited from ICEnroll3)

HashAlgorithm

Read/write

Sets or retrieves only the signature hash algorithm used to sign the PKCS #10.

(Inherited from ICEnroll)

IncludeSubjectKeyID

Sets or retrieves a Boolean value that controls whether a subject key identifier extension is included in the certificate request.

(Inherited from ICEnroll4)

KeySpec

Read/write

Sets or retrieves the type of key generated.

(Inherited from ICEnroll)

LimitExchangeKeyToEncipherment

Read/write

Sets or retrieves a Boolean value that controls whether an AT_KEYEXCHANGE request contains digital signature and non-repudiation key usages.

(Inherited from ICEnroll3)

MyStoreFlags

Read/write

Sets the registry location used for the MY store.

(Inherited from ICEnroll)

MyStoreName

Read/write

Sets or retrieves the name of the store where certificates with linked private keys are kept.

(Inherited from ICEnroll)

MyStoreType

Read/write

Sets or retrieves the type of store specified by the MyStoreName property.

(Inherited from ICEnroll)

PrivateKeyArchiveCertificate

Read/write

Sets or retrieves the certificate that is used to archive a private key with a PKCS #7 or CMC request.

(Inherited from ICEnroll4)

ProviderFlags

Read/write

Sets or retrieves the CSP type.

(Inherited from ICEnroll)

ProviderName

Read/write

Sets or retrieves the name of the CSP to use.

(Inherited from ICEnroll)

ProviderType

Read/write

Sets or retrieves the type of provider.

(Inherited from ICEnroll)

PVKFileName

Read/write

Sets or retrieves the name of the file that will contain exported keys.

(Inherited from ICEnroll)

RequestStoreFlags

Read/write

Sets or retrieves the registry location used for the REQUEST store.

(Inherited from ICEnroll)

RequestStoreName

Read/write

Sets or retrieves the name of the store that contains the dummy certificate. This dummy certificate, along with the added private keys, remains in the request store until a certification authority processes the request and responds with a PKCS #7.

(Inherited from ICEnroll)

RequestStoreType

Read/write

Sets or retrieves the type of store to use for the store specified by the RequestStoreName property.

(Inherited from ICEnroll)

ReuseHardwareKeyIfUnableToGenNew

Read/write

Sets or retrieves a Boolean value that determines the action taken by the certificate enrollment control object if an error is encountered when generating a new key.

(Inherited from ICEnroll3)

RootStoreFlags

Read/write

Sets or retrieves the registry location used for the ROOT store.

(Inherited from ICEnroll)

RootStoreName

Read/write

Sets or retrieves the name of the root store where all intrinsically trusted self-signed ROOT certificates are kept.

(Inherited from ICEnroll)

RootStoreType

Read/write

Sets or retrieves the type of store to use for the store specified by the RootStoreName property.

(Inherited from ICEnroll)

SignerCertificate

Write-only

Sets the signer's certificate.

(Inherited from ICEnroll4)

SPCFileName

Read/write

Sets or retrieves the name of the file to write the resulting base64-encoded PKCS #7 (in BSTR form) as returned from the certification authority.

(Inherited from ICEnroll)

ThumbPrint

Read/write

Sets or retrieves a hash of the certificate data.

(Inherited from ICEnroll4)

UseExistingKeySet

Read/write

Sets or retrieves a Boolean value that indicates whether the existing keys should be used.

(Inherited from ICEnroll)

WriteCertToCSP

Read/write

Sets or retrieves a Boolean value that indicates whether a certificate should be written to the CSP.

(Inherited from ICEnroll)

WriteCertToUserDS

Read/write

Sets or retrieves a Boolean value that controls whether the certificate is written to the user's Active Directory store.

(Inherited from ICEnroll2)

 

Requirements

Minimum supported client

Windows XP [desktop apps only]

Minimum supported server

Windows Server 2003 [desktop apps only]

End of client support

Windows XP

End of server support

Windows Server 2003

Header

Xenroll.h

Library

Uuid.lib

DLL

Xenroll.dll

IID

IID_ICEnroll4 is defined as c1f1188a-2eb5-4a80-841b-7e729a356d90

 

 

Community Additions

ADD
Show:
© 2014 Microsoft