IOpcSigningOptions::SetCertificateEmbeddingOption method (msopc.h)

Article
02/22/2024

Set the storage location of the certificate to be used for the signature.

Syntax

HRESULT SetCertificateEmbeddingOption(
  [in] OPC_CERTIFICATE_EMBEDDING_OPTION embeddingOption
);

Parameters

[in] embeddingOption

The OPC_CERTIFICATE_EMBEDDING_OPTION value that describes the location of the certificate.

Return value

The method returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return code	Description
S_OK	The method succeeded.
E_POINTER	The embeddingOption parameter is NULL.

Remarks

This method changes the location of the certificate from the default location, OPC_CERTIFICATE_IN_CERTIFICATE_PART, to a location that is specified by the caller.

To access the value that describes the certificate location, call the IOpcSigningOptions::GetCertificateEmbeddingOption method.

Thread Safety

Packaging objects are not thread-safe.

For more information, see the Getting Started with the Packaging API.

Requirements

Requirement	Value
Minimum supported client	Windows 7 [desktop apps only]
Minimum supported server	Windows Server 2008 R2 [desktop apps only]
Target Platform	Windows
Header	msopc.h