IXpsOMVisual::SetClipGeometryLookup method (xpsobjectmodel.h)

Article
10/13/2021

Sets the lookup key name of a shared clip geometry in a resource dictionary.

Syntax

HRESULT SetClipGeometryLookup(
  [in] LPCWSTR key
);

Parameters

[in] key

The lookup key name of the clip geometry in the dictionary. A NULL pointer clears the previously assigned key name.

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.
XPS_E_INVALID_RESOURCE_KEY	According to the XML Paper Specification, the value of lookup is not a valid lookup key string.
XPS_E_INVALID_LOOKUP_TYPE	The lookup key name in key references an object that is not a geometry.
XPS_E_LOOKUP_NOT_FOUND	No object could be found with a key name that matched the value passed in key.

Remarks

After you call SetClipGeometryLookup, the local clip geometry is released and GetClipGeometryLocal returns a NULL pointer in the clipGeometry parameter. The table that follows explains the relationship between the local and lookup values of this property.

Most recent method called	Object that is returned in clipGeometry by GetClipGeometry	Object that is returned in clipGeometry by GetClipGeometryLocal	String that is returned in key by GetClipGeometryLookup
SetClipGeometryLocal	The local clip geometry that is set by SetClipGeometryLocal.	The local clip geometry that is set by SetClipGeometryLocal.	NULL pointer.
SetClipGeometryLookup (this method)	The shared clip geometry that gets retrieved, with a lookup key that matches the key that is set by SetClipGeometryLookup, from the resource directory.	NULL pointer.	The lookup key that is set by SetClipGeometryLookup.
Neither SetClipGeometryLookup nor SetClipGeometryLocal has been called yet.	NULL pointer.	NULL pointer.	NULL pointer.

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