IX509PrivateKey::CspInformations property

The CspInformations property specifies or retrieves a collection of ICspInformation objects that contain information about the available cryptographic providers that support the public key algorithm associated with the private key. This property is web enabled for both input and output.

This property is read/write.

Syntax


HRESULT put_CspInformations(
  [in]   ICspInformations *pValue
);

HRESULT get_CspInformations(
  [out]  ICspInformations **ppValue
);

Property value

Pointer to an ICspInformations interface that represents the collection.

Error codes

If the function succeeds, the function returns S_OK.

If the function fails, it returns an HRESULT value that indicates the error. Possible values include, but are not limited to, those in the following table. For a list of common error codes, see Common HRESULT Values.

Name/valueMeaning
CERTSRV_E_PROPERTY_EMPTY

The property value could not be found.

HRESULT_FROM_WIN32(ERROR_FILE_READ_ONLY)

The key is open, and the property value cannot be set.

HRESULT_FROM_WIN32(ERROR_FILE_EXISTS)

The property value has already been set.

Remarks

The enrollment process expects the ICspInformations collection to include all providers installed on the client computer. You should therefore not attempt to set this property to a subset of the installed providers. We recommend that you create an empty collection and call AddAvailableCsps to populate it. Build this collection once and set it on all top level request objects (or the private key if you are using the IX509PrivateKey object directly) to avoid the cost of creating multiple collections. An ICspInformations collection is large.

Requirements

Minimum supported client

Windows Vista [desktop apps only]

Minimum supported server

Windows Server 2008 [desktop apps only]

Header

CertEnroll.h

DLL

CertEnroll.dll

See also

IX509PrivateKey

 

 

Community Additions

ADD
Show:
© 2014 Microsoft