Edit

IPreviewHandlerVisuals::SetBackgroundColor method (shobjidl_core.h)

  • Article

Sets the background color of the preview handler.

Syntax

HRESULT SetBackgroundColor(
  [in] COLORREF color
);

Parameters

[in] color

Type: COLORREF

A value of type COLORREF to use for the preview handler background.

Return value

Type: HRESULT

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

Remarks

Note  These are suggestions. It is not compulsory for this method to be called. The preview handlers must be able to make their own decisions.
 

Requirements

Requirement Value
Minimum supported client Windows Vista, Windows XP [desktop apps only]
Minimum supported server Windows Server 2003 [desktop apps only]
Target Platform Windows
Header shobjidl_core.h (include Shobjidl.h)
Redistributable Windows Search 4 or later