The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

ID2D1StrokeStyle::GetDashes method

Copies the dash pattern to the specified array.

Syntax

C++


virtual void GetDashes(
  [out] FLOAT *dashes,
        UINT  dashesCount
) const = 0;

Parameters

dashes [out]

Type: FLOAT*

A pointer to an array that will receive the dash pattern. The array must be able to contain at least as many elements as specified by dashesCount. You must allocate storage for this array.

dashesCount

Type: UINT

The number of dashes to copy. If this value is less than the number of dashes in the stroke style's dashes array, the returned dashes are truncated to dashesCount. If this value is greater than the number of dashes in the stroke style's dashes array, the extra dashes are set to 0.0f. To obtain the actual number of dashes in the stroke style's dashes array, use the GetDashesCount method.

Return value

This method does not return a value.

Remarks

The dashes are specified in units that are a multiple of the stroke width, with subsequent members of the array indicating the dashes and gaps between dashes: the first entry indicates a filled dash, the second a gap, and so on.

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]
Minimum supported phone	Windows Phone 8.1 [Windows Phone Silverlight 8.1 and Windows Runtime apps]
Header	D2d1.h
Library	D2d1.lib
DLL	D2d1.dll