BitmapEscape (Compact 2013)

3/28/2014

This function passes its parameters for a bitmap allocated to a device through to the display driver’s DrvEscape function.

Syntax

int BitmapEscape(
    HBITMAP hbmp,
    int nEscape,
    int cbInput,
    LPCSTR lpszInData,
    int cbOutput,
    LPSTR lpszOutData
); 

Parameters

• hbmp
  [in] Handle to the bitmap passed to the display driver’s DrvEscape function. The handle is a pointer to a SURFOBJ structure that describes the bitmap.

• nEscape
  [in] Display driver escape function code to pass to the display driver’s DrvEscape function.

• cbInput
  [in] Size, in bytes, of the buffer to which lpszInData points.

• lpszInData
  [in] Pointer to the input data buffer.

• cbOutput
  [in] Size, in bytes, of the buffer to which lpszOutData points.

• lpszOutData
  [out] Pointer to the output buffer.

Return Value

Returns 0 (zero) if the escape function code specified by nEscape is not supported; otherwise, returns the value returned by the escape function specified by the nEscape parameter.

To retrieve extended error information, call GetLastError.

Remarks

The operating system passes an appropriate SURFOBJ pointer to the DrvEscape function that describes the specified bitmap surface. DrvEscape processes the escape function code passed in nEscape and returns a value to BitmapEscape, which then returns the value to the calling application.

Requirements

See Also

Reference

GDI Functions
ExtEscape
SURFOBJ

Other Resources

DrvEscape