Edit

ImageList_Copy function (commctrl.h)

  • Article

Copies images within a given image list.

Syntax

BOOL ImageList_Copy(
  HIMAGELIST himlDst,
  int        iDst,
  HIMAGELIST himlSrc,
  int        iSrc,
  UINT       uFlags
);

Parameters

himlDst

Type: HIMAGELIST

A handle to an image list that is the target of the copy operation. In current versions of Windows, both himlDst and himlSrc must be identical.

iDst

Type: int

The zero-based index of the image to be used as the destination of the copy operation.

himlSrc

Type: HIMAGELIST

A handle to an image list that is the target of the copy operation. In current versions of Windows, both himlDst and himlSrc must be identical.

iSrc

Type: int

The zero-based index of the image to be used as the source of the copy operation.

uFlags

Type: UINT

the bit flag value that specifies the type of copy operation to be made. This parameter can be one of the following values:

Value Meaning
ILCF_MOVE
 The source image is copied to the destination image's index. This operation results in multiple instances of a given image.
ILCF_SWAP
 The source and destination images exchange positions within the image list.

Return value

Type: BOOL

Returns nonzero if successful, or zero otherwise.

Requirements

Requirement Value
Minimum supported client Windows Vista [desktop apps only]
Minimum supported server Windows Server 2003 [desktop apps only]
Target Platform Windows
Header commctrl.h
Library Comctl32.lib
DLL Comctl32.dll (version 4.70 or later)