ICertProperty interface (certenroll.h)

The ICertProperty interface can be used to associate an external property with a certificate. Properties are never sent to or processed by a certification authority, and they are not stored inside a certificate. Typically, they are associated with a certificate after the certificate is received from the certification authority and before it is saved in a store. The properties are saved in the store along with the certificate. A collection of properties is contained in an ICertProperties object. You can initialize the collection by using an existing certificate.

The CERTENROLL_PROPERTYID enumeration identifies the properties that you can specify or retrieve. Also, the following interfaces, which inherit from ICertProperty, can be used to specify the most commonly used properties:

• ICertPropertyArchived
• ICertPropertyArchivedKeyHash
• ICertPropertyAutoEnroll
• ICertPropertyBackedUp
• ICertPropertyDescription
• ICertPropertyEnrollment
• ICertPropertyFriendlyName
• ICertPropertyKeyProvInfo
• ICertPropertyRenewal
• ICertPropertyRequestOriginator
• ICertPropertySHA1Hash

Note  We recommend that you use the interfaces in the preceding list when appropriate. Enrollment behavior is not defined when you use an ICertProperty base interface to represent any of these common properties.

 

Inheritance

The ICertProperty interface inherits from the IDispatch interface. ICertProperty also has these types of members:

Methods

The ICertProperty interface has these methods.

ICertProperty::get_PropertyId Specifies or retrieves a value of the CERTENROLL_PROPERTYID enumeration that identifies an external certificate property. (Get)
ICertProperty::get_RawData Retrieves the value of the certificate property.
ICertProperty::InitializeDecode Initializes the object from a byte array that contains the property value.
ICertProperty::InitializeFromCertificate Initializes the object by using a property value associated with an existing certificate.
ICertProperty::put_PropertyId Specifies or retrieves a value of the CERTENROLL_PROPERTYID enumeration that identifies an external certificate property. (Put)
ICertProperty::RemoveFromCertificate Disassociates a property from a certificate.
ICertProperty::SetValueOnCertificate Associates a property value with an existing certificate.

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

See also

CertEnroll Interfaces

ICertProperties

IDispatch