IXpsOMTileBrush::GetTransform method (xpsobjectmodel.h)

Article
07/27/2022

Gets a pointer to the IXpsOMMatrixTransform interface that contains the resolved matrix transform for the brush.

Syntax

HRESULT GetTransform(
  [out, retval] IXpsOMMatrixTransform **transform
);

Parameters

[out, retval] transform

A pointer to the IXpsOMMatrixTransform interface that contains the resolved matrix transform for the brush. If a matrix transform has not been set, a NULL pointer is returned.

The value that is returned in this parameter depends on which method has most recently been called to set the transform.

Most recent method called	Object that is returned in transform
SetTransformLocal	The transform that is set by SetTransformLocal.
SetTransformLookup	The transform which is retrieved, using a lookup key that matches the key that is set by SetTransformLookup, from the resource directory.
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	transform is NULL.
XPS_E_LOOKUP_INVALID_TYPE	The lookup key name set by SetStrokeBrushLookup references an object that is not a brush.
XPS_E_LOOKUP_NOT_FOUND	No object could be found with a key name that matched the lookup value.

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.

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