In This Topic ▼

L_AnnGetTransparent

Summary

Gets a value indicating whether the bitmap stamp is using a transparent color.

Syntax

#include "l_bitmap.h"

L_LTANN_API L_INT L_AnnGetTransparent(hObject, pbTransparent)

Parameters

HANNOBJECT hObject

Handle of the annotation object

L_BOOL *pbTransparent

Address of the variable to be updated with a value indicating whether the bitmap stamp is transparent. Possible values are:

Value	Meaning
TRUE	The bitmap stamp is using a transparent color.
FALSE	The bitmap stamp is not using a transparent color.

Returns

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

Comments

Gets a value indicating whether the bitmap is using a transparent color. A transparent color is not painted when the image is painted.

The L_AnnGetTransparent function is valid only for the following object types when they are using a bitmap:

Point
Stamp (including the Rubber Stamp tools)

In addition, the Automation object stores transparency settings along with the other object default settings.

Call the L_AnnSetTransparent function to set such objects to use a transparent color. By default the transparent color is white (0x00FFFFFF). Call the L_AnnSetTransparentColor function to set the color to be used as the transparent color. Call the L_AnnGetTransparent function to get a value that indicates whether the bitmap being used by the annotation object is using a transparent color. Call the L_AnnGetTransparentColor function to get a value that indicates which color is being used as the transparent color.