IEnroll2::get_ReuseHardwareKeyIfUnableToGenNew method (xenroll.h)

Article
02/22/2024

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

The ReuseHardwareKeyIfUnableToGenNew property sets or retrieves a Boolean value that determines the action taken by the certificate enrollment control object if an error is encountered when generating a new key.

This property was first defined in the IEnroll2 interface.

This property is read/write.

Syntax

HRESULT get_ReuseHardwareKeyIfUnableToGenNew(
  BOOL *fReuseHardwareKeyIfUnableToGenNew
);

Parameters

fReuseHardwareKeyIfUnableToGenNew

Return value

None

Remarks

This property is a Boolean value. This property affects only cryptographic service providers (CSP) that return NTE_TOKEN_KEYSET_STORAGE_FULL. These CSPs are typically hardware-based; an example is a smart card. If this property is TRUE and an error is encountered while generating a new key, the certificate enrollment control object will reuse the existing hardware key. If this property is FALSE and an error is encountered while generating a new key, the certificate enrollment control object will not reuse the existing hardware key but will instead pass an error to the caller.

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