IX509CertificateRequest::get_UIContextMessage method (certenroll.h)

The UIContextMessage property specifies or retrieves a context string to display in the user interface.

This property is read/write.

Syntax

HRESULT get_UIContextMessage(
  BSTR *pValue
);

Parameters

pValue

Return value

None

Remarks

You can set this property before calling any initialization method or the Encode method. For a PKCS #10 request, the property value is retrieved from and specified on the associated IX509PrivateKey object if the key exists. For a PKCS #7 or CMC request the property value is updated on the inner request and all signing certificates.

The context string should include additional information about an action. For example, if the user interface instructs the user to enter a smartcard PIN, the context string can indicate that a PIN is used to verify the identity of the user so that the request can be signed.

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

See also

IX509CertificateRequest

IX509CertificateRequestCertificate

IX509CertificateRequestCmc

IX509CertificateRequestPkcs10

IX509CertificateRequestPkcs7

IX509SignatureInformation