IXpsSignatureRequest::GetIntent method
Sets the string that describes the intent or meaning of the signature.
Syntax
HRESULT GetIntent(
[out, retval] LPWSTR *intent
);
Parameters
- intent [out, retval]
The signature intention agreement against which the signer is signing.
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.
This method allocates the memory used by the string that is returned in intent. If intent is not NULL, use the CoTaskMemFree function to free the memory.
Requirements
Minimum supported client |
Windows 7 [desktop apps only] |
Minimum supported server |
Windows Server 2008 R2 [desktop apps only] |
Header |
Xpsdigitalsignature.h |
IDL |
XpsDigitalSignature.idl |