Edit

Share via

DrawEdge function (winuser.h)

  • Article
  • 10/13/2021

The DrawEdge function draws one or more edges of rectangle.

Syntax

BOOL DrawEdge(
  [in]      HDC    hdc,
  [in, out] LPRECT qrc,
  [in]      UINT   edge,
  [in]      UINT   grfFlags
);

Parameters

[in] hdc

A handle to the device context.

[in, out] qrc

A pointer to a RECT structure that contains the logical coordinates of the rectangle.

[in] edge

The type of inner and outer edges to draw. This parameter must be a combination of one inner-border flag and one outer-border flag. The inner-border flags are as follows.

Value Meaning
BDR_RAISEDINNER
 Raised inner edge.
BDR_SUNKENINNER
 Sunken inner edge.
 

The outer-border flags are as follows.

Value Meaning
BDR_RAISEDOUTER
 Raised outer edge.
BDR_SUNKENOUTER
 Sunken outer edge.
 

Alternatively, the edge parameter can specify one of the following flags.

Value Meaning
EDGE_BUMP
 Combination of BDR_RAISEDOUTER and BDR_SUNKENINNER.
EDGE_ETCHED
 Combination of BDR_SUNKENOUTER and BDR_RAISEDINNER.
EDGE_RAISED
 Combination of BDR_RAISEDOUTER and BDR_RAISEDINNER.
EDGE_SUNKEN
 Combination of BDR_SUNKENOUTER and BDR_SUNKENINNER.

[in] grfFlags

The type of border. This parameter can be a combination of the following values.

Value Meaning
BF_ADJUST
 If this flag is passed, shrink the rectangle pointed to by the qrc parameter to exclude the edges that were drawn.

If this flag is not passed, then do not change the rectangle pointed to by the qrc parameter.
BF_BOTTOM
 Bottom of border rectangle.
BF_BOTTOMLEFT
 Bottom and left side of border rectangle.
BF_BOTTOMRIGHT
 Bottom and right side of border rectangle.
BF_DIAGONAL
 Diagonal border.
BF_DIAGONAL_ENDBOTTOMLEFT
 Diagonal border. The end point is the lower-left corner of the rectangle; the origin is top-right corner.
BF_DIAGONAL_ENDBOTTOMRIGHT
 Diagonal border. The end point is the lower-right corner of the rectangle; the origin is top-left corner.
BF_DIAGONAL_ENDTOPLEFT
 Diagonal border. The end point is the top-left corner of the rectangle; the origin is lower-right corner.
BF_DIAGONAL_ENDTOPRIGHT
 Diagonal border. The end point is the top-right corner of the rectangle; the origin is lower-left corner.
BF_FLAT
 Flat border.
BF_LEFT
 Left side of border rectangle.
BF_MIDDLE
 Interior of rectangle to be filled.
BF_MONO
 One-dimensional border.
BF_RECT
 Entire border rectangle.
BF_RIGHT
 Right side of border rectangle.
BF_SOFT
 Soft buttons instead of tiles.
BF_TOP
 Top of border rectangle.
BF_TOPLEFT
 Top and left side of border rectangle.
BF_TOPRIGHT
 Top and right side of border rectangle.

Return value

If the function succeeds, the return value is nonzero.

If the function fails, the return value is zero.

Requirements

Requirement Value
Minimum supported client Windows 2000 Professional [desktop apps only]
Minimum supported server Windows 2000 Server [desktop apps only]
Target Platform Windows
Header winuser.h (include Windows.h)
Library User32.lib
DLL User32.dll
API set ext-ms-win-ntuser-draw-l1-1-2 (introduced in Windows 10, version 10.0.10240)

See also

Painting and Drawing Functions

Painting and Drawing Overview

RECT

Additional resources