IDesktopWallpaper::GetPosition method

Retrieves the current display value for the desktop background image.

Syntax


HRESULT GetPosition(
  [out]  DESKTOP_WALLPAPER_POSITION *position
);

Parameters

position [out]

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 codeDescription
E_POINTER

A NULL pointer was provided in position.

 

Requirements

Minimum supported client

Windows 8 [desktop apps only]

Minimum supported server

Windows Server 2012 [desktop apps only]

Header

Shobjidl.h

IDL

Shobjidl.idl

See also

IDesktopWallpaper
IDesktopWallpaper::SetPosition

 

 

Community Additions

ADD
Show:
© 2015 Microsoft