IXpsSignatureRequest::SetIntent method (xpsdigitalsignature.h)

Article
02/22/2024

Sets the string that describes the intent or meaning of the signature.

Syntax

HRESULT SetIntent(
  [in] LPCWSTR intent
);

Parameters

[in] intent

The string that describes the intent or meaning of 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_POINTER	intent is NULL.
E_UNEXPECTED	The interface is not connected to the signature manager.

Remarks

The signature intent string describes what the signature means to the signer. For example, for the signature intent string "I have read and agree with the contents of this document" the presence of a digital signature means that the signer has read and agrees with the content of the document.

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