IXpsSignature::GetPolicy method (xpsdigitalsignature.h)

Article
02/22/2024

Gets the XPS_SIGN_POLICY value that represents the signing policy used when the signature is created.

Syntax

HRESULT GetPolicy(
  [out, retval] XPS_SIGN_POLICY *policy
);

Parameters

[out, retval] policy

The logical OR of the XPS_SIGN_POLICY values that represent the signing policy.

Return value

The method returns an HRESULT. Possible values include, but are not limited to, those in the table that follows. For return values that are not listed in this table, see XPS Digital Signature API Errors and XPS Document Errors.

Return code	Description
S_OK	The method succeeded.
E_POINTER	policy is NULL.
E_UNEXPECTED	The interface is not connected to the signature manager.

Remarks

The signing policy value that is returned in policy is determined by examining the signed parts and relationships in the document.

This method deduces the signature policy by examining the list of signed parts and relationships. For example, the XPS_SIGN_POLICY_DISCARD_CONTROL flag is set if the discard-control relationship type from the XPS package root is signed.

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

Share via