ICEnroll::get_ProviderFlags method (xenroll.h)

Article
02/22/2024

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

The ProviderFlags property sets or retrieves the provider type.

The ProviderFlags property is passed to the CryptAcquireContext CryptoAPI function. Valid values are determined by the cryptographic service provider (CSP) in use.

The default value for this property is zero. This property was first defined in the ICEnroll interface.

This property is read/write.

Syntax

HRESULT get_ProviderFlags(
  LONG *pdwFlags
);

Parameters

pdwFlags

Return value

None

Remarks

For more information about valid ProviderFlags values for the Microsoft Base Cryptographic Provider, see the CryptAcquireContext CryptoAPI function.

For information about other CSPs, see the documentation provided with the CSP.

The ProviderFlags property value is passed to CryptAcquireContext by using its dwFlags parameter.

The ProviderFlags property affects the behavior of the following methods:

Examples

DWORD    dwProvFlags;
HRESULT  hr;

// pEnroll is previously instantiated ICEnroll interface pointer
// get the ProviderFlags value
hr = pEnroll->get_ProviderFlags( &dwProvFlags );
if (FAILED( hr ))
    printf("Failed get_ProviderFlags - %x\n", hr );
else
    printf( "ProviderFlags: %d\n", dwProvFlags );

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

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