ICertRequest3 interface
The ICertRequest3 interface is one of three interfaces that provide communications between a client or intermediary application and Certificate Services.
Client and intermediary applications can call the ICertRequest3 methods to perform the following tasks:
- Submit a certificate request.
- Retrieve the disposition, last status, and identifier of a request.
- Retrieve the certificate issued for the request.
- Retrieve pending certificates for previous requests.
- Retrieve the certification authority (CA) certificate for the Certificate Services server.
- Retrieve the CA property value, display name, and any flags associated with the property.
- Retrieve the cached response data returned by the server.
- Retrieve error message text for an HRESULT error code.
ICertRequest3 is defined in Certcli.h. When you create your program, however, use Certsrv.h as the include file. Certcli.dll provides the ICertRequest3 interface. The type information for this interface is also in Certcli.dll, which is shipped with the Platform Software Development Kit (SDK).
Certificate Services interfaces support both apartment-threading and free-threading models. For better throughput, free threading is recommended.
Inheritance
The ICertRequest3 interface inherits and extends the ICertRequest2 interface.
Members
The ICertRequest3 interface inherits from ICertRequest2, ICertRequest, and IDispatch. ICertRequest3 also has these types of members:
Methods
The ICertRequest3 interface has these methods.
| Method | Description |
|---|---|
| GetCACertificate |
Returns the CA certificate for the Certificate Services server. (Inherited from ICertRequest2 ICertRequest CCertRequest) |
| GetCAProperty |
Retrieves a property value from the CA. This method's functionality is identical to ICertAdmin2::GetCAProperty. (Inherited from ICertRequest2 CCertRequest) |
| GetCAPropertyDisplayName |
Retrieves the display name for a property. This method's functionality is identical to ICertAdmin2::GetCAPropertyDisplayName. (Inherited from ICertRequest2 CCertRequest) |
| GetCAPropertyFlags |
Retrieves the property flags (denoting data type and indexed status) for a property. This method's functionality is identical to ICertAdmin2::GetCAPropertyFlags. (Inherited from ICertRequest2 CCertRequest) |
| GetCertificate |
Returns the certificate issued for the request. (Inherited from ICertRequest2 ICertRequest CCertRequest) |
| GetDispositionMessage |
Gets a human-readable message giving the current disposition of the certificate request. (Inherited from ICertRequest2 ICertRequest CCertRequest) |
| GetErrorMessageText |
Retrieves message text for a given HRESULT error code. (Inherited from ICertRequest2 CCertRequest) |
| GetFullResponseProperty |
Retrieves the cached response data returned by the server. (Inherited from ICertRequest2 CCertRequest) |
| GetIssuedCertificate |
Retrieves the disposition of a certificate request. (Inherited from ICertRequest2 CCertRequest) |
| GetIssuedCertificate2 |
Retrieves a certificate's disposition by specifying either the request ID string or the certificate serial number. |
| GetLastStatus |
Gets the last return code for this request. (Inherited from ICertRequest2 ICertRequest CCertRequest) |
| GetRefreshPolicy |
Returns a value that indicates whether a client's cached certificate enrollment policy is out of date and needs to be refreshed. |
| GetRequestId |
Gets the current internal request number for the request and subsequent certificate. (Inherited from ICertRequest2 ICertRequest CCertRequest) |
| GetRequestIdString |
Gets the current internal request number, formatted as a string, for the request and subsequent certificate. |
| RetrievePending |
Attempts to retrieve the certificate issued for an earlier request, that may have initially been made pending. (Inherited from ICertRequest2 ICertRequest CCertRequest) |
| SetCredential |
Sets the credential used to contact the Certificate Enrollment Web Service. |
| Submit |
Submits a request to the Certificate Services server. (Inherited from ICertRequest2 ICertRequest CCertRequest) |
Requirements
|
Minimum supported client | Windows 7 [desktop apps only] |
|---|---|
|
Minimum supported server | Windows Server 2008 R2 [desktop apps only] |
|
Header |
|
|
Library |
|
|
DLL |
|
|
IID |
IID_ICertRequest3 is defined as AFC8F92B-33A2-4861-BF36-2933B7CD67B3 |
Send comments about this topic to Microsoft
Build date: 10/26/2012
