IXpsOMGradientBrush::GetTransform method (xpsobjectmodel.h)
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 the transform has not been set, a NULL pointer is returned.
The value that is returned in this parameter depends on which method has been most recently called to set the transform.
| Most recent method called | Object that is returned in transform |
|---|---|
| The local transform that is set by SetTransformLocal. | |
| The shared transform that is retrieved, with a lookup key that matches the key 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 |
|---|---|
|
The method succeeded. |
|
transform is NULL. |
|
The lookup key name set by SetStrokeBrushLookup references an object that is not a brush. |
|
No object could be found with a key name that matched the lookup value.
No object could be found with a key name that matched the value passed in lookup. |
Remarks
The transform determines how the gradient is transformed. The visible part of the gradient that is ultimately rendered in the image is determined by the path, stroke, or glyph that is using the gradient 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 |