IXpsOMVisual::GetClipGeometryLookup method

Gets the lookup key for the IXpsOMGeometry interface in a resource dictionary that contains the visual's clipping region.

Syntax


HRESULT GetClipGeometryLookup(
  [out, retval] LPWSTR *key
);

Parameters

key [out, retval]

The lookup key for the IXpsOMGeometry interface in a resource dictionary that contains the visual's clipping region. If a lookup key for the clip geometry has not been set, or if a local clip geometry has been set, a NULL pointer is returned.

Most recent method calledLookup key string that is returned in key

SetClipGeometryLocal

NULL pointer.

SetClipGeometryLookup

The lookup key that is set by SetClipGeometryLookup.

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 codeDescription
S_OK

The method succeeded.

E_POINTER

key is NULL.

 

Remarks

This method allocates the memory that is used by the string returned in key. If key is not NULL, use the SignatureDefinitions function to free the memory.

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

See also

IXpsOMVisual
IXpsOMGeometry
XPS Document Errors
XML Paper Specification

 

 

Show: