IDesktopWallpaper::GetSlideshowOptions method (shobjidl_core.h)

Gets the current desktop wallpaper slideshow settings for shuffle and timing.

Syntax

HRESULT GetSlideshowOptions(
  [out] DESKTOP_SLIDESHOW_OPTIONS *options,
  [out] UINT                      *slideshowTick
);

Parameters

[out] options

Type: DESKTOP_SLIDESHOW_OPTIONS*

A pointer to a value that, when this method returns successfully, receives either 0 to indicate that shuffle is disabled or the following value.

DSO_SHUFFLEIMAGES (0x01)

Shuffle is enabled; the images are shown in a random order.

[out] slideshowTick

Type: UINT*

A pointer to a value that, when this method returns successfully, receives the interval between image transitions, in milliseconds.

Return value

Type: HRESULT

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

Return code Description
E_POINTER
A NULL pointer was provided in one of the parameters.

Requirements

   
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)

See also

IDesktopWallpaper

IDesktopWallpaper::SetSlideshowOptions