IXpsOMPath::GetSnapsToPixels method (xpsobjectmodel.h)

Article
02/22/2024

Gets a Boolean value that indicates whether the path is to be snapped to device pixels when the path is rendered.

Syntax

HRESULT GetSnapsToPixels(
  [out, retval] BOOL *snapsToPixels
);

Parameters

[out, retval] snapsToPixels

A Boolean value that indicates whether the path is to be snapped to device pixels when the path is rendered. The following table describes the values possible for this parameter.

Value	Meaning
TRUE	The path is to be snapped to device pixels.
FALSE	The path is not to be snapped to device pixels.

Return value

The method returns an HRESULT. Possible values include, but are not limited to, those in the table that follows. For information about XPS document API return values that are not listed in this table, see XPS Document Errors.

Return code	Description
S_OK	The method succeeded.
E_POINTER	snapsToPixels is NULL.

Remarks

The value returned by GetSnapsToPixels corresponds to the SnapsToDevicePixels element in the document markup.

Requirements

Requirement	Value
Minimum supported client	Windows 7, Windows Vista with SP2 and Platform Update for Windows Vista [desktop apps \| UWP apps]
Minimum supported server	Windows Server 2008 R2, Windows Server 2008 with SP2 and Platform Update for Windows Server 2008 [desktop apps \| UWP apps]
Target Platform	Windows
Header	xpsobjectmodel.h