IShellImageData::ReplaceFrame method (shimgdata.h)

Article
02/22/2024

Replaces the current frame with a new image.

Syntax

HRESULT ReplaceFrame(
  [in] Image *pImg
);

Parameters

[in] pImg

Type: Image*

The address of the new image.

Return value

Type: HRESULT

Always returns S_OK.

Remarks

You should also call IShellImageData::DiscardEdit to ensure that any edited properties of the original image are not retained.

In the case of a multiframed image such as a .gif file, the current frame is replaced. In the case of non-multiframed images such a .jpg file, the entire image is replaced.

Replacing a frame in an animated .gif file causes that file's animation to no longer be functional. Replacing a frame in a Tagged Image File Format (TIFF) file could cause that file to lose pages, particularly if the TIFF frame's image is not the same size as the original. If possible, you should always replace a TIFF frame's image with a TIFF of the same size.

The IShellImageData implementation takes ownership of the image named in pImg and the caller should not try to use it after calling IShellImageData::ReplaceFrame.

Requirements

Requirement	Value
Minimum supported client	Windows XP [desktop apps only]
Minimum supported server	Windows Server 2003 [desktop apps only]
Target Platform	Windows
Header	shimgdata.h
DLL	Shell32.dll

Share via