Edit

IThumbnailSettings::SetContext method (thumbcache.h)

  • Article

Enables a thumbnail provider to return a thumbnail specific to the user's context.

Initially, a thumbnail provider receives a request for a thumbnail image through a call to the IThumbnailCache::GetThumbnail method. In response, before the provider calls IExtractImage::Extract or IThumbnailProvider::GetThumbnail, the thumbnail cache can call IThumbnailSettings::SetContext to ensure that the thumbnail that is returned is appropriate to the user's context. For example, the provider could detect the new WTS_APPSTYLE flag and return a thumbnail that conforms to the Windows 8 UI guidelines.

Syntax

HRESULT SetContext(
  [in] WTS_CONTEXTFLAGS dwContext
);

Parameters

[in] dwContext

Type: WTS_CONTEXTFLAGS

One or more flags that specify the context. This value is based on the WTS_FLAGS values that are received by the thumbnail provider through the call to IThumbnailProvider::GetThumbnail.

Return value

Type: HRESULT

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 thumbcache.h

See also

IThumbnailSettings