ICEnroll::get_UseExistingKeySet method (xenroll.h)

Article
02/22/2024

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

The UseExistingKeySet property sets or retrieves a Boolean value that determines whether the existing keys should be used.

This property was first defined in the ICEnroll interface.

This property is read/write.

Syntax

HRESULT get_UseExistingKeySet(
  BOOL *fUseExistingKeys
);

Parameters

fUseExistingKeys

Return value

None

Remarks

If an existing key set is used, the UseExistingKeySet property must be set to true.

The UseExistingKeySet property affects the behavior of the following methods:

Examples

BOOL     bUEKS;
HRESULT  hr;

// pEnroll is previously instantiated ICEnroll interface pointer

// get the UseExistingKeySet value
hr = pEnroll->get_UseExistingKeySet( &bUEKS );
if (FAILED( hr ))
    printf("Failed get_UseExistingKeySet - %x\n", hr );
else
    printf( "UseExistingKeySet: %d\n", bUEKS );

// set the UseExistingKeySet value
hr = pEnroll->put_UseExistingKeySet( TRUE );
if (FAILED( hr ))
    printf("Failed put_UseExistingKeySet - %x\n", hr );
else
    printf( "UseExistingKeySet set to TRUE\n" );

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

Share via