IDesktopWallpaper::AdvanceSlideshow method (shobjidl_core.h)

Article
02/22/2024

Switches the wallpaper on a specified monitor to the next image in the slideshow.

Syntax

HRESULT AdvanceSlideshow(
  [in] LPCWSTR                     monitorID,
  [in] DESKTOP_SLIDESHOW_DIRECTION direction
);

Parameters

[in] monitorID

The ID of the monitor on which to change the wallpaper image. This ID can be obtained through the GetMonitorDevicePathAt method. If this parameter is set to NULL, the monitor scheduled to change next is used.

[in] direction

The direction that the slideshow should advance. One of the following DESKTOP_SLIDESHOW_DIRECTION values:

DSD_FORWARD (0)

Advance the slideshow forward.

DSD_BACKWARD (1)

Advance the slideshow backward.

Return value

If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Requirements

Requirement	Value
Minimum supported client	Windows 8 [desktop apps only]
Minimum supported server	Windows Server 2012 [desktop apps only]
Target Platform	Windows
Header	shobjidl_core.h (include Shobjidl.h)

Share via