IDesktopWallpaper::SetBackgroundColor method (shobjidl_core.h)

Sets the color that is visible on the desktop when no image is displayed or when the desktop background has been disabled. This color is also used as a border when the desktop wallpaper does not fill the entire screen.

Syntax

HRESULT SetBackgroundColor(
  [in] COLORREF color
);

Parameters

[in] color

A COLORREF value that specifies the background RGB color value.

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

IDesktopWallpaper::GetBackgroundColor