ICEnroll4::UseExistingKeySet property

[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 put_UseExistingKeySet(
  [in]  BOOL bValue
);

HRESULT get_UseExistingKeySet(
  [out] BOOL *pbValue
);

Property value

If true, the existing keys should be used.

Error codes

If the property access methods put_UseExistingKeySet and get_UseExistingKeySet succeed, they return S_OK.

Any other HRESULT value indicates that the call failed.

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

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_ICEnroll4 is defined as c1f1188a-2eb5-4a80-841b-7e729a356d90

 

 

Show: