GreGetBitmapDimension: Difference between revisions
Appearance
Created page with "GreGetBitmapDimension renders height and width values for the bit map indicated by hbm. This function is supported by the graphics engine. ==Syntax== GreGetBitmapDimensio..." |
mNo edit summary |
||
Line 1: | Line 1: | ||
GreGetBitmapDimension renders height and width values for the bit map indicated by hbm. | GreGetBitmapDimension renders height and width values for the bit map indicated by hbm. | ||
This function is supported by the graphics engine. | This function is supported by the graphics engine. | ||
==Syntax== | ==Syntax== | ||
GreGetBitmapDimension(hbm, pDimension, pInstance, lFunction) | GreGetBitmapDimension(hbm, pDimension, pInstance, lFunction) | ||
==Parameters== | ==Parameters== | ||
;hbm (HBITMAP) - input | ;hbm (HBITMAP) - input:Bit-map handle. | ||
:Bit-map handle. | ;pDimension (PSIZEL) - input:Pointer to width and height values in 0.1mm units. | ||
;pInstance (PVOID) - input:Pointer to instance data. | |||
;pDimension (PSIZEL) - input | ;lFunction (ULONG) - input:High-order WORD=flags; low-order WORD=NGreGetBitmapDimension. | ||
:Pointer to width and height values in 0.1mm units. | |||
;pInstance (PVOID) - input | |||
:Pointer to instance data. | |||
;lFunction (ULONG) - input | |||
:High-order WORD=flags; low-order WORD=NGreGetBitmapDimension. | |||
==Return Code== | ==Return Code== | ||
;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_HBITMAP_BUSY | ||
:*PMERR_INV_HBITMAP | |||
:Possible Errors Detected: | :Refer to the "Error Explanations" section of the ''Presentation Manager Programming Reference'' for further explanation. | ||
:*PMERR_BITMAP_IS_SELECTED | |||
:*PMERR_HBITMAP_BUSY | |||
:*PMERR_INV_HBITMAP | |||
:Refer to the "Error Explanations" section of the Presentation Manager Programming Reference for further explanation. | |||
==Remarks== | ==Remarks== | ||
These are values that have been set by a previous call to GreSetBitmapDimension. They are not used by the system. | These are values that have been set by a previous call to GreSetBitmapDimension. They are not used by the system. | ||
==Sample Code== | ==Sample Code== | ||
Line 51: | Line 38: | ||
BOOL fSuccess; /* Return codes. */ | BOOL fSuccess; /* Return codes. */ | ||
fSuccess = GreGetBitmapDimension(hbm, pDimension, | fSuccess = GreGetBitmapDimension(hbm, pDimension, pInstance, lFunction); | ||
</PRE> | </PRE> | ||
[[Category:Gre]] | [[Category:Gre]] |
Latest revision as of 04:35, 24 March 2020
GreGetBitmapDimension renders height and width values for the bit map indicated by hbm.
This function is supported by the graphics engine.
Syntax
GreGetBitmapDimension(hbm, pDimension, pInstance, lFunction)
Parameters
- hbm (HBITMAP) - input
- Bit-map handle.
- pDimension (PSIZEL) - input
- Pointer to width and height values in 0.1mm units.
- pInstance (PVOID) - input
- Pointer to instance data.
- lFunction (ULONG) - input
- High-order WORD=flags; low-order WORD=NGreGetBitmapDimension.
Return Code
- 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_HBITMAP_BUSY
- PMERR_INV_HBITMAP
- Refer to the "Error Explanations" section of the Presentation Manager Programming Reference for further explanation.
Remarks
These are values that have been set by a previous call to GreSetBitmapDimension. They are not used by the system.
Sample Code
#define INCL_GRE_DEVSUPPORT #include <os2.h> HBITMAP hbm; /* Bit-map handle. */ PSIZEL pDimension; /* Pointer to width and height values in 0.1mm units. */ PVOID pInstance; /* Pointer to instance data. */ ULONG lFunction; /* High-order WORD=flags; low-order WORD=NGreGetBitmapDimension. */ BOOL fSuccess; /* Return codes. */ fSuccess = GreGetBitmapDimension(hbm, pDimension, pInstance, lFunction);