IXpsOMRadialGradientBrush::GetRadiiSizes method
Gets the sizes of the radii that define the ellipse of the radial gradient region.
Syntax
HRESULT GetRadiiSizes(
[out, retval] XPS_SIZE *radiiSizes
);
Parameters
radiiSizes [out, retval]
The XPS_SIZE structure that receives the sizes of the radii.Field Meaning width
Size of the radius along the x-axis.
height
Size of the radius along the y-axis.
Size is described in XPS units. There are 96 XPS units per inch. For example, a 1" radius is 96 XPS units.
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 | radiiSizes is NULL. |
Remarks
The following illustration shows the parts of a radial gradient. radiiSizes.width gets the x-radius, and radiiSizes.height the y-radius. For a more detailed description of this diagram, see IXpsOMRadialGradientBrush.
.png "A figure that shows the terms used in a radial gradient")
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 |