ICertRequest2 interface

The ICertRequest2 interface is one of two interfaces that provide communications between a client or intermediary application and Certificate Services.

Client and intermediary applications can call the ICertRequest2 methods to perform the following tasks:

  • Submit 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.

ICertRequest2 is defined in Certcli.h. When you create your program, however, use Certsrv.h as the include file. Certcli.dll provides the ICertRequest2 interface. The type information for this interface is also in Certclil.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 ICertRequest2 interface inherits and extends the ICertRequest interface. All the methods defined by ICertRequest2 are inherited by ICertRequest3 and are documented under the newer interface.

Members

The ICertRequest2 interface inherits from ICertRequest and IDispatch. ICertRequest2 also has these types of members:

Methods

The ICertRequest2 interface has these methods.

MethodDescription
GetCACertificate

Returns the CA certificate for the Certificate Services server.

(Inherited from ICertRequest2ICertRequestCCertRequest)
GetCAProperty

Retrieves a property value from the CA. This method's functionality is identical to ICertAdmin2::GetCAProperty.

(Inherited from ICertRequest2CCertRequest)
GetCAPropertyDisplayName

Retrieves the display name for a property. This method's functionality is identical to ICertAdmin2::GetCAPropertyDisplayName.

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

Returns the certificate issued for the request.

(Inherited from ICertRequest2ICertRequestCCertRequest)
GetDispositionMessage

Gets a human-readable message giving the current disposition of the certificate request.

(Inherited from ICertRequest2ICertRequestCCertRequest)
GetErrorMessageText

Retrieves message text for a given HRESULT error code.

(Inherited from ICertRequest2CCertRequest)
GetFullResponseProperty

Retrieves the cached response data returned by the server.

(Inherited from ICertRequest2CCertRequest)
GetIssuedCertificate

Retrieves the disposition of a certificate request.

(Inherited from ICertRequest2CCertRequest)
GetLastStatus

Gets the last return code for this request.

(Inherited from ICertRequest2ICertRequestCCertRequest)
GetRequestId

Gets the current internal request number for the request and subsequent certificate.

(Inherited from ICertRequest2ICertRequestCCertRequest)
RetrievePending

Attempts to retrieve the certificate issued for an earlier request, that may have initially been made pending.

(Inherited from ICertRequest2ICertRequestCCertRequest)
Submit

Submits a request to the Certificate Services server.

(Inherited from ICertRequest2ICertRequestCCertRequest)

 

Requirements

Minimum supported client

Windows XP [desktop apps only]

Minimum supported server

Windows Server 2003 [desktop apps only]

Header

Certcli.h (include Certsrv.h)

Library

Certidl.lib

DLL

Certcli.dll

IID

IID_ICertRequest2 is defined as A4772988-4A85-4FA9-824E-B5CF5C16405A

 

 

Community Additions

ADD
Show:
© 2014 Microsoft