Ovis_Segmented_Line_Segment_Color_Get()
Abstract
Returns the color of a segment in a segmented line.
Syntax
Ovis_Segmented_Line_Segment_Color_Get (seg_line_ptr, index, color_ptr)
| Argument | Type | Description |
|---|---|---|
seg_line_ptr |
OvisT_Segmented_Line * |
Segmented line |
index |
unsigned char |
Index number of the line segment |
color_ptr |
PrgT_Color * |
Line segment color |
Return Type
OvisT_Compcode
OvisC_Compcode_Success if the decoration is a valid 2D or 3D segmented line; OvisC_Compcode_Failure otherwise.
Header
ovis_decoration.h
Details
This function returns the color of a segment in the segmented line.
Example
OvisT_2D_Segmented_Line * line;
PrgT_Color color;
/* … .line created at some point */
Ovis_Segmented_Line_Segment_Color_Get (line, 0, &color);
Errors
- Decoration is not a segmented Line.
- Decoration is NIL.
- 0-based segment index (
<index>) is too large for<num>segments. - Can't use 'OVISC_SEGMENTED_LINE_ALL_SEGMENTS' index value.
- Return address for color value is NIL.
Reference
- Use the function
Ovis_Segmented_Line_Segment_Color_Set()to specify the color of a segment.