ReuseHardwareKeyIfUnableToGenNew Property

IEnroll4::ReuseHardwareKeyIfUnableToGenNew property

[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 put_ReuseHardwareKeyIfUnableToGenNew(
  [in]  BOOL fReuseHardwareKeyIfUnableToGenNew
);

HRESULT get_ReuseHardwareKeyIfUnableToGenNew(
  [out] BOOL *pfReuseHardwareKeyIfUnableToGenNew
);

Property value

BOOL value assigned to the ReuseHardwareKeyIfUnableToGenNew property. The default value is TRUE.

Error codes

If the property access methods put_ReuseHardwareKeyIfUnableToGenNew and get_ReuseHardwareKeyIfUnableToGenNew succeed, they return S_OK.

Any other HRESULT value indicates that the call failed.

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

Minimum supported client

Windows XP [desktop apps only]

Minimum supported server

Windows Server 2003 [desktop apps only]

End of client support

Windows XP

End of server support

Windows Server 2003

Header

Xenroll.h

Library

Uuid.lib

DLL

Xenroll.dll

IID

IID_IEnroll4 is defined as f8053fe5-78f4-448f-a0db-41d61b73446b

See also

IEnroll4

 

 

Show:
© 2016 Microsoft