Creates a new image (icon, cursor, or bitmap) and copies the attributes of the specified image to the new one. If necessary, the function stretches the bits to fit the desired size of the new image.
Syntax
HANDLE CopyImage(
HANDLE hImage,
UINT uType,
int cxDesired,
int cyDesired,
UINT fuFlags
);
Parameters
- hImage
-
[in] Handle to the image to be copied.
- uType
-
[in] Specifies the type of image to be copied. This parameter can be one of the following values.
IMAGE_BITMAP- Copies a bitmap.
IMAGE_CURSOR- Copies a cursor.
IMAGE_ICON- Copies an icon.
- cxDesired
-
[in] Specifies the desired width, in pixels, of the image. If this is zero, then the returned image will have the same width as the original hImage.
- cyDesired
-
[in] Specifies the desired height, in pixels, of the image. If this is zero, then the returned image will have the same height as the original hImage.
- fuFlags
-
[in] This parameter can be one or more of the following values.
LR_COPYDELETEORG- Deletes the original image after creating the copy.
LR_COPYFROMRESOURCE- Tries to reload an icon or cursor resource from the original resource file rather than simply copying the current image. This is useful for creating a different-sized copy when the resource file contains multiple sizes of the resource. Without this flag, CopyImage stretches the original image to the new size. If this flag is set, CopyImage uses the size in the resource file closest to the desired size. This will succeed only if hImage was loaded by LoadIcon or LoadCursor, or by LoadImage with the LR_SHARED flag.
LR_COPYRETURNORG- Returns the original hImage if it satisfies the criteria for the copy—that is, correct dimensions and color depth—in which case the LR_COPYDELETEORG flag is ignored. If this flag is not specified, a new object is always created.
LR_CREATEDIBSECTION- If this is set and a new bitmap is created, the bitmap is created as a device-independent bitmap (DIB) section. Otherwise, the bitmap image is created as a device-dependent bitmap. This flag is only valid if uType is IMAGE_BITMAP.
LR_DEFAULTSIZE- Uses the width or height specified by the system metric values for cursors or icons, if the cxDesired or cyDesired values are set to zero. If this flag is not specified and cxDesired and cyDesired are set to zero, the function uses the actual resource size. If the resource contains multiple images, the function uses the size of the first image.
LR_MONOCHROME- Creates a new monochrome image.
Return Value
If the function succeeds, the return value is the handle to the newly created image.
If the function fails, the return value is NULL. To get extended error information, call GetLastError.
Remarks
When you are finished using the resource, you can release its associated memory by calling one of the functions in the following table.
The system automatically deletes the resource when its process terminates, however, calling the appropriate function saves memory and decreases the size of the process's working set.
Function Information
| Minimum DLL Version | user32.dll |
|---|
| Header | Declared in Winuser.h, include Windows.h |
|---|
| Import library | User32.lib |
|---|
| Minimum operating systems |
Windows 95, Windows NT 3.5 |
|---|
See Also