GetBitmapInfo
- Updated2023-02-21
- 2 minute(s) read
int GetBitmapInfo (int bitmapID, int *colorSize, int *bitsSize, int *maskSize);
Purpose
 |
Note This function has been superseded by GetBitmapInfoEx, which supports alpha-channel transparency. |
Obtains size information about the image associated with a bitmap. You can use this information to allocate the buffers you pass to GetBitmapData.
You can obtain the ID of the bitmap object from functions such as GetCtrlBitmap.
As an alternative to this function, you can call AllocBitmapData, which allocates the buffers for you.
Parameters
| Input | ||
| Name | Type | Description |
| bitmapID | int | ID of the bitmap object that contains the image. You can obtain the ID from functions such as NewBitmap and GetCtrlBitmap. |
| Output | ||
| Name | Type | Description |
| colorSize | int | Number of bytes in the image color table. This parameter value is 0 if the pixel depth is greater than 8. You can pass NULL for this parameter. |
| bitsSize | int | Number of bytes in the image bitmap. You can pass NULL for this parameter. |
| maskSize | int | Number of bytes in the image mask. This parameter value is 0 if no mask exists. You can pass NULL for this parameter. |
Return Value
| Name | Type | Description |
| status | int | Return value indicating whether the function was successful. A negative number indicates that an error occurred. |
Additional Information
Library: User Interface Library
Include file: userint.h
LabWindows/CVI compatibility: LabWindows/CVI 4.0 and later
Examples
Refer to the following examples that use the GetBitmapInfo function:
- userint\ICOViewer.cws
Open example - userint\imagedit.cws
Open example