GdipGetPenCompoundArray

Description

Gets the compound array currently set for this Pen object.

Syntax

GpStatus WINGDIPAPI GdipGetPenCompoundArray(

    GpPen *pen,

    REAL *dash,

    INT count

);

PowerBASIC Syntax

DECLARE FUNCTION GdipGetPenCompoundArray ( _

    BYVAL pen AS DWORD, _

    BYREF dash AS SINGLE, _

    BYVAL count AS LONG _

) AS LONG

Parameters

pen

[in] Pointer to the Pen object.

dash

[out] Pointer to an array that receives the compound array.

count

[in] Long integer value that specifies the number of elements in the dash array.

Remarks

Suppose that a compound array contains the values 0.0, 0.2, 0.7, and 1.0 and that the pen has a width of 100. When you use the pen to draw, you get two parallel lines. The first line has a width of 20, the space between the two lines has a width of 50, and the second line has a width of 30.

 

For a more complex example, suppose that a compound array contains the values 0.0, 0.2, 0.3, 0.6, 0.85, and 1.0 and that the pen has a width of 100. When you use the pen to draw, you get three parallel lines. The widths of the three lines are 20, 30, and 15 respectively. The widths of the two spaces between the lines are 10 and 15 respectively.