GdipSetPenDashArray

 

 

Description

Sets an array of custom dashes and spaces for this Pen object.

Syntax

GpStatus WINGDIPAPI GdipSetPenDashArray(

    GpPen *pen,

    GDIPCONST REAL *dash,

    INT count

);

PowerBASIC Syntax

DECLARE FUNCTION GdipSetPenDashArray ( _

    BYVAL pen AS DWORD, _

    BYREF dash AS SINGLE, _

    BYVAL count AS LONG _

) AS LONG

Parameters

 

pen

[in] Pointer to the Pen object.

dash

[in] Pointer to an array of real numbers that specifies the length of the custom dashes and spaces. All elements in the array must be positive real numbers.

count

[in] Long integer that specifies the number of elements in the dash array. The integer must be greater than 0 and not greater than the total number of elements in the array.

Remarks

This method will set the DashStyle enumeration for this Pen object to DashStyleCustom.

 

The elements in the dash array set the length of each dash and space in the dash pattern. The first element sets the length of a dash, the second element sets the length of a space, the third element sets the length of a dash, and so forth.

 

The length of each dash and space in the dash pattern is the product of the element value in the array and the width of the Pen object.

 

Valid HTML 4.01 Transitional