IXpsSignatureRequest::GetRequestSignByDate method (xpsdigitalsignature.h)

Article
02/22/2024

Gets the date and time before which the requested signer must sign the specified parts of the document.

Syntax

HRESULT GetRequestSignByDate(
  [out, retval] LPWSTR *dateString
);

Parameters

[out, retval] dateString

A string that contains the date and time before which the requested signer must sign the specified parts of the document.

The string is formatted as either YYYY-MM-DDThh:mmZ, which includes the UTC time zone offset, or YYYY-MM-DDThh:mm, which does not include the UTC time zone offset. For example, without the time zone offset, 7:30:29 P.M. on July 4, 2008 would be represented as 2008-07-04T19:30:29.

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

Remarks

This method allocates the memory used by the string that is returned in dateString. If dateString is not NULL, use the CoTaskMemFree function to free the memory.

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