Edit

IDesktopWallpaper::GetStatus method (shobjidl_core.h)

  • Article

Gets the current status of the slideshow.

Syntax

HRESULT GetStatus(
  [out] DESKTOP_SLIDESHOW_STATE *state
);

Parameters

[out] state

A pointer to a DESKTOP_SLIDESHOW_STATE value that, when this method returns successfully, receives one or more of the following flags.

DSS_ENABLED (0x01)

Slideshows are enabled.

DSS_SLIDESHOW (0x02)

A slideshow is currently configured.

DSS_DISABLED_BY_REMOTE_SESSION (0x04)

A remote session has temporarily disabled the slideshow.

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)

See also

IDesktopWallpaper