IX509PrivateKey::Description property

The Description property specifies or retrieves a string that contains a description of the private key.

This property is read/write.

Syntax


HRESULT put_Description(
  [in]  BSTR 
);

HRESULT get_Description(
  [out] BSTR *
);

Property value

A BSTR that contains the description.

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_ALREADY_INITIALIZED)

The property value has already been specified.

Remarks

This property can contain any text and is intended to be displayed in a user interface to identify the nature and uses of the private key.

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: