Skip to content

Latest commit

 

History

History
154 lines (112 loc) · 7.17 KB

nf-xenroll-icenroll-get_genkeyflags.md

File metadata and controls

154 lines (112 loc) · 7.17 KB
UID title description helpviewer_keywords old-location tech.root ms.assetid ms.date ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames req.redist ms.custom f1_keywords dev_langs topic_type api_type api_location api_name
NF:xenroll.ICEnroll.get_GenKeyFlags
ICEnroll::get_GenKeyFlags (xenroll.h)
Sets or retrieves the values passed to the CryptGenKey function when the certificate request is generated. (Get)
CEnroll object [Security]
GenKeyFlags property
GenKeyFlags property [Security]
GenKeyFlags property [Security]
CEnroll object
GenKeyFlags property [Security]
ICEnroll interface
GenKeyFlags property [Security]
ICEnroll2 interface
GenKeyFlags property [Security]
ICEnroll3 interface
GenKeyFlags property [Security]
ICEnroll4 interface
ICEnroll interface [Security]
GenKeyFlags property
ICEnroll.GenKeyFlags
ICEnroll.get_GenKeyFlags
ICEnroll2 interface [Security]
GenKeyFlags property
ICEnroll2.GenKeyFlags
ICEnroll2::get_GenKeyFlags
ICEnroll2::put_GenKeyFlags
ICEnroll3 interface [Security]
GenKeyFlags property
ICEnroll3.GenKeyFlags
ICEnroll3::get_GenKeyFlags
ICEnroll3::put_GenKeyFlags
ICEnroll4 interface [Security]
GenKeyFlags property
ICEnroll4.GenKeyFlags
ICEnroll4::GenKeyFlags
ICEnroll4::get_GenKeyFlags
ICEnroll4::put_GenKeyFlags
ICEnroll::get_GenKeyFlags
ICEnroll::put_GenKeyFlags
get_GenKeyFlags
security.icenroll4_genkeyflags
xenroll/ICEnroll2::GenKeyFlags
xenroll/ICEnroll2::get_GenKeyFlags
xenroll/ICEnroll2::put_GenKeyFlags
xenroll/ICEnroll3::GenKeyFlags
xenroll/ICEnroll3::get_GenKeyFlags
xenroll/ICEnroll3::put_GenKeyFlags
xenroll/ICEnroll4::GenKeyFlags
xenroll/ICEnroll4::get_GenKeyFlags
xenroll/ICEnroll4::put_GenKeyFlags
xenroll/ICEnroll::GenKeyFlags
xenroll/ICEnroll::get_GenKeyFlags
xenroll/ICEnroll::put_GenKeyFlags
security\icenroll4_genkeyflags.htm
security
d22fe4d4-a939-4f77-8e11-f9312c81ec1e
12/05/2018
CEnroll object [Security],GenKeyFlags property, GenKeyFlags property [Security], GenKeyFlags property [Security],CEnroll object, GenKeyFlags property [Security],ICEnroll interface, GenKeyFlags property [Security],ICEnroll2 interface, GenKeyFlags property [Security],ICEnroll3 interface, GenKeyFlags property [Security],ICEnroll4 interface, ICEnroll interface [Security],GenKeyFlags property, ICEnroll.GenKeyFlags, ICEnroll.get_GenKeyFlags, ICEnroll2 interface [Security],GenKeyFlags property, ICEnroll2.GenKeyFlags, ICEnroll2::get_GenKeyFlags, ICEnroll2::put_GenKeyFlags, ICEnroll3 interface [Security],GenKeyFlags property, ICEnroll3.GenKeyFlags, ICEnroll3::get_GenKeyFlags, ICEnroll3::put_GenKeyFlags, ICEnroll4 interface [Security],GenKeyFlags property, ICEnroll4.GenKeyFlags, ICEnroll4::GenKeyFlags, ICEnroll4::get_GenKeyFlags, ICEnroll4::put_GenKeyFlags, ICEnroll::get_GenKeyFlags, ICEnroll::put_GenKeyFlags, get_GenKeyFlags, security.icenroll4_genkeyflags, xenroll/ICEnroll2::GenKeyFlags, xenroll/ICEnroll2::get_GenKeyFlags, xenroll/ICEnroll2::put_GenKeyFlags, xenroll/ICEnroll3::GenKeyFlags, xenroll/ICEnroll3::get_GenKeyFlags, xenroll/ICEnroll3::put_GenKeyFlags, xenroll/ICEnroll4::GenKeyFlags, xenroll/ICEnroll4::get_GenKeyFlags, xenroll/ICEnroll4::put_GenKeyFlags, xenroll/ICEnroll::GenKeyFlags, xenroll/ICEnroll::get_GenKeyFlags, xenroll/ICEnroll::put_GenKeyFlags
xenroll.h
Windows
Windows XP [desktop apps only]
Windows Server 2003 [desktop apps only]
Uuid.lib
Xenroll.dll
Windows
19H1
ICEnroll::get_GenKeyFlags
xenroll/ICEnroll::get_GenKeyFlags
c++
APIRef
kbSyntax
COM
Xenroll.dll
ICEnroll4.GenKeyFlags
ICEnroll4.get_GenKeyFlags
ICEnroll4.put_GenKeyFlags
ICEnroll3.GenKeyFlags
ICEnroll3.get_GenKeyFlags
ICEnroll3.put_GenKeyFlags
ICEnroll2.GenKeyFlags
ICEnroll2.get_GenKeyFlags
ICEnroll2.put_GenKeyFlags
ICEnroll.GenKeyFlags
ICEnroll.get_GenKeyFlags
ICEnroll.put_GenKeyFlags
CEnroll.GenKeyFlags

ICEnroll::get_GenKeyFlags

-description

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

The GenKeyFlags property sets or retrieves the values passed to the CryptGenKey function when the certificate request is generated.

By default, the GenKeyFlags property is set to zero. However, when a .pvk file is specified, the value of GenKeyFlags defaults to CRYPT_EXPORTABLE. For more information, see Remarks.

This property was first defined in the ICEnroll interface.

This property is read/write.

-parameters

-remarks

By default, private keys are not exportable unless a .pvk file is requested. To make the private key exportable without specifying a .pvk file, set GenKeyFlags to CRYPT_EXPORTABLE.

To specify a .pvk file name, use the PVKFileName property.

The GenKeyFlags property value is passed to the CryptGenKey CryptoAPI function by using its dwFlags parameter.

If the cryptographic service provider (CSP) does not support exportable private keys, an error occurs.

The GenKeyFlags property affects the behavior of the following methods:

Note  The default value for the GenKeyFlags property is zero. If you need to change this value, you must do so before calling these methods. After calling any of these methods, you cannot change the GenKeyFlags property value.
 

Examples

LONG     lGenKey;
HRESULT  hr;

// pEnroll is a previously instantiated ICEnroll interface pointer.

// Get the GenKeyFlags value.
hr = pEnroll->get_GenKeyFlags( &lGenKey );
if (FAILED( hr ))
    printf("Failed get_GenKeyFlags - %x\n", hr );
else
    printf( "GenKeyFlags: %d\n", lGenKey );

// Set the GenKeyFlags value.
hr = pEnroll->put_GenKeyFlags( CRYPT_EXPORTABLE );
if (FAILED( hr ))
    printf("Failed put_GenKeyFlags - %x\n", hr );
else
    printf( "GenKeyFlags set to %d\n", CRYPT_EXPORTABLE );

-see-also

CEnroll

CryptGenKey

ICEnroll

ICEnroll2

ICEnroll3

ICEnroll4