GreDeleteBitmap: Difference between revisions

Latest revision as of 18:24, 5 April 2025

GreDeleteBitmap deletes the bit map identified by hbm. If the bit map is currently selected into a DC, GreDeleteBitmap returns an error.

This function is supported by the graphics engine.

Syntax

GreDeleteBitmap(hbm, pInstance, lFunction)

Parameters

hbm (HBITMAP) - input: Bit-map handle.
pInstance (PVOID) - input: Pointer to instance data.
lFunction (ULONG) - input: High-order WORD=flags; low-order WORD=NGreDeleteBitmap.

Returns

fSuccess (BOOL) - returns

Return codes.

On completion, the handling routine must return BOOLEAN (fSuccess).

TRUE Successful
FALSE Error

Possible Errors Detected: When an error is detected, the graphics engine calls WinSetErrorInfo to post the condition. Reasons for failure of this function include:

PMERR_BITMAP_IS_SELECTED
PMERR_DEV_FUNC_NOT_INSTALLED
PMERR_HBITMAP_BUSY
PMERR_INSUFFICIENT_MEMORY
PMERR_INV_HBITMAP
PMERR_INV_HDC
PMERR_INV_INFO_TABLE
PMERR_INV_LENGTH_OR_COUNT
PMERR_INV_SCAN_START

Refer to the "Error Explanations" section of the Presentation Manager Programming Reference for further explanation.

Sample

#define INCL_GRE_DEVSUPPORT
#include <os2.h>

HBITMAP    hbm;        /*  Bit-map handle. */
PVOID      pInstance;  /*  Pointer to instance data. */
ULONG      lFunction;  /*  High-order WORD=flags; low-order WORD=NGreDeleteBitmap. */
BOOL       fSuccess;   /*  Return codes. */

fSuccess = GreDeleteBitmap(hbm, pInstance, lFunction);

@@ Line 1: / Line 1: @@
 GreDeleteBitmap deletes the bit map identified by hbm. If the bit map is currently selected into a DC, GreDeleteBitmap returns an error.
 This function is supported by the graphics engine.
 == Syntax ==
-  GreDeleteBitmap(hbm, pInstance, lFunction);
+  GreDeleteBitmap(hbm, pInstance, lFunction)
 == Parameters ==
-;hbm (HBITMAP) - input
+;hbm (HBITMAP) - input:Bit-map handle.
-:Bit-map handle.
+;pInstance (PVOID) - input:Pointer to instance data.
+;lFunction (ULONG) - input:High-order WORD=flags; low-order WORD=NGreDeleteBitmap.
-;pInstance (PVOID) - input
-:Pointer to instance data.
-;lFunction (ULONG) - input
-:High-order WORD=flags; low-order WORD=NGreDeleteBitmap.
 == Returns ==
-;fSuccess (BOOL) - returns
+;fSuccess (BOOL) - returns:Return codes.
-:Return codes.
+:On completion, the handling routine must return BOOLEAN (fSuccess).
+:*TRUE Successful
-:On completion, the handling routine must return BOOLEAN (fSuccess).
+:*FALSE Error
+:Possible Errors Detected: When an error is detected, the graphics engine calls WinSetErrorInfo to post the condition. Reasons for failure of this function include:
-:*TRUE Successful
+:*PMERR_BITMAP_IS_SELECTED
-:*FALSE Error
+:*PMERR_DEV_FUNC_NOT_INSTALLED
+:*PMERR_HBITMAP_BUSY
-:Possible Errors Detected:   When an error is detected, the graphics engine calls WinSetErrorInfo to post the condition. Reasons for failure of this function include:
+:*PMERR_INSUFFICIENT_MEMORY
+:*PMERR_INV_HBITMAP
+:*PMERR_INV_HDC
-:*PMERR_BITMAP_IS_SELECTED
+:*PMERR_INV_INFO_TABLE
-:*PMERR_DEV_FUNC_NOT_INSTALLED
+:*PMERR_INV_LENGTH_OR_COUNT
-:*PMERR_HBITMAP_BUSY
+:*PMERR_INV_SCAN_START
-:*PMERR_INSUFFICIENT_MEMORY
+:Refer to the "Error Explanations" section of the Presentation Manager Programming Reference for further explanation.
-:*PMERR_INV_HBITMAP
-:*PMERR_INV_HDC
-:*PMERR_INV_INFO_TABLE
-:*PMERR_INV_LENGTH_OR_COUNT
-:*PMERR_INV_SCAN_START
-:Refer to the "Error Explanations" section of the Presentation Manager Programming Reference for further explanation.
 == Sample ==
@@ Line 50: / Line 38: @@
 BOOL       fSuccess;   /*  Return codes. */
-fSuccess = GreDeleteBitmap(hbm, pInstance,
+fSuccess = GreDeleteBitmap(hbm, pInstance, lFunction);
-             lFunction);
 </pre>
 [[Category:Gre]]