Ovis_Line_Thickness_Get()
Abstract
Returns the thickness of the line.
Syntax
Ovis_Line_Thickness_Get (line_dec_ptr, thickness_ptr)
| Argument | Type | Description |
|---|---|---|
line_dec_ptr |
OvisT_Line * |
Ovis line |
thickness_ptr |
unsigned char * |
Line thickness |
Return Type
OvisT_Compcode
OvisC_Compcode_Success if the decoration is a line. Otherwise, it returns OvisC_Compcode_Failure.
Header
ovis_decoration.h
Details
This function returns the thickness of the line. The line can be a segmented line or solid line and it can be either a 2D line or 3D line.
Example
OvisT_2D_Line * line;
unsigned char thickness;
/* … .line created at some point */
Ovis_Line_Thickness_Get (line, &thickness);
Errors
- Decoration is not a line.
- Decoration is NIL.
- Return address for thickness value is NIL.
Reference
- Use the function Ovis_Line_Thickness_Set() to set the line thickness.