Edit

IXpsOMVisual::GetClipGeometry method (xpsobjectmodel.h)

  • Article

Gets a pointer to the IXpsOMGeometry interface that contains the resolved geometry of the visual's clipping region.

Syntax

HRESULT GetClipGeometry(
  [out, retval] IXpsOMGeometry **clipGeometry
);

Parameters

[out, retval] clipGeometry

A pointer to the IXpsOMGeometry interface that contains the resolved geometry of the visual's clipping region. If the clip geometry has not been set, a NULL pointer is returned.

The value that is returned in this parameter depends on which method has most recently been called to set the geometry.

Most recent method called Object that is returned in clipGeometry

SetClipGeometryLocal

 The local clip geometry that is set by SetClipGeometryLocal.

SetClipGeometryLookup

 The shared clip geometry that gets retrieved, with a lookup key that matches the key that is set by SetClipGeometryLookup, from the resource directory.
Neither SetClipGeometryLocal nor SetClipGeometryLookup has been called yet. NULL pointer.

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
 clipGeometry is NULL.
XPS_E_LOOKUP_INVALID_TYPE
 The lookup key name set by SetStrokeBrushLookup references an object that is not a brush.
XPS_E_LOOKUP_NOT_FOUND
 No object could be found with a key name that matched the lookup value.

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

See also

IXpsOMGeometry

IXpsOMVisual

XML Paper Specification

XPS Document Errors