GreGetBitmapParameters
Appearance
GreGetBitmapParameters returns, in the buffer addressed by pInfoHd, header information for the specified bit map.
This function is supported by the graphics engine.
Syntax
GreGetBitmapParameters(hbm, pInfoHd, pInstance, lFunction)
Parameters
- hbm (HBITMAP) - input
- Bit-map handle.
- pInfoHd (PBITMAPINFOHEADER) - input
- Pointer to a BITMAPINFOHEADER or to a BITMAPINFOHEADER2 structure where the returned information is stored.
- pInstance (PVOID) - input
- Pointer to instance data.
- lFunction (ULONG) - input
- High-order WORD=flags; low-order WORD=NGreGetBitmapParameters.
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
The header information is returned as a BITMAPINFOHEADER or BITMAPINFOHEADER2 structure and gives details such as the width, height, number of planes, and number of bits per pel.