IXpsSignature::GetCertificateEnumerator method (xpsdigitalsignature.h)

Article
02/22/2024

Gets a pointer to an IOpcCertificateEnumerator interface, which enumerates the package certificates that are attached to the signature.

Syntax

HRESULT GetCertificateEnumerator(
  [out, retval] IOpcCertificateEnumerator **certificateEnumerator
);

Parameters

[out, retval] certificateEnumerator

A pointer to an IOpcCertificateEnumerator interface, which enumerates the certificates that are attached to the signature.

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_UNEXPECTED	The interface is not connected to the signature manager.

Remarks

The IOpcCertificateEnumerator interface returned in certificateEnumerator can be empty; however the XML Paper Specification requires that at least the signing certificate be included in the XPS package. Package producers may include additional certificates as well. For example, the entire certificate trust chain could be included in the XPS package.

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