IXpsOMTileBrush::GetTransformLookup method (xpsobjectmodel.h)

Article
10/13/2021

Gets the lookup key that identifies the IXpsOMMatrixTransform interface in a resource dictionary that contains the resolved matrix transform for the brush.

Syntax

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

Parameters

[out, retval] key

The lookup key that identifies the IXpsOMMatrixTransform interface in a resource dictionary that contains the resolved matrix transform for the brush. If a matrix transform lookup key has not been set or if a local matrix transform has been set, a NULL pointer is returned.

Most recent method called	Object that is returned in key
SetTransformLocal	NULL pointer.
SetTransformLookup	The lookup key set by SetTransformLookup.
Neither SetTransformLocal nor SetTransformLookup 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	key is NULL.

Remarks

The transform determines how the output area is transformed before the brush image is rendered in the path, stroke, or glyph that is using the tile brush.

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

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