ICspStatuses::get_ItemByProvider method (certenroll.h)

Article
04/02/2021

The ItemByProvider property retrieves an ICspStatus object that has the same name as the provider specified on input but identifies an algorithm that supports a different intended key use.

This property is read-only.

Syntax

HRESULT get_ItemByProvider(
  ICspStatus *pCspStatus,
  ICspStatus **ppValue
);

Parameters

pCspStatus

ppValue

Return value

None

Remarks

The ItemByProvider property retrieves the ICspStatus object that matches the name of the input provider but is associated with a different X509KeySpec enumeration value. For example, if the input provider has a KeySpec value of XCN_AT_KEYEXCHANGE, the ItemByProvider property attempts to find an ICspStatus object for the same provider but with a KeySpec value of XCN_AT_SIGNATURE.

Because the KeySpec property is only associated with legacy providers, if you specify a Cryptography API: Next Generation (CNG) providers, the ItemByProvider property returns the same ICspStatus object as that entered.

To use this property to iterate through the collection, perform the following steps:

Retrieve an ICspStatuses collection by calling the GetCspStatuses method or the CspStatuses property on the IX509CertificateRequestPkcs10 interface.
Call the ItemByIndex property to iterate through the collection.
For each ICspStatus element retrieved that contains the provider you are interested in, call ItemByProvider.

Requirements

Requirement	Value
Minimum supported client	Windows Vista [desktop apps only]
Minimum supported server	Windows Server 2008 [desktop apps only]
Target Platform	Windows
Header	certenroll.h
DLL	CertEnroll.dll