LAnnContainer::SetBitmap

#include "ltwrappr.h"

virtual L_INT LAnnContainer::SetBitmap(pBitmap, uFlags=0)

virtual L_INT LAnnContainer::SetBitmap(pBitmap, uFlags=0)

LBitmapBase * pBitmap;

/* pointer to an LBitmapBase object */

pBITMAPHANDLE pBitmap;

/* pointer to the bitmap handle */

L_UINT uFlags;

/* flags that indicate the objects to process */

Sets the bitmap of the annotation object.

Parameter

Description

pBitmap

Pointer to the bitmap handle referencing the bitmap to assign to the specified object.

pBitmap

Pointer to the LBitmapBase object referencing the bitmap object to assign to the specified object.

uFlags

Flags that determine which objects to process. Most of the flags apply only to container objects. You can combine values when appropriate by using a bitwise OR ( | ). The following are valid values:

 

Value

Meaning

 

0

Process only the specified object.

 

ANNFLAG_SELECTED

[0x0001] Process only objects that have the selected property set to TRUE. For getting and setting the selected property, use the LAnnContainer::GetSelectItems and LAnnotation::SetSelected functions.

 

ANNFLAG_NOTTHIS

[0x0004] Process only one level of objects within the specified container, not the container itself. If there are containers within the container, they are modified, but the objects within them are not.

 

ANNFLAG_RECURSE

[0x0008] Process objects within a container, and within any subcontainers, down to any level.

 

ANNFLAG_NOTCONTAINER

[0x0002] (Used with ANNFLAG_RECURSE) Process objects within containers, not the containers themselves.

 

ANNFLAG_NOINVALIDATE

[0x0010] Do not invalidate the affected rectangle in the window. Use this to avoid generating unwanted paint messages.

Returns

SUCCESS

The function was successful.

< 1

An error occurred. Refer to Return Codes.

Required DLLs and Libraries

LTANN

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:

Class Members

Topics:

Annotation Functions: Object Properties

Example

This is an example for LAnnContainer::SetBitmap(pBitmap,

uFlags) with pBitmap of type pBITMAPHANDLE:

L_INT LAnnContainer_SetBitmapExample(pBITMAPHANDLE pBitmap, LAnnContainer  * pAnnContainer)
{
   L_INT nRet;
   nRet = pAnnContainer->SetBitmap(pBitmap,0);
   return nRet;
}