LBitmapBase::CopyFromClipboard

#include "ltwrappr.h"

virtual L_INT LBitmapBase::CopyFromClipboard(hWnd)

HWND hWnd;

/* handle to the active window. */

Copies image data from the clipboard to a specified bitmap. The image on the clipboard must be a DIB, DDB, or a WMF.

Parameter	Description
hWnd	Handle to the active window.

Returns

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

Comments

The LBitmapBase objects bitmap is referenced by the pointer to the bitmap handle. The bitmap will contain the same width, height, and bits per pixel as the image contained in the clipboard. The color order field in the bitmap handle will be set to ORDER_BGR. If the copied image is not in BGR order, it is up to you to change its color order using LBitmapBase::ColorRes.

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::CopyToClipboard, Class Members
Topics:	Using DIBs, DDBs, and the Clipboard

Example

L_INT LBitmapBase__CopyFromClipboardExample(LBitmapBase& MyBitmap,HWND hWnd)
{
   L_INT nRet = 0;
   if(MyBitmap.IsClipboardReady())
      nRet = MyBitmap.CopyFromClipboard(hWnd);
   return nRet;
}