L_AnnGetFillPattern (original) (raw)
Summary
Gets the fill pattern of the specified annotation object.
Syntax
#include "l_bitmap.h"
L_LTANN_API L_INT L_AnnGetFillPattern(hObject, puFillPattern)
Parameters
HANNOBJECT hObject
Handle to the annotation object.
L_UINT *puFillPattern
Address of the variable to be updated with the object's fill pattern constant. Possible fill pattern values are:
| Value | Meaning |
|---|---|
| ANNPATTERN_SOLID | [0] Solid |
| ANNPATTERN_BDIAGONAL | [1] Backward diagonal |
| ANNPATTERN_CROSS | [2] Cross |
| ANNPATTERN_DIAGCROSS | [3] Diagonal cross |
| ANNPATTERN_FDIAGONAL | [4] Forward diagonal |
| ANNPATTERN_HORIZONTAL | [5] Horizontal |
| ANNPATTERN_VERTICAL | [6] Vertical |
Returns
| Value | Meaning |
|---|---|
| SUCCESS | The function was successful. |
| < 1 | An error occurred. Refer to Return Codes. |
Comments
Before calling this function, you must declare a variable of data type L_UINT. Then, pass the address of the variable in the puFillPattern parameter. This function will update the variable with the annotation object's fill pattern constant.
To see the possible fill modes and patterns, refer to Illustration of Fill Options for Annotations.
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
- L_AnnSetFillPattern
- L_AnnGetPolyFillMode
- L_AnnSetPolyFillMode
- L_AnnGetFillMode
- L_AnnSetFillMode
- L_AnnGetOptions
- L_AnnSetOptions
Topics
- Annotation Functions: Object Properties
- Annotation Objects - Default Values
- Annotation Objects - Automated Features
- Implementing an Automated Annotation Program
- Implementing a Non-automated Annotation Program
- Obtaining Annotation Object Information
Example
For an example, refer to L_AnnSetFillPattern.
LEADTOOLS Raster Imaging C API Help