LAnnPushPin::GetSecondaryBitmap

#include "ltwrappr.h"

virtual L_INT LAnnPushPin::GetSecondaryBitmap(pLBitmap, uStructSize)

virtual L_INT LAnnPushPin::GetSecondaryBitmap(pBitmap, uStructSize)

Gets the bitmap handle for the secondary bitmap of the annotation object.

Parameters

LBitmapBase * pLBitmap

Pointer to an LBitmapBase object to be updated with the handle to the annotation object's secondary bitmap.

pBITMAPHANDLE pBitmap

Address of the variable to be updated with the handle to the annotation object's secondary bitmap.

L_UINT uStructSize

Size in bytes, of the structure pointed to by pBitmap, for versioning. Use sizeof(BITMAPHANDLE).

Returns

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

Comments

Before calling LAnnPushPin::GetSecondaryBitmap(pLBitmap), where pLBitmap is of type LBitmapBase, you must declare an LBitmapBase object. Then, pass the address of the object in the pLBitmap parameter. This function will update the object with the handle to the annotation object's secondary bitmap.

Before calling LAnnPushPin::GetBitmap(pBitmap), where pBitmap is of type pBITMAPHANDLE, you must declare a variable of data type BITMAPHANDLE. Then, pass the address of the variable in the pBitmap parameter. This function will update the variable with the handle to the annotation object's secondary bitmap.

A pushpin object has a primary bitmap, (manipulated using LAnnPushPin::SetBitmap/LAnnPushPin::GetBitmap) when the text is shown, and a secondary bitmap, manipulated using LAnnPushPin::SetSecondaryBitmap/LAnnPushPin::GetSecondaryBitmap. The primary bitmap is shown with the note text. The secondary bitmap is shown by itself when the note is minimized.

In design mode, the PushPin object shows the text and displays the primary bitmap. In run mode, the object shows/hides the text when clicked. The pushpin object has the active mode property. When the mode is ANNACTIVE_ENABLED, the text is shown and the primary bitmap is painted in the top-left corner of the note.

When the mode is ANNACTIVE_DISABLED, the text is hidden and the secondary bitmap is displayed.

Required DLLs and Libraries

Platforms

Win32, x64.

See Also

Functions

Topics

Example

For an example of both forms of LAnnPushPin::GetSecondaryBitmap(pBitmap), refer to LAnnPushPin::GetBitmap.

Help Version 21.0.2021.4.8
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2021 LEAD Technologies, Inc. All Rights Reserved.

LEADTOOLS Raster Imaging C++ Class Library Help