IOpcDigitalSignature::GetCanonicalizationMethod method (msopc.h)

Gets the canonicalization method that was applied to the SignedInfo element of the serialized signature.

Syntax

HRESULT GetCanonicalizationMethod(
  OPC_CANONICALIZATION_METHOD *canonicalizationMethod
);

Parameters

canonicalizationMethod

An OPC_CANONICALIZATION_METHOD value that specifies the canonicalization method that was applied to the SignedInfo element of the signature markup when the signature was generated.

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 canonicalizationMethod parameter is NULL.

Remarks

When using the APIs to generate a signature, the C14N canonicalization method that removes comments is applied to the SignedInfo element. This method corresponds to the OPC_CANONICALIZATION_C14N enum value.

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]
Target Platform Windows
Header msopc.h

See also

Core Packaging Interfaces

Digital Signatures Overview

Getting Started with the Packaging API

IOpcDigitalSignature

Overviews

Packaging API Programming Guide

Packaging API Reference

Packaging API Samples

Packaging Digital Signature Interfaces

Packaging Interfaces

Reference