IBasicBitmapOps::Clone (Compact 2013)

  • Article

3/26/2014

This feature is being deprecated for this release. Refer to this component: Windows Imaging Component.

This method makes a copy of the bitmap image object.

Syntax

HRESULT Clone(
  OPTIONAL const RECT* rect,
  IBitmapImage**       outbmp,
  BOOL                 bNeedCloneProperty
);

Parameters

  • rect
    [in] An optional pointer to a RECT structure that identifies a subset of the bitmap to copy.

    Set this pointer to NULL to copy the entire bitmap.

  • outbmp
    [out] A pointer to the resulting IBitmapImage interface pointer.

    Use the interface to access the bitmap created by this method.

  • bNeedCloneProperty
    [in] A BOOL value that specifies whether the property items associated with the bitmap should be copied.

    Set to TRUE to copy the property items, or FALSE to leave the property items for the bitmap undefined.

Return Value

If successful, this method returns S_OK.

If it fails, this method should return one of the following error values:

  • IMGERR_OBJECTBUSY
  • E_INVALIDARG
  • E_OUTOFMEMORY

For more information, see Error Codes for the Imaging API.

Requirements

Header

imaging.h

Library

Imaging.lib

See Also

Reference

IBasicBitmapOps
IBitmapImage

Other Resources

RECT