IXpsSignatureRequest::GetSpotLocation method (xpsdigitalsignature.h)

Article
10/13/2021

Gets the page and the location on the page where the visible digital signature or the digital signature request will be displayed.

Syntax

HRESULT GetSpotLocation(
  [out] INT32       *pageIndex,
  [out] IOpcPartUri **pagePartName,
  [out] float       *x,
  [out] float       *y
);

Parameters

[out] pageIndex

The index value of the FixedPage part that contains the signature or the digital signature request. If a spot location is not specified for the signature request, –1 is returned.

[out] pagePartName

A pointer to an IOpcPartUri interface of the part that contains the FixedPage on which the digital signature is to be displayed.

[out] x

The x-coordinate value of the signing spot on the page.

[out] y

The y-coordinate value of the signing spot on the page.

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	pageIndex, pagePartName, x, or y is NULL.
E_UNEXPECTED	The interface is not connected to the signature manager.

Remarks

The location of the signing spot is specified in XPS units from the upper-left corner of the page. There are 96 XPS units per inch.

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