Edit

Share via

IDesktopWallpaper::GetPosition method (shobjidl_core.h)

  • Article

Retrieves the current display value for the desktop background image.

Syntax

HRESULT GetPosition(
  [out] DESKTOP_WALLPAPER_POSITION *position
);

Parameters

[out] position

A pointer to a value that, when this method returns successfully, receives one of the DESKTOP_WALLPAPER_POSITION enumeration values that specify how the image is being displayed on the system's monitors.

Return value

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 position.

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

IDesktopWallpaper::SetPosition