Edit

ICEnroll4::enumPendingRequest method (xenroll.h)

  • Article

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

The enumPendingRequest method enumerates pending certificate requests and retrieves a specified property from each.

This method was first defined in the ICEnroll4 interface.

Syntax

HRESULT enumPendingRequest(
  [in]  LONG    lIndex,
  [in]  LONG    lDesiredProperty,
  [out] VARIANT *pvarProperty
);

Parameters

[in] lIndex

Specifies the ordinal position of the pending request whose property will be retrieved. Specify zero for the first request.

[in] lDesiredProperty

The identifier for the property being retrieved. This parameter can be one of the following values.

Value Meaning
XEPR_CADNS
 The DNS name for the certification authority (CA).
XEPR_CAFRIENDLYNAME
 The display name of the CA.
XEPR_CANAME
 The name of the CA.
XEPR_HASH
 The hash value of the request.
XEPR_REQUESTID
 The certificate request ID.

[out] pvarProperty

A pointer to a VARIANT that receives the value of the retrieved property.

When you have finished using the VARIANT, free it by calling the VariantClear function.

Return value

C++

If the method succeeds, the method returns S_OK.

If the method fails, it returns an HRESULT value that indicates the error. For a list of common error codes, see Common HRESULT Values.

If the following values are specified for lDesiredProperty, this method returns E_NOTIMPL:

  • XEPR_DATE
  • XEPR_V1TEMPLATENAME
  • XEPR_V2TEMPLATEOID
  • XEPR_VERSION

If you specify any other value for lDesiredProperty this method returns E_INVALIDARG.

VB

Returns a Variant that contains a property from a pending request.

Remarks

This method is disabled when the Certificate Enrollment Control is executed as a scripted control.

Requirements

Requirement Value
Minimum supported client Windows XP [desktop apps only]
Minimum supported server Windows Server 2003 [desktop apps only]
Target Platform Windows
Header xenroll.h
Library Uuid.lib
DLL Xenroll.dll