IOpcDigitalSignature::GetCanonicalizationMethod method (msopc.h)

Article
10/13/2021

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

Syntax

HRESULT GetCanonicalizationMethod(
  [out, retval] OPC_CANONICALIZATION_METHOD *canonicalizationMethod
);

Parameters

[out, retval] 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

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