IOpcSigningOptions::GetDefaultDigestMethod method (msopc.h)

Article
02/22/2024

Gets the default digest method that will be used to compute digest values for objects to be signed.

Syntax

HRESULT GetDefaultDigestMethod(
  [out, retval] LPWSTR *digestMethod
);

Parameters

[out, retval] digestMethod

A pointer to the default digest method, or the empty string "" if a default has not been set using the SetDefaultDigestMethod method.

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

Remarks

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

To set the default digest method, call the IOpcSigningOptions::SetDefaultDigestMethod method.

Important The default digest method must be set before the signature is generated by calling the IOpcDigitalSignatureManager::Sign 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