L_AnnGetSecondaryBitmap - Raster Imaging C API Help

L_AnnGetSecondaryBitmap

#include "l_bitmap.h"

L_LTANN_API L_INT L_AnnGetSecondaryBitmap(hObject, pBitmap, uStructSize)

HANNOBJECT hObject;

handle to the annotation object

pBITMAPHANDLE pBitmap;

pointer to a bitmap handle

L_UINT uStructSize;

size in bytes, of the structure pointed to by pBitmap

Retrieves the secondary bitmap of the specified object.

Parameter

Description

hObject

Handle to the annotation object.

pBitmap

Pointer to the bitmap handle that references the secondary bitmap.

uStructSize

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

Returns

SUCCESS

The function was successful.

< 1

An error occurred. Refer to Return Codes.

Comments

Only PushPin objects use a secondary bitmap.

A pushpin object has a primary bitmap, (manipulated using L_AnnSetBitmap / L_AnnGetBitmap) when the text is shown, and a secondary bitmap, changed using L_AnnSetSecondaryBitmap. 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

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.

Help Version 20.0.2018.7.30
Products | Support | Contact Us | Copyright Notices
© 1991-2018 LEAD Technologies, Inc. All Rights Reserved.

LEADTOOLS Raster Imaging C API Help