GdipGetAdjustableArrowCapMiddleInset

Description

Gets the value of the inset. The middle inset is the number of units that the midpoint of the base shifts towards the vertex.

Syntax

GpStatus WINGDIPAPI GdipGetAdjustableArrowCapMiddleInset(

    GpAdjustableArrowCap* cap,

    REAL* middleInset

);

PowerBASIC Syntax

DECLARE FUNCTION GdipGetAdjustableArrowCapMiddleInset _

    BYVAL cap AS DWORD, _

    BYREF middleInset AS SINGLE _

) AS LONG

Parameters

cap

[in] Pointer to the arrow cap.

middleInset

[out] Pointer to a single precision variable that receives a value that specifies the number of units that the midpoint of the base shifts towards the vertex.

Remarks

The middle inset is the number of units that the midpoint of the base shifts towards the vertex. A middle inset of zero results in no shift — the base is a straight line, giving the arrow a triangular shape. A positive (greater than zero) middle inset results in a shift the specified number of units toward the vertex — the base is an arrow shape that points toward the vertex, giving the arrow cap a V-shape. A negative (less than zero) middle inset results in a shift the specified number of units away from the vertex — the base becomes an arrow shape that points away from the vertex, giving the arrow either a diamond shape (if the absolute value of the middle inset is equal to the height) or distorted diamond shape. If the middle inset is equal to or greater than the height of the arrow cap, the cap does not appear at all. The value of the middle inset affects the arrow cap only if the arrow cap is filled. The middle inset defaults to zero when an AdjustableArrowCap object is constructed.