IXpsOMVisual::SetClipGeometryLocal method
Sets the local, unshared clipping region for the visual.
Syntax
HRESULT SetClipGeometryLocal(
[in] IXpsOMGeometry *clipGeometry
);
Parameters
- clipGeometry [in]
A pointer to the IXpsOMGeometry interface to be set as the local, unshared clipping region for the visual. A NULL pointer releases the previously assigned geometry interface.
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_NO_CUSTOM_OBJECTS | clipGeometry does not point to a recognized interface implementation. Custom implementation of XPS Document API interfaces is not supported. |
Remarks
After you call SetClipGeometryLocal, the clip geometry lookup key is released and GetClipGeometryLookup returns a NULL pointer in the key 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 (this method) |
The local clip geometry that is set by SetClipGeometryLocal. |
The local clip geometry that is set by SetClipGeometryLocal. |
NULL pointer. |
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
Minimum supported client |
Windows 7, Windows Vista with SP2 and Platform Update for Windows Vista [desktop apps | Windows Store apps] |
Minimum supported server |
Windows Server 2008 R2, Windows Server 2008 with SP2 and Platform Update for Windows Server 2008 [desktop apps | Windows Store apps] |
Header |
Xpsobjectmodel.h |
IDL |
XpsObjectModel.idl |