Ovis_Segmented_Line_Num_Segments_Set()
Abstract
Specifies the number of segments in a segmented line.
Syntax
Ovis_Segmented_Line_Num_Segments_Set (seg_line_ptr, num)
| Argument | Type | Description |
|---|---|---|
seg_line_ptr |
OvisT_Segmented_Line * |
Specifies the segmented line |
num |
unsigned char |
Specifies the number of segments |
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 number of segments in the segmented line.
Example
OvisT_2D_Segmented_Line * line;
/* … .line created at some point */
Ovis_Segmented_Line_Num_Segments_Set (line, 3);
Errors
- Decoration is not a segmented Line.
- Decoration is NIL.
- Number of segments must be greater than 0.
Reference
- Use the function
Ovis_Segmented_Line_Num_Segments_Get()to obtain the number of segments in a line.