IOpcSigningOptions::GetCertificateEmbeddingOption method

Gets a value that specifies the storage location in the package of the certificate to be used for the signature.

Syntax


HRESULT GetCertificateEmbeddingOption(
  [out, retval] OPC_CERTIFICATE_EMBEDDING_OPTION *embeddingOption
);

Parameters

embeddingOption [out, retval]

A value that specifies 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 codeDescription
S_OK

The method succeeded.

E_INVALIDARG

The embeddingOption parameter is not a valid OPC_CERTIFICATE_EMBEDDING_OPTION enum value.

 

Remarks

The default location of the certificate is OPC_CERTIFICATE_IN_CERTIFICATE_PART. To change this value, call the IOpcSigningOptions::SetCertificateEmbeddingOption method.

Thread Safety

Packaging objects are not thread-safe.

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

Requirements

Minimum supported client

Windows 7 [desktop apps only]

Minimum supported server

Windows Server 2008 R2 [desktop apps only]

Header

Msopc.h

IDL

OpcDigitalSignature.idl

See also

IOpcSigningOptions
Overviews
Getting Started with the Packaging API
Packaging API Programming Guide
Reference
OPC_CERTIFICATE_EMBEDDING_OPTION
Core Packaging Interfaces
Packaging Digital Signature Interfaces
Packaging Interfaces
Packaging API Reference
Packaging API Samples

 

 

Community Additions

ADD
Show: