IXpsOMGradientBrush::GetSpreadMethod method
Gets the XPS_SPREAD_METHOD value, which describes how the area outside of the gradient region will be rendered.
Syntax
HRESULT GetSpreadMethod(
[out, retval] XPS_SPREAD_METHOD *spreadMethod
);
Parameters
- spreadMethod [out, retval]
The XPS_SPREAD_METHOD value that describes how the area outside of the gradient region will be rendered. The gradient region is defined by the linear-gradient brush or radial-gradient brush that inherits this 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. |
| E_POINTER | spreadMethod is NULL. |
Remarks
For more information about different types of spread methods, see XPS_SPREAD_METHOD.
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 |