ISharedBitmap::InitializeBitmap method (thumbcache.h)

Initializes a new ISharedBitmap object with a given bitmap.

Syntax

HRESULT InitializeBitmap(
  [in] HBITMAP       hbm,
  [in] WTS_ALPHATYPE wtsAT
);

Parameters

[in] hbm

Type: HBITMAP

A handle to the bitmap with which to initialize a new ISharedBitmap object. The bitmap must be a DIB.

[in] wtsAT

Type: WTS_ALPHATYPE

The alpha type of the bitmap image. May be one of the following values.

WTSAT_UNKNOWN

Cannot determine whether the bitmap has an alpha channel.

WTSAT_RGB

The bitmap does not contain an alpha channel for transparency.

WTSAT_ARGB

The bitmap contains an alpha channel for transparency.

Return value

Type: HRESULT

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

Remarks

When an ISharedBitmap object is instantiated by the client (as opposed to being returned by the IThumbnailCache::GetThumbnailByID or IThumbnailCache::GetThumbnail methods), the underlying bitmap will not reside in shared memory.

Requirements

Requirement	Value
Minimum supported client	Windows Vista [desktop apps only]
Minimum supported server	Windows Server 2008 [desktop apps only]
Target Platform	Windows
Header	thumbcache.h