IXRShape::GetStroke (Compact 2013)

3/28/2014

This method retrieves the brush that specifies how the outline of this shape object is painted.

Syntax

virtual HRESULT STDMETHODCALLTYPE GetStroke(
    IXRBrush **ppStroke
) = 0;

Parameters

• ppStroke
  [out] Address of a pointer to an object that derives from IXRBrush.

Return Value

Returns an HRESULT that indicates success or failure.

Remarks

When you use this method in the inheriting classes IXRLine and IXRPolyline, the value in ppStroke defines the whole brush-defined appearance for the object. For these inheriting classes, IXRShape::SetFill has no effect.

Notice that you cannot reuse an existing brush that has already been applied. For example, you cannot pass in the brush of one object into IXRShape::SetStroke for another object.

To use a specific interface pointer type, you can use the helper template version of this method that XAML for Windows Embedded provides. When you supply a derived type, this version automatically supplies a type-safe method that implicitly converts the returned type from a generic interface so you do not have to explicitly call QueryInterface to convert the generic interface into the required object type.

There is also an object named IXRStroke. This object is not directly related to the brush passed with this method; IXRStroke is related to ink support in XAML for Windows Embedded.

.NET Framework Equivalent

System.Windows.Shapes.Shape.Stroke

Requirements

See Also

Reference

IXRShape
IXRShape::SetStroke