LBitmapBase::CopyToClipboard

#include "ltwrappr.h"

virtual L_INT LBitmapBase::CopyToClipboard(hWnd, uFlags=COPY2CB_EMPTY|COPY2CB_DIB|COPY2CB_DDB|COPY2CB_PALETTE)

HWND hWnd;	/* handle to the active window that owns the clipboard */
L_UINT uFlags;	/* flag that indicates how image data is placed on the clipboard */

Copies the class object's bitmap to the clipboard.

Parameter	Description
hWnd	Handle to the active window that owns the clipboard.
uFlags	Indicates how image data is placed on the clipboard. You can use a bitwise OR ( \| ) to pass more than one value. Valid values are:
	Value	Meaning
	COPY2CB_EMPTY	[0x0001] Empty the clipboard before copying data to it.
	COPY2CB_DIB	[0x0002] Copy DIB data to the clipboard.
	COPY2CB_DDB	[0x0004] Copy DDB data to the clipboard.
	COPY2CB_PALETTE	[0x0008] Copy palette data to the clipboard.
	COPY2CB_RGN	[0x0010] Copy the bitmap's region to the clipboard.

Returns

SUCCESS	The function was successful.
< 1	An error occurred. Refer to Return Codes.

Comments

The clipboard will contain the same width, height, bits per pixel, and color order as the image in the bitmap.

Required DLLs and Libraries

LTDIS
LTFIL

For a listing of the exact DLLs and Libraries needed, based on the toolkit version, refer to Files To Be Included With Your Application.

Platforms

Win32, x64.

See Also

Functions:	LBitmapBase::IsClipboardReady, LBitmapBase::CopyFromClipboard, LBitmapBase::CopyToClipboard, Class Members
Topics:	Using DIBs, DDBs, and the Clipboard

Example

L_INT LBitmapBase__CopyToClipboardExample(LBitmapBase& MyBitmap,HWND hWnd)
{
   L_INT nRet =SUCCESS;
   if(MyBitmap.IsAllocated())
      nRet = MyBitmap.CopyToClipboard(hWnd);
   return nRet;
}