ICertPropertyFriendlyName::Initialize method (certenroll.h)

Article
02/22/2024

The Initialize method initializes the object from the certificate display name. This method is web enabled.

Syntax

HRESULT Initialize(
  [in] BSTR strFriendlyName
);

Parameters

[in] strFriendlyName

A BSTR variable that contains the name. The string length cannot exceed 260 characters.

Return value

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.

Return code/value	Description
HRESULT_FROM_WIN32(ERROR_ALREADY_INITIALIZED)	The object is already initialized.
HRESULT_FROM_WIN32(ERROR_FILENAME_EXCED_RANGE)	The string length exceeds 260 characters.

Remarks

Typically, you specify the display name in a user interface or from the command line before beginning the enrollment process so that the name can be associated with the dummy certificate in the request store. To retrieve that value and use it here, call the CertificateFriendlyName on the IX509Enrollment interface.

Call the SetValueOnCertificate method to associate the property with a certificate. Call the FriendlyName property to retrieve the display name.

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