DrawEscape function (wingdi.h)

Article
02/22/2024

The DrawEscape function provides drawing capabilities of the specified video display that are not directly available through the graphics device interface (GDI).

Syntax

int DrawEscape(
  [in] HDC    hdc,
  [in] int    iEscape,
  [in] int    cjIn,
  [in] LPCSTR lpIn
);

Parameters

[in] hdc

A handle to the DC for the specified video display.

[in] iEscape

The escape function to be performed.

[in] cjIn

The number of bytes of data pointed to by the lpszInData parameter.

[in] lpIn

A pointer to the input structure required for the specified escape.

Return value

If the function is successful, the return value is greater than zero except for the QUERYESCSUPPORT draw escape, which checks for implementation only.

If the escape is not implemented, the return value is zero.

If an error occurred, the return value is less than zero.

Remarks

When an application calls the DrawEscape function, the data identified by cbInput and lpszInData is passed directly to the specified display driver.

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	wingdi.h (include Windows.h)
Library	Gdi32.lib
DLL	Gdi32.dll