AdjustableArrowCap Functions (GDI+)

The AdjustableArrowCap functions build a line cap that looks like an arrow.

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.

Return Values

If the function succeeds, it returns Ok, which is an element of the Status enumeration.

 

If the function fails, it returns one of the other elements of the Status enumeration.

GdipCreateAdjustableArrowCap

Description

Creates an adjustable arrow line cap with the specified height and width. The arrow line cap can be filled or nonfilled. The middle inset defaults to zero.

Syntax

GpStatus WINGDIPAPI GdipCreateAdjustableArrowCap(

    REAL height,

    REAL width,

    BOOL isFilled,

    GpAdjustableArrowCap **cap

);

PowerBASIC Syntax

DECLARE FUNCTION GdipCreateAdjustableArrowCap _

    BYVAL nHeight AS SINGLE, _

    BYVAL nWidth AS SINGLE, _

    BYVAL isFilled AS LONG, _

    BYREF cap AS DWORD _

) AS LONG

Parameters

height       

[in] Single precision number that specifies the length, in units, of the arrow from its base to its point.

width        

[in] Single precision number that specifies the distance, in units, between the corners of the base of the arrow.

isFilled       

[in] Boolean value (TRUE or FALSE) that specifies whether the arrow is filled.

cap

[out] Pointer to a variable that receives a pointer to the new created adjustable arrow line cap.

s

GdipGetAdjustableArrowCapFillState

Description

Determines whether the arrow cap is filled.

Syntax

GpStatus WINGDIPAPI GdipGetAdjustableArrowCapFillState(

    GpAdjustableArrowCap* cap,

    BOOL* fillState

);

PowerBASIC Syntax

DECLARE FUNCTION GdipGetAdjustableArrowCapFillState _

    BYVAL cap AS DWORD, _

    BYREF fillState AS LONG _

) AS LONG

Parameters

cap

[in] Pointer to the arrow cap.

fillState

[out] Pointer to a variable that receives a boolean value that indicates if the arrow cap is filled (TRUE) or not (FALSE).

GdipGetAdjustableArrowCapHeight

Description

Gets the height of the arrow cap. The height is the distance from the base of the arrow to its vertex.

Syntax

GpStatus WINGDIPAPI GdipGetAdjustableArrowCapHeight(

    GpAdjustableArrowCap* cap,

    REAL* height

);

PowerBASIC Syntax

DECLARE FUNCTION GdipGetAdjustableArrowCapHeight _

    BYVAL cap AS DWORD, _

    BYREF nHeight AS SINGLE _

) AS LONG

Parameters

cap

[in] Pointer to the arrow cap.

height

[out] Pointer to a single precision variable that receives a value that indicates the height, in units, of the arrow cap.

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.

GdipGetAdjustableArrowCapWidth

Description

Gets the width of the arrow cap. The width is the distance between the endpoints of the base of the arrow.

Syntax

GpStatus WINGDIPAPI GdipGetAdjustableArrowCapWidth(

    GpAdjustableArrowCap* cap,

    REAL* width

);

PowerBASIC Syntax

DECLARE FUNCTION GdipGetAdjustableArrowCapWidth _

    BYVAL cap AS DWORD, _

    BYREF nWidth AS SINGLE _

) AS LONG

Parameters

cap

[in] Pointer to the arrow cap.

width

[out] Pointer to a single precision variable that receives a value that specifies the distance, in units, between the two corners of the base of the arrow.

GdipSetAdjustableArrowCapFillState

Description

Sets the fill state of the arrow cap. If the arrow cap is not filled, only the outline is drawn.

Syntax

GpStatus WINGDIPAPI GdipSetAdjustableArrowCapFillState(

    GpAdjustableArrowCap* cap,

    BOOL fillState

);

PowerBASIC Syntax

DECLARE FUNCTION GdipSetAdjustableArrowCapFillState _

    BYVAL cap AS DWORD, _

    BYVAL fillState AS LONG _

) AS LONG

Parameters

cap

[in] Pointer to the arrow cap object.

fillState

[in] Boolean (TRUE or FALSE) value that specifies whether the arrow cap is filled.

GdipSetAdjustableArrowCapHeight

Description

Sets the height of the arrow cap. This is the distance from the base of the arrow to its vertex.

Syntax

GpStatus WINGDIPAPI GdipSetAdjustableArrowCapHeight(

    GpAdjustableArrowCap* cap,

    REAL height

);

PowerBASIC Syntax

DECLARE FUNCTION GdipSetAdjustableArrowCapHeight _

    BYVAL cap AS DWORD, _

    BYVAL nHeight AS SINGLE _

) AS LONG

Parameters

cap

[in] Pointer to the arrow cap.

height

[in] Single precision value that specifies the height, in units, for the arrow cap.

GdipSetAdjustableArrowCapMiddleInset

Description

Sets the number of units that the midpoint of the base shifts towards the vertex.

Syntax

GpStatus WINGDIPAPI GdipSetAdjustableArrowCapMiddleInset(

    GpAdjustableArrowCap* cap,

    REAL middleInset

);

PowerBASIC Syntax

DECLARE FUNCTION GdipSetAdjustableArrowCapMiddleInset _

    BYVAL cap AS DWORD, _

    BYVAL middleInset AS SINGLE _

) AS LONG

Parameters

cap

[in] Pointer to the arrow cap.

middleInset

[in] Single precision value that specifies the number of units that the midpoint of the base shifts towards the vertex.

GdipSetAdjustableArrowCapWidth

Description

Sets the width of the arrow cap. The width is the distance between the endpoints of the base of the arrow.

Syntax

GpStatus WINGDIPAPI GdipSetAdjustableArrowCapWidth(

    GpAdjustableArrowCap* cap,

    REAL width

);

PowerBASIC Syntax

DECLARE FUNCTION GdipSetAdjustableArrowCapWidth _

    BYVAL cap AS DWORD, _

    BYVAL nWidth AS SINGLE _

) AS LONG

Parameters

cap

[in] Pointer to the arrow cap.

width

[in] Single precision value that specifies the distance, in units, between the two corners of the base of the arrow.