ICertSrvSetup interface
The ICertSrvSetup interface defines functionality to install and uninstall Certification Authority (CA) and Certification Authority Web Enrollment roles on a Certificate Services computer.
Microsoft provides an implementation of this interface in the CCertSrvSetup class. For installation, you must call the InitializeDefaults method before accessing any properties or calling any other methods on the CCertSrvSetup object.
In C++, you create an instance of this interface by calling the CoCreateInstance function with the CLSID_CCertSrvSetup class identifier.
Windows Server 2008 Standard: The following services are not available:
- Online Responder Service
- Network Device Enrollment Service
In addition, the certification authority (CA) service has limited functionality:
- V2 templates are not supported; therefore, autoenrollment is not supported.
- Delegated enrollment agents are not supported.
- Role separation is not supported.
Members
The ICertSrvSetup interface inherits from the IDispatch interface. ICertSrvSetup also has these types of members:
Methods
The ICertSrvSetup interface has these methods.
| Method | Description |
|---|---|
| CAImportPFX |
Imports a CA certificate and its associated private key into the "LocalMachine" store. |
| GetCASetupProperty |
Gets a property value for a CA configuration. |
| GetExistingCACertificates |
Gets the collection of CCertSrvSetupKeyInformation objects that represent valid CA certificates currently installed on the computer. |
| GetHashAlgorithmList |
Gets the list of hashing algorithms supported by the specified cryptographic service provider (CSP) for an asymmetric key signature algorithm. |
| GetKeyLengthList |
Gets the list of key lengths supported by the specified CSP. |
| GetPrivateKeyContainerList |
Gets the list of key container names stored by the specified CSP for asymmetric key signature algorithms. |
| GetProviderNameList |
Gets the list of CSPs that provide asymmetric key signature algorithms on the computer. |
| GetSupportedCATypes |
Gets the types of CAs that can be installed on a computer under the caller context. |
| InitializeDefaults |
Initializes a CCertSrvSetup object with default values to enable installation of a CA role. |
| Install |
Installs a CA role as configured in the CCertSrvSetup object. |
| IsPropertyEditable |
Indicates to the caller whether a specified property can be edited. |
| PostUnInstall |
This method is not implemented and is reserved for future use. |
| PreUnInstall |
Temporarily saves role-specific state information. |
| SetCADistinguishedName |
Sets a CA common name and an optional distinguished name suffix. |
| SetCASetupProperty |
Sets a property value for a CA configuration. |
| SetDatabaseInformation |
Sets the database related information for the CA role. |
| SetParentCAInformation |
Sets the parent CA information for a subordinate CA configuration. |
| SetWebCAInformation |
Sets the CA information for the Certification Authority Web Enrollment role. |
Properties
The ICertSrvSetup interface has these properties.
| Property | Access type | Description |
|---|---|---|
| Read-only |
Gets the ID for additional error information related to a failed CA specification. | |
| Read-only |
Gets the string data for additional error information related to a failed CA specification. |
Requirements
|
Minimum supported client | None supported [desktop apps only] |
|---|---|
|
Minimum supported server | Windows Server 2008 [desktop apps only] |
|
Header |
|
|
IDL |
|
|
DLL |
|
|
IID |
IID_ICertSrvSetup is defined as b760a1bb-4784-44c0-8f12-555f0780ff25 |
Send comments about this topic to Microsoft
Build date: 10/26/2012
