IXpsSignature::SetSignatureXml method (xpsdigitalsignature.h)

Article
02/22/2024

Sets the XML markup of the digital signature.

Syntax

HRESULT SetSignatureXml(
  [in] const UINT8 *signatureXml,
  [in] UINT32      count
);

Parameters

[in] signatureXml

The XML markup of the digital signature.

[in] count

The size, in bytes, of the buffer referenced by signatureXml.

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

Remarks

Before calling this method, the application must check that the signature markup is valid. If the signature markup is not valid, this method will fail and the content of the signature part will not be changed.

Warning

Using this method to create digital signatures might cause other methods of this interface to return signatures and data that are no longer valid.

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