Gdi::ExtEscape_I

  • Article

This method allows applications to access capabilities of a particular device that are not available through the graphics display interface (GDI). The OEM must implement the device capabilities that this function accesses.

static WINGDIAPI int WINAPI ExtEscape_I(
  HDC hdc, 
  int nEscape, 
  int cbInput, 
  const char* lpszInData,
  int cbOutput,
  char* lpszOutData
);

Parameters

  • hdc
    [in] Handle to the device context.
  • nEscape
    [in] Integer that specifies the escape function to be performed.
  • cbInput
    [in] Integer that specifies the number of bytes of data pointed to by the lpszInData parameter.
  • lpszInData
    [in] Long pointer to the input structure required for the specified escape.
  • cbOutput
    [in] Integer that specifies the number of bytes of data pointed to by the lpszOutData parameter.
  • lpszOutData
    [out] Long pointer to the structure that receives output from this escape. This parameter must not be NULL if you call Gdi::ExtEscape_I as a query function. If you do not want data returned in this structure, set cbOutput to 0.

Return Values

A value greater than zero indicates success. A value less than zero indicates an error. The QUERYESCSUPPORT printer escape, which checks for implementation only, returns zero when the escape is not implemented.

To get extended error information, call GetLastError.

Remarks

This method is an internal version of the ExtEscape function.

Use this method to pass a driver-defined escape value to a device.

The escape values that you pass in to this method are driver-defined. Windows CE does not support any system-defined escape values.

When using QUERYESCSUPPORT to find out whether a device supports an escape value, set the nEscape parameter to QUERYESCSUPPORT and point to the escape value in question with the lpszInData parameter.

Requirements

OS Versions: Windows CE .NET 4.0 and later.
Header: Gdi.hpp.

See Also

ExtEscape | Gdi::GetDeviceCaps_I

Last updated on Wednesday, April 13, 2005

© 2005 Microsoft Corporation. All rights reserved.