IOpcSigningOptions::GetSignatureMethod method

Gets the signature method to use to calculate and encrypt the hash value of the SignedInfo element, which will be serialized as the SignatureValue element of the signature.

Syntax

HRESULT GetSignatureMethod(
  [out, retval] LPCWSTR *signatureMethod
);

Parameters

signatureMethod [out, retval]

A pointer to the signature method to use, or the empty string "" if no method has been set using the SetSignatureMethod method.

Return value

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

Remarks

This method allocates memory used by the string returned in signatureMethod. If the method succeeds, call the CoTaskMemFree function to free the memory.

To set the signature method, call the IOpcSigningOptions::SetSignatureMethod method.

To access the signature method before the signature is generated, call the IOpcSigningOptions::GetSignatureMethod. To access the signature method after the signature is generated, call the IOpcDigitalSignature::GetSignatureMethod method.

When a signature is generated it is serialized as signature markup. The signature method is used to calculate the value in the SignatureValue element in the signature markup.

When a signature is validated, the signature method is used to recalculate that value, and the recalculated value is compared to the value in the SignatureValue element in the signature markup.

Thread Safety

Packaging objects are not thread-safe.

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

Requirements

See also

IOpcSigningOptions

Overviews

Getting Started with the Packaging API

Packaging API Programming Guide

Reference

IOpcDigitalSignature

IOpcDigitalSignatureManager

Core Packaging Interfaces

Packaging Digital Signature Interfaces

Packaging Interfaces

Packaging API Reference

Packaging API Samples