ISharedBitmap::Detach method

Retrieves the bitmap contained in an ISharedBitmap object, and returns a copy if the contained bitmap resides in shared memory. After calling this method the bitmap is no longer associated with this ISharedBitmap and you cannot call ISharedBitmap::GetSharedBitmap or ISharedBitmap::Detach on it again.

Syntax


HRESULT Detach(
  [out] HBITMAP *phbm
);

Parameters

phbm [out]

Type: HBITMAP*

When this method returns, contains a pointer to a handle to the bitmap to retrieve.

Return value

Type: HRESULT

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

Remarks

If the bitmap being retrieved resides in shared memory, a copy of the bitmap is returned. The Detach method does not release any references to the underlying shared memory.

If the bitmap being retrieved does not reside in shared memory, the bitmap itself is returned and no copy is made.

Requirements

Minimum supported client

Windows Vista [desktop apps only]

Minimum supported server

Windows Server 2008 [desktop apps only]

Header

Thumbcache.h

IDL

Thumbcache.idl

 

 

Show: