Edit

IXpsOMVisual::GetClipGeometryLocal method (xpsobjectmodel.h)

  • Article

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

Syntax

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

Parameters

[out, retval] clipGeometry

A pointer to the IXpsOMGeometry interface that contains the local, unshared geometry of the visual's clipping region. If a clip geometry lookup key has been set, or if a local clip geometry has not been set, a NULL pointer is returned.

Most recent method called Object that is returned in clipGeometry

SetClipGeometryLocal

 The local clip geometry that is set by SetClipGeometryLocal.

SetClipGeometryLookup

 NULL pointer.
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.

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