IX509CertificateRequest::GetInnerRequest method (certenroll.h)

Article
10/13/2021

The GetInnerRequest method retrieves a nested request object.

Syntax

HRESULT GetInnerRequest(
  [in]  InnerRequestLevel       Level,
  [out] IX509CertificateRequest **ppValue
);

Parameters

[in] Level

A value of an InnerRequestLevel enumeration that specifies the envelopment level of the data to retrieve. You can use the LevelNext value to iterate through the nested levels or the LevelInnermost value to retrieve the most deeply nested request object. You cannot specify LevelNext for a PKCS #10 request.

[out] ppValue

Address of a variable that receives a pointer to an IX509CertificateRequest interface that contains the nested request. Call the Type property to determine whether the inner request object is a PKCS #10 or a CMC request. Then call QueryInterface to retrieve the appropriate pointer.

Return value

If the function succeeds, the function returns S_OK.

If the function fails, it returns an HRESULT value that indicates the error. Possible values include, but are not limited to, those in the following table. For a list of common error codes, see Common HRESULT Values.

Return code/value	Description
CERTSRV_E_PROPERTY_EMPTY	You specified a value of LevelNext PKCS #10 request.

Remarks

A top-level request object can be a PKCS #10, PKCS #7, or CMC request. The following rules apply to inner request objects:

A PKCS #10 request cannot contain an inner request object.
A PKCS #7 request can contain only a PKCS #10 inner request object.
A CMC request can contain a CMC or a PKCS #10 inner request object. For a CMC request that contains an inner CMC request, there is no theoretical limit to the number of nested levels that can exist before the final inner PKCS #10 request is reached. That is, a top-level CMC request can contain an inner CMC request that also contains an inner CMC request and so on.

Requirements

Requirement	Value
Minimum supported client	Windows Vista [desktop apps only]
Minimum supported server	Windows Server 2008 [desktop apps only]
Target Platform	Windows
Header	certenroll.h
DLL	CertEnroll.dll