IXpsSigningOptions::SetDigestMethod method (xpsdigitalsignature.h)

Article
02/22/2024

Sets the URI of the digest method.

Syntax

HRESULT SetDigestMethod(
  [in] LPCWSTR digestMethod
);

Parameters

[in] digestMethod

The URI of the digest method.

This parameter must refer to the URI of a valid digest method. The following digest methods have been tested in Windows 7:

Return value

If the method succeeds, it returns S_OK; otherwise, it returns an HRESULT error code.

Remarks

The digest method must be set before signing.

When a new instance of this interface is returned by IXpsSignatureManager::CreateSigningOptions, the SignatureMethod and DigestMethod properties are not initialized. They must be initialized before the new interface can be used as a parameter of the Sign method.

Sets the string that identifies the URI of the algorithm that is used to digest the parts, relationships, and signature references. The following is an example of a valid URI: http://www.w3.org/2000/09/xmldsig#sha1.

The signing certificate, signature method, and digest method must be compatible with one another.

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	xpsdigitalsignature.h