Export (0) Print
Expand All

ICEnroll2 interface

[This interface is no longer available for use as of Windows Server 2008 and Windows Vista.]

The ICEnroll2 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 ICEnroll2 interface has been extended by the following interfaces, with each new interface inheriting all the methods and properties of the previous interfaces:

Members

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

Methods

The ICEnroll2 interface has these methods.

MethodDescription
acceptFilePKCS7

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

(Inherited from ICEnroll)
acceptPKCS7

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

(Inherited from ICEnroll)
addCertTypeToRequest

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

(Inherited from ICEnroll2)
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)
createFilePKCS10

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

(Inherited from ICEnroll)
createPKCS10

Creates a base64-encoded PKCS #10 certificate request.

(Inherited from ICEnroll)
enumContainers

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

(Inherited from ICEnroll)
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_ContainerName

Retrieves the value of the ContainerName property.

(Inherited from ICEnroll)
get_DeleteRequestCert

Retrieves the value of the DeleteRequestCert property.

(Inherited from ICEnroll)
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_HashAlgorithm

Retrieves the value of the HashAlgorithm property.

(Inherited from ICEnroll)
get_KeySpec

Retrieves the value of the KeySpec property.

(Inherited from ICEnroll)
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_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_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_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)
getCertFromPKCS7

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

(Inherited from ICEnroll)
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_ContainerName

Sets the value of the ContainerName property.

(Inherited from ICEnroll)
put_DeleteRequestCert

Sets the value of the DeleteRequestCert property.

(Inherited from ICEnroll)
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_HashAlgorithm

Sets the value of the HashAlgorithm property.

(Inherited from ICEnroll)
put_KeySpec

Sets the value of the KeySpec property.

(Inherited from ICEnroll)
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_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_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_SPCFileName

Sets the value of the SPCFileName property.

(Inherited from ICEnroll)
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)

 

Properties

The ICEnroll2 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)

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)

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 a flag that controls whether a private key is exportable.

(Inherited from ICEnroll)

HashAlgorithm

Read/write

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

(Inherited from ICEnroll)

KeySpec

Read/write

Sets or retrieves the type of key generated.

(Inherited from ICEnroll)

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)

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)

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)

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)

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_ICEnroll2 is defined as 704CA730-C90B-11D1-9BEC-00C04FC295E1

See also

ICEnroll

 

 

Community Additions

ADD
Show:
© 2014 Microsoft