IXpsSigningOptions::GetSignatureMethod method (xpsdigitalsignature.h)

Article
02/22/2024

Gets the signature method.

Syntax

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

Parameters

[out, retval] signatureMethod

The signature method that is expressed as a URI. If no signature method has been set, a NULL pointer is returned.

The following signature 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

A signature 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 valid; they must be initialized before the new interface can be used as a parameter of the Sign method.

This method allocates the memory used by the string that is returned in signatureMethod. If signatureMethod is not NULL, use the CoTaskMemFree function to free the memory.

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