Ovis_Segmented_Line_Segment_Pattern_Set()
Abstract
Specifies the pattern of a segment in a segmented line.
Syntax
Ovis_Segmented_Line_Segment_Pattern_Set (seg_line_ptr, index, pattern)
| Argument | Type | Description |
|---|---|---|
seg_line_ptr |
OvisT_Segmented_Line * |
Specifies the segmented line |
index |
unsigned char |
Specifies the index number of the line segment |
pattern |
unsigned int |
Specifies the pattern of the segment |
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 specifies the pattern for the segment in the segmented line.
If index is OVISC_SEGMENTED_LINE_ALL_SEGMENTS, all segments of the line are set to the specified pattern.
Example
OvisT_2D_Segmented_Line * line;
/* … .line created at some point */
Ovis_Segmented_Line_Segment_Pattern_Set (line, 0, 0xABABABAB);
Errors
- Decoration is not a segmented Line.
- Decoration is NIL.
- 0-based segment index (
<index>) is too large for<num>segments.
Reference
- Use the function Ovis_Segmented_Line_Segment_Pattern_Get() to obtain the pattern of a segment.